Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Service Configuration
- Errors
- Waiters
- Operations
- AssociateApi
- CreateApiCache
- CreateApiKey
- CreateDataSource
- CreateDomainName
- CreateFunction
- CreateGraphqlApi
- CreateResolver
- CreateType
- DeleteApiCache
- DeleteApiKey
- DeleteDataSource
- DeleteDomainName
- DeleteFunction
- DeleteGraphqlApi
- DeleteResolver
- DeleteType
- DisassociateApi
- EvaluateCode
- EvaluateMappingTemplate
- FlushApiCache
- GetApiAssociation
- GetApiCache
- GetDataSource
- GetDomainName
- GetFunction
- GetGraphqlApi
- GetIntrospectionSchema
- GetResolver
- GetSchemaCreationStatus
- GetType
- ListApiKeys (Paginated)
- ListDataSources (Paginated)
- ListDomainNames
- ListFunctions (Paginated)
- ListGraphqlApis (Paginated)
- ListResolvers (Paginated)
- ListResolversByFunction (Paginated)
- ListTagsForResource
- ListTypes (Paginated)
- StartSchemaCreation
- TagResource
- UntagResource
- UpdateApiCache
- UpdateApiKey
- UpdateDataSource
- UpdateDomainName
- UpdateFunction
- UpdateGraphqlApi
- UpdateResolver
- UpdateType
- Types
- ApiCacheStatus
- ApiCacheType
- ApiCachingBehavior
- AssociationStatus
- AuthenticationType
- AuthorizationType
- ConflictDetectionType
- ConflictHandlerType
- DataSourceType
- DefaultAction
- FieldLogLevel
- OutputType
- RelationalDatabaseSourceType
- ResolverKind
- RuntimeName
- SchemaStatus
- TypeDefinitionFormat
- AdditionalAuthenticationProvider
- ApiAssociation
- ApiCache
- ApiKey
- AppSyncRuntime
- AuthorizationConfig
- AwsIamConfig
- CachingConfig
- CodeError
- CodeErrorLocation
- CognitoUserPoolConfig
- DataSource
- DeltaSyncConfig
- DomainNameConfig
- DynamodbDataSourceConfig
- ElasticsearchDataSourceConfig
- ErrorDetail
- EvaluateCodeErrorDetail
- FunctionConfiguration
- GraphqlApi
- HttpDataSourceConfig
- LambdaAuthorizerConfig
- LambdaConflictHandlerConfig
- LambdaDataSourceConfig
- LogConfig
- OpenIDConnectConfig
- OpenSearchServiceDataSourceConfig
- PipelineConfig
- RdsHttpEndpointConfig
- RelationalDatabaseDataSourceConfig
- Resolver
- SyncConfig
- Type
- UserPoolConfig
Derived from API version 2017-07-25
of the AWS service descriptions, licensed under Apache 2.0.
AppSync provides API actions for creating and interacting with data sources using GraphQL from your application.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ApiKeyLimitExceededException :: AsError a => Fold a ServiceError
- _ApiKeyValidityOutOfBoundsException :: AsError a => Fold a ServiceError
- _ApiLimitExceededException :: AsError a => Fold a ServiceError
- _BadRequestException :: AsError a => Fold a ServiceError
- _ConcurrentModificationException :: AsError a => Fold a ServiceError
- _GraphQLSchemaException :: AsError a => Fold a ServiceError
- _InternalFailureException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _NotFoundException :: AsError a => Fold a ServiceError
- _UnauthorizedException :: AsError a => Fold a ServiceError
- data AssociateApi = AssociateApi' Text Text
- newAssociateApi :: Text -> Text -> AssociateApi
- data AssociateApiResponse = AssociateApiResponse' (Maybe ApiAssociation) Int
- newAssociateApiResponse :: Int -> AssociateApiResponse
- data CreateApiCache = CreateApiCache' (Maybe Bool) (Maybe Bool) Text Integer ApiCachingBehavior ApiCacheType
- newCreateApiCache :: Text -> Integer -> ApiCachingBehavior -> ApiCacheType -> CreateApiCache
- data CreateApiCacheResponse = CreateApiCacheResponse' (Maybe ApiCache) Int
- newCreateApiCacheResponse :: Int -> CreateApiCacheResponse
- data CreateApiKey = CreateApiKey' (Maybe Text) (Maybe Integer) Text
- newCreateApiKey :: Text -> CreateApiKey
- data CreateApiKeyResponse = CreateApiKeyResponse' (Maybe ApiKey) Int
- newCreateApiKeyResponse :: Int -> CreateApiKeyResponse
- data CreateDataSource = CreateDataSource' (Maybe Text) (Maybe DynamodbDataSourceConfig) (Maybe ElasticsearchDataSourceConfig) (Maybe HttpDataSourceConfig) (Maybe LambdaDataSourceConfig) (Maybe OpenSearchServiceDataSourceConfig) (Maybe RelationalDatabaseDataSourceConfig) (Maybe Text) Text Text DataSourceType
- newCreateDataSource :: Text -> Text -> DataSourceType -> CreateDataSource
- data CreateDataSourceResponse = CreateDataSourceResponse' (Maybe DataSource) Int
- newCreateDataSourceResponse :: Int -> CreateDataSourceResponse
- data CreateDomainName = CreateDomainName' (Maybe Text) Text Text
- newCreateDomainName :: Text -> Text -> CreateDomainName
- data CreateDomainNameResponse = CreateDomainNameResponse' (Maybe DomainNameConfig) Int
- newCreateDomainNameResponse :: Int -> CreateDomainNameResponse
- data CreateFunction = CreateFunction' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe AppSyncRuntime) (Maybe SyncConfig) Text Text Text
- newCreateFunction :: Text -> Text -> Text -> CreateFunction
- data CreateFunctionResponse = CreateFunctionResponse' (Maybe FunctionConfiguration) Int
- newCreateFunctionResponse :: Int -> CreateFunctionResponse
- data CreateGraphqlApi = CreateGraphqlApi' (Maybe [AdditionalAuthenticationProvider]) (Maybe LambdaAuthorizerConfig) (Maybe LogConfig) (Maybe OpenIDConnectConfig) (Maybe (HashMap Text Text)) (Maybe UserPoolConfig) (Maybe Bool) Text AuthenticationType
- newCreateGraphqlApi :: Text -> AuthenticationType -> CreateGraphqlApi
- data CreateGraphqlApiResponse = CreateGraphqlApiResponse' (Maybe GraphqlApi) Int
- newCreateGraphqlApiResponse :: Int -> CreateGraphqlApiResponse
- data CreateResolver = CreateResolver' (Maybe CachingConfig) (Maybe Text) (Maybe Text) (Maybe ResolverKind) (Maybe Natural) (Maybe PipelineConfig) (Maybe Text) (Maybe Text) (Maybe AppSyncRuntime) (Maybe SyncConfig) Text Text Text
- newCreateResolver :: Text -> Text -> Text -> CreateResolver
- data CreateResolverResponse = CreateResolverResponse' (Maybe Resolver) Int
- newCreateResolverResponse :: Int -> CreateResolverResponse
- data CreateType = CreateType' Text Text TypeDefinitionFormat
- newCreateType :: Text -> Text -> TypeDefinitionFormat -> CreateType
- data CreateTypeResponse = CreateTypeResponse' (Maybe Type) Int
- newCreateTypeResponse :: Int -> CreateTypeResponse
- data DeleteApiCache = DeleteApiCache' Text
- newDeleteApiCache :: Text -> DeleteApiCache
- data DeleteApiCacheResponse = DeleteApiCacheResponse' Int
- newDeleteApiCacheResponse :: Int -> DeleteApiCacheResponse
- data DeleteApiKey = DeleteApiKey' Text Text
- newDeleteApiKey :: Text -> Text -> DeleteApiKey
- data DeleteApiKeyResponse = DeleteApiKeyResponse' Int
- newDeleteApiKeyResponse :: Int -> DeleteApiKeyResponse
- data DeleteDataSource = DeleteDataSource' Text Text
- newDeleteDataSource :: Text -> Text -> DeleteDataSource
- data DeleteDataSourceResponse = DeleteDataSourceResponse' Int
- newDeleteDataSourceResponse :: Int -> DeleteDataSourceResponse
- data DeleteDomainName = DeleteDomainName' Text
- newDeleteDomainName :: Text -> DeleteDomainName
- data DeleteDomainNameResponse = DeleteDomainNameResponse' Int
- newDeleteDomainNameResponse :: Int -> DeleteDomainNameResponse
- data DeleteFunction = DeleteFunction' Text Text
- newDeleteFunction :: Text -> Text -> DeleteFunction
- data DeleteFunctionResponse = DeleteFunctionResponse' Int
- newDeleteFunctionResponse :: Int -> DeleteFunctionResponse
- data DeleteGraphqlApi = DeleteGraphqlApi' Text
- newDeleteGraphqlApi :: Text -> DeleteGraphqlApi
- data DeleteGraphqlApiResponse = DeleteGraphqlApiResponse' Int
- newDeleteGraphqlApiResponse :: Int -> DeleteGraphqlApiResponse
- data DeleteResolver = DeleteResolver' Text Text Text
- newDeleteResolver :: Text -> Text -> Text -> DeleteResolver
- data DeleteResolverResponse = DeleteResolverResponse' Int
- newDeleteResolverResponse :: Int -> DeleteResolverResponse
- data DeleteType = DeleteType' Text Text
- newDeleteType :: Text -> Text -> DeleteType
- data DeleteTypeResponse = DeleteTypeResponse' Int
- newDeleteTypeResponse :: Int -> DeleteTypeResponse
- data DisassociateApi = DisassociateApi' Text
- newDisassociateApi :: Text -> DisassociateApi
- data DisassociateApiResponse = DisassociateApiResponse' Int
- newDisassociateApiResponse :: Int -> DisassociateApiResponse
- data EvaluateCode = EvaluateCode' (Maybe Text) AppSyncRuntime Text Text
- newEvaluateCode :: AppSyncRuntime -> Text -> Text -> EvaluateCode
- data EvaluateCodeResponse = EvaluateCodeResponse' (Maybe EvaluateCodeErrorDetail) (Maybe Text) (Maybe [Text]) Int
- newEvaluateCodeResponse :: Int -> EvaluateCodeResponse
- data EvaluateMappingTemplate = EvaluateMappingTemplate' Text Text
- newEvaluateMappingTemplate :: Text -> Text -> EvaluateMappingTemplate
- data EvaluateMappingTemplateResponse = EvaluateMappingTemplateResponse' (Maybe ErrorDetail) (Maybe Text) (Maybe [Text]) Int
- newEvaluateMappingTemplateResponse :: Int -> EvaluateMappingTemplateResponse
- data FlushApiCache = FlushApiCache' Text
- newFlushApiCache :: Text -> FlushApiCache
- data FlushApiCacheResponse = FlushApiCacheResponse' Int
- newFlushApiCacheResponse :: Int -> FlushApiCacheResponse
- data GetApiAssociation = GetApiAssociation' Text
- newGetApiAssociation :: Text -> GetApiAssociation
- data GetApiAssociationResponse = GetApiAssociationResponse' (Maybe ApiAssociation) Int
- newGetApiAssociationResponse :: Int -> GetApiAssociationResponse
- data GetApiCache = GetApiCache' Text
- newGetApiCache :: Text -> GetApiCache
- data GetApiCacheResponse = GetApiCacheResponse' (Maybe ApiCache) Int
- newGetApiCacheResponse :: Int -> GetApiCacheResponse
- data GetDataSource = GetDataSource' Text Text
- newGetDataSource :: Text -> Text -> GetDataSource
- data GetDataSourceResponse = GetDataSourceResponse' (Maybe DataSource) Int
- newGetDataSourceResponse :: Int -> GetDataSourceResponse
- data GetDomainName = GetDomainName' Text
- newGetDomainName :: Text -> GetDomainName
- data GetDomainNameResponse = GetDomainNameResponse' (Maybe DomainNameConfig) Int
- newGetDomainNameResponse :: Int -> GetDomainNameResponse
- data GetFunction = GetFunction' Text Text
- newGetFunction :: Text -> Text -> GetFunction
- data GetFunctionResponse = GetFunctionResponse' (Maybe FunctionConfiguration) Int
- newGetFunctionResponse :: Int -> GetFunctionResponse
- data GetGraphqlApi = GetGraphqlApi' Text
- newGetGraphqlApi :: Text -> GetGraphqlApi
- data GetGraphqlApiResponse = GetGraphqlApiResponse' (Maybe GraphqlApi) Int
- newGetGraphqlApiResponse :: Int -> GetGraphqlApiResponse
- data GetIntrospectionSchema = GetIntrospectionSchema' (Maybe Bool) Text OutputType
- newGetIntrospectionSchema :: Text -> OutputType -> GetIntrospectionSchema
- data GetIntrospectionSchemaResponse = GetIntrospectionSchemaResponse' (Maybe ByteString) Int
- newGetIntrospectionSchemaResponse :: Int -> GetIntrospectionSchemaResponse
- data GetResolver = GetResolver' Text Text Text
- newGetResolver :: Text -> Text -> Text -> GetResolver
- data GetResolverResponse = GetResolverResponse' (Maybe Resolver) Int
- newGetResolverResponse :: Int -> GetResolverResponse
- data GetSchemaCreationStatus = GetSchemaCreationStatus' Text
- newGetSchemaCreationStatus :: Text -> GetSchemaCreationStatus
- data GetSchemaCreationStatusResponse = GetSchemaCreationStatusResponse' (Maybe Text) (Maybe SchemaStatus) Int
- newGetSchemaCreationStatusResponse :: Int -> GetSchemaCreationStatusResponse
- data GetType = GetType' Text Text TypeDefinitionFormat
- newGetType :: Text -> Text -> TypeDefinitionFormat -> GetType
- data GetTypeResponse = GetTypeResponse' (Maybe Type) Int
- newGetTypeResponse :: Int -> GetTypeResponse
- data ListApiKeys = ListApiKeys' (Maybe Natural) (Maybe Text) Text
- newListApiKeys :: Text -> ListApiKeys
- data ListApiKeysResponse = ListApiKeysResponse' (Maybe [ApiKey]) (Maybe Text) Int
- newListApiKeysResponse :: Int -> ListApiKeysResponse
- data ListDataSources = ListDataSources' (Maybe Natural) (Maybe Text) Text
- newListDataSources :: Text -> ListDataSources
- data ListDataSourcesResponse = ListDataSourcesResponse' (Maybe [DataSource]) (Maybe Text) Int
- newListDataSourcesResponse :: Int -> ListDataSourcesResponse
- data ListDomainNames = ListDomainNames' (Maybe Natural) (Maybe Text)
- newListDomainNames :: ListDomainNames
- data ListDomainNamesResponse = ListDomainNamesResponse' (Maybe [DomainNameConfig]) (Maybe Text) Int
- newListDomainNamesResponse :: Int -> ListDomainNamesResponse
- data ListFunctions = ListFunctions' (Maybe Natural) (Maybe Text) Text
- newListFunctions :: Text -> ListFunctions
- data ListFunctionsResponse = ListFunctionsResponse' (Maybe [FunctionConfiguration]) (Maybe Text) Int
- newListFunctionsResponse :: Int -> ListFunctionsResponse
- data ListGraphqlApis = ListGraphqlApis' (Maybe Natural) (Maybe Text)
- newListGraphqlApis :: ListGraphqlApis
- data ListGraphqlApisResponse = ListGraphqlApisResponse' (Maybe [GraphqlApi]) (Maybe Text) Int
- newListGraphqlApisResponse :: Int -> ListGraphqlApisResponse
- data ListResolvers = ListResolvers' (Maybe Natural) (Maybe Text) Text Text
- newListResolvers :: Text -> Text -> ListResolvers
- data ListResolversResponse = ListResolversResponse' (Maybe Text) (Maybe [Resolver]) Int
- newListResolversResponse :: Int -> ListResolversResponse
- data ListResolversByFunction = ListResolversByFunction' (Maybe Natural) (Maybe Text) Text Text
- newListResolversByFunction :: Text -> Text -> ListResolversByFunction
- data ListResolversByFunctionResponse = ListResolversByFunctionResponse' (Maybe Text) (Maybe [Resolver]) Int
- newListResolversByFunctionResponse :: Int -> ListResolversByFunctionResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data ListTypes = ListTypes' (Maybe Natural) (Maybe Text) Text TypeDefinitionFormat
- newListTypes :: Text -> TypeDefinitionFormat -> ListTypes
- data ListTypesResponse = ListTypesResponse' (Maybe Text) (Maybe [Type]) Int
- newListTypesResponse :: Int -> ListTypesResponse
- data StartSchemaCreation = StartSchemaCreation' Text Base64
- newStartSchemaCreation :: Text -> ByteString -> StartSchemaCreation
- data StartSchemaCreationResponse = StartSchemaCreationResponse' (Maybe SchemaStatus) Int
- newStartSchemaCreationResponse :: Int -> StartSchemaCreationResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text (NonEmpty Text)
- newUntagResource :: Text -> NonEmpty Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateApiCache = UpdateApiCache' Text Integer ApiCachingBehavior ApiCacheType
- newUpdateApiCache :: Text -> Integer -> ApiCachingBehavior -> ApiCacheType -> UpdateApiCache
- data UpdateApiCacheResponse = UpdateApiCacheResponse' (Maybe ApiCache) Int
- newUpdateApiCacheResponse :: Int -> UpdateApiCacheResponse
- data UpdateApiKey = UpdateApiKey' (Maybe Text) (Maybe Integer) Text Text
- newUpdateApiKey :: Text -> Text -> UpdateApiKey
- data UpdateApiKeyResponse = UpdateApiKeyResponse' (Maybe ApiKey) Int
- newUpdateApiKeyResponse :: Int -> UpdateApiKeyResponse
- data UpdateDataSource = UpdateDataSource' (Maybe Text) (Maybe DynamodbDataSourceConfig) (Maybe ElasticsearchDataSourceConfig) (Maybe HttpDataSourceConfig) (Maybe LambdaDataSourceConfig) (Maybe OpenSearchServiceDataSourceConfig) (Maybe RelationalDatabaseDataSourceConfig) (Maybe Text) Text Text DataSourceType
- newUpdateDataSource :: Text -> Text -> DataSourceType -> UpdateDataSource
- data UpdateDataSourceResponse = UpdateDataSourceResponse' (Maybe DataSource) Int
- newUpdateDataSourceResponse :: Int -> UpdateDataSourceResponse
- data UpdateDomainName = UpdateDomainName' (Maybe Text) Text
- newUpdateDomainName :: Text -> UpdateDomainName
- data UpdateDomainNameResponse = UpdateDomainNameResponse' (Maybe DomainNameConfig) Int
- newUpdateDomainNameResponse :: Int -> UpdateDomainNameResponse
- data UpdateFunction = UpdateFunction' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe AppSyncRuntime) (Maybe SyncConfig) Text Text Text Text
- newUpdateFunction :: Text -> Text -> Text -> Text -> UpdateFunction
- data UpdateFunctionResponse = UpdateFunctionResponse' (Maybe FunctionConfiguration) Int
- newUpdateFunctionResponse :: Int -> UpdateFunctionResponse
- data UpdateGraphqlApi = UpdateGraphqlApi' (Maybe [AdditionalAuthenticationProvider]) (Maybe AuthenticationType) (Maybe LambdaAuthorizerConfig) (Maybe LogConfig) (Maybe OpenIDConnectConfig) (Maybe UserPoolConfig) (Maybe Bool) Text Text
- newUpdateGraphqlApi :: Text -> Text -> UpdateGraphqlApi
- data UpdateGraphqlApiResponse = UpdateGraphqlApiResponse' (Maybe GraphqlApi) Int
- newUpdateGraphqlApiResponse :: Int -> UpdateGraphqlApiResponse
- data UpdateResolver = UpdateResolver' (Maybe CachingConfig) (Maybe Text) (Maybe Text) (Maybe ResolverKind) (Maybe Natural) (Maybe PipelineConfig) (Maybe Text) (Maybe Text) (Maybe AppSyncRuntime) (Maybe SyncConfig) Text Text Text
- newUpdateResolver :: Text -> Text -> Text -> UpdateResolver
- data UpdateResolverResponse = UpdateResolverResponse' (Maybe Resolver) Int
- newUpdateResolverResponse :: Int -> UpdateResolverResponse
- data UpdateType = UpdateType' (Maybe Text) Text Text TypeDefinitionFormat
- newUpdateType :: Text -> Text -> TypeDefinitionFormat -> UpdateType
- data UpdateTypeResponse = UpdateTypeResponse' (Maybe Type) Int
- newUpdateTypeResponse :: Int -> UpdateTypeResponse
- newtype ApiCacheStatus where
- ApiCacheStatus' { }
- pattern ApiCacheStatus_AVAILABLE :: ApiCacheStatus
- pattern ApiCacheStatus_CREATING :: ApiCacheStatus
- pattern ApiCacheStatus_DELETING :: ApiCacheStatus
- pattern ApiCacheStatus_FAILED :: ApiCacheStatus
- pattern ApiCacheStatus_MODIFYING :: ApiCacheStatus
- newtype ApiCacheType where
- ApiCacheType' { }
- pattern ApiCacheType_LARGE :: ApiCacheType
- pattern ApiCacheType_LARGE_12X :: ApiCacheType
- pattern ApiCacheType_LARGE_2X :: ApiCacheType
- pattern ApiCacheType_LARGE_4X :: ApiCacheType
- pattern ApiCacheType_LARGE_8X :: ApiCacheType
- pattern ApiCacheType_MEDIUM :: ApiCacheType
- pattern ApiCacheType_R4_2XLARGE :: ApiCacheType
- pattern ApiCacheType_R4_4XLARGE :: ApiCacheType
- pattern ApiCacheType_R4_8XLARGE :: ApiCacheType
- pattern ApiCacheType_R4_LARGE :: ApiCacheType
- pattern ApiCacheType_R4_XLARGE :: ApiCacheType
- pattern ApiCacheType_SMALL :: ApiCacheType
- pattern ApiCacheType_T2_MEDIUM :: ApiCacheType
- pattern ApiCacheType_T2_SMALL :: ApiCacheType
- pattern ApiCacheType_XLARGE :: ApiCacheType
- newtype ApiCachingBehavior where
- newtype AssociationStatus where
- AssociationStatus' { }
- pattern AssociationStatus_FAILED :: AssociationStatus
- pattern AssociationStatus_PROCESSING :: AssociationStatus
- pattern AssociationStatus_SUCCESS :: AssociationStatus
- newtype AuthenticationType where
- AuthenticationType' { }
- pattern AuthenticationType_AMAZON_COGNITO_USER_POOLS :: AuthenticationType
- pattern AuthenticationType_API_KEY :: AuthenticationType
- pattern AuthenticationType_AWS_IAM :: AuthenticationType
- pattern AuthenticationType_AWS_LAMBDA :: AuthenticationType
- pattern AuthenticationType_OPENID_CONNECT :: AuthenticationType
- newtype AuthorizationType where
- newtype ConflictDetectionType where
- newtype ConflictHandlerType where
- newtype DataSourceType where
- DataSourceType' { }
- pattern DataSourceType_AMAZON_DYNAMODB :: DataSourceType
- pattern DataSourceType_AMAZON_ELASTICSEARCH :: DataSourceType
- pattern DataSourceType_AMAZON_OPENSEARCH_SERVICE :: DataSourceType
- pattern DataSourceType_AWS_LAMBDA :: DataSourceType
- pattern DataSourceType_HTTP :: DataSourceType
- pattern DataSourceType_NONE :: DataSourceType
- pattern DataSourceType_RELATIONAL_DATABASE :: DataSourceType
- newtype DefaultAction where
- DefaultAction' { }
- pattern DefaultAction_ALLOW :: DefaultAction
- pattern DefaultAction_DENY :: DefaultAction
- newtype FieldLogLevel where
- FieldLogLevel' { }
- pattern FieldLogLevel_ALL :: FieldLogLevel
- pattern FieldLogLevel_ERROR :: FieldLogLevel
- pattern FieldLogLevel_NONE :: FieldLogLevel
- newtype OutputType where
- OutputType' { }
- pattern OutputType_JSON :: OutputType
- pattern OutputType_SDL :: OutputType
- newtype RelationalDatabaseSourceType where
- newtype ResolverKind where
- ResolverKind' { }
- pattern ResolverKind_PIPELINE :: ResolverKind
- pattern ResolverKind_UNIT :: ResolverKind
- newtype RuntimeName where
- RuntimeName' { }
- pattern RuntimeName_APPSYNC_JS :: RuntimeName
- newtype SchemaStatus where
- SchemaStatus' { }
- pattern SchemaStatus_ACTIVE :: SchemaStatus
- pattern SchemaStatus_DELETING :: SchemaStatus
- pattern SchemaStatus_FAILED :: SchemaStatus
- pattern SchemaStatus_NOT_APPLICABLE :: SchemaStatus
- pattern SchemaStatus_PROCESSING :: SchemaStatus
- pattern SchemaStatus_SUCCESS :: SchemaStatus
- newtype TypeDefinitionFormat where
- data AdditionalAuthenticationProvider = AdditionalAuthenticationProvider' (Maybe AuthenticationType) (Maybe LambdaAuthorizerConfig) (Maybe OpenIDConnectConfig) (Maybe CognitoUserPoolConfig)
- newAdditionalAuthenticationProvider :: AdditionalAuthenticationProvider
- data ApiAssociation = ApiAssociation' (Maybe Text) (Maybe AssociationStatus) (Maybe Text) (Maybe Text)
- newApiAssociation :: ApiAssociation
- data ApiCache = ApiCache' (Maybe ApiCachingBehavior) (Maybe Bool) (Maybe ApiCacheStatus) (Maybe Bool) (Maybe Integer) (Maybe ApiCacheType)
- newApiCache :: ApiCache
- data ApiKey = ApiKey' (Maybe Integer) (Maybe Text) (Maybe Integer) (Maybe Text)
- newApiKey :: ApiKey
- data AppSyncRuntime = AppSyncRuntime' RuntimeName Text
- newAppSyncRuntime :: RuntimeName -> Text -> AppSyncRuntime
- data AuthorizationConfig = AuthorizationConfig' (Maybe AwsIamConfig) AuthorizationType
- newAuthorizationConfig :: AuthorizationType -> AuthorizationConfig
- data AwsIamConfig = AwsIamConfig' (Maybe Text) (Maybe Text)
- newAwsIamConfig :: AwsIamConfig
- data CachingConfig = CachingConfig' (Maybe [Text]) Integer
- newCachingConfig :: Integer -> CachingConfig
- data CodeError = CodeError' (Maybe Text) (Maybe CodeErrorLocation) (Maybe Text)
- newCodeError :: CodeError
- data CodeErrorLocation = CodeErrorLocation' (Maybe Int) (Maybe Int) (Maybe Int)
- newCodeErrorLocation :: CodeErrorLocation
- data CognitoUserPoolConfig = CognitoUserPoolConfig' (Maybe Text) Text Text
- newCognitoUserPoolConfig :: Text -> Text -> CognitoUserPoolConfig
- data DataSource = DataSource' (Maybe Text) (Maybe Text) (Maybe DynamodbDataSourceConfig) (Maybe ElasticsearchDataSourceConfig) (Maybe HttpDataSourceConfig) (Maybe LambdaDataSourceConfig) (Maybe Text) (Maybe OpenSearchServiceDataSourceConfig) (Maybe RelationalDatabaseDataSourceConfig) (Maybe Text) (Maybe DataSourceType)
- newDataSource :: DataSource
- data DeltaSyncConfig = DeltaSyncConfig' (Maybe Integer) (Maybe Text) (Maybe Integer)
- newDeltaSyncConfig :: DeltaSyncConfig
- data DomainNameConfig = DomainNameConfig' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newDomainNameConfig :: DomainNameConfig
- data DynamodbDataSourceConfig = DynamodbDataSourceConfig' (Maybe DeltaSyncConfig) (Maybe Bool) (Maybe Bool) Text Text
- newDynamodbDataSourceConfig :: Text -> Text -> DynamodbDataSourceConfig
- data ElasticsearchDataSourceConfig = ElasticsearchDataSourceConfig' Text Text
- newElasticsearchDataSourceConfig :: Text -> Text -> ElasticsearchDataSourceConfig
- data ErrorDetail = ErrorDetail' (Maybe Text)
- newErrorDetail :: ErrorDetail
- data EvaluateCodeErrorDetail = EvaluateCodeErrorDetail' (Maybe [CodeError]) (Maybe Text)
- newEvaluateCodeErrorDetail :: EvaluateCodeErrorDetail
- data FunctionConfiguration = FunctionConfiguration' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe AppSyncRuntime) (Maybe SyncConfig)
- newFunctionConfiguration :: FunctionConfiguration
- data GraphqlApi = GraphqlApi' (Maybe [AdditionalAuthenticationProvider]) (Maybe Text) (Maybe Text) (Maybe AuthenticationType) (Maybe LambdaAuthorizerConfig) (Maybe LogConfig) (Maybe Text) (Maybe OpenIDConnectConfig) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe UserPoolConfig) (Maybe Text) (Maybe Bool)
- newGraphqlApi :: GraphqlApi
- data HttpDataSourceConfig = HttpDataSourceConfig' (Maybe AuthorizationConfig) (Maybe Text)
- newHttpDataSourceConfig :: HttpDataSourceConfig
- data LambdaAuthorizerConfig = LambdaAuthorizerConfig' (Maybe Natural) (Maybe Text) Text
- newLambdaAuthorizerConfig :: Text -> LambdaAuthorizerConfig
- data LambdaConflictHandlerConfig = LambdaConflictHandlerConfig' (Maybe Text)
- newLambdaConflictHandlerConfig :: LambdaConflictHandlerConfig
- data LambdaDataSourceConfig = LambdaDataSourceConfig' Text
- newLambdaDataSourceConfig :: Text -> LambdaDataSourceConfig
- data LogConfig = LogConfig' (Maybe Bool) FieldLogLevel Text
- newLogConfig :: FieldLogLevel -> Text -> LogConfig
- data OpenIDConnectConfig = OpenIDConnectConfig' (Maybe Integer) (Maybe Text) (Maybe Integer) Text
- newOpenIDConnectConfig :: Text -> OpenIDConnectConfig
- data OpenSearchServiceDataSourceConfig = OpenSearchServiceDataSourceConfig' Text Text
- newOpenSearchServiceDataSourceConfig :: Text -> Text -> OpenSearchServiceDataSourceConfig
- data PipelineConfig = PipelineConfig' (Maybe [Text])
- newPipelineConfig :: PipelineConfig
- data RdsHttpEndpointConfig = RdsHttpEndpointConfig' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newRdsHttpEndpointConfig :: RdsHttpEndpointConfig
- data RelationalDatabaseDataSourceConfig = RelationalDatabaseDataSourceConfig' (Maybe RdsHttpEndpointConfig) (Maybe RelationalDatabaseSourceType)
- newRelationalDatabaseDataSourceConfig :: RelationalDatabaseDataSourceConfig
- data Resolver = Resolver' (Maybe CachingConfig) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ResolverKind) (Maybe Natural) (Maybe PipelineConfig) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe AppSyncRuntime) (Maybe SyncConfig) (Maybe Text)
- newResolver :: Resolver
- data SyncConfig = SyncConfig' (Maybe ConflictDetectionType) (Maybe ConflictHandlerType) (Maybe LambdaConflictHandlerConfig)
- newSyncConfig :: SyncConfig
- data Type = Type' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe TypeDefinitionFormat) (Maybe Text)
- newType :: Type
- data UserPoolConfig = UserPoolConfig' (Maybe Text) Text Text DefaultAction
- newUserPoolConfig :: Text -> Text -> DefaultAction -> UserPoolConfig
Service Configuration
defaultService :: Service Source #
API version 2017-07-25
of the Amazon AppSync SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by AppSync
.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You don't have access to perform this operation on this resource.
ApiKeyLimitExceededException
_ApiKeyLimitExceededException :: AsError a => Fold a ServiceError Source #
The API key exceeded a limit. Try your request again.
ApiKeyValidityOutOfBoundsException
_ApiKeyValidityOutOfBoundsException :: AsError a => Fold a ServiceError Source #
The API key expiration must be set to a value between 1 and 365 days
from creation (for CreateApiKey
) or from update (for UpdateApiKey
).
ApiLimitExceededException
_ApiLimitExceededException :: AsError a => Fold a ServiceError Source #
The GraphQL API exceeded a limit. Try your request again.
BadRequestException
_BadRequestException :: AsError a => Fold a ServiceError Source #
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.
ConcurrentModificationException
_ConcurrentModificationException :: AsError a => Fold a ServiceError Source #
Another modification is in progress at this time and it must complete before you can make your change.
GraphQLSchemaException
_GraphQLSchemaException :: AsError a => Fold a ServiceError Source #
The GraphQL schema is not valid.
InternalFailureException
_InternalFailureException :: AsError a => Fold a ServiceError Source #
An internal AppSync error occurred. Try your request again.
LimitExceededException
_LimitExceededException :: AsError a => Fold a ServiceError Source #
The request exceeded a limit. Try your request again.
NotFoundException
_NotFoundException :: AsError a => Fold a ServiceError Source #
The resource specified in the request was not found. Check the resource, and then try again.
UnauthorizedException
_UnauthorizedException :: AsError a => Fold a ServiceError Source #
You aren't authorized to perform this operation.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
AssociateApi
data AssociateApi Source #
See: newAssociateApi
smart constructor.
Instances
Create a value of AssociateApi
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AssociateApi
, associateApi_domainName
- The domain name.
AssociateApi
, associateApi_apiId
- The API ID.
data AssociateApiResponse Source #
See: newAssociateApiResponse
smart constructor.
Instances
newAssociateApiResponse Source #
Create a value of AssociateApiResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:apiAssociation:AssociateApiResponse'
, associateApiResponse_apiAssociation
- The ApiAssociation
object.
$sel:httpStatus:AssociateApiResponse'
, associateApiResponse_httpStatus
- The response's http status code.
CreateApiCache
data CreateApiCache Source #
Represents the input of a CreateApiCache
operation.
See: newCreateApiCache
smart constructor.
Instances
:: Text | |
-> Integer | |
-> ApiCachingBehavior | |
-> ApiCacheType | |
-> CreateApiCache |
Create a value of CreateApiCache
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateApiCache
, createApiCache_atRestEncryptionEnabled
- At-rest encryption flag for cache. You cannot update this setting after
creation.
CreateApiCache
, createApiCache_transitEncryptionEnabled
- Transit encryption flag when connecting to cache. You cannot update this
setting after creation.
CreateApiCache
, createApiCache_apiId
- The GraphQL API ID.
CreateApiCache
, createApiCache_ttl
- TTL in seconds for cache entries.
Valid values are 1–3,600 seconds.
CreateApiCache
, createApiCache_apiCachingBehavior
- Caching behavior.
- FULL_REQUEST_CACHING: All requests are fully cached.
- PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
CreateApiCache
, createApiCache_type
- The cache instance type. Valid values are
SMALL
MEDIUM
LARGE
XLARGE
LARGE_2X
LARGE_4X
LARGE_8X
(not available in all regions)LARGE_12X
Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.
The following legacy instance types are available, but their use is discouraged:
- T2_SMALL: A t2.small instance type.
- T2_MEDIUM: A t2.medium instance type.
- R4_LARGE: A r4.large instance type.
- R4_XLARGE: A r4.xlarge instance type.
- R4_2XLARGE: A r4.2xlarge instance type.
- R4_4XLARGE: A r4.4xlarge instance type.
- R4_8XLARGE: A r4.8xlarge instance type.
data CreateApiCacheResponse Source #
Represents the output of a CreateApiCache
operation.
See: newCreateApiCacheResponse
smart constructor.
Instances
newCreateApiCacheResponse Source #
Create a value of CreateApiCacheResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:apiCache:CreateApiCacheResponse'
, createApiCacheResponse_apiCache
- The ApiCache
object.
$sel:httpStatus:CreateApiCacheResponse'
, createApiCacheResponse_httpStatus
- The response's http status code.
CreateApiKey
data CreateApiKey Source #
See: newCreateApiKey
smart constructor.
Instances
Create a value of CreateApiKey
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateApiKey
, createApiKey_description
- A description of the purpose of the API key.
CreateApiKey
, createApiKey_expires
- From the creation time, the time after which the API key expires. The
date is represented as seconds since the epoch, rounded down to the
nearest hour. The default value for this parameter is 7 days from
creation time. For more information, see .
CreateApiKey
, createApiKey_apiId
- The ID for your GraphQL API.
data CreateApiKeyResponse Source #
See: newCreateApiKeyResponse
smart constructor.
Instances
newCreateApiKeyResponse Source #
Create a value of CreateApiKeyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:apiKey:CreateApiKeyResponse'
, createApiKeyResponse_apiKey
- The API key.
$sel:httpStatus:CreateApiKeyResponse'
, createApiKeyResponse_httpStatus
- The response's http status code.
CreateDataSource
data CreateDataSource Source #
See: newCreateDataSource
smart constructor.
Instances
Create a value of CreateDataSource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateDataSource
, createDataSource_description
- A description of the DataSource
.
CreateDataSource
, createDataSource_dynamodbConfig
- Amazon DynamoDB settings.
CreateDataSource
, createDataSource_elasticsearchConfig
- Amazon OpenSearch Service settings.
As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is deprecated. For new data sources, use CreateDataSourceRequest$openSearchServiceConfig to create an OpenSearch data source.
CreateDataSource
, createDataSource_httpConfig
- HTTP endpoint settings.
CreateDataSource
, createDataSource_lambdaConfig
- Lambda settings.
CreateDataSource
, createDataSource_openSearchServiceConfig
- Amazon OpenSearch Service settings.
CreateDataSource
, createDataSource_relationalDatabaseConfig
- Relational database settings.
CreateDataSource
, createDataSource_serviceRoleArn
- The Identity and Access Management (IAM) service role Amazon Resource
Name (ARN) for the data source. The system assumes this role when
accessing the data source.
CreateDataSource
, createDataSource_apiId
- The API ID for the GraphQL API for the DataSource
.
CreateDataSource
, createDataSource_name
- A user-supplied name for the DataSource
.
CreateDataSource
, createDataSource_type
- The type of the DataSource
.
data CreateDataSourceResponse Source #
See: newCreateDataSourceResponse
smart constructor.
Instances
newCreateDataSourceResponse Source #
Create a value of CreateDataSourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataSource:CreateDataSourceResponse'
, createDataSourceResponse_dataSource
- The DataSource
object.
$sel:httpStatus:CreateDataSourceResponse'
, createDataSourceResponse_httpStatus
- The response's http status code.
CreateDomainName
data CreateDomainName Source #
See: newCreateDomainName
smart constructor.
Instances
Create a value of CreateDomainName
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateDomainName
, createDomainName_description
- A description of the DomainName
.
CreateDomainName
, createDomainName_domainName
- The domain name.
CreateDomainName
, createDomainName_certificateArn
- The Amazon Resource Name (ARN) of the certificate. This can be an
Certificate Manager (ACM) certificate or an Identity and Access
Management (IAM) server certificate.
data CreateDomainNameResponse Source #
See: newCreateDomainNameResponse
smart constructor.
Instances
newCreateDomainNameResponse Source #
Create a value of CreateDomainNameResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainNameConfig:CreateDomainNameResponse'
, createDomainNameResponse_domainNameConfig
- The configuration for the DomainName
.
$sel:httpStatus:CreateDomainNameResponse'
, createDomainNameResponse_httpStatus
- The response's http status code.
CreateFunction
data CreateFunction Source #
See: newCreateFunction
smart constructor.
CreateFunction' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe AppSyncRuntime) (Maybe SyncConfig) Text Text Text |
Instances
Create a value of CreateFunction
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateFunction
, createFunction_code
- The function
code that contains the request and response functions.
When code is used, the runtime
is required. The runtime
value must
be APPSYNC_JS
.
CreateFunction
, createFunction_description
- The Function
description.
CreateFunction
, createFunction_functionVersion
- The version
of the request mapping template. Currently, the supported
value is 2018-05-29. Note that when using VTL and mapping templates, the
functionVersion
is required.
CreateFunction
, createFunction_maxBatchSize
- The maximum batching size for a resolver.
CreateFunction
, createFunction_requestMappingTemplate
- The Function
request mapping template. Functions support only the
2018-05-29 version of the request mapping template.
CreateFunction
, createFunction_responseMappingTemplate
- The Function
response mapping template.
CreateFunction
, createFunction_runtime
- Undocumented member.
CreateFunction
, createFunction_syncConfig
- Undocumented member.
CreateFunction
, createFunction_apiId
- The GraphQL API ID.
CreateFunction
, createFunction_name
- The Function
name. The function name does not have to be unique.
CreateFunction
, createFunction_dataSourceName
- The Function
DataSource
name.
data CreateFunctionResponse Source #
See: newCreateFunctionResponse
smart constructor.
Instances
newCreateFunctionResponse Source #
Create a value of CreateFunctionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:functionConfiguration:CreateFunctionResponse'
, createFunctionResponse_functionConfiguration
- The Function
object.
$sel:httpStatus:CreateFunctionResponse'
, createFunctionResponse_httpStatus
- The response's http status code.
CreateGraphqlApi
data CreateGraphqlApi Source #
See: newCreateGraphqlApi
smart constructor.
Instances
Create a value of CreateGraphqlApi
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateGraphqlApi
, createGraphqlApi_additionalAuthenticationProviders
- A list of additional authentication providers for the GraphqlApi
API.
CreateGraphqlApi
, createGraphqlApi_lambdaAuthorizerConfig
- Configuration for Lambda function authorization.
CreateGraphqlApi
, createGraphqlApi_logConfig
- The Amazon CloudWatch Logs configuration.
CreateGraphqlApi
, createGraphqlApi_openIDConnectConfig
- The OIDC configuration.
CreateGraphqlApi
, createGraphqlApi_tags
- A TagMap
object.
CreateGraphqlApi
, createGraphqlApi_userPoolConfig
- The Amazon Cognito user pool configuration.
CreateGraphqlApi
, createGraphqlApi_xrayEnabled
- A flag indicating whether to use X-Ray tracing for the GraphqlApi
.
CreateGraphqlApi
, createGraphqlApi_name
- A user-supplied name for the GraphqlApi
.
CreateGraphqlApi
, createGraphqlApi_authenticationType
- The authentication type: API key, Identity and Access Management (IAM),
OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
data CreateGraphqlApiResponse Source #
See: newCreateGraphqlApiResponse
smart constructor.
Instances
newCreateGraphqlApiResponse Source #
Create a value of CreateGraphqlApiResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:graphqlApi:CreateGraphqlApiResponse'
, createGraphqlApiResponse_graphqlApi
- The GraphqlApi
.
$sel:httpStatus:CreateGraphqlApiResponse'
, createGraphqlApiResponse_httpStatus
- The response's http status code.
CreateResolver
data CreateResolver Source #
See: newCreateResolver
smart constructor.
CreateResolver' (Maybe CachingConfig) (Maybe Text) (Maybe Text) (Maybe ResolverKind) (Maybe Natural) (Maybe PipelineConfig) (Maybe Text) (Maybe Text) (Maybe AppSyncRuntime) (Maybe SyncConfig) Text Text Text |
Instances
Create a value of CreateResolver
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateResolver
, createResolver_cachingConfig
- The caching configuration for the resolver.
CreateResolver
, createResolver_code
- The resolver
code that contains the request and response functions.
When code is used, the runtime
is required. The runtime
value must
be APPSYNC_JS
.
CreateResolver
, createResolver_dataSourceName
- The name of the data source for which the resolver is being created.
CreateResolver
, createResolver_kind
- The resolver type.
- UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.
- PIPELINE: A PIPELINE resolver type. You can use a PIPELINE
resolver to invoke a series of
Function
objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.
CreateResolver
, createResolver_maxBatchSize
- The maximum batching size for a resolver.
CreateResolver
, createResolver_pipelineConfig
- The PipelineConfig
.
CreateResolver
, createResolver_requestMappingTemplate
- The mapping template to use for requests.
A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source can understand. Mapping templates are written in Apache Velocity Template Language (VTL).
VTL request mapping templates are optional when using an Lambda data source. For all other data sources, VTL request and response mapping templates are required.
CreateResolver
, createResolver_responseMappingTemplate
- The mapping template to use for responses from the data source.
CreateResolver
, createResolver_runtime
- Undocumented member.
CreateResolver
, createResolver_syncConfig
- The SyncConfig
for a resolver attached to a versioned data source.
CreateResolver
, createResolver_apiId
- The ID for the GraphQL API for which the resolver is being created.
CreateResolver
, createResolver_typeName
- The name of the Type
.
CreateResolver
, createResolver_fieldName
- The name of the field to attach the resolver to.
data CreateResolverResponse Source #
See: newCreateResolverResponse
smart constructor.
Instances
newCreateResolverResponse Source #
Create a value of CreateResolverResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resolver:CreateResolverResponse'
, createResolverResponse_resolver
- The Resolver
object.
$sel:httpStatus:CreateResolverResponse'
, createResolverResponse_httpStatus
- The response's http status code.
CreateType
data CreateType Source #
See: newCreateType
smart constructor.
Instances
Create a value of CreateType
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateType
, createType_apiId
- The API ID.
CreateType
, createType_definition
- The type definition, in GraphQL Schema Definition Language (SDL) format.
For more information, see the GraphQL SDL documentation.
CreateType
, createType_format
- The type format: SDL or JSON.
data CreateTypeResponse Source #
See: newCreateTypeResponse
smart constructor.
Instances
newCreateTypeResponse Source #
Create a value of CreateTypeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateTypeResponse
, createTypeResponse_type
- The Type
object.
$sel:httpStatus:CreateTypeResponse'
, createTypeResponse_httpStatus
- The response's http status code.
DeleteApiCache
data DeleteApiCache Source #
Represents the input of a DeleteApiCache
operation.
See: newDeleteApiCache
smart constructor.
Instances
Create a value of DeleteApiCache
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteApiCache
, deleteApiCache_apiId
- The API ID.
data DeleteApiCacheResponse Source #
Represents the output of a DeleteApiCache
operation.
See: newDeleteApiCacheResponse
smart constructor.
Instances
Generic DeleteApiCacheResponse Source # | |
Defined in Amazonka.AppSync.DeleteApiCache type Rep DeleteApiCacheResponse :: Type -> Type # | |
Read DeleteApiCacheResponse Source # | |
Show DeleteApiCacheResponse Source # | |
Defined in Amazonka.AppSync.DeleteApiCache showsPrec :: Int -> DeleteApiCacheResponse -> ShowS # show :: DeleteApiCacheResponse -> String # showList :: [DeleteApiCacheResponse] -> ShowS # | |
NFData DeleteApiCacheResponse Source # | |
Defined in Amazonka.AppSync.DeleteApiCache rnf :: DeleteApiCacheResponse -> () # | |
Eq DeleteApiCacheResponse Source # | |
Defined in Amazonka.AppSync.DeleteApiCache | |
type Rep DeleteApiCacheResponse Source # | |
Defined in Amazonka.AppSync.DeleteApiCache type Rep DeleteApiCacheResponse = D1 ('MetaData "DeleteApiCacheResponse" "Amazonka.AppSync.DeleteApiCache" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" 'False) (C1 ('MetaCons "DeleteApiCacheResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDeleteApiCacheResponse Source #
Create a value of DeleteApiCacheResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteApiCacheResponse'
, deleteApiCacheResponse_httpStatus
- The response's http status code.
DeleteApiKey
data DeleteApiKey Source #
See: newDeleteApiKey
smart constructor.
Instances
Create a value of DeleteApiKey
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteApiKey
, deleteApiKey_apiId
- The API ID.
DeleteApiKey
, deleteApiKey_id
- The ID for the API key.
data DeleteApiKeyResponse Source #
See: newDeleteApiKeyResponse
smart constructor.
Instances
newDeleteApiKeyResponse Source #
Create a value of DeleteApiKeyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteApiKeyResponse'
, deleteApiKeyResponse_httpStatus
- The response's http status code.
DeleteDataSource
data DeleteDataSource Source #
See: newDeleteDataSource
smart constructor.
Instances
Create a value of DeleteDataSource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteDataSource
, deleteDataSource_apiId
- The API ID.
DeleteDataSource
, deleteDataSource_name
- The name of the data source.
data DeleteDataSourceResponse Source #
See: newDeleteDataSourceResponse
smart constructor.
Instances
newDeleteDataSourceResponse Source #
Create a value of DeleteDataSourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteDataSourceResponse'
, deleteDataSourceResponse_httpStatus
- The response's http status code.
DeleteDomainName
data DeleteDomainName Source #
See: newDeleteDomainName
smart constructor.
Instances
Create a value of DeleteDomainName
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteDomainName
, deleteDomainName_domainName
- The domain name.
data DeleteDomainNameResponse Source #
See: newDeleteDomainNameResponse
smart constructor.
Instances
newDeleteDomainNameResponse Source #
Create a value of DeleteDomainNameResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteDomainNameResponse'
, deleteDomainNameResponse_httpStatus
- The response's http status code.
DeleteFunction
data DeleteFunction Source #
See: newDeleteFunction
smart constructor.
Instances
Create a value of DeleteFunction
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteFunction
, deleteFunction_apiId
- The GraphQL API ID.
DeleteFunction
, deleteFunction_functionId
- The Function
ID.
data DeleteFunctionResponse Source #
See: newDeleteFunctionResponse
smart constructor.
Instances
Generic DeleteFunctionResponse Source # | |
Defined in Amazonka.AppSync.DeleteFunction type Rep DeleteFunctionResponse :: Type -> Type # | |
Read DeleteFunctionResponse Source # | |
Show DeleteFunctionResponse Source # | |
Defined in Amazonka.AppSync.DeleteFunction showsPrec :: Int -> DeleteFunctionResponse -> ShowS # show :: DeleteFunctionResponse -> String # showList :: [DeleteFunctionResponse] -> ShowS # | |
NFData DeleteFunctionResponse Source # | |
Defined in Amazonka.AppSync.DeleteFunction rnf :: DeleteFunctionResponse -> () # | |
Eq DeleteFunctionResponse Source # | |
Defined in Amazonka.AppSync.DeleteFunction | |
type Rep DeleteFunctionResponse Source # | |
Defined in Amazonka.AppSync.DeleteFunction type Rep DeleteFunctionResponse = D1 ('MetaData "DeleteFunctionResponse" "Amazonka.AppSync.DeleteFunction" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" 'False) (C1 ('MetaCons "DeleteFunctionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDeleteFunctionResponse Source #
Create a value of DeleteFunctionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteFunctionResponse'
, deleteFunctionResponse_httpStatus
- The response's http status code.
DeleteGraphqlApi
data DeleteGraphqlApi Source #
See: newDeleteGraphqlApi
smart constructor.
Instances
Create a value of DeleteGraphqlApi
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteGraphqlApi
, deleteGraphqlApi_apiId
- The API ID.
data DeleteGraphqlApiResponse Source #
See: newDeleteGraphqlApiResponse
smart constructor.
Instances
newDeleteGraphqlApiResponse Source #
Create a value of DeleteGraphqlApiResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteGraphqlApiResponse'
, deleteGraphqlApiResponse_httpStatus
- The response's http status code.
DeleteResolver
data DeleteResolver Source #
See: newDeleteResolver
smart constructor.
Instances
Create a value of DeleteResolver
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteResolver
, deleteResolver_apiId
- The API ID.
DeleteResolver
, deleteResolver_typeName
- The name of the resolver type.
DeleteResolver
, deleteResolver_fieldName
- The resolver field name.
data DeleteResolverResponse Source #
See: newDeleteResolverResponse
smart constructor.
Instances
Generic DeleteResolverResponse Source # | |
Defined in Amazonka.AppSync.DeleteResolver type Rep DeleteResolverResponse :: Type -> Type # | |
Read DeleteResolverResponse Source # | |
Show DeleteResolverResponse Source # | |
Defined in Amazonka.AppSync.DeleteResolver showsPrec :: Int -> DeleteResolverResponse -> ShowS # show :: DeleteResolverResponse -> String # showList :: [DeleteResolverResponse] -> ShowS # | |
NFData DeleteResolverResponse Source # | |
Defined in Amazonka.AppSync.DeleteResolver rnf :: DeleteResolverResponse -> () # | |
Eq DeleteResolverResponse Source # | |
Defined in Amazonka.AppSync.DeleteResolver | |
type Rep DeleteResolverResponse Source # | |
Defined in Amazonka.AppSync.DeleteResolver type Rep DeleteResolverResponse = D1 ('MetaData "DeleteResolverResponse" "Amazonka.AppSync.DeleteResolver" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" 'False) (C1 ('MetaCons "DeleteResolverResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDeleteResolverResponse Source #
Create a value of DeleteResolverResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteResolverResponse'
, deleteResolverResponse_httpStatus
- The response's http status code.
DeleteType
data DeleteType Source #
See: newDeleteType
smart constructor.
Instances
Create a value of DeleteType
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteType
, deleteType_apiId
- The API ID.
DeleteType
, deleteType_typeName
- The type name.
data DeleteTypeResponse Source #
See: newDeleteTypeResponse
smart constructor.
Instances
newDeleteTypeResponse Source #
Create a value of DeleteTypeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteTypeResponse'
, deleteTypeResponse_httpStatus
- The response's http status code.
DisassociateApi
data DisassociateApi Source #
See: newDisassociateApi
smart constructor.
Instances
Create a value of DisassociateApi
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DisassociateApi
, disassociateApi_domainName
- The domain name.
data DisassociateApiResponse Source #
See: newDisassociateApiResponse
smart constructor.
Instances
newDisassociateApiResponse Source #
Create a value of DisassociateApiResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DisassociateApiResponse'
, disassociateApiResponse_httpStatus
- The response's http status code.
EvaluateCode
data EvaluateCode Source #
See: newEvaluateCode
smart constructor.
Instances
Create a value of EvaluateCode
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:function:EvaluateCode'
, evaluateCode_function
- The function within the code to be evaluated. If provided, the valid
values are request
and response
.
EvaluateCode
, evaluateCode_runtime
- The runtime to be used when evaluating the code. Currently, only the
APPSYNC_JS
runtime is supported.
EvaluateCode
, evaluateCode_code
- The code definition to be evaluated. Note that code
and runtime
are
both required for this action. The runtime
value must be APPSYNC_JS
.
$sel:context:EvaluateCode'
, evaluateCode_context
- The map that holds all of the contextual information for your resolver
invocation. A context
is required for this action.
data EvaluateCodeResponse Source #
See: newEvaluateCodeResponse
smart constructor.
Instances
newEvaluateCodeResponse Source #
Create a value of EvaluateCodeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:error:EvaluateCodeResponse'
, evaluateCodeResponse_error
- Contains the payload of the response error.
$sel:evaluationResult:EvaluateCodeResponse'
, evaluateCodeResponse_evaluationResult
- The result of the evaluation operation.
$sel:logs:EvaluateCodeResponse'
, evaluateCodeResponse_logs
- A list of logs that were generated by calls to util.log.info
and
util.log.error
in the evaluated code.
$sel:httpStatus:EvaluateCodeResponse'
, evaluateCodeResponse_httpStatus
- The response's http status code.
EvaluateMappingTemplate
data EvaluateMappingTemplate Source #
See: newEvaluateMappingTemplate
smart constructor.
Instances
newEvaluateMappingTemplate Source #
:: Text | |
-> Text | |
-> EvaluateMappingTemplate |
Create a value of EvaluateMappingTemplate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:template:EvaluateMappingTemplate'
, evaluateMappingTemplate_template
- The mapping template; this can be a request or response template. A
template
is required for this action.
$sel:context:EvaluateMappingTemplate'
, evaluateMappingTemplate_context
- The map that holds all of the contextual information for your resolver
invocation. A context
is required for this action.
data EvaluateMappingTemplateResponse Source #
See: newEvaluateMappingTemplateResponse
smart constructor.
Instances
newEvaluateMappingTemplateResponse Source #
Create a value of EvaluateMappingTemplateResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:error:EvaluateMappingTemplateResponse'
, evaluateMappingTemplateResponse_error
- The ErrorDetail
object.
$sel:evaluationResult:EvaluateMappingTemplateResponse'
, evaluateMappingTemplateResponse_evaluationResult
- The mapping template; this can be a request or response template.
$sel:logs:EvaluateMappingTemplateResponse'
, evaluateMappingTemplateResponse_logs
- A list of logs that were generated by calls to util.log.info
and
util.log.error
in the evaluated code.
$sel:httpStatus:EvaluateMappingTemplateResponse'
, evaluateMappingTemplateResponse_httpStatus
- The response's http status code.
FlushApiCache
data FlushApiCache Source #
Represents the input of a FlushApiCache
operation.
See: newFlushApiCache
smart constructor.
Instances
Create a value of FlushApiCache
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
FlushApiCache
, flushApiCache_apiId
- The API ID.
data FlushApiCacheResponse Source #
Represents the output of a FlushApiCache
operation.
See: newFlushApiCacheResponse
smart constructor.
Instances
newFlushApiCacheResponse Source #
Create a value of FlushApiCacheResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:FlushApiCacheResponse'
, flushApiCacheResponse_httpStatus
- The response's http status code.
GetApiAssociation
data GetApiAssociation Source #
See: newGetApiAssociation
smart constructor.
Instances
Create a value of GetApiAssociation
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetApiAssociation
, getApiAssociation_domainName
- The domain name.
data GetApiAssociationResponse Source #
See: newGetApiAssociationResponse
smart constructor.
Instances
newGetApiAssociationResponse Source #
Create a value of GetApiAssociationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:apiAssociation:GetApiAssociationResponse'
, getApiAssociationResponse_apiAssociation
- The ApiAssociation
object.
$sel:httpStatus:GetApiAssociationResponse'
, getApiAssociationResponse_httpStatus
- The response's http status code.
GetApiCache
data GetApiCache Source #
Represents the input of a GetApiCache
operation.
See: newGetApiCache
smart constructor.
Instances
Create a value of GetApiCache
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetApiCache
, getApiCache_apiId
- The API ID.
data GetApiCacheResponse Source #
Represents the output of a GetApiCache
operation.
See: newGetApiCacheResponse
smart constructor.
Instances
newGetApiCacheResponse Source #
Create a value of GetApiCacheResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:apiCache:GetApiCacheResponse'
, getApiCacheResponse_apiCache
- The ApiCache
object.
$sel:httpStatus:GetApiCacheResponse'
, getApiCacheResponse_httpStatus
- The response's http status code.
GetDataSource
data GetDataSource Source #
See: newGetDataSource
smart constructor.
Instances
Create a value of GetDataSource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetDataSource
, getDataSource_apiId
- The API ID.
GetDataSource
, getDataSource_name
- The name of the data source.
data GetDataSourceResponse Source #
See: newGetDataSourceResponse
smart constructor.
Instances
newGetDataSourceResponse Source #
Create a value of GetDataSourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataSource:GetDataSourceResponse'
, getDataSourceResponse_dataSource
- The DataSource
object.
$sel:httpStatus:GetDataSourceResponse'
, getDataSourceResponse_httpStatus
- The response's http status code.
GetDomainName
data GetDomainName Source #
See: newGetDomainName
smart constructor.
Instances
Create a value of GetDomainName
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetDomainName
, getDomainName_domainName
- The domain name.
data GetDomainNameResponse Source #
See: newGetDomainNameResponse
smart constructor.
Instances
newGetDomainNameResponse Source #
Create a value of GetDomainNameResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainNameConfig:GetDomainNameResponse'
, getDomainNameResponse_domainNameConfig
- The configuration for the DomainName
.
$sel:httpStatus:GetDomainNameResponse'
, getDomainNameResponse_httpStatus
- The response's http status code.
GetFunction
data GetFunction Source #
See: newGetFunction
smart constructor.
Instances
Create a value of GetFunction
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetFunction
, getFunction_apiId
- The GraphQL API ID.
GetFunction
, getFunction_functionId
- The Function
ID.
data GetFunctionResponse Source #
See: newGetFunctionResponse
smart constructor.
Instances
newGetFunctionResponse Source #
Create a value of GetFunctionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:functionConfiguration:GetFunctionResponse'
, getFunctionResponse_functionConfiguration
- The Function
object.
$sel:httpStatus:GetFunctionResponse'
, getFunctionResponse_httpStatus
- The response's http status code.
GetGraphqlApi
data GetGraphqlApi Source #
See: newGetGraphqlApi
smart constructor.
Instances
Create a value of GetGraphqlApi
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetGraphqlApi
, getGraphqlApi_apiId
- The API ID for the GraphQL API.
data GetGraphqlApiResponse Source #
See: newGetGraphqlApiResponse
smart constructor.
Instances
newGetGraphqlApiResponse Source #
Create a value of GetGraphqlApiResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:graphqlApi:GetGraphqlApiResponse'
, getGraphqlApiResponse_graphqlApi
- The GraphqlApi
object.
$sel:httpStatus:GetGraphqlApiResponse'
, getGraphqlApiResponse_httpStatus
- The response's http status code.
GetIntrospectionSchema
data GetIntrospectionSchema Source #
See: newGetIntrospectionSchema
smart constructor.
Instances
newGetIntrospectionSchema Source #
Create a value of GetIntrospectionSchema
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:includeDirectives:GetIntrospectionSchema'
, getIntrospectionSchema_includeDirectives
- A flag that specifies whether the schema introspection should contain
directives.
GetIntrospectionSchema
, getIntrospectionSchema_apiId
- The API ID.
GetIntrospectionSchema
, getIntrospectionSchema_format
- The schema format: SDL or JSON.
data GetIntrospectionSchemaResponse Source #
See: newGetIntrospectionSchemaResponse
smart constructor.
Instances
Generic GetIntrospectionSchemaResponse Source # | |
Read GetIntrospectionSchemaResponse Source # | |
Show GetIntrospectionSchemaResponse Source # | |
Defined in Amazonka.AppSync.GetIntrospectionSchema | |
NFData GetIntrospectionSchemaResponse Source # | |
Defined in Amazonka.AppSync.GetIntrospectionSchema rnf :: GetIntrospectionSchemaResponse -> () # | |
Eq GetIntrospectionSchemaResponse Source # | |
type Rep GetIntrospectionSchemaResponse Source # | |
Defined in Amazonka.AppSync.GetIntrospectionSchema type Rep GetIntrospectionSchemaResponse = D1 ('MetaData "GetIntrospectionSchemaResponse" "Amazonka.AppSync.GetIntrospectionSchema" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" 'False) (C1 ('MetaCons "GetIntrospectionSchemaResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ByteString)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newGetIntrospectionSchemaResponse Source #
Create a value of GetIntrospectionSchemaResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetIntrospectionSchemaResponse
, getIntrospectionSchemaResponse_schema
- The schema, in GraphQL Schema Definition Language (SDL) format.
For more information, see the GraphQL SDL documentation.
$sel:httpStatus:GetIntrospectionSchemaResponse'
, getIntrospectionSchemaResponse_httpStatus
- The response's http status code.
GetResolver
data GetResolver Source #
See: newGetResolver
smart constructor.
Instances
Create a value of GetResolver
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetResolver
, getResolver_apiId
- The API ID.
GetResolver
, getResolver_typeName
- The resolver type name.
GetResolver
, getResolver_fieldName
- The resolver field name.
data GetResolverResponse Source #
See: newGetResolverResponse
smart constructor.
Instances
newGetResolverResponse Source #
Create a value of GetResolverResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resolver:GetResolverResponse'
, getResolverResponse_resolver
- The Resolver
object.
$sel:httpStatus:GetResolverResponse'
, getResolverResponse_httpStatus
- The response's http status code.
GetSchemaCreationStatus
data GetSchemaCreationStatus Source #
See: newGetSchemaCreationStatus
smart constructor.
Instances
newGetSchemaCreationStatus Source #
Create a value of GetSchemaCreationStatus
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetSchemaCreationStatus
, getSchemaCreationStatus_apiId
- The API ID.
data GetSchemaCreationStatusResponse Source #
See: newGetSchemaCreationStatusResponse
smart constructor.
Instances
newGetSchemaCreationStatusResponse Source #
Create a value of GetSchemaCreationStatusResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:details:GetSchemaCreationStatusResponse'
, getSchemaCreationStatusResponse_details
- Detailed information about the status of the schema creation operation.
GetSchemaCreationStatusResponse
, getSchemaCreationStatusResponse_status
- The current state of the schema (PROCESSING, FAILED, SUCCESS, or
NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add
data.
$sel:httpStatus:GetSchemaCreationStatusResponse'
, getSchemaCreationStatusResponse_httpStatus
- The response's http status code.
GetType
See: newGetType
smart constructor.
Instances
Create a value of GetType
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetType
, getType_apiId
- The API ID.
GetType
, getType_typeName
- The type name.
GetType
, getType_format
- The type format: SDL or JSON.
data GetTypeResponse Source #
See: newGetTypeResponse
smart constructor.
Instances
Create a value of GetTypeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetTypeResponse
, getTypeResponse_type
- The Type
object.
$sel:httpStatus:GetTypeResponse'
, getTypeResponse_httpStatus
- The response's http status code.
ListApiKeys (Paginated)
data ListApiKeys Source #
See: newListApiKeys
smart constructor.
Instances
Create a value of ListApiKeys
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListApiKeys'
, listApiKeys_maxResults
- The maximum number of results that you want the request to return.
ListApiKeys
, listApiKeys_nextToken
- An identifier that was returned from the previous call to this
operation, which you can use to return the next set of items in the
list.
ListApiKeys
, listApiKeys_apiId
- The API ID.
data ListApiKeysResponse Source #
See: newListApiKeysResponse
smart constructor.
Instances
newListApiKeysResponse Source #
Create a value of ListApiKeysResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:apiKeys:ListApiKeysResponse'
, listApiKeysResponse_apiKeys
- The ApiKey
objects.
ListApiKeys
, listApiKeysResponse_nextToken
- An identifier to pass in the next request to this operation to return
the next set of items in the list.
$sel:httpStatus:ListApiKeysResponse'
, listApiKeysResponse_httpStatus
- The response's http status code.
ListDataSources (Paginated)
data ListDataSources Source #
See: newListDataSources
smart constructor.
Instances
Create a value of ListDataSources
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListDataSources'
, listDataSources_maxResults
- The maximum number of results that you want the request to return.
ListDataSources
, listDataSources_nextToken
- An identifier that was returned from the previous call to this
operation, which you can use to return the next set of items in the
list.
ListDataSources
, listDataSources_apiId
- The API ID.
data ListDataSourcesResponse Source #
See: newListDataSourcesResponse
smart constructor.
Instances
newListDataSourcesResponse Source #
Create a value of ListDataSourcesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataSources:ListDataSourcesResponse'
, listDataSourcesResponse_dataSources
- The DataSource
objects.
ListDataSources
, listDataSourcesResponse_nextToken
- An identifier to pass in the next request to this operation to return
the next set of items in the list.
$sel:httpStatus:ListDataSourcesResponse'
, listDataSourcesResponse_httpStatus
- The response's http status code.
ListDomainNames
data ListDomainNames Source #
See: newListDomainNames
smart constructor.
Instances
newListDomainNames :: ListDomainNames Source #
Create a value of ListDomainNames
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListDomainNames'
, listDomainNames_maxResults
- The maximum number of results that you want the request to return.
ListDomainNames
, listDomainNames_nextToken
- The API token.
data ListDomainNamesResponse Source #
See: newListDomainNamesResponse
smart constructor.
Instances
newListDomainNamesResponse Source #
Create a value of ListDomainNamesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainNameConfigs:ListDomainNamesResponse'
, listDomainNamesResponse_domainNameConfigs
- Lists configurations for multiple domain names.
ListDomainNames
, listDomainNamesResponse_nextToken
- The API token.
$sel:httpStatus:ListDomainNamesResponse'
, listDomainNamesResponse_httpStatus
- The response's http status code.
ListFunctions (Paginated)
data ListFunctions Source #
See: newListFunctions
smart constructor.
Instances
Create a value of ListFunctions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListFunctions'
, listFunctions_maxResults
- The maximum number of results that you want the request to return.
ListFunctions
, listFunctions_nextToken
- An identifier that was returned from the previous call to this
operation, which you can use to return the next set of items in the
list.
ListFunctions
, listFunctions_apiId
- The GraphQL API ID.
data ListFunctionsResponse Source #
See: newListFunctionsResponse
smart constructor.
Instances
newListFunctionsResponse Source #
Create a value of ListFunctionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListFunctionsResponse
, listFunctionsResponse_functions
- A list of Function
objects.
ListFunctions
, listFunctionsResponse_nextToken
- An identifier that was returned from the previous call to this
operation, which you can use to return the next set of items in the
list.
$sel:httpStatus:ListFunctionsResponse'
, listFunctionsResponse_httpStatus
- The response's http status code.
ListGraphqlApis (Paginated)
data ListGraphqlApis Source #
See: newListGraphqlApis
smart constructor.
Instances
newListGraphqlApis :: ListGraphqlApis Source #
Create a value of ListGraphqlApis
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListGraphqlApis'
, listGraphqlApis_maxResults
- The maximum number of results that you want the request to return.
ListGraphqlApis
, listGraphqlApis_nextToken
- An identifier that was returned from the previous call to this
operation, which you can use to return the next set of items in the
list.
data ListGraphqlApisResponse Source #
See: newListGraphqlApisResponse
smart constructor.
Instances
newListGraphqlApisResponse Source #
Create a value of ListGraphqlApisResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:graphqlApis:ListGraphqlApisResponse'
, listGraphqlApisResponse_graphqlApis
- The GraphqlApi
objects.
ListGraphqlApis
, listGraphqlApisResponse_nextToken
- An identifier to pass in the next request to this operation to return
the next set of items in the list.
$sel:httpStatus:ListGraphqlApisResponse'
, listGraphqlApisResponse_httpStatus
- The response's http status code.
ListResolvers (Paginated)
data ListResolvers Source #
See: newListResolvers
smart constructor.
Instances
Create a value of ListResolvers
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListResolvers'
, listResolvers_maxResults
- The maximum number of results that you want the request to return.
ListResolvers
, listResolvers_nextToken
- An identifier that was returned from the previous call to this
operation, which you can use to return the next set of items in the
list.
ListResolvers
, listResolvers_apiId
- The API ID.
ListResolvers
, listResolvers_typeName
- The type name.
data ListResolversResponse Source #
See: newListResolversResponse
smart constructor.
Instances
newListResolversResponse Source #
Create a value of ListResolversResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListResolvers
, listResolversResponse_nextToken
- An identifier to pass in the next request to this operation to return
the next set of items in the list.
$sel:resolvers:ListResolversResponse'
, listResolversResponse_resolvers
- The Resolver
objects.
$sel:httpStatus:ListResolversResponse'
, listResolversResponse_httpStatus
- The response's http status code.
ListResolversByFunction (Paginated)
data ListResolversByFunction Source #
See: newListResolversByFunction
smart constructor.
Instances
newListResolversByFunction Source #
Create a value of ListResolversByFunction
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListResolversByFunction'
, listResolversByFunction_maxResults
- The maximum number of results that you want the request to return.
ListResolversByFunction
, listResolversByFunction_nextToken
- An identifier that was returned from the previous call to this
operation, which you can use to return the next set of items in the
list.
ListResolversByFunction
, listResolversByFunction_apiId
- The API ID.
ListResolversByFunction
, listResolversByFunction_functionId
- The function ID.
data ListResolversByFunctionResponse Source #
See: newListResolversByFunctionResponse
smart constructor.
Instances
newListResolversByFunctionResponse Source #
Create a value of ListResolversByFunctionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListResolversByFunction
, listResolversByFunctionResponse_nextToken
- An identifier that you can use to return the next set of items in the
list.
$sel:resolvers:ListResolversByFunctionResponse'
, listResolversByFunctionResponse_resolvers
- The list of resolvers.
$sel:httpStatus:ListResolversByFunctionResponse'
, listResolversByFunctionResponse_httpStatus
- The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:ListTagsForResource'
, listTagsForResource_resourceArn
- The GraphqlApi
Amazon Resource Name (ARN).
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTagsForResourceResponse
, listTagsForResourceResponse_tags
- A TagMap
object.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
ListTypes (Paginated)
See: newListTypes
smart constructor.
Instances
Create a value of ListTypes
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListTypes'
, listTypes_maxResults
- The maximum number of results that you want the request to return.
ListTypes
, listTypes_nextToken
- An identifier that was returned from the previous call to this
operation, which you can use to return the next set of items in the
list.
ListTypes
, listTypes_apiId
- The API ID.
ListTypes
, listTypes_format
- The type format: SDL or JSON.
data ListTypesResponse Source #
See: newListTypesResponse
smart constructor.
Instances
Create a value of ListTypesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTypes
, listTypesResponse_nextToken
- An identifier to pass in the next request to this operation to return
the next set of items in the list.
$sel:types:ListTypesResponse'
, listTypesResponse_types
- The Type
objects.
$sel:httpStatus:ListTypesResponse'
, listTypesResponse_httpStatus
- The response's http status code.
StartSchemaCreation
data StartSchemaCreation Source #
See: newStartSchemaCreation
smart constructor.
Instances
newStartSchemaCreation Source #
Create a value of StartSchemaCreation
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartSchemaCreation
, startSchemaCreation_apiId
- The API ID.
StartSchemaCreation
, startSchemaCreation_definition
- The schema definition, in GraphQL schema language format.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
data StartSchemaCreationResponse Source #
See: newStartSchemaCreationResponse
smart constructor.
Instances
newStartSchemaCreationResponse Source #
Create a value of StartSchemaCreationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartSchemaCreationResponse
, startSchemaCreationResponse_status
- The current state of the schema (PROCESSING, FAILED, SUCCESS, or
NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add
data.
$sel:httpStatus:StartSchemaCreationResponse'
, startSchemaCreationResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:TagResource'
, tagResource_resourceArn
- The GraphqlApi
Amazon Resource Name (ARN).
TagResource
, tagResource_tags
- A TagMap
object.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
Create a value of TagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:UntagResource'
, untagResource_resourceArn
- The GraphqlApi
Amazon Resource Name (ARN).
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- A list of TagKey
objects.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
UpdateApiCache
data UpdateApiCache Source #
Represents the input of a UpdateApiCache
operation.
See: newUpdateApiCache
smart constructor.
Instances
:: Text | |
-> Integer | |
-> ApiCachingBehavior | |
-> ApiCacheType | |
-> UpdateApiCache |
Create a value of UpdateApiCache
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateApiCache
, updateApiCache_apiId
- The GraphQL API ID.
UpdateApiCache
, updateApiCache_ttl
- TTL in seconds for cache entries.
Valid values are 1–3,600 seconds.
UpdateApiCache
, updateApiCache_apiCachingBehavior
- Caching behavior.
- FULL_REQUEST_CACHING: All requests are fully cached.
- PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
UpdateApiCache
, updateApiCache_type
- The cache instance type. Valid values are
SMALL
MEDIUM
LARGE
XLARGE
LARGE_2X
LARGE_4X
LARGE_8X
(not available in all regions)LARGE_12X
Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.
The following legacy instance types are available, but their use is discouraged:
- T2_SMALL: A t2.small instance type.
- T2_MEDIUM: A t2.medium instance type.
- R4_LARGE: A r4.large instance type.
- R4_XLARGE: A r4.xlarge instance type.
- R4_2XLARGE: A r4.2xlarge instance type.
- R4_4XLARGE: A r4.4xlarge instance type.
- R4_8XLARGE: A r4.8xlarge instance type.
data UpdateApiCacheResponse Source #
Represents the output of a UpdateApiCache
operation.
See: newUpdateApiCacheResponse
smart constructor.
Instances
newUpdateApiCacheResponse Source #
Create a value of UpdateApiCacheResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:apiCache:UpdateApiCacheResponse'
, updateApiCacheResponse_apiCache
- The ApiCache
object.
$sel:httpStatus:UpdateApiCacheResponse'
, updateApiCacheResponse_httpStatus
- The response's http status code.
UpdateApiKey
data UpdateApiKey Source #
See: newUpdateApiKey
smart constructor.
Instances
Create a value of UpdateApiKey
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateApiKey
, updateApiKey_description
- A description of the purpose of the API key.
UpdateApiKey
, updateApiKey_expires
- From the update time, the time after which the API key expires. The date
is represented as seconds since the epoch. For more information, see .
UpdateApiKey
, updateApiKey_apiId
- The ID for the GraphQL API.
UpdateApiKey
, updateApiKey_id
- The API key ID.
data UpdateApiKeyResponse Source #
See: newUpdateApiKeyResponse
smart constructor.
Instances
newUpdateApiKeyResponse Source #
Create a value of UpdateApiKeyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:apiKey:UpdateApiKeyResponse'
, updateApiKeyResponse_apiKey
- The API key.
$sel:httpStatus:UpdateApiKeyResponse'
, updateApiKeyResponse_httpStatus
- The response's http status code.
UpdateDataSource
data UpdateDataSource Source #
See: newUpdateDataSource
smart constructor.
Instances
Create a value of UpdateDataSource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateDataSource
, updateDataSource_description
- The new description for the data source.
UpdateDataSource
, updateDataSource_dynamodbConfig
- The new Amazon DynamoDB configuration.
UpdateDataSource
, updateDataSource_elasticsearchConfig
- The new OpenSearch configuration.
As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is deprecated. Instead, use UpdateDataSourceRequest$openSearchServiceConfig to update an OpenSearch data source.
UpdateDataSource
, updateDataSource_httpConfig
- The new HTTP endpoint configuration.
UpdateDataSource
, updateDataSource_lambdaConfig
- The new Lambda configuration.
UpdateDataSource
, updateDataSource_openSearchServiceConfig
- The new OpenSearch configuration.
UpdateDataSource
, updateDataSource_relationalDatabaseConfig
- The new relational database configuration.
UpdateDataSource
, updateDataSource_serviceRoleArn
- The new service role Amazon Resource Name (ARN) for the data source.
UpdateDataSource
, updateDataSource_apiId
- The API ID.
UpdateDataSource
, updateDataSource_name
- The new name for the data source.
UpdateDataSource
, updateDataSource_type
- The new data source type.
data UpdateDataSourceResponse Source #
See: newUpdateDataSourceResponse
smart constructor.
Instances
newUpdateDataSourceResponse Source #
Create a value of UpdateDataSourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataSource:UpdateDataSourceResponse'
, updateDataSourceResponse_dataSource
- The updated DataSource
object.
$sel:httpStatus:UpdateDataSourceResponse'
, updateDataSourceResponse_httpStatus
- The response's http status code.
UpdateDomainName
data UpdateDomainName Source #
See: newUpdateDomainName
smart constructor.
Instances
Create a value of UpdateDomainName
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateDomainName
, updateDomainName_description
- A description of the DomainName
.
UpdateDomainName
, updateDomainName_domainName
- The domain name.
data UpdateDomainNameResponse Source #
See: newUpdateDomainNameResponse
smart constructor.
Instances
newUpdateDomainNameResponse Source #
Create a value of UpdateDomainNameResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainNameConfig:UpdateDomainNameResponse'
, updateDomainNameResponse_domainNameConfig
- The configuration for the DomainName
.
$sel:httpStatus:UpdateDomainNameResponse'
, updateDomainNameResponse_httpStatus
- The response's http status code.
UpdateFunction
data UpdateFunction Source #
See: newUpdateFunction
smart constructor.
UpdateFunction' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe AppSyncRuntime) (Maybe SyncConfig) Text Text Text Text |
Instances
:: Text | |
-> Text | |
-> Text | |
-> Text | |
-> UpdateFunction |
Create a value of UpdateFunction
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateFunction
, updateFunction_code
- The function
code that contains the request and response functions.
When code is used, the runtime
is required. The runtime
value must
be APPSYNC_JS
.
UpdateFunction
, updateFunction_description
- The Function
description.
UpdateFunction
, updateFunction_functionVersion
- The version
of the request mapping template. Currently, the supported
value is 2018-05-29. Note that when using VTL and mapping templates, the
functionVersion
is required.
UpdateFunction
, updateFunction_maxBatchSize
- The maximum batching size for a resolver.
UpdateFunction
, updateFunction_requestMappingTemplate
- The Function
request mapping template. Functions support only the
2018-05-29 version of the request mapping template.
UpdateFunction
, updateFunction_responseMappingTemplate
- The Function
request mapping template.
UpdateFunction
, updateFunction_runtime
- Undocumented member.
UpdateFunction
, updateFunction_syncConfig
- Undocumented member.
UpdateFunction
, updateFunction_apiId
- The GraphQL API ID.
UpdateFunction
, updateFunction_name
- The Function
name.
UpdateFunction
, updateFunction_functionId
- The function ID.
UpdateFunction
, updateFunction_dataSourceName
- The Function
DataSource
name.
data UpdateFunctionResponse Source #
See: newUpdateFunctionResponse
smart constructor.
Instances
newUpdateFunctionResponse Source #
Create a value of UpdateFunctionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:functionConfiguration:UpdateFunctionResponse'
, updateFunctionResponse_functionConfiguration
- The Function
object.
$sel:httpStatus:UpdateFunctionResponse'
, updateFunctionResponse_httpStatus
- The response's http status code.
UpdateGraphqlApi
data UpdateGraphqlApi Source #
See: newUpdateGraphqlApi
smart constructor.
Instances
Create a value of UpdateGraphqlApi
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateGraphqlApi
, updateGraphqlApi_additionalAuthenticationProviders
- A list of additional authentication providers for the GraphqlApi
API.
UpdateGraphqlApi
, updateGraphqlApi_authenticationType
- The new authentication type for the GraphqlApi
object.
UpdateGraphqlApi
, updateGraphqlApi_lambdaAuthorizerConfig
- Configuration for Lambda function authorization.
UpdateGraphqlApi
, updateGraphqlApi_logConfig
- The Amazon CloudWatch Logs configuration for the GraphqlApi
object.
UpdateGraphqlApi
, updateGraphqlApi_openIDConnectConfig
- The OpenID Connect configuration for the GraphqlApi
object.
UpdateGraphqlApi
, updateGraphqlApi_userPoolConfig
- The new Amazon Cognito user pool configuration for the ~GraphqlApi
object.
UpdateGraphqlApi
, updateGraphqlApi_xrayEnabled
- A flag indicating whether to use X-Ray tracing for the GraphqlApi
.
UpdateGraphqlApi
, updateGraphqlApi_apiId
- The API ID.
UpdateGraphqlApi
, updateGraphqlApi_name
- The new name for the GraphqlApi
object.
data UpdateGraphqlApiResponse Source #
See: newUpdateGraphqlApiResponse
smart constructor.
Instances
newUpdateGraphqlApiResponse Source #
Create a value of UpdateGraphqlApiResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:graphqlApi:UpdateGraphqlApiResponse'
, updateGraphqlApiResponse_graphqlApi
- The updated GraphqlApi
object.
$sel:httpStatus:UpdateGraphqlApiResponse'
, updateGraphqlApiResponse_httpStatus
- The response's http status code.
UpdateResolver
data UpdateResolver Source #
See: newUpdateResolver
smart constructor.
UpdateResolver' (Maybe CachingConfig) (Maybe Text) (Maybe Text) (Maybe ResolverKind) (Maybe Natural) (Maybe PipelineConfig) (Maybe Text) (Maybe Text) (Maybe AppSyncRuntime) (Maybe SyncConfig) Text Text Text |
Instances
Create a value of UpdateResolver
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateResolver
, updateResolver_cachingConfig
- The caching configuration for the resolver.
UpdateResolver
, updateResolver_code
- The resolver
code that contains the request and response functions.
When code is used, the runtime
is required. The runtime
value must
be APPSYNC_JS
.
UpdateResolver
, updateResolver_dataSourceName
- The new data source name.
UpdateResolver
, updateResolver_kind
- The resolver type.
- UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.
- PIPELINE: A PIPELINE resolver type. You can use a PIPELINE
resolver to invoke a series of
Function
objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.
UpdateResolver
, updateResolver_maxBatchSize
- The maximum batching size for a resolver.
UpdateResolver
, updateResolver_pipelineConfig
- The PipelineConfig
.
UpdateResolver
, updateResolver_requestMappingTemplate
- The new request mapping template.
A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source can understand. Mapping templates are written in Apache Velocity Template Language (VTL).
VTL request mapping templates are optional when using an Lambda data source. For all other data sources, VTL request and response mapping templates are required.
UpdateResolver
, updateResolver_responseMappingTemplate
- The new response mapping template.
UpdateResolver
, updateResolver_runtime
- Undocumented member.
UpdateResolver
, updateResolver_syncConfig
- The SyncConfig
for a resolver attached to a versioned data source.
UpdateResolver
, updateResolver_apiId
- The API ID.
UpdateResolver
, updateResolver_typeName
- The new type name.
UpdateResolver
, updateResolver_fieldName
- The new field name.
data UpdateResolverResponse Source #
See: newUpdateResolverResponse
smart constructor.
Instances
newUpdateResolverResponse Source #
Create a value of UpdateResolverResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resolver:UpdateResolverResponse'
, updateResolverResponse_resolver
- The updated Resolver
object.
$sel:httpStatus:UpdateResolverResponse'
, updateResolverResponse_httpStatus
- The response's http status code.
UpdateType
data UpdateType Source #
See: newUpdateType
smart constructor.
Instances
Create a value of UpdateType
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateType
, updateType_definition
- The new definition.
UpdateType
, updateType_apiId
- The API ID.
UpdateType
, updateType_typeName
- The new type name.
UpdateType
, updateType_format
- The new type format: SDL or JSON.
data UpdateTypeResponse Source #
See: newUpdateTypeResponse
smart constructor.
Instances
newUpdateTypeResponse Source #
Create a value of UpdateTypeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateTypeResponse
, updateTypeResponse_type
- The updated Type
object.
$sel:httpStatus:UpdateTypeResponse'
, updateTypeResponse_httpStatus
- The response's http status code.
Types
ApiCacheStatus
newtype ApiCacheStatus Source #
pattern ApiCacheStatus_AVAILABLE :: ApiCacheStatus | |
pattern ApiCacheStatus_CREATING :: ApiCacheStatus | |
pattern ApiCacheStatus_DELETING :: ApiCacheStatus | |
pattern ApiCacheStatus_FAILED :: ApiCacheStatus | |
pattern ApiCacheStatus_MODIFYING :: ApiCacheStatus |
Instances
ApiCacheType
newtype ApiCacheType Source #
pattern ApiCacheType_LARGE :: ApiCacheType | |
pattern ApiCacheType_LARGE_12X :: ApiCacheType | |
pattern ApiCacheType_LARGE_2X :: ApiCacheType | |
pattern ApiCacheType_LARGE_4X :: ApiCacheType | |
pattern ApiCacheType_LARGE_8X :: ApiCacheType | |
pattern ApiCacheType_MEDIUM :: ApiCacheType | |
pattern ApiCacheType_R4_2XLARGE :: ApiCacheType | |
pattern ApiCacheType_R4_4XLARGE :: ApiCacheType | |
pattern ApiCacheType_R4_8XLARGE :: ApiCacheType | |
pattern ApiCacheType_R4_LARGE :: ApiCacheType | |
pattern ApiCacheType_R4_XLARGE :: ApiCacheType | |
pattern ApiCacheType_SMALL :: ApiCacheType | |
pattern ApiCacheType_T2_MEDIUM :: ApiCacheType | |
pattern ApiCacheType_T2_SMALL :: ApiCacheType | |
pattern ApiCacheType_XLARGE :: ApiCacheType |
Instances
ApiCachingBehavior
newtype ApiCachingBehavior Source #
pattern ApiCachingBehavior_FULL_REQUEST_CACHING :: ApiCachingBehavior | |
pattern ApiCachingBehavior_PER_RESOLVER_CACHING :: ApiCachingBehavior |
Instances
AssociationStatus
newtype AssociationStatus Source #
pattern AssociationStatus_FAILED :: AssociationStatus | |
pattern AssociationStatus_PROCESSING :: AssociationStatus | |
pattern AssociationStatus_SUCCESS :: AssociationStatus |
Instances
AuthenticationType
newtype AuthenticationType Source #
pattern AuthenticationType_AMAZON_COGNITO_USER_POOLS :: AuthenticationType | |
pattern AuthenticationType_API_KEY :: AuthenticationType | |
pattern AuthenticationType_AWS_IAM :: AuthenticationType | |
pattern AuthenticationType_AWS_LAMBDA :: AuthenticationType | |
pattern AuthenticationType_OPENID_CONNECT :: AuthenticationType |
Instances
AuthorizationType
newtype AuthorizationType Source #
pattern AuthorizationType_AWS_IAM :: AuthorizationType |
Instances
ConflictDetectionType
newtype ConflictDetectionType Source #
pattern ConflictDetectionType_NONE :: ConflictDetectionType | |
pattern ConflictDetectionType_VERSION :: ConflictDetectionType |
Instances
ConflictHandlerType
newtype ConflictHandlerType Source #
pattern ConflictHandlerType_AUTOMERGE :: ConflictHandlerType | |
pattern ConflictHandlerType_LAMBDA :: ConflictHandlerType | |
pattern ConflictHandlerType_NONE :: ConflictHandlerType | |
pattern ConflictHandlerType_OPTIMISTIC_CONCURRENCY :: ConflictHandlerType |
Instances
DataSourceType
newtype DataSourceType Source #
pattern DataSourceType_AMAZON_DYNAMODB :: DataSourceType | |
pattern DataSourceType_AMAZON_ELASTICSEARCH :: DataSourceType | |
pattern DataSourceType_AMAZON_OPENSEARCH_SERVICE :: DataSourceType | |
pattern DataSourceType_AWS_LAMBDA :: DataSourceType | |
pattern DataSourceType_HTTP :: DataSourceType | |
pattern DataSourceType_NONE :: DataSourceType | |
pattern DataSourceType_RELATIONAL_DATABASE :: DataSourceType |
Instances
DefaultAction
newtype DefaultAction Source #
pattern DefaultAction_ALLOW :: DefaultAction | |
pattern DefaultAction_DENY :: DefaultAction |
Instances
FieldLogLevel
newtype FieldLogLevel Source #
pattern FieldLogLevel_ALL :: FieldLogLevel | |
pattern FieldLogLevel_ERROR :: FieldLogLevel | |
pattern FieldLogLevel_NONE :: FieldLogLevel |
Instances
OutputType
newtype OutputType Source #
pattern OutputType_JSON :: OutputType | |
pattern OutputType_SDL :: OutputType |
Instances
RelationalDatabaseSourceType
newtype RelationalDatabaseSourceType Source #
Instances
ResolverKind
newtype ResolverKind Source #
pattern ResolverKind_PIPELINE :: ResolverKind | |
pattern ResolverKind_UNIT :: ResolverKind |
Instances
RuntimeName
newtype RuntimeName Source #
pattern RuntimeName_APPSYNC_JS :: RuntimeName |
Instances
SchemaStatus
newtype SchemaStatus Source #
pattern SchemaStatus_ACTIVE :: SchemaStatus | |
pattern SchemaStatus_DELETING :: SchemaStatus | |
pattern SchemaStatus_FAILED :: SchemaStatus | |
pattern SchemaStatus_NOT_APPLICABLE :: SchemaStatus | |
pattern SchemaStatus_PROCESSING :: SchemaStatus | |
pattern SchemaStatus_SUCCESS :: SchemaStatus |
Instances
TypeDefinitionFormat
newtype TypeDefinitionFormat Source #
pattern TypeDefinitionFormat_JSON :: TypeDefinitionFormat | |
pattern TypeDefinitionFormat_SDL :: TypeDefinitionFormat |
Instances
AdditionalAuthenticationProvider
data AdditionalAuthenticationProvider Source #
Describes an additional authentication provider.
See: newAdditionalAuthenticationProvider
smart constructor.
AdditionalAuthenticationProvider' (Maybe AuthenticationType) (Maybe LambdaAuthorizerConfig) (Maybe OpenIDConnectConfig) (Maybe CognitoUserPoolConfig) |
Instances
newAdditionalAuthenticationProvider :: AdditionalAuthenticationProvider Source #
Create a value of AdditionalAuthenticationProvider
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:authenticationType:AdditionalAuthenticationProvider'
, additionalAuthenticationProvider_authenticationType
- The authentication type: API key, Identity and Access Management (IAM),
OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
$sel:lambdaAuthorizerConfig:AdditionalAuthenticationProvider'
, additionalAuthenticationProvider_lambdaAuthorizerConfig
- Configuration for Lambda function authorization.
$sel:openIDConnectConfig:AdditionalAuthenticationProvider'
, additionalAuthenticationProvider_openIDConnectConfig
- The OIDC configuration.
$sel:userPoolConfig:AdditionalAuthenticationProvider'
, additionalAuthenticationProvider_userPoolConfig
- The Amazon Cognito user pool configuration.
ApiAssociation
data ApiAssociation Source #
Describes an ApiAssociation
object.
See: newApiAssociation
smart constructor.
ApiAssociation' (Maybe Text) (Maybe AssociationStatus) (Maybe Text) (Maybe Text) |
Instances
newApiAssociation :: ApiAssociation Source #
Create a value of ApiAssociation
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:apiId:ApiAssociation'
, apiAssociation_apiId
- The API ID.
$sel:associationStatus:ApiAssociation'
, apiAssociation_associationStatus
- Identifies the status of an association.
- PROCESSING: The API association is being created. You cannot modify association requests during processing.
- SUCCESS: The API association was successful. You can modify associations after success.
- FAILED: The API association has failed. You can modify associations after failure.
$sel:deploymentDetail:ApiAssociation'
, apiAssociation_deploymentDetail
- Details about the last deployment status.
$sel:domainName:ApiAssociation'
, apiAssociation_domainName
- The domain name.
ApiCache
The ApiCache
object.
See: newApiCache
smart constructor.
ApiCache' (Maybe ApiCachingBehavior) (Maybe Bool) (Maybe ApiCacheStatus) (Maybe Bool) (Maybe Integer) (Maybe ApiCacheType) |
Instances
newApiCache :: ApiCache Source #
Create a value of ApiCache
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:apiCachingBehavior:ApiCache'
, apiCache_apiCachingBehavior
- Caching behavior.
- FULL_REQUEST_CACHING: All requests are fully cached.
- PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
$sel:atRestEncryptionEnabled:ApiCache'
, apiCache_atRestEncryptionEnabled
- At-rest encryption flag for cache. You cannot update this setting after
creation.
$sel:status:ApiCache'
, apiCache_status
- The cache instance status.
- AVAILABLE: The instance is available for use.
- CREATING: The instance is currently creating.
- DELETING: The instance is currently deleting.
- MODIFYING: The instance is currently modifying.
- FAILED: The instance has failed creation.
$sel:transitEncryptionEnabled:ApiCache'
, apiCache_transitEncryptionEnabled
- Transit encryption flag when connecting to cache. You cannot update this
setting after creation.
$sel:ttl:ApiCache'
, apiCache_ttl
- TTL in seconds for cache entries.
Valid values are 1–3,600 seconds.
$sel:type':ApiCache'
, apiCache_type
- The cache instance type. Valid values are
SMALL
MEDIUM
LARGE
XLARGE
LARGE_2X
LARGE_4X
LARGE_8X
(not available in all regions)LARGE_12X
Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.
The following legacy instance types are available, but their use is discouraged:
- T2_SMALL: A t2.small instance type.
- T2_MEDIUM: A t2.medium instance type.
- R4_LARGE: A r4.large instance type.
- R4_XLARGE: A r4.xlarge instance type.
- R4_2XLARGE: A r4.2xlarge instance type.
- R4_4XLARGE: A r4.4xlarge instance type.
- R4_8XLARGE: A r4.8xlarge instance type.
ApiKey
Describes an API key.
Customers invoke AppSync GraphQL API operations with API keys as an identity mechanism. There are two key versions:
da1: We introduced this version at launch in November 2017. These keys always expire after 7 days. Amazon DynamoDB TTL manages key expiration. These keys ceased to be valid after February 21, 2018, and they should no longer be used.
ListApiKeys
returns the expiration time in milliseconds.CreateApiKey
returns the expiration time in milliseconds.UpdateApiKey
is not available for this key version.DeleteApiKey
deletes the item from the table.- Expiration is stored in DynamoDB as milliseconds. This results in a bug where keys are not automatically deleted because DynamoDB expects the TTL to be stored in seconds. As a one-time action, we deleted these keys from the table on February 21, 2018.
da2: We introduced this version in February 2018 when AppSync added support to extend key expiration.
ListApiKeys
returns the expiration time and deletion time in seconds.CreateApiKey
returns the expiration time and deletion time in seconds and accepts a user-provided expiration time in seconds.UpdateApiKey
returns the expiration time and and deletion time in seconds and accepts a user-provided expiration time in seconds. Expired API keys are kept for 60 days after the expiration time. You can update the key expiration time as long as the key isn't deleted.DeleteApiKey
deletes the item from the table.- Expiration is stored in DynamoDB as seconds. After the expiration time, using the key to authenticate will fail. However, you can reinstate the key before deletion.
- Deletion is stored in DynamoDB as seconds. The key is deleted after deletion time.
See: newApiKey
smart constructor.
Instances
FromJSON ApiKey Source # | |
Generic ApiKey Source # | |
Read ApiKey Source # | |
Show ApiKey Source # | |
NFData ApiKey Source # | |
Defined in Amazonka.AppSync.Types.ApiKey | |
Eq ApiKey Source # | |
Hashable ApiKey Source # | |
Defined in Amazonka.AppSync.Types.ApiKey | |
type Rep ApiKey Source # | |
Defined in Amazonka.AppSync.Types.ApiKey type Rep ApiKey = D1 ('MetaData "ApiKey" "Amazonka.AppSync.Types.ApiKey" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" 'False) (C1 ('MetaCons "ApiKey'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "deletes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "expires") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) |
Create a value of ApiKey
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deletes:ApiKey'
, apiKey_deletes
- The time after which the API key is deleted. The date is represented as
seconds since the epoch, rounded down to the nearest hour.
$sel:description:ApiKey'
, apiKey_description
- A description of the purpose of the API key.
$sel:expires:ApiKey'
, apiKey_expires
- The time after which the API key expires. The date is represented as
seconds since the epoch, rounded down to the nearest hour.
$sel:id:ApiKey'
, apiKey_id
- The API key ID.
AppSyncRuntime
data AppSyncRuntime Source #
Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.
See: newAppSyncRuntime
smart constructor.
Instances
Create a value of AppSyncRuntime
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:AppSyncRuntime'
, appSyncRuntime_name
- The name
of the runtime to use. Currently, the only allowed value is
APPSYNC_JS
.
$sel:runtimeVersion:AppSyncRuntime'
, appSyncRuntime_runtimeVersion
- The version
of the runtime to use. Currently, the only allowed version
is 1.0.0
.
AuthorizationConfig
data AuthorizationConfig Source #
The authorization configuration in case the HTTP endpoint requires authorization.
See: newAuthorizationConfig
smart constructor.
Instances
newAuthorizationConfig Source #
Create a value of AuthorizationConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:awsIamConfig:AuthorizationConfig'
, authorizationConfig_awsIamConfig
- The Identity and Access Management (IAM) settings.
$sel:authorizationType:AuthorizationConfig'
, authorizationConfig_authorizationType
- The authorization type that the HTTP endpoint requires.
- AWS_IAM: The authorization type is Signature Version 4 (SigV4).
AwsIamConfig
data AwsIamConfig Source #
The Identity and Access Management (IAM) configuration.
See: newAwsIamConfig
smart constructor.
AwsIamConfig' (Maybe Text) (Maybe Text) |
Instances
newAwsIamConfig :: AwsIamConfig Source #
Create a value of AwsIamConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:signingRegion:AwsIamConfig'
, awsIamConfig_signingRegion
- The signing Amazon Web Services Region for IAM authorization.
$sel:signingServiceName:AwsIamConfig'
, awsIamConfig_signingServiceName
- The signing service name for IAM authorization.
CachingConfig
data CachingConfig Source #
The caching configuration for a resolver that has caching activated.
See: newCachingConfig
smart constructor.
Instances
Create a value of CachingConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cachingKeys:CachingConfig'
, cachingConfig_cachingKeys
- The caching keys for a resolver that has caching activated.
Valid values are entries from the $context.arguments
,
$context.source
, and $context.identity
maps.
$sel:ttl:CachingConfig'
, cachingConfig_ttl
- The TTL in seconds for a resolver that has caching activated.
Valid values are 1–3,600 seconds.
CodeError
Describes an AppSync error.
See: newCodeError
smart constructor.
Instances
FromJSON CodeError Source # | |
Generic CodeError Source # | |
Read CodeError Source # | |
Show CodeError Source # | |
NFData CodeError Source # | |
Defined in Amazonka.AppSync.Types.CodeError | |
Eq CodeError Source # | |
Hashable CodeError Source # | |
Defined in Amazonka.AppSync.Types.CodeError | |
type Rep CodeError Source # | |
Defined in Amazonka.AppSync.Types.CodeError type Rep CodeError = D1 ('MetaData "CodeError" "Amazonka.AppSync.Types.CodeError" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" 'False) (C1 ('MetaCons "CodeError'" 'PrefixI 'True) (S1 ('MetaSel ('Just "errorType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CodeErrorLocation)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) |
newCodeError :: CodeError Source #
Create a value of CodeError
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorType:CodeError'
, codeError_errorType
- The type of code error.
Examples include, but aren't limited to: LINT_ERROR
, PARSER_ERROR
.
$sel:location:CodeError'
, codeError_location
- The line, column, and span location of the error in the code.
$sel:value:CodeError'
, codeError_value
- A user presentable error.
Examples include, but aren't limited to:
Parsing error: Unterminated string literal
.
CodeErrorLocation
data CodeErrorLocation Source #
Describes the location of the error in a code sample.
See: newCodeErrorLocation
smart constructor.
Instances
newCodeErrorLocation :: CodeErrorLocation Source #
Create a value of CodeErrorLocation
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:column:CodeErrorLocation'
, codeErrorLocation_column
- The column number in the code. Defaults to 0
if unknown.
$sel:line:CodeErrorLocation'
, codeErrorLocation_line
- The line number in the code. Defaults to 0
if unknown.
$sel:span:CodeErrorLocation'
, codeErrorLocation_span
- The span/length of the error. Defaults to -1
if unknown.
CognitoUserPoolConfig
data CognitoUserPoolConfig Source #
Describes an Amazon Cognito user pool configuration.
See: newCognitoUserPoolConfig
smart constructor.
Instances
newCognitoUserPoolConfig Source #
:: Text | |
-> Text | |
-> CognitoUserPoolConfig |
Create a value of CognitoUserPoolConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:appIdClientRegex:CognitoUserPoolConfig'
, cognitoUserPoolConfig_appIdClientRegex
- A regular expression for validating the incoming Amazon Cognito user
pool app client ID. If this value isn't set, no filtering is applied.
$sel:userPoolId:CognitoUserPoolConfig'
, cognitoUserPoolConfig_userPoolId
- The user pool ID.
$sel:awsRegion:CognitoUserPoolConfig'
, cognitoUserPoolConfig_awsRegion
- The Amazon Web Services Region in which the user pool was created.
DataSource
data DataSource Source #
Describes a data source.
See: newDataSource
smart constructor.
Instances
newDataSource :: DataSource Source #
Create a value of DataSource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataSourceArn:DataSource'
, dataSource_dataSourceArn
- The data source Amazon Resource Name (ARN).
$sel:description:DataSource'
, dataSource_description
- The description of the data source.
$sel:dynamodbConfig:DataSource'
, dataSource_dynamodbConfig
- DynamoDB settings.
$sel:elasticsearchConfig:DataSource'
, dataSource_elasticsearchConfig
- Amazon OpenSearch Service settings.
$sel:httpConfig:DataSource'
, dataSource_httpConfig
- HTTP endpoint settings.
$sel:lambdaConfig:DataSource'
, dataSource_lambdaConfig
- Lambda settings.
$sel:name:DataSource'
, dataSource_name
- The name of the data source.
$sel:openSearchServiceConfig:DataSource'
, dataSource_openSearchServiceConfig
- Amazon OpenSearch Service settings.
$sel:relationalDatabaseConfig:DataSource'
, dataSource_relationalDatabaseConfig
- Relational database settings.
$sel:serviceRoleArn:DataSource'
, dataSource_serviceRoleArn
- The Identity and Access Management (IAM) service role Amazon Resource
Name (ARN) for the data source. The system assumes this role when
accessing the data source.
$sel:type':DataSource'
, dataSource_type
- The type of the data source.
- AWS_LAMBDA: The data source is an Lambda function.
- AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table.
- AMAZON_ELASTICSEARCH: The data source is an Amazon OpenSearch Service domain.
- AMAZON_OPENSEARCH_SERVICE: The data source is an Amazon OpenSearch Service domain.
- NONE: There is no data source. Use this type when you want to invoke a GraphQL operation without connecting to a data source, such as when you're performing data transformation with resolvers or invoking a subscription from a mutation.
- HTTP: The data source is an HTTP endpoint.
- RELATIONAL_DATABASE: The data source is a relational database.
DeltaSyncConfig
data DeltaSyncConfig Source #
Describes a Delta Sync configuration.
See: newDeltaSyncConfig
smart constructor.
Instances
newDeltaSyncConfig :: DeltaSyncConfig Source #
Create a value of DeltaSyncConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:baseTableTTL:DeltaSyncConfig'
, deltaSyncConfig_baseTableTTL
- The number of minutes that an Item is stored in the data source.
$sel:deltaSyncTableName:DeltaSyncConfig'
, deltaSyncConfig_deltaSyncTableName
- The Delta Sync table name.
$sel:deltaSyncTableTTL:DeltaSyncConfig'
, deltaSyncConfig_deltaSyncTableTTL
- The number of minutes that a Delta Sync log entry is stored in the Delta
Sync table.
DomainNameConfig
data DomainNameConfig Source #
Describes a configuration for a custom domain.
See: newDomainNameConfig
smart constructor.
Instances
newDomainNameConfig :: DomainNameConfig Source #
Create a value of DomainNameConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:appsyncDomainName:DomainNameConfig'
, domainNameConfig_appsyncDomainName
- The domain name that AppSync provides.
$sel:certificateArn:DomainNameConfig'
, domainNameConfig_certificateArn
- The Amazon Resource Name (ARN) of the certificate. This can be an
Certificate Manager (ACM) certificate or an Identity and Access
Management (IAM) server certificate.
$sel:description:DomainNameConfig'
, domainNameConfig_description
- A description of the DomainName
configuration.
$sel:domainName:DomainNameConfig'
, domainNameConfig_domainName
- The domain name.
$sel:hostedZoneId:DomainNameConfig'
, domainNameConfig_hostedZoneId
- The ID of your Amazon Route 53 hosted zone.
DynamodbDataSourceConfig
data DynamodbDataSourceConfig Source #
Describes an Amazon DynamoDB data source configuration.
See: newDynamodbDataSourceConfig
smart constructor.
Instances
newDynamodbDataSourceConfig Source #
:: Text | |
-> Text | |
-> DynamodbDataSourceConfig |
Create a value of DynamodbDataSourceConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deltaSyncConfig:DynamodbDataSourceConfig'
, dynamodbDataSourceConfig_deltaSyncConfig
- The DeltaSyncConfig
for a versioned data source.
$sel:useCallerCredentials:DynamodbDataSourceConfig'
, dynamodbDataSourceConfig_useCallerCredentials
- Set to TRUE to use Amazon Cognito credentials with this data source.
$sel:versioned:DynamodbDataSourceConfig'
, dynamodbDataSourceConfig_versioned
- Set to TRUE to use Conflict Detection and Resolution with this data
source.
$sel:tableName:DynamodbDataSourceConfig'
, dynamodbDataSourceConfig_tableName
- The table name.
$sel:awsRegion:DynamodbDataSourceConfig'
, dynamodbDataSourceConfig_awsRegion
- The Amazon Web Services Region.
ElasticsearchDataSourceConfig
data ElasticsearchDataSourceConfig Source #
Describes an OpenSearch data source configuration.
As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is deprecated. For new data sources, use OpenSearchServiceDataSourceConfig to specify an OpenSearch data source.
See: newElasticsearchDataSourceConfig
smart constructor.
Instances
newElasticsearchDataSourceConfig Source #
Create a value of ElasticsearchDataSourceConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endpoint:ElasticsearchDataSourceConfig'
, elasticsearchDataSourceConfig_endpoint
- The endpoint.
$sel:awsRegion:ElasticsearchDataSourceConfig'
, elasticsearchDataSourceConfig_awsRegion
- The Amazon Web Services Region.
ErrorDetail
data ErrorDetail Source #
Contains the list of errors generated. When using JavaScript, this will apply to the request or response function evaluation.
See: newErrorDetail
smart constructor.
Instances
newErrorDetail :: ErrorDetail Source #
Create a value of ErrorDetail
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:message:ErrorDetail'
, errorDetail_message
- The error payload.
EvaluateCodeErrorDetail
data EvaluateCodeErrorDetail Source #
Contains the list of errors from a code evaluation response.
See: newEvaluateCodeErrorDetail
smart constructor.
Instances
newEvaluateCodeErrorDetail :: EvaluateCodeErrorDetail Source #
Create a value of EvaluateCodeErrorDetail
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:codeErrors:EvaluateCodeErrorDetail'
, evaluateCodeErrorDetail_codeErrors
- Contains the list of CodeError
objects.
$sel:message:EvaluateCodeErrorDetail'
, evaluateCodeErrorDetail_message
- The error payload.
FunctionConfiguration
data FunctionConfiguration Source #
A function is a reusable entity. You can use multiple functions to compose the resolver logic.
See: newFunctionConfiguration
smart constructor.
FunctionConfiguration' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe AppSyncRuntime) (Maybe SyncConfig) |
Instances
newFunctionConfiguration :: FunctionConfiguration Source #
Create a value of FunctionConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:code:FunctionConfiguration'
, functionConfiguration_code
- The function
code that contains the request and response functions.
When code is used, the runtime
is required. The runtime
value must
be APPSYNC_JS
.
$sel:dataSourceName:FunctionConfiguration'
, functionConfiguration_dataSourceName
- The name of the DataSource
.
$sel:description:FunctionConfiguration'
, functionConfiguration_description
- The Function
description.
$sel:functionArn:FunctionConfiguration'
, functionConfiguration_functionArn
- The Amazon Resource Name (ARN) of the Function
object.
$sel:functionId:FunctionConfiguration'
, functionConfiguration_functionId
- A unique ID representing the Function
object.
$sel:functionVersion:FunctionConfiguration'
, functionConfiguration_functionVersion
- The version of the request mapping template. Currently, only the
2018-05-29 version of the template is supported.
$sel:maxBatchSize:FunctionConfiguration'
, functionConfiguration_maxBatchSize
- The maximum batching size for a resolver.
FunctionConfiguration
, functionConfiguration_name
- The name of the Function
object.
$sel:requestMappingTemplate:FunctionConfiguration'
, functionConfiguration_requestMappingTemplate
- The Function
request mapping template. Functions support only the
2018-05-29 version of the request mapping template.
$sel:responseMappingTemplate:FunctionConfiguration'
, functionConfiguration_responseMappingTemplate
- The Function
response mapping template.
$sel:runtime:FunctionConfiguration'
, functionConfiguration_runtime
- Undocumented member.
$sel:syncConfig:FunctionConfiguration'
, functionConfiguration_syncConfig
- Undocumented member.
GraphqlApi
data GraphqlApi Source #
Describes a GraphQL API.
See: newGraphqlApi
smart constructor.
GraphqlApi' (Maybe [AdditionalAuthenticationProvider]) (Maybe Text) (Maybe Text) (Maybe AuthenticationType) (Maybe LambdaAuthorizerConfig) (Maybe LogConfig) (Maybe Text) (Maybe OpenIDConnectConfig) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe UserPoolConfig) (Maybe Text) (Maybe Bool) |
Instances
newGraphqlApi :: GraphqlApi Source #
Create a value of GraphqlApi
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:additionalAuthenticationProviders:GraphqlApi'
, graphqlApi_additionalAuthenticationProviders
- A list of additional authentication providers for the GraphqlApi
API.
$sel:apiId:GraphqlApi'
, graphqlApi_apiId
- The API ID.
$sel:arn:GraphqlApi'
, graphqlApi_arn
- The Amazon Resource Name (ARN).
GraphqlApi
, graphqlApi_authenticationType
- The authentication type.
GraphqlApi
, graphqlApi_lambdaAuthorizerConfig
- Configuration for Lambda function authorization.
$sel:logConfig:GraphqlApi'
, graphqlApi_logConfig
- The Amazon CloudWatch Logs configuration.
$sel:name:GraphqlApi'
, graphqlApi_name
- The API name.
GraphqlApi
, graphqlApi_openIDConnectConfig
- The OpenID Connect configuration.
$sel:tags:GraphqlApi'
, graphqlApi_tags
- The tags.
$sel:uris:GraphqlApi'
, graphqlApi_uris
- The URIs.
GraphqlApi
, graphqlApi_userPoolConfig
- The Amazon Cognito user pool configuration.
$sel:wafWebAclArn:GraphqlApi'
, graphqlApi_wafWebAclArn
- The ARN of the WAF access control list (ACL) associated with this
GraphqlApi
, if one exists.
$sel:xrayEnabled:GraphqlApi'
, graphqlApi_xrayEnabled
- A flag indicating whether to use X-Ray tracing for this GraphqlApi
.
HttpDataSourceConfig
data HttpDataSourceConfig Source #
Describes an HTTP data source configuration.
See: newHttpDataSourceConfig
smart constructor.
Instances
newHttpDataSourceConfig :: HttpDataSourceConfig Source #
Create a value of HttpDataSourceConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:authorizationConfig:HttpDataSourceConfig'
, httpDataSourceConfig_authorizationConfig
- The authorization configuration in case the HTTP endpoint requires
authorization.
$sel:endpoint:HttpDataSourceConfig'
, httpDataSourceConfig_endpoint
- The HTTP URL endpoint. You can specify either the domain name or IP, and
port combination, and the URL scheme must be HTTP or HTTPS. If you
don't specify the port, AppSync uses the default port 80 for the HTTP
endpoint and port 443 for HTTPS endpoints.
LambdaAuthorizerConfig
data LambdaAuthorizerConfig Source #
A LambdaAuthorizerConfig
specifies how to authorize AppSync API access
when using the AWS_LAMBDA
authorizer mode. Be aware that an AppSync
API can have only one Lambda authorizer configured at a time.
See: newLambdaAuthorizerConfig
smart constructor.
Instances
newLambdaAuthorizerConfig Source #
Create a value of LambdaAuthorizerConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:authorizerResultTtlInSeconds:LambdaAuthorizerConfig'
, lambdaAuthorizerConfig_authorizerResultTtlInSeconds
- The number of seconds a response should be cached for. The default is 5
minutes (300 seconds). The Lambda function can override this by
returning a ttlOverride
key in its response. A value of 0 disables
caching of responses.
$sel:identityValidationExpression:LambdaAuthorizerConfig'
, lambdaAuthorizerConfig_identityValidationExpression
- A regular expression for validation of tokens before the Lambda function
is called.
$sel:authorizerUri:LambdaAuthorizerConfig'
, lambdaAuthorizerConfig_authorizerUri
- The Amazon Resource Name (ARN) of the Lambda function to be called for
authorization. This can be a standard Lambda ARN, a version ARN
(.../v3
), or an alias ARN.
Note: This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is done for you. To use the Command Line Interface (CLI), run the following:
aws lambda add-permission --function-name "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id "appsync" --principal appsync.amazonaws.com --action lambda:InvokeFunction
LambdaConflictHandlerConfig
data LambdaConflictHandlerConfig Source #
The LambdaConflictHandlerConfig
object when configuring LAMBDA
as
the Conflict Handler.
See: newLambdaConflictHandlerConfig
smart constructor.
Instances
newLambdaConflictHandlerConfig :: LambdaConflictHandlerConfig Source #
Create a value of LambdaConflictHandlerConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lambdaConflictHandlerArn:LambdaConflictHandlerConfig'
, lambdaConflictHandlerConfig_lambdaConflictHandlerArn
- The Amazon Resource Name (ARN) for the Lambda function to use as the
Conflict Handler.
LambdaDataSourceConfig
data LambdaDataSourceConfig Source #
Describes an Lambda data source configuration.
See: newLambdaDataSourceConfig
smart constructor.
Instances
newLambdaDataSourceConfig Source #
Create a value of LambdaDataSourceConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lambdaFunctionArn:LambdaDataSourceConfig'
, lambdaDataSourceConfig_lambdaFunctionArn
- The Amazon Resource Name (ARN) for the Lambda function.
LogConfig
The Amazon CloudWatch Logs configuration.
See: newLogConfig
smart constructor.
Instances
FromJSON LogConfig Source # | |
ToJSON LogConfig Source # | |
Defined in Amazonka.AppSync.Types.LogConfig | |
Generic LogConfig Source # | |
Read LogConfig Source # | |
Show LogConfig Source # | |
NFData LogConfig Source # | |
Defined in Amazonka.AppSync.Types.LogConfig | |
Eq LogConfig Source # | |
Hashable LogConfig Source # | |
Defined in Amazonka.AppSync.Types.LogConfig | |
type Rep LogConfig Source # | |
Defined in Amazonka.AppSync.Types.LogConfig type Rep LogConfig = D1 ('MetaData "LogConfig" "Amazonka.AppSync.Types.LogConfig" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" 'False) (C1 ('MetaCons "LogConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "excludeVerboseContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "fieldLogLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FieldLogLevel) :*: S1 ('MetaSel ('Just "cloudWatchLogsRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) |
:: FieldLogLevel | |
-> Text | |
-> LogConfig |
Create a value of LogConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:excludeVerboseContent:LogConfig'
, logConfig_excludeVerboseContent
- Set to TRUE to exclude sections that contain information such as
headers, context, and evaluated mapping templates, regardless of logging
level.
$sel:fieldLogLevel:LogConfig'
, logConfig_fieldLogLevel
- The field logging level. Values can be NONE, ERROR, or ALL.
- NONE: No field-level logs are captured.
ERROR: Logs the following information only for the fields that are in error:
- The error section in the server response.
- Field-level errors.
- The generated request/response functions that got resolved for error fields.
ALL: The following information is logged for all fields in the query:
- Field-level tracing information.
- The generated request/response functions that got resolved for each field.
$sel:cloudWatchLogsRoleArn:LogConfig'
, logConfig_cloudWatchLogsRoleArn
- The service role that AppSync assumes to publish to CloudWatch logs in
your account.
OpenIDConnectConfig
data OpenIDConnectConfig Source #
Describes an OpenID Connect (OIDC) configuration.
See: newOpenIDConnectConfig
smart constructor.
Instances
newOpenIDConnectConfig Source #
Create a value of OpenIDConnectConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:authTTL:OpenIDConnectConfig'
, openIDConnectConfig_authTTL
- The number of milliseconds that a token is valid after being
authenticated.
$sel:clientId:OpenIDConnectConfig'
, openIDConnectConfig_clientId
- The client identifier of the relying party at the OpenID identity
provider. This identifier is typically obtained when the relying party
is registered with the OpenID identity provider. You can specify a
regular expression so that AppSync can validate against multiple client
identifiers at a time.
$sel:iatTTL:OpenIDConnectConfig'
, openIDConnectConfig_iatTTL
- The number of milliseconds that a token is valid after it's issued to a
user.
$sel:issuer:OpenIDConnectConfig'
, openIDConnectConfig_issuer
- The issuer for the OIDC configuration. The issuer returned by discovery
must exactly match the value of iss
in the ID token.
OpenSearchServiceDataSourceConfig
data OpenSearchServiceDataSourceConfig Source #
Describes an OpenSearch data source configuration.
See: newOpenSearchServiceDataSourceConfig
smart constructor.
Instances
newOpenSearchServiceDataSourceConfig Source #
Create a value of OpenSearchServiceDataSourceConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endpoint:OpenSearchServiceDataSourceConfig'
, openSearchServiceDataSourceConfig_endpoint
- The endpoint.
$sel:awsRegion:OpenSearchServiceDataSourceConfig'
, openSearchServiceDataSourceConfig_awsRegion
- The Amazon Web Services Region.
PipelineConfig
data PipelineConfig Source #
The pipeline configuration for a resolver of kind PIPELINE
.
See: newPipelineConfig
smart constructor.
PipelineConfig' (Maybe [Text]) |
Instances
newPipelineConfig :: PipelineConfig Source #
Create a value of PipelineConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:functions:PipelineConfig'
, pipelineConfig_functions
- A list of Function
objects.
RdsHttpEndpointConfig
data RdsHttpEndpointConfig Source #
The Amazon Relational Database Service (Amazon RDS) HTTP endpoint configuration.
See: newRdsHttpEndpointConfig
smart constructor.
Instances
newRdsHttpEndpointConfig :: RdsHttpEndpointConfig Source #
Create a value of RdsHttpEndpointConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:awsRegion:RdsHttpEndpointConfig'
, rdsHttpEndpointConfig_awsRegion
- Amazon Web Services Region for Amazon RDS HTTP endpoint.
$sel:awsSecretStoreArn:RdsHttpEndpointConfig'
, rdsHttpEndpointConfig_awsSecretStoreArn
- Amazon Web Services secret store Amazon Resource Name (ARN) for database
credentials.
$sel:databaseName:RdsHttpEndpointConfig'
, rdsHttpEndpointConfig_databaseName
- Logical database name.
$sel:dbClusterIdentifier:RdsHttpEndpointConfig'
, rdsHttpEndpointConfig_dbClusterIdentifier
- Amazon RDS cluster Amazon Resource Name (ARN).
$sel:schema:RdsHttpEndpointConfig'
, rdsHttpEndpointConfig_schema
- Logical schema name.
RelationalDatabaseDataSourceConfig
data RelationalDatabaseDataSourceConfig Source #
Describes a relational database data source configuration.
See: newRelationalDatabaseDataSourceConfig
smart constructor.
RelationalDatabaseDataSourceConfig' (Maybe RdsHttpEndpointConfig) (Maybe RelationalDatabaseSourceType) |
Instances
newRelationalDatabaseDataSourceConfig :: RelationalDatabaseDataSourceConfig Source #
Create a value of RelationalDatabaseDataSourceConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:rdsHttpEndpointConfig:RelationalDatabaseDataSourceConfig'
, relationalDatabaseDataSourceConfig_rdsHttpEndpointConfig
- Amazon RDS HTTP endpoint settings.
$sel:relationalDatabaseSourceType:RelationalDatabaseDataSourceConfig'
, relationalDatabaseDataSourceConfig_relationalDatabaseSourceType
- Source type for the relational database.
- RDS_HTTP_ENDPOINT: The relational database source type is an Amazon Relational Database Service (Amazon RDS) HTTP endpoint.
Resolver
Describes a resolver.
See: newResolver
smart constructor.
Resolver' (Maybe CachingConfig) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ResolverKind) (Maybe Natural) (Maybe PipelineConfig) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe AppSyncRuntime) (Maybe SyncConfig) (Maybe Text) |
Instances
newResolver :: Resolver Source #
Create a value of Resolver
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cachingConfig:Resolver'
, resolver_cachingConfig
- The caching configuration for the resolver.
$sel:code:Resolver'
, resolver_code
- The resolver
code that contains the request and response functions.
When code is used, the runtime
is required. The runtime
value must
be APPSYNC_JS
.
$sel:dataSourceName:Resolver'
, resolver_dataSourceName
- The resolver data source name.
$sel:fieldName:Resolver'
, resolver_fieldName
- The resolver field name.
$sel:kind:Resolver'
, resolver_kind
- The resolver type.
- UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.
- PIPELINE: A PIPELINE resolver type. You can use a PIPELINE
resolver to invoke a series of
Function
objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.
$sel:maxBatchSize:Resolver'
, resolver_maxBatchSize
- The maximum batching size for a resolver.
$sel:pipelineConfig:Resolver'
, resolver_pipelineConfig
- The PipelineConfig
.
$sel:requestMappingTemplate:Resolver'
, resolver_requestMappingTemplate
- The request mapping template.
$sel:resolverArn:Resolver'
, resolver_resolverArn
- The resolver Amazon Resource Name (ARN).
$sel:responseMappingTemplate:Resolver'
, resolver_responseMappingTemplate
- The response mapping template.
$sel:runtime:Resolver'
, resolver_runtime
- Undocumented member.
$sel:syncConfig:Resolver'
, resolver_syncConfig
- The SyncConfig
for a resolver attached to a versioned data source.
$sel:typeName:Resolver'
, resolver_typeName
- The resolver type name.
SyncConfig
data SyncConfig Source #
Describes a Sync configuration for a resolver.
Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.
See: newSyncConfig
smart constructor.
SyncConfig' (Maybe ConflictDetectionType) (Maybe ConflictHandlerType) (Maybe LambdaConflictHandlerConfig) |
Instances
newSyncConfig :: SyncConfig Source #
Create a value of SyncConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:conflictDetection:SyncConfig'
, syncConfig_conflictDetection
- The Conflict Detection strategy to use.
- VERSION: Detect conflicts based on object versions for this resolver.
- NONE: Do not detect conflicts when invoking this resolver.
$sel:conflictHandler:SyncConfig'
, syncConfig_conflictHandler
- The Conflict Resolution strategy to perform in the event of a conflict.
- OPTIMISTIC_CONCURRENCY: Resolve conflicts by rejecting mutations when versions don't match the latest version at the server.
- AUTOMERGE: Resolve conflicts with the Automerge conflict resolution strategy.
- LAMBDA: Resolve conflicts with an Lambda function supplied in
the
LambdaConflictHandlerConfig
.
$sel:lambdaConflictHandlerConfig:SyncConfig'
, syncConfig_lambdaConflictHandlerConfig
- The LambdaConflictHandlerConfig
when configuring LAMBDA
as the
Conflict Handler.
Type
Describes a type.
See: newType
smart constructor.
Instances
Create a value of Type
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:Type'
, type_arn
- The type Amazon Resource Name (ARN).
$sel:definition:Type'
, type_definition
- The type definition.
$sel:description:Type'
, type_description
- The type description.
$sel:format:Type'
, type_format
- The type format: SDL or JSON.
$sel:name:Type'
, type_name
- The type name.
UserPoolConfig
data UserPoolConfig Source #
Describes an Amazon Cognito user pool configuration.
See: newUserPoolConfig
smart constructor.
Instances
:: Text | |
-> Text | |
-> DefaultAction | |
-> UserPoolConfig |
Create a value of UserPoolConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:appIdClientRegex:UserPoolConfig'
, userPoolConfig_appIdClientRegex
- A regular expression for validating the incoming Amazon Cognito user
pool app client ID. If this value isn't set, no filtering is applied.
$sel:userPoolId:UserPoolConfig'
, userPoolConfig_userPoolId
- The user pool ID.
$sel:awsRegion:UserPoolConfig'
, userPoolConfig_awsRegion
- The Amazon Web Services Region in which the user pool was created.
$sel:defaultAction:UserPoolConfig'
, userPoolConfig_defaultAction
- The action that you want your GraphQL API to take when a request that
uses Amazon Cognito user pool authentication doesn't match the Amazon
Cognito user pool configuration.