| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.AppSync
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- UpdateDataSource
- DeleteDataSource
- CreateType
- GetGraphqlApi
- ListTagsForResource
- CreateGraphqlApi
- StartSchemaCreation
- FlushApiCache
- DeleteGraphqlApi
- UpdateGraphqlApi
- GetIntrospectionSchema
- GetDataSource
- ListResolversByFunction (Paginated)
- CreateFunction
- DeleteApiKey
- UpdateApiKey
- UpdateType
- DeleteType
- CreateDataSource
- ListTypes (Paginated)
- GetFunction
- ListDataSources (Paginated)
- UpdateResolver
- DeleteResolver
- ListResolvers (Paginated)
- CreateResolver
- GetSchemaCreationStatus
- GetApiCache
- UpdateApiCache
- DeleteApiCache
- ListGraphqlApis (Paginated)
- CreateApiCache
- TagResource
- GetResolver
- UpdateFunction
- DeleteFunction
- UntagResource
- CreateApiKey
- ListFunctions (Paginated)
- ListApiKeys (Paginated)
- GetType
- Types
- ApiCacheStatus
- ApiCacheType
- ApiCachingBehavior
- AuthenticationType
- AuthorizationType
- ConflictDetectionType
- ConflictHandlerType
- DataSourceType
- DefaultAction
- FieldLogLevel
- OutputType
- RelationalDatabaseSourceType
- ResolverKind
- SchemaStatus
- TypeDefinitionFormat
- AdditionalAuthenticationProvider
- ApiCache
- ApiKey
- AuthorizationConfig
- AwsIamConfig
- CachingConfig
- CognitoUserPoolConfig
- DataSource
- DeltaSyncConfig
- DynamodbDataSourceConfig
- ElasticsearchDataSourceConfig
- FunctionConfiguration
- GraphqlApi
- HttpDataSourceConfig
- LambdaAuthorizerConfig
- LambdaConflictHandlerConfig
- LambdaDataSourceConfig
- LogConfig
- OpenIDConnectConfig
- OpenSearchServiceDataSourceConfig
- PipelineConfig
- RdsHttpEndpointConfig
- RelationalDatabaseDataSourceConfig
- Resolver
- SyncConfig
- Type
- UserPoolConfig
Description
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
- _ApiKeyValidityOutOfBoundsException :: AsError a => Getting (First ServiceError) a ServiceError
- _AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
- _ApiKeyLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ApiLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _GraphQLSchemaException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalFailureException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnauthorizedException :: AsError a => Getting (First ServiceError) a ServiceError
- _BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- data UpdateDataSource = UpdateDataSource' (Maybe Text) (Maybe RelationalDatabaseDataSourceConfig) (Maybe DynamodbDataSourceConfig) (Maybe HttpDataSourceConfig) (Maybe OpenSearchServiceDataSourceConfig) (Maybe LambdaDataSourceConfig) (Maybe Text) (Maybe ElasticsearchDataSourceConfig) Text Text DataSourceType
- newUpdateDataSource :: Text -> Text -> DataSourceType -> UpdateDataSource
- data UpdateDataSourceResponse = UpdateDataSourceResponse' (Maybe DataSource) Int
- newUpdateDataSourceResponse :: Int -> UpdateDataSourceResponse
- data DeleteDataSource = DeleteDataSource' Text Text
- newDeleteDataSource :: Text -> Text -> DeleteDataSource
- data DeleteDataSourceResponse = DeleteDataSourceResponse' Int
- newDeleteDataSourceResponse :: Int -> DeleteDataSourceResponse
- data CreateType = CreateType' Text Text TypeDefinitionFormat
- newCreateType :: Text -> Text -> TypeDefinitionFormat -> CreateType
- data CreateTypeResponse = CreateTypeResponse' (Maybe Type) Int
- newCreateTypeResponse :: Int -> CreateTypeResponse
- data GetGraphqlApi = GetGraphqlApi' Text
- newGetGraphqlApi :: Text -> GetGraphqlApi
- data GetGraphqlApiResponse = GetGraphqlApiResponse' (Maybe GraphqlApi) Int
- newGetGraphqlApiResponse :: Int -> GetGraphqlApiResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data CreateGraphqlApi = CreateGraphqlApi' (Maybe Bool) (Maybe OpenIDConnectConfig) (Maybe [AdditionalAuthenticationProvider]) (Maybe LambdaAuthorizerConfig) (Maybe UserPoolConfig) (Maybe LogConfig) (Maybe (HashMap Text Text)) Text AuthenticationType
- newCreateGraphqlApi :: Text -> AuthenticationType -> CreateGraphqlApi
- data CreateGraphqlApiResponse = CreateGraphqlApiResponse' (Maybe GraphqlApi) Int
- newCreateGraphqlApiResponse :: Int -> CreateGraphqlApiResponse
- data StartSchemaCreation = StartSchemaCreation' Text Base64
- newStartSchemaCreation :: Text -> ByteString -> StartSchemaCreation
- data StartSchemaCreationResponse = StartSchemaCreationResponse' (Maybe SchemaStatus) Int
- newStartSchemaCreationResponse :: Int -> StartSchemaCreationResponse
- data FlushApiCache = FlushApiCache' Text
- newFlushApiCache :: Text -> FlushApiCache
- data FlushApiCacheResponse = FlushApiCacheResponse' Int
- newFlushApiCacheResponse :: Int -> FlushApiCacheResponse
- data DeleteGraphqlApi = DeleteGraphqlApi' Text
- newDeleteGraphqlApi :: Text -> DeleteGraphqlApi
- data DeleteGraphqlApiResponse = DeleteGraphqlApiResponse' Int
- newDeleteGraphqlApiResponse :: Int -> DeleteGraphqlApiResponse
- data UpdateGraphqlApi = UpdateGraphqlApi' (Maybe Bool) (Maybe OpenIDConnectConfig) (Maybe [AdditionalAuthenticationProvider]) (Maybe LambdaAuthorizerConfig) (Maybe UserPoolConfig) (Maybe AuthenticationType) (Maybe LogConfig) Text Text
- newUpdateGraphqlApi :: Text -> Text -> UpdateGraphqlApi
- data UpdateGraphqlApiResponse = UpdateGraphqlApiResponse' (Maybe GraphqlApi) Int
- newUpdateGraphqlApiResponse :: Int -> UpdateGraphqlApiResponse
- data GetIntrospectionSchema = GetIntrospectionSchema' (Maybe Bool) Text OutputType
- newGetIntrospectionSchema :: Text -> OutputType -> GetIntrospectionSchema
- data GetIntrospectionSchemaResponse = GetIntrospectionSchemaResponse' (Maybe ByteString) Int
- newGetIntrospectionSchemaResponse :: Int -> GetIntrospectionSchemaResponse
- data GetDataSource = GetDataSource' Text Text
- newGetDataSource :: Text -> Text -> GetDataSource
- data GetDataSourceResponse = GetDataSourceResponse' (Maybe DataSource) Int
- newGetDataSourceResponse :: Int -> GetDataSourceResponse
- data ListResolversByFunction = ListResolversByFunction' (Maybe Text) (Maybe Natural) Text Text
- newListResolversByFunction :: Text -> Text -> ListResolversByFunction
- data ListResolversByFunctionResponse = ListResolversByFunctionResponse' (Maybe Text) (Maybe [Resolver]) Int
- newListResolversByFunctionResponse :: Int -> ListResolversByFunctionResponse
- data CreateFunction = CreateFunction' (Maybe Text) (Maybe Text) (Maybe SyncConfig) (Maybe Text) Text Text Text Text
- newCreateFunction :: Text -> Text -> Text -> Text -> CreateFunction
- data CreateFunctionResponse = CreateFunctionResponse' (Maybe FunctionConfiguration) Int
- newCreateFunctionResponse :: Int -> CreateFunctionResponse
- data DeleteApiKey = DeleteApiKey' Text Text
- newDeleteApiKey :: Text -> Text -> DeleteApiKey
- data DeleteApiKeyResponse = DeleteApiKeyResponse' Int
- newDeleteApiKeyResponse :: Int -> DeleteApiKeyResponse
- data UpdateApiKey = UpdateApiKey' (Maybe Integer) (Maybe Text) Text Text
- newUpdateApiKey :: Text -> Text -> UpdateApiKey
- data UpdateApiKeyResponse = UpdateApiKeyResponse' (Maybe ApiKey) Int
- newUpdateApiKeyResponse :: Int -> UpdateApiKeyResponse
- data UpdateType = UpdateType' (Maybe Text) Text Text TypeDefinitionFormat
- newUpdateType :: Text -> Text -> TypeDefinitionFormat -> UpdateType
- data UpdateTypeResponse = UpdateTypeResponse' (Maybe Type) Int
- newUpdateTypeResponse :: Int -> UpdateTypeResponse
- data DeleteType = DeleteType' Text Text
- newDeleteType :: Text -> Text -> DeleteType
- data DeleteTypeResponse = DeleteTypeResponse' Int
- newDeleteTypeResponse :: Int -> DeleteTypeResponse
- data CreateDataSource = CreateDataSource' (Maybe Text) (Maybe RelationalDatabaseDataSourceConfig) (Maybe DynamodbDataSourceConfig) (Maybe HttpDataSourceConfig) (Maybe OpenSearchServiceDataSourceConfig) (Maybe LambdaDataSourceConfig) (Maybe Text) (Maybe ElasticsearchDataSourceConfig) Text Text DataSourceType
- newCreateDataSource :: Text -> Text -> DataSourceType -> CreateDataSource
- data CreateDataSourceResponse = CreateDataSourceResponse' (Maybe DataSource) Int
- newCreateDataSourceResponse :: Int -> CreateDataSourceResponse
- data ListTypes = ListTypes' (Maybe Text) (Maybe Natural) Text TypeDefinitionFormat
- newListTypes :: Text -> TypeDefinitionFormat -> ListTypes
- data ListTypesResponse = ListTypesResponse' (Maybe [Type]) (Maybe Text) Int
- newListTypesResponse :: Int -> ListTypesResponse
- data GetFunction = GetFunction' Text Text
- newGetFunction :: Text -> Text -> GetFunction
- data GetFunctionResponse = GetFunctionResponse' (Maybe FunctionConfiguration) Int
- newGetFunctionResponse :: Int -> GetFunctionResponse
- data ListDataSources = ListDataSources' (Maybe Text) (Maybe Natural) Text
- newListDataSources :: Text -> ListDataSources
- data ListDataSourcesResponse = ListDataSourcesResponse' (Maybe [DataSource]) (Maybe Text) Int
- newListDataSourcesResponse :: Int -> ListDataSourcesResponse
- data UpdateResolver = UpdateResolver' (Maybe Text) (Maybe Text) (Maybe ResolverKind) (Maybe CachingConfig) (Maybe Text) (Maybe SyncConfig) (Maybe PipelineConfig) Text Text Text
- newUpdateResolver :: Text -> Text -> Text -> UpdateResolver
- data UpdateResolverResponse = UpdateResolverResponse' (Maybe Resolver) Int
- newUpdateResolverResponse :: Int -> UpdateResolverResponse
- data DeleteResolver = DeleteResolver' Text Text Text
- newDeleteResolver :: Text -> Text -> Text -> DeleteResolver
- data DeleteResolverResponse = DeleteResolverResponse' Int
- newDeleteResolverResponse :: Int -> DeleteResolverResponse
- data ListResolvers = ListResolvers' (Maybe Text) (Maybe Natural) Text Text
- newListResolvers :: Text -> Text -> ListResolvers
- data ListResolversResponse = ListResolversResponse' (Maybe Text) (Maybe [Resolver]) Int
- newListResolversResponse :: Int -> ListResolversResponse
- data CreateResolver = CreateResolver' (Maybe Text) (Maybe Text) (Maybe ResolverKind) (Maybe CachingConfig) (Maybe Text) (Maybe SyncConfig) (Maybe PipelineConfig) Text Text Text
- newCreateResolver :: Text -> Text -> Text -> CreateResolver
- data CreateResolverResponse = CreateResolverResponse' (Maybe Resolver) Int
- newCreateResolverResponse :: Int -> CreateResolverResponse
- data GetSchemaCreationStatus = GetSchemaCreationStatus' Text
- newGetSchemaCreationStatus :: Text -> GetSchemaCreationStatus
- data GetSchemaCreationStatusResponse = GetSchemaCreationStatusResponse' (Maybe SchemaStatus) (Maybe Text) Int
- newGetSchemaCreationStatusResponse :: Int -> GetSchemaCreationStatusResponse
- data GetApiCache = GetApiCache' Text
- newGetApiCache :: Text -> GetApiCache
- data GetApiCacheResponse = GetApiCacheResponse' (Maybe ApiCache) Int
- newGetApiCacheResponse :: Int -> GetApiCacheResponse
- data UpdateApiCache = UpdateApiCache' Text Integer ApiCachingBehavior ApiCacheType
- newUpdateApiCache :: Text -> Integer -> ApiCachingBehavior -> ApiCacheType -> UpdateApiCache
- data UpdateApiCacheResponse = UpdateApiCacheResponse' (Maybe ApiCache) Int
- newUpdateApiCacheResponse :: Int -> UpdateApiCacheResponse
- data DeleteApiCache = DeleteApiCache' Text
- newDeleteApiCache :: Text -> DeleteApiCache
- data DeleteApiCacheResponse = DeleteApiCacheResponse' Int
- newDeleteApiCacheResponse :: Int -> DeleteApiCacheResponse
- data ListGraphqlApis = ListGraphqlApis' (Maybe Text) (Maybe Natural)
- newListGraphqlApis :: ListGraphqlApis
- data ListGraphqlApisResponse = ListGraphqlApisResponse' (Maybe Text) (Maybe [GraphqlApi]) Int
- newListGraphqlApisResponse :: Int -> ListGraphqlApisResponse
- 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 TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data GetResolver = GetResolver' Text Text Text
- newGetResolver :: Text -> Text -> Text -> GetResolver
- data GetResolverResponse = GetResolverResponse' (Maybe Resolver) Int
- newGetResolverResponse :: Int -> GetResolverResponse
- data UpdateFunction = UpdateFunction' (Maybe Text) (Maybe Text) (Maybe SyncConfig) (Maybe Text) Text Text Text Text Text
- newUpdateFunction :: Text -> Text -> Text -> Text -> Text -> UpdateFunction
- data UpdateFunctionResponse = UpdateFunctionResponse' (Maybe FunctionConfiguration) Int
- newUpdateFunctionResponse :: Int -> UpdateFunctionResponse
- data DeleteFunction = DeleteFunction' Text Text
- newDeleteFunction :: Text -> Text -> DeleteFunction
- data DeleteFunctionResponse = DeleteFunctionResponse' Int
- newDeleteFunctionResponse :: Int -> DeleteFunctionResponse
- data UntagResource = UntagResource' Text (NonEmpty Text)
- newUntagResource :: Text -> NonEmpty Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data CreateApiKey = CreateApiKey' (Maybe Integer) (Maybe Text) Text
- newCreateApiKey :: Text -> CreateApiKey
- data CreateApiKeyResponse = CreateApiKeyResponse' (Maybe ApiKey) Int
- newCreateApiKeyResponse :: Int -> CreateApiKeyResponse
- data ListFunctions = ListFunctions' (Maybe Text) (Maybe Natural) Text
- newListFunctions :: Text -> ListFunctions
- data ListFunctionsResponse = ListFunctionsResponse' (Maybe Text) (Maybe [FunctionConfiguration]) Int
- newListFunctionsResponse :: Int -> ListFunctionsResponse
- data ListApiKeys = ListApiKeys' (Maybe Text) (Maybe Natural) Text
- newListApiKeys :: Text -> ListApiKeys
- data ListApiKeysResponse = ListApiKeysResponse' (Maybe [ApiKey]) (Maybe Text) Int
- newListApiKeysResponse :: Int -> ListApiKeysResponse
- data GetType = GetType' Text Text TypeDefinitionFormat
- newGetType :: Text -> Text -> TypeDefinitionFormat -> GetType
- data GetTypeResponse = GetTypeResponse' (Maybe Type) Int
- newGetTypeResponse :: Int -> GetTypeResponse
- 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 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 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 OpenIDConnectConfig) (Maybe LambdaAuthorizerConfig) (Maybe CognitoUserPoolConfig) (Maybe AuthenticationType)
- newAdditionalAuthenticationProvider :: AdditionalAuthenticationProvider
- data ApiCache = ApiCache' (Maybe Integer) (Maybe ApiCacheStatus) (Maybe Bool) (Maybe Bool) (Maybe ApiCachingBehavior) (Maybe ApiCacheType)
- newApiCache :: ApiCache
- data ApiKey = ApiKey' (Maybe Integer) (Maybe Integer) (Maybe Text) (Maybe Text)
- newApiKey :: ApiKey
- data AuthorizationConfig = AuthorizationConfig' (Maybe AwsIamConfig) AuthorizationType
- newAuthorizationConfig :: AuthorizationType -> AuthorizationConfig
- data AwsIamConfig = AwsIamConfig' (Maybe Text) (Maybe Text)
- newAwsIamConfig :: AwsIamConfig
- data CachingConfig = CachingConfig' (Maybe Integer) (Maybe [Text])
- newCachingConfig :: CachingConfig
- data CognitoUserPoolConfig = CognitoUserPoolConfig' (Maybe Text) Text Text
- newCognitoUserPoolConfig :: Text -> Text -> CognitoUserPoolConfig
- data DataSource = DataSource' (Maybe Text) (Maybe RelationalDatabaseDataSourceConfig) (Maybe Text) (Maybe DynamodbDataSourceConfig) (Maybe Text) (Maybe HttpDataSourceConfig) (Maybe OpenSearchServiceDataSourceConfig) (Maybe LambdaDataSourceConfig) (Maybe DataSourceType) (Maybe Text) (Maybe ElasticsearchDataSourceConfig)
- newDataSource :: DataSource
- data DeltaSyncConfig = DeltaSyncConfig' (Maybe Integer) (Maybe Text) (Maybe Integer)
- newDeltaSyncConfig :: DeltaSyncConfig
- data DynamodbDataSourceConfig = DynamodbDataSourceConfig' (Maybe Bool) (Maybe Bool) (Maybe DeltaSyncConfig) Text Text
- newDynamodbDataSourceConfig :: Text -> Text -> DynamodbDataSourceConfig
- data ElasticsearchDataSourceConfig = ElasticsearchDataSourceConfig' Text Text
- newElasticsearchDataSourceConfig :: Text -> Text -> ElasticsearchDataSourceConfig
- data FunctionConfiguration = FunctionConfiguration' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe SyncConfig) (Maybe Text) (Maybe Text)
- newFunctionConfiguration :: FunctionConfiguration
- data GraphqlApi = GraphqlApi' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe OpenIDConnectConfig) (Maybe Text) (Maybe [AdditionalAuthenticationProvider]) (Maybe LambdaAuthorizerConfig) (Maybe Text) (Maybe UserPoolConfig) (Maybe AuthenticationType) (Maybe LogConfig) (Maybe (HashMap Text Text))
- newGraphqlApi :: GraphqlApi
- data HttpDataSourceConfig = HttpDataSourceConfig' (Maybe AuthorizationConfig) (Maybe Text)
- newHttpDataSourceConfig :: HttpDataSourceConfig
- data LambdaAuthorizerConfig = LambdaAuthorizerConfig' (Maybe Text) (Maybe Natural) 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 RelationalDatabaseSourceType) (Maybe RdsHttpEndpointConfig)
- newRelationalDatabaseDataSourceConfig :: RelationalDatabaseDataSourceConfig
- data Resolver = Resolver' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ResolverKind) (Maybe Text) (Maybe CachingConfig) (Maybe Text) (Maybe Text) (Maybe SyncConfig) (Maybe PipelineConfig)
- newResolver :: Resolver
- data SyncConfig = SyncConfig' (Maybe ConflictHandlerType) (Maybe ConflictDetectionType) (Maybe LambdaConflictHandlerConfig)
- newSyncConfig :: SyncConfig
- data Type = Type' (Maybe Text) (Maybe Text) (Maybe TypeDefinitionFormat) (Maybe Text) (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.
ApiKeyValidityOutOfBoundsException
_ApiKeyValidityOutOfBoundsException :: AsError a => Getting (First ServiceError) 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).
AccessDeniedException
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You do not have access to perform this operation on this resource.
ApiKeyLimitExceededException
_ApiKeyLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The API key exceeded a limit. Try your request again.
ApiLimitExceededException
_ApiLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The GraphQL API exceeded a limit. Try your request again.
NotFoundException
_NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource specified in the request was not found. Check the resource, and then try again.
GraphQLSchemaException
_GraphQLSchemaException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The GraphQL schema is not valid.
ConcurrentModificationException
_ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Another modification is in progress at this time and it must complete before you can make your change.
InternalFailureException
_InternalFailureException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An internal AppSync error occurred. Try your request again.
UnauthorizedException
_UnauthorizedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You are not authorized to perform this operation.
BadRequestException
_BadRequestException :: AsError a => Getting (First ServiceError) 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.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request exceeded a limit. Try your request again.
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.
UpdateDataSource
data UpdateDataSource Source #
See: newUpdateDataSource smart constructor.
Constructors
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DataSourceType | |
| -> UpdateDataSource |
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:
$sel:serviceRoleArn:UpdateDataSource', updateDataSource_serviceRoleArn - The new service role ARN for the data source.
$sel:relationalDatabaseConfig:UpdateDataSource', updateDataSource_relationalDatabaseConfig - The new relational database configuration.
$sel:dynamodbConfig:UpdateDataSource', updateDataSource_dynamodbConfig - The new Amazon DynamoDB configuration.
$sel:httpConfig:UpdateDataSource', updateDataSource_httpConfig - The new HTTP endpoint configuration.
$sel:openSearchServiceConfig:UpdateDataSource', updateDataSource_openSearchServiceConfig - The new OpenSearch configuration.
$sel:lambdaConfig:UpdateDataSource', updateDataSource_lambdaConfig - The new Amazon Web Services Lambda configuration.
$sel:description:UpdateDataSource', updateDataSource_description - The new description for the data source.
$sel:elasticsearchConfig: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.
$sel:apiId:UpdateDataSource', updateDataSource_apiId - The API ID.
$sel:name:UpdateDataSource', updateDataSource_name - The new name for the data source.
$sel:type':UpdateDataSource', updateDataSource_type - The new data source type.
data UpdateDataSourceResponse Source #
See: newUpdateDataSourceResponse smart constructor.
Constructors
| UpdateDataSourceResponse' (Maybe DataSource) Int |
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.
DeleteDataSource
data DeleteDataSource Source #
See: newDeleteDataSource smart constructor.
Constructors
| DeleteDataSource' Text Text |
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:
$sel:apiId:DeleteDataSource', deleteDataSource_apiId - The API ID.
$sel:name:DeleteDataSource', deleteDataSource_name - The name of the data source.
data DeleteDataSourceResponse Source #
See: newDeleteDataSourceResponse smart constructor.
Constructors
| DeleteDataSourceResponse' Int |
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.
CreateType
data CreateType Source #
See: newCreateType smart constructor.
Constructors
| CreateType' Text Text TypeDefinitionFormat |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> TypeDefinitionFormat | |
| -> CreateType |
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:
$sel:apiId:CreateType', createType_apiId - The API ID.
$sel:definition:CreateType', createType_definition - The type definition, in GraphQL Schema Definition Language (SDL) format.
For more information, see the GraphQL SDL documentation.
$sel:format:CreateType', createType_format - The type format: SDL or JSON.
data CreateTypeResponse Source #
See: newCreateTypeResponse smart constructor.
Constructors
| CreateTypeResponse' (Maybe Type) Int |
Instances
newCreateTypeResponse Source #
Arguments
| :: Int | |
| -> CreateTypeResponse |
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:
$sel:type':CreateTypeResponse', createTypeResponse_type - The Type object.
$sel:httpStatus:CreateTypeResponse', createTypeResponse_httpStatus - The response's http status code.
GetGraphqlApi
data GetGraphqlApi Source #
See: newGetGraphqlApi smart constructor.
Constructors
| GetGraphqlApi' Text |
Instances
Arguments
| :: Text | |
| -> GetGraphqlApi |
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:
$sel:apiId:GetGraphqlApi', getGraphqlApi_apiId - The API ID for the GraphQL API.
data GetGraphqlApiResponse Source #
See: newGetGraphqlApiResponse smart constructor.
Constructors
| GetGraphqlApiResponse' (Maybe GraphqlApi) Int |
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.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
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 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:
$sel:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - A TagMap object.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
CreateGraphqlApi
data CreateGraphqlApi Source #
See: newCreateGraphqlApi smart constructor.
Constructors
Instances
Arguments
| :: Text | |
| -> AuthenticationType | |
| -> CreateGraphqlApi |
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:
$sel:xrayEnabled:CreateGraphqlApi', createGraphqlApi_xrayEnabled - A flag indicating whether to enable X-Ray tracing for the GraphqlApi.
$sel:openIDConnectConfig:CreateGraphqlApi', createGraphqlApi_openIDConnectConfig - The OpenID Connect configuration.
$sel:additionalAuthenticationProviders:CreateGraphqlApi', createGraphqlApi_additionalAuthenticationProviders - A list of additional authentication providers for the GraphqlApi API.
$sel:lambdaAuthorizerConfig:CreateGraphqlApi', createGraphqlApi_lambdaAuthorizerConfig - Configuration for Amazon Web Services Lambda function authorization.
$sel:userPoolConfig:CreateGraphqlApi', createGraphqlApi_userPoolConfig - The Amazon Cognito user pool configuration.
$sel:logConfig:CreateGraphqlApi', createGraphqlApi_logConfig - The Amazon CloudWatch Logs configuration.
$sel:tags:CreateGraphqlApi', createGraphqlApi_tags - A TagMap object.
$sel:name:CreateGraphqlApi', createGraphqlApi_name - A user-supplied name for the GraphqlApi.
$sel:authenticationType:CreateGraphqlApi', createGraphqlApi_authenticationType - The authentication type: API key, Identity and Access Management, OIDC,
Amazon Cognito user pools, or Amazon Web Services Lambda.
data CreateGraphqlApiResponse Source #
See: newCreateGraphqlApiResponse smart constructor.
Constructors
| CreateGraphqlApiResponse' (Maybe GraphqlApi) Int |
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.
StartSchemaCreation
data StartSchemaCreation Source #
See: newStartSchemaCreation smart constructor.
Constructors
| StartSchemaCreation' Text Base64 |
Instances
newStartSchemaCreation Source #
Arguments
| :: Text | |
| -> ByteString | |
| -> StartSchemaCreation |
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:
$sel:apiId:StartSchemaCreation', startSchemaCreation_apiId - The API ID.
$sel:definition: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.
Constructors
| StartSchemaCreationResponse' (Maybe SchemaStatus) Int |
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:
$sel:status: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.
FlushApiCache
data FlushApiCache Source #
Represents the input of a FlushApiCache operation.
See: newFlushApiCache smart constructor.
Constructors
| FlushApiCache' Text |
Instances
Arguments
| :: Text | |
| -> FlushApiCache |
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:
$sel:apiId:FlushApiCache', flushApiCache_apiId - The API ID.
data FlushApiCacheResponse Source #
Represents the output of a FlushApiCache operation.
See: newFlushApiCacheResponse smart constructor.
Constructors
| FlushApiCacheResponse' Int |
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.
DeleteGraphqlApi
data DeleteGraphqlApi Source #
See: newDeleteGraphqlApi smart constructor.
Constructors
| DeleteGraphqlApi' Text |
Instances
Arguments
| :: Text | |
| -> DeleteGraphqlApi |
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:
$sel:apiId:DeleteGraphqlApi', deleteGraphqlApi_apiId - The API ID.
data DeleteGraphqlApiResponse Source #
See: newDeleteGraphqlApiResponse smart constructor.
Constructors
| DeleteGraphqlApiResponse' Int |
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.
UpdateGraphqlApi
data UpdateGraphqlApi Source #
See: newUpdateGraphqlApi smart constructor.
Constructors
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:
$sel:xrayEnabled:UpdateGraphqlApi', updateGraphqlApi_xrayEnabled - A flag indicating whether to enable X-Ray tracing for the GraphqlApi.
$sel:openIDConnectConfig:UpdateGraphqlApi', updateGraphqlApi_openIDConnectConfig - The OpenID Connect configuration for the GraphqlApi object.
$sel:additionalAuthenticationProviders:UpdateGraphqlApi', updateGraphqlApi_additionalAuthenticationProviders - A list of additional authentication providers for the GraphqlApi API.
$sel:lambdaAuthorizerConfig:UpdateGraphqlApi', updateGraphqlApi_lambdaAuthorizerConfig - Configuration for Amazon Web Services Lambda function authorization.
$sel:userPoolConfig:UpdateGraphqlApi', updateGraphqlApi_userPoolConfig - The new Amazon Cognito user pool configuration for the GraphqlApi
object.
$sel:authenticationType:UpdateGraphqlApi', updateGraphqlApi_authenticationType - The new authentication type for the GraphqlApi object.
$sel:logConfig:UpdateGraphqlApi', updateGraphqlApi_logConfig - The Amazon CloudWatch Logs configuration for the GraphqlApi object.
$sel:apiId:UpdateGraphqlApi', updateGraphqlApi_apiId - The API ID.
$sel:name:UpdateGraphqlApi', updateGraphqlApi_name - The new name for the GraphqlApi object.
data UpdateGraphqlApiResponse Source #
See: newUpdateGraphqlApiResponse smart constructor.
Constructors
| UpdateGraphqlApiResponse' (Maybe GraphqlApi) Int |
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.
GetIntrospectionSchema
data GetIntrospectionSchema Source #
See: newGetIntrospectionSchema smart constructor.
Constructors
| GetIntrospectionSchema' (Maybe Bool) Text OutputType |
Instances
newGetIntrospectionSchema Source #
Arguments
| :: Text | |
| -> OutputType | |
| -> GetIntrospectionSchema |
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.
$sel:apiId:GetIntrospectionSchema', getIntrospectionSchema_apiId - The API ID.
$sel:format:GetIntrospectionSchema', getIntrospectionSchema_format - The schema format: SDL or JSON.
data GetIntrospectionSchemaResponse Source #
See: newGetIntrospectionSchemaResponse smart constructor.
Constructors
| GetIntrospectionSchemaResponse' (Maybe ByteString) Int |
Instances
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:
$sel:schema: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.
GetDataSource
data GetDataSource Source #
See: newGetDataSource smart constructor.
Constructors
| GetDataSource' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> GetDataSource |
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:
$sel:apiId:GetDataSource', getDataSource_apiId - The API ID.
$sel:name:GetDataSource', getDataSource_name - The name of the data source.
data GetDataSourceResponse Source #
See: newGetDataSourceResponse smart constructor.
Constructors
| GetDataSourceResponse' (Maybe DataSource) Int |
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.
ListResolversByFunction (Paginated)
data ListResolversByFunction Source #
See: newListResolversByFunction smart constructor.
Instances
newListResolversByFunction Source #
Arguments
| :: Text | |
| -> Text | |
| -> ListResolversByFunction |
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:nextToken: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.
$sel:maxResults:ListResolversByFunction', listResolversByFunction_maxResults - The maximum number of results you want the request to return.
$sel:apiId:ListResolversByFunction', listResolversByFunction_apiId - The API ID.
$sel:functionId: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:
$sel:nextToken:ListResolversByFunction', listResolversByFunctionResponse_nextToken - An identifier that can be used 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.
CreateFunction
data CreateFunction Source #
See: newCreateFunction smart constructor.
Constructors
| CreateFunction' (Maybe Text) (Maybe Text) (Maybe SyncConfig) (Maybe Text) Text Text Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> CreateFunction |
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:
$sel:requestMappingTemplate:CreateFunction', createFunction_requestMappingTemplate - The Function request mapping template. Functions support only the
2018-05-29 version of the request mapping template.
$sel:responseMappingTemplate:CreateFunction', createFunction_responseMappingTemplate - The Function response mapping template.
$sel:syncConfig:CreateFunction', createFunction_syncConfig - Undocumented member.
$sel:description:CreateFunction', createFunction_description - The Function description.
$sel:apiId:CreateFunction', createFunction_apiId - The GraphQL API ID.
$sel:name:CreateFunction', createFunction_name - The Function name. The function name does not have to be unique.
$sel:dataSourceName:CreateFunction', createFunction_dataSourceName - The Function DataSource name.
$sel:functionVersion:CreateFunction', createFunction_functionVersion - The version of the request mapping template. Currently the supported
value is 2018-05-29.
data CreateFunctionResponse Source #
See: newCreateFunctionResponse smart constructor.
Constructors
| CreateFunctionResponse' (Maybe FunctionConfiguration) Int |
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.
DeleteApiKey
data DeleteApiKey Source #
See: newDeleteApiKey smart constructor.
Constructors
| DeleteApiKey' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DeleteApiKey |
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:
$sel:apiId:DeleteApiKey', deleteApiKey_apiId - The API ID.
$sel:id:DeleteApiKey', deleteApiKey_id - The ID for the API key.
data DeleteApiKeyResponse Source #
See: newDeleteApiKeyResponse smart constructor.
Constructors
| DeleteApiKeyResponse' Int |
Instances
newDeleteApiKeyResponse Source #
Arguments
| :: Int | |
| -> DeleteApiKeyResponse |
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.
UpdateApiKey
data UpdateApiKey Source #
See: newUpdateApiKey smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> UpdateApiKey |
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:
$sel:expires:UpdateApiKey', updateApiKey_expires - The time from update time after which the API key expires. The date is
represented as seconds since the epoch. For more information, see .
$sel:description:UpdateApiKey', updateApiKey_description - A description of the purpose of the API key.
$sel:apiId:UpdateApiKey', updateApiKey_apiId - The ID for the GraphQL API.
$sel:id:UpdateApiKey', updateApiKey_id - The API key ID.
data UpdateApiKeyResponse Source #
See: newUpdateApiKeyResponse smart constructor.
Constructors
| UpdateApiKeyResponse' (Maybe ApiKey) Int |
Instances
newUpdateApiKeyResponse Source #
Arguments
| :: Int | |
| -> UpdateApiKeyResponse |
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.
UpdateType
data UpdateType Source #
See: newUpdateType smart constructor.
Constructors
| UpdateType' (Maybe Text) Text Text TypeDefinitionFormat |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> TypeDefinitionFormat | |
| -> UpdateType |
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:
$sel:definition:UpdateType', updateType_definition - The new definition.
$sel:apiId:UpdateType', updateType_apiId - The API ID.
$sel:typeName:UpdateType', updateType_typeName - The new type name.
$sel:format:UpdateType', updateType_format - The new type format: SDL or JSON.
data UpdateTypeResponse Source #
See: newUpdateTypeResponse smart constructor.
Constructors
| UpdateTypeResponse' (Maybe Type) Int |
Instances
newUpdateTypeResponse Source #
Arguments
| :: Int | |
| -> UpdateTypeResponse |
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:
$sel:type':UpdateTypeResponse', updateTypeResponse_type - The updated Type object.
$sel:httpStatus:UpdateTypeResponse', updateTypeResponse_httpStatus - The response's http status code.
DeleteType
data DeleteType Source #
See: newDeleteType smart constructor.
Constructors
| DeleteType' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DeleteType |
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:
$sel:apiId:DeleteType', deleteType_apiId - The API ID.
$sel:typeName:DeleteType', deleteType_typeName - The type name.
data DeleteTypeResponse Source #
See: newDeleteTypeResponse smart constructor.
Constructors
| DeleteTypeResponse' Int |
Instances
newDeleteTypeResponse Source #
Arguments
| :: Int | |
| -> DeleteTypeResponse |
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.
CreateDataSource
data CreateDataSource Source #
See: newCreateDataSource smart constructor.
Constructors
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DataSourceType | |
| -> CreateDataSource |
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:
$sel:serviceRoleArn:CreateDataSource', createDataSource_serviceRoleArn - The Identity and Access Management service role ARN for the data source.
The system assumes this role when accessing the data source.
$sel:relationalDatabaseConfig:CreateDataSource', createDataSource_relationalDatabaseConfig - Relational database settings.
$sel:dynamodbConfig:CreateDataSource', createDataSource_dynamodbConfig - Amazon DynamoDB settings.
$sel:httpConfig:CreateDataSource', createDataSource_httpConfig - HTTP endpoint settings.
$sel:openSearchServiceConfig:CreateDataSource', createDataSource_openSearchServiceConfig - Amazon OpenSearch Service settings.
$sel:lambdaConfig:CreateDataSource', createDataSource_lambdaConfig - Amazon Web Services Lambda settings.
$sel:description:CreateDataSource', createDataSource_description - A description of the DataSource.
$sel:elasticsearchConfig: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.
$sel:apiId:CreateDataSource', createDataSource_apiId - The API ID for the GraphQL API for the DataSource.
$sel:name:CreateDataSource', createDataSource_name - A user-supplied name for the DataSource.
$sel:type':CreateDataSource', createDataSource_type - The type of the DataSource.
data CreateDataSourceResponse Source #
See: newCreateDataSourceResponse smart constructor.
Constructors
| CreateDataSourceResponse' (Maybe DataSource) Int |
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.
ListTypes (Paginated)
See: newListTypes smart constructor.
Constructors
| ListTypes' (Maybe Text) (Maybe Natural) Text TypeDefinitionFormat |
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:nextToken:ListTypes', listTypes_nextToken - An identifier that was returned from the previous call to this
operation, which can be used to return the next set of items in the
list.
$sel:maxResults:ListTypes', listTypes_maxResults - The maximum number of results you want the request to return.
$sel:apiId:ListTypes', listTypes_apiId - The API ID.
$sel:format:ListTypes', listTypes_format - The type format: SDL or JSON.
data ListTypesResponse Source #
See: newListTypesResponse smart constructor.
Instances
Arguments
| :: Int | |
| -> ListTypesResponse |
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:
$sel:types:ListTypesResponse', listTypesResponse_types - The Type objects.
$sel:nextToken:ListTypes', listTypesResponse_nextToken - An identifier to be passed in the next request to this operation to
return the next set of items in the list.
$sel:httpStatus:ListTypesResponse', listTypesResponse_httpStatus - The response's http status code.
GetFunction
data GetFunction Source #
See: newGetFunction smart constructor.
Constructors
| GetFunction' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> GetFunction |
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:
$sel:apiId:GetFunction', getFunction_apiId - The GraphQL API ID.
$sel:functionId:GetFunction', getFunction_functionId - The Function ID.
data GetFunctionResponse Source #
See: newGetFunctionResponse smart constructor.
Constructors
| GetFunctionResponse' (Maybe FunctionConfiguration) Int |
Instances
newGetFunctionResponse Source #
Arguments
| :: Int | |
| -> GetFunctionResponse |
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.
ListDataSources (Paginated)
data ListDataSources Source #
See: newListDataSources smart constructor.
Instances
Arguments
| :: Text | |
| -> ListDataSources |
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:nextToken:ListDataSources', listDataSources_nextToken - An identifier that was returned from the previous call to this
operation, which can be used to return the next set of items in the
list.
$sel:maxResults:ListDataSources', listDataSources_maxResults - The maximum number of results you want the request to return.
$sel:apiId:ListDataSources', listDataSources_apiId - The API ID.
data ListDataSourcesResponse Source #
See: newListDataSourcesResponse smart constructor.
Constructors
| ListDataSourcesResponse' (Maybe [DataSource]) (Maybe Text) Int |
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.
$sel:nextToken:ListDataSources', listDataSourcesResponse_nextToken - An identifier to be passed 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.
UpdateResolver
data UpdateResolver Source #
See: newUpdateResolver smart constructor.
Constructors
| UpdateResolver' (Maybe Text) (Maybe Text) (Maybe ResolverKind) (Maybe CachingConfig) (Maybe Text) (Maybe SyncConfig) (Maybe PipelineConfig) Text Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> UpdateResolver |
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:
$sel:dataSourceName:UpdateResolver', updateResolver_dataSourceName - The new data source name.
$sel:requestMappingTemplate: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 a Lambda data source. For all other data sources, VTL request and response mapping templates are required.
$sel:kind:UpdateResolver', updateResolver_kind - The resolver type.
- UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source.
- PIPELINE: A PIPELINE resolver type. A PIPELINE resolver enables
you to execute a series of
Functionin a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.
$sel:cachingConfig:UpdateResolver', updateResolver_cachingConfig - The caching configuration for the resolver.
$sel:responseMappingTemplate:UpdateResolver', updateResolver_responseMappingTemplate - The new response mapping template.
$sel:syncConfig:UpdateResolver', updateResolver_syncConfig - The SyncConfig for a resolver attached to a versioned datasource.
$sel:pipelineConfig:UpdateResolver', updateResolver_pipelineConfig - The PipelineConfig.
$sel:apiId:UpdateResolver', updateResolver_apiId - The API ID.
$sel:typeName:UpdateResolver', updateResolver_typeName - The new type name.
$sel:fieldName:UpdateResolver', updateResolver_fieldName - The new field name.
data UpdateResolverResponse Source #
See: newUpdateResolverResponse smart constructor.
Constructors
| UpdateResolverResponse' (Maybe Resolver) Int |
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.
DeleteResolver
data DeleteResolver Source #
See: newDeleteResolver smart constructor.
Constructors
| DeleteResolver' Text Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> DeleteResolver |
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:
$sel:apiId:DeleteResolver', deleteResolver_apiId - The API ID.
$sel:typeName:DeleteResolver', deleteResolver_typeName - The name of the resolver type.
$sel:fieldName:DeleteResolver', deleteResolver_fieldName - The resolver field name.
data DeleteResolverResponse Source #
See: newDeleteResolverResponse smart constructor.
Constructors
| DeleteResolverResponse' Int |
Instances
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.
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:nextToken:ListResolvers', listResolvers_nextToken - An identifier that was returned from the previous call to this
operation, which can be used to return the next set of items in the
list.
$sel:maxResults:ListResolvers', listResolvers_maxResults - The maximum number of results you want the request to return.
$sel:apiId:ListResolvers', listResolvers_apiId - The API ID.
$sel:typeName: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:
$sel:nextToken:ListResolvers', listResolversResponse_nextToken - An identifier to be passed 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.
CreateResolver
data CreateResolver Source #
See: newCreateResolver smart constructor.
Constructors
| CreateResolver' (Maybe Text) (Maybe Text) (Maybe ResolverKind) (Maybe CachingConfig) (Maybe Text) (Maybe SyncConfig) (Maybe PipelineConfig) Text Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> CreateResolver |
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:
$sel:dataSourceName:CreateResolver', createResolver_dataSourceName - The name of the data source for which the resolver is being created.
$sel:requestMappingTemplate:CreateResolver', createResolver_requestMappingTemplate - The mapping template to be used 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 a Lambda data source. For all other data sources, VTL request and response mapping templates are required.
$sel:kind:CreateResolver', createResolver_kind - The resolver type.
- UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source.
- PIPELINE: A PIPELINE resolver type. A PIPELINE resolver enables
you to execute a series of
Functionin a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.
$sel:cachingConfig:CreateResolver', createResolver_cachingConfig - The caching configuration for the resolver.
$sel:responseMappingTemplate:CreateResolver', createResolver_responseMappingTemplate - The mapping template to be used for responses from the data source.
$sel:syncConfig:CreateResolver', createResolver_syncConfig - The SyncConfig for a resolver attached to a versioned datasource.
$sel:pipelineConfig:CreateResolver', createResolver_pipelineConfig - The PipelineConfig.
$sel:apiId:CreateResolver', createResolver_apiId - The ID for the GraphQL API for which the resolver is being created.
$sel:typeName:CreateResolver', createResolver_typeName - The name of the Type.
$sel:fieldName:CreateResolver', createResolver_fieldName - The name of the field to attach the resolver to.
data CreateResolverResponse Source #
See: newCreateResolverResponse smart constructor.
Constructors
| CreateResolverResponse' (Maybe Resolver) Int |
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.
GetSchemaCreationStatus
data GetSchemaCreationStatus Source #
See: newGetSchemaCreationStatus smart constructor.
Constructors
| GetSchemaCreationStatus' Text |
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:
$sel:apiId:GetSchemaCreationStatus', getSchemaCreationStatus_apiId - The API ID.
data GetSchemaCreationStatusResponse Source #
See: newGetSchemaCreationStatusResponse smart constructor.
Constructors
| GetSchemaCreationStatusResponse' (Maybe SchemaStatus) (Maybe Text) Int |
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:status: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:details:GetSchemaCreationStatusResponse', getSchemaCreationStatusResponse_details - Detailed information about the status of the schema creation operation.
$sel:httpStatus:GetSchemaCreationStatusResponse', getSchemaCreationStatusResponse_httpStatus - The response's http status code.
GetApiCache
data GetApiCache Source #
Represents the input of a GetApiCache operation.
See: newGetApiCache smart constructor.
Constructors
| GetApiCache' Text |
Instances
Arguments
| :: Text | |
| -> GetApiCache |
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:
$sel:apiId:GetApiCache', getApiCache_apiId - The API ID.
data GetApiCacheResponse Source #
Represents the output of a GetApiCache operation.
See: newGetApiCacheResponse smart constructor.
Constructors
| GetApiCacheResponse' (Maybe ApiCache) Int |
Instances
newGetApiCacheResponse Source #
Arguments
| :: Int | |
| -> GetApiCacheResponse |
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.
UpdateApiCache
data UpdateApiCache Source #
Represents the input of a UpdateApiCache operation.
See: newUpdateApiCache smart constructor.
Constructors
| UpdateApiCache' Text Integer ApiCachingBehavior ApiCacheType |
Instances
Arguments
| :: 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:
$sel:apiId:UpdateApiCache', updateApiCache_apiId - The GraphQL API Id.
$sel:ttl:UpdateApiCache', updateApiCache_ttl - TTL in seconds for cache entries.
Valid values are between 1 and 3600 seconds.
$sel:apiCachingBehavior:UpdateApiCache', updateApiCache_apiCachingBehavior - Caching behavior.
- FULL_REQUEST_CACHING: All requests are fully cached.
- PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
$sel:type':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.
Constructors
| UpdateApiCacheResponse' (Maybe ApiCache) Int |
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.
DeleteApiCache
data DeleteApiCache Source #
Represents the input of a DeleteApiCache operation.
See: newDeleteApiCache smart constructor.
Constructors
| DeleteApiCache' Text |
Instances
Arguments
| :: Text | |
| -> DeleteApiCache |
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:
$sel:apiId:DeleteApiCache', deleteApiCache_apiId - The API ID.
data DeleteApiCacheResponse Source #
Represents the output of a DeleteApiCache operation.
See: newDeleteApiCacheResponse smart constructor.
Constructors
| DeleteApiCacheResponse' Int |
Instances
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.
ListGraphqlApis (Paginated)
data ListGraphqlApis Source #
See: newListGraphqlApis smart constructor.
Constructors
| ListGraphqlApis' (Maybe Text) (Maybe Natural) |
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:nextToken:ListGraphqlApis', listGraphqlApis_nextToken - An identifier that was returned from the previous call to this
operation, which can be used to return the next set of items in the
list.
$sel:maxResults:ListGraphqlApis', listGraphqlApis_maxResults - The maximum number of results you want the request to return.
data ListGraphqlApisResponse Source #
See: newListGraphqlApisResponse smart constructor.
Constructors
| ListGraphqlApisResponse' (Maybe Text) (Maybe [GraphqlApi]) Int |
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:nextToken:ListGraphqlApis', listGraphqlApisResponse_nextToken - An identifier to be passed in the next request to this operation to
return the next set of items in the list.
$sel:graphqlApis:ListGraphqlApisResponse', listGraphqlApisResponse_graphqlApis - The GraphqlApi objects.
$sel:httpStatus:ListGraphqlApisResponse', listGraphqlApisResponse_httpStatus - The response's http status code.
CreateApiCache
data CreateApiCache Source #
Represents the input of a CreateApiCache operation.
See: newCreateApiCache smart constructor.
Constructors
| CreateApiCache' (Maybe Bool) (Maybe Bool) Text Integer ApiCachingBehavior ApiCacheType |
Instances
Arguments
| :: 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:
$sel:atRestEncryptionEnabled:CreateApiCache', createApiCache_atRestEncryptionEnabled - At rest encryption flag for cache. This setting cannot be updated after
creation.
$sel:transitEncryptionEnabled:CreateApiCache', createApiCache_transitEncryptionEnabled - Transit encryption flag when connecting to cache. This setting cannot be
updated after creation.
$sel:apiId:CreateApiCache', createApiCache_apiId - The GraphQL API Id.
$sel:ttl:CreateApiCache', createApiCache_ttl - TTL in seconds for cache entries.
Valid values are between 1 and 3600 seconds.
$sel:apiCachingBehavior:CreateApiCache', createApiCache_apiCachingBehavior - Caching behavior.
- FULL_REQUEST_CACHING: All requests are fully cached.
- PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
$sel:type':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.
Constructors
| CreateApiCacheResponse' (Maybe ApiCache) Int |
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.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text (HashMap Text Text) |
Instances
Arguments
| :: Text | |
| -> TagResource |
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 ARN.
$sel:tags:TagResource', tagResource_tags - A TagMap object.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
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.
GetResolver
data GetResolver Source #
See: newGetResolver smart constructor.
Constructors
| GetResolver' Text Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> GetResolver |
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:
$sel:apiId:GetResolver', getResolver_apiId - The API ID.
$sel:typeName:GetResolver', getResolver_typeName - The resolver type name.
$sel:fieldName:GetResolver', getResolver_fieldName - The resolver field name.
data GetResolverResponse Source #
See: newGetResolverResponse smart constructor.
Constructors
| GetResolverResponse' (Maybe Resolver) Int |
Instances
newGetResolverResponse Source #
Arguments
| :: Int | |
| -> GetResolverResponse |
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.
UpdateFunction
data UpdateFunction Source #
See: newUpdateFunction smart constructor.
Constructors
| UpdateFunction' (Maybe Text) (Maybe Text) (Maybe SyncConfig) (Maybe Text) Text Text Text Text Text |
Instances
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:
$sel:requestMappingTemplate:UpdateFunction', updateFunction_requestMappingTemplate - The Function request mapping template. Functions support only the
2018-05-29 version of the request mapping template.
$sel:responseMappingTemplate:UpdateFunction', updateFunction_responseMappingTemplate - The Function request mapping template.
$sel:syncConfig:UpdateFunction', updateFunction_syncConfig - Undocumented member.
$sel:description:UpdateFunction', updateFunction_description - The Function description.
$sel:apiId:UpdateFunction', updateFunction_apiId - The GraphQL API ID.
$sel:name:UpdateFunction', updateFunction_name - The Function name.
$sel:functionId:UpdateFunction', updateFunction_functionId - The function ID.
$sel:dataSourceName:UpdateFunction', updateFunction_dataSourceName - The Function DataSource name.
$sel:functionVersion:UpdateFunction', updateFunction_functionVersion - The version of the request mapping template. Currently the supported
value is 2018-05-29.
data UpdateFunctionResponse Source #
See: newUpdateFunctionResponse smart constructor.
Constructors
| UpdateFunctionResponse' (Maybe FunctionConfiguration) Int |
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.
DeleteFunction
data DeleteFunction Source #
See: newDeleteFunction smart constructor.
Constructors
| DeleteFunction' Text Text |
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:
$sel:apiId:DeleteFunction', deleteFunction_apiId - The GraphQL API ID.
$sel:functionId:DeleteFunction', deleteFunction_functionId - The Function ID.
data DeleteFunctionResponse Source #
See: newDeleteFunctionResponse smart constructor.
Constructors
| DeleteFunctionResponse' Int |
Instances
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.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text (NonEmpty Text) |
Instances
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> UntagResource |
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 ARN.
$sel:tagKeys:UntagResource', untagResource_tagKeys - A list of TagKey objects.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
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.
CreateApiKey
data CreateApiKey Source #
See: newCreateApiKey smart constructor.
Instances
Arguments
| :: Text | |
| -> CreateApiKey |
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:
$sel:expires:CreateApiKey', createApiKey_expires - The time from creation 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 .
$sel:description:CreateApiKey', createApiKey_description - A description of the purpose of the API key.
$sel:apiId:CreateApiKey', createApiKey_apiId - The ID for your GraphQL API.
data CreateApiKeyResponse Source #
See: newCreateApiKeyResponse smart constructor.
Constructors
| CreateApiKeyResponse' (Maybe ApiKey) Int |
Instances
newCreateApiKeyResponse Source #
Arguments
| :: Int | |
| -> CreateApiKeyResponse |
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.
ListFunctions (Paginated)
data ListFunctions Source #
See: newListFunctions smart constructor.
Instances
Arguments
| :: Text | |
| -> ListFunctions |
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:nextToken:ListFunctions', listFunctions_nextToken - An identifier that was returned from the previous call to this
operation, which can be used to return the next set of items in the
list.
$sel:maxResults:ListFunctions', listFunctions_maxResults - The maximum number of results you want the request to return.
$sel:apiId:ListFunctions', listFunctions_apiId - The GraphQL API ID.
data ListFunctionsResponse Source #
See: newListFunctionsResponse smart constructor.
Constructors
| ListFunctionsResponse' (Maybe Text) (Maybe [FunctionConfiguration]) Int |
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:
$sel:nextToken:ListFunctions', listFunctionsResponse_nextToken - An identifier that was returned from the previous call to this
operation, which can be used to return the next set of items in the
list.
$sel:functions:ListFunctionsResponse', listFunctionsResponse_functions - A list of Function objects.
$sel:httpStatus:ListFunctionsResponse', listFunctionsResponse_httpStatus - The response's http status code.
ListApiKeys (Paginated)
data ListApiKeys Source #
See: newListApiKeys smart constructor.
Instances
Arguments
| :: Text | |
| -> ListApiKeys |
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:nextToken:ListApiKeys', listApiKeys_nextToken - An identifier that was returned from the previous call to this
operation, which can be used to return the next set of items in the
list.
$sel:maxResults:ListApiKeys', listApiKeys_maxResults - The maximum number of results you want the request to return.
$sel:apiId:ListApiKeys', listApiKeys_apiId - The API ID.
data ListApiKeysResponse Source #
See: newListApiKeysResponse smart constructor.
Instances
newListApiKeysResponse Source #
Arguments
| :: Int | |
| -> ListApiKeysResponse |
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.
$sel:nextToken:ListApiKeys', listApiKeysResponse_nextToken - An identifier to be passed 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.
GetType
See: newGetType smart constructor.
Constructors
| GetType' Text Text TypeDefinitionFormat |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> TypeDefinitionFormat | |
| -> GetType |
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:
$sel:apiId:GetType', getType_apiId - The API ID.
$sel:typeName:GetType', getType_typeName - The type name.
$sel:format:GetType', getType_format - The type format: SDL or JSON.
data GetTypeResponse Source #
See: newGetTypeResponse smart constructor.
Constructors
| GetTypeResponse' (Maybe Type) Int |
Instances
Arguments
| :: Int | |
| -> GetTypeResponse |
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:
$sel:type':GetTypeResponse', getTypeResponse_type - The Type object.
$sel:httpStatus:GetTypeResponse', getTypeResponse_httpStatus - The response's http status code.
Types
ApiCacheStatus
newtype ApiCacheStatus Source #
Constructors
| ApiCacheStatus' | |
Fields | |
Bundled Patterns
| 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 #
Constructors
| ApiCacheType' | |
Fields | |
Bundled Patterns
| 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 #
Constructors
| ApiCachingBehavior' | |
Fields | |
Bundled Patterns
| pattern ApiCachingBehavior_FULL_REQUEST_CACHING :: ApiCachingBehavior | |
| pattern ApiCachingBehavior_PER_RESOLVER_CACHING :: ApiCachingBehavior |
Instances
AuthenticationType
newtype AuthenticationType Source #
Constructors
| AuthenticationType' | |
Fields | |
Bundled Patterns
| 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 #
Constructors
| AuthorizationType' | |
Fields | |
Bundled Patterns
| pattern AuthorizationType_AWS_IAM :: AuthorizationType |
Instances
ConflictDetectionType
newtype ConflictDetectionType Source #
Constructors
| ConflictDetectionType' | |
Fields | |
Bundled Patterns
| pattern ConflictDetectionType_NONE :: ConflictDetectionType | |
| pattern ConflictDetectionType_VERSION :: ConflictDetectionType |
Instances
ConflictHandlerType
newtype ConflictHandlerType Source #
Constructors
| ConflictHandlerType' | |
Fields | |
Bundled Patterns
| pattern ConflictHandlerType_AUTOMERGE :: ConflictHandlerType | |
| pattern ConflictHandlerType_LAMBDA :: ConflictHandlerType | |
| pattern ConflictHandlerType_NONE :: ConflictHandlerType | |
| pattern ConflictHandlerType_OPTIMISTIC_CONCURRENCY :: ConflictHandlerType |
Instances
DataSourceType
newtype DataSourceType Source #
Constructors
| DataSourceType' | |
Fields | |
Bundled Patterns
| 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 #
Constructors
| DefaultAction' | |
Fields | |
Bundled Patterns
| pattern DefaultAction_ALLOW :: DefaultAction | |
| pattern DefaultAction_DENY :: DefaultAction |
Instances
FieldLogLevel
newtype FieldLogLevel Source #
Constructors
| FieldLogLevel' | |
Fields | |
Bundled Patterns
| pattern FieldLogLevel_ALL :: FieldLogLevel | |
| pattern FieldLogLevel_ERROR :: FieldLogLevel | |
| pattern FieldLogLevel_NONE :: FieldLogLevel |
Instances
OutputType
newtype OutputType Source #
Constructors
| OutputType' | |
Fields | |
Bundled Patterns
| pattern OutputType_JSON :: OutputType | |
| pattern OutputType_SDL :: OutputType |
Instances
RelationalDatabaseSourceType
newtype RelationalDatabaseSourceType Source #
Constructors
| RelationalDatabaseSourceType' | |
Fields | |
Bundled Patterns
| pattern RelationalDatabaseSourceType_RDS_HTTP_ENDPOINT :: RelationalDatabaseSourceType |
Instances
ResolverKind
newtype ResolverKind Source #
Constructors
| ResolverKind' | |
Fields | |
Bundled Patterns
| pattern ResolverKind_PIPELINE :: ResolverKind | |
| pattern ResolverKind_UNIT :: ResolverKind |
Instances
SchemaStatus
newtype SchemaStatus Source #
Constructors
| SchemaStatus' | |
Fields | |
Bundled Patterns
| 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 #
Constructors
| TypeDefinitionFormat' | |
Fields | |
Bundled Patterns
| pattern TypeDefinitionFormat_JSON :: TypeDefinitionFormat | |
| pattern TypeDefinitionFormat_SDL :: TypeDefinitionFormat |
Instances
AdditionalAuthenticationProvider
data AdditionalAuthenticationProvider Source #
Describes an additional authentication provider.
See: newAdditionalAuthenticationProvider smart constructor.
Constructors
| AdditionalAuthenticationProvider' (Maybe OpenIDConnectConfig) (Maybe LambdaAuthorizerConfig) (Maybe CognitoUserPoolConfig) (Maybe AuthenticationType) |
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:openIDConnectConfig:AdditionalAuthenticationProvider', additionalAuthenticationProvider_openIDConnectConfig - The OpenID Connect configuration.
$sel:lambdaAuthorizerConfig:AdditionalAuthenticationProvider', additionalAuthenticationProvider_lambdaAuthorizerConfig - Configuration for Amazon Web Services Lambda function authorization.
$sel:userPoolConfig:AdditionalAuthenticationProvider', additionalAuthenticationProvider_userPoolConfig - The Amazon Cognito user pool configuration.
$sel:authenticationType:AdditionalAuthenticationProvider', additionalAuthenticationProvider_authenticationType - The authentication type: API key, Identity and Access Management, OIDC,
Amazon Cognito user pools, or Amazon Web Services Lambda.
ApiCache
The ApiCache object.
See: newApiCache smart constructor.
Constructors
| ApiCache' (Maybe Integer) (Maybe ApiCacheStatus) (Maybe Bool) (Maybe Bool) (Maybe ApiCachingBehavior) (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:ttl:ApiCache', apiCache_ttl - TTL in seconds for cache entries.
Valid values are between 1 and 3600 seconds.
$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:atRestEncryptionEnabled:ApiCache', apiCache_atRestEncryptionEnabled - At rest encryption flag for cache. This setting cannot be updated after
creation.
$sel:transitEncryptionEnabled:ApiCache', apiCache_transitEncryptionEnabled - Transit encryption flag when connecting to cache. This setting cannot be
updated after creation.
$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: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: This version was introduced at launch in November 2017. These keys always expire after 7 days. Key expiration is managed by Amazon DynamoDB TTL. The keys ceased to be valid after February 21, 2018 and should not be used after that date.
ListApiKeysreturns the expiration time in milliseconds.CreateApiKeyreturns the expiration time in milliseconds.UpdateApiKeyis not available for this key version.DeleteApiKeydeletes the item from the table.- Expiration is stored in Amazon 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 will delete these keys from the table after February 21, 2018.
da2: This version was introduced in February 2018 when AppSync added support to extend key expiration.
ListApiKeysreturns the expiration time and deletion time in seconds.CreateApiKeyreturns the expiration time and deletion time in seconds and accepts a user-provided expiration time in seconds.UpdateApiKeyreturns 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. Key expiration time can be updated while the key is not deleted.DeleteApiKeydeletes the item from the table.- Expiration is stored in Amazon DynamoDB as seconds. After the expiration time, using the key to authenticate will fail. But the key can be reinstated before deletion.
- Deletion is stored in Amazon DynamoDB as seconds. The key will be deleted after deletion time.
See: newApiKey smart constructor.
Instances
| Eq ApiKey Source # | |
| Read ApiKey Source # | |
| Show ApiKey Source # | |
| Generic ApiKey Source # | |
| NFData ApiKey Source # | |
Defined in Amazonka.AppSync.Types.ApiKey | |
| Hashable ApiKey Source # | |
Defined in Amazonka.AppSync.Types.ApiKey | |
| FromJSON ApiKey Source # | |
| type Rep ApiKey Source # | |
Defined in Amazonka.AppSync.Types.ApiKey type Rep ApiKey = D1 ('MetaData "ApiKey" "Amazonka.AppSync.Types.ApiKey" "libZSservicesZSamazonka-appsyncZSamazonka-appsync" 'False) (C1 ('MetaCons "ApiKey'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "expires") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "deletes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") '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: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: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:id:ApiKey', apiKey_id - The API key ID.
$sel:description:ApiKey', apiKey_description - A description of the purpose of the API key.
AuthorizationConfig
data AuthorizationConfig Source #
The authorization config in case the HTTP endpoint requires authorization.
See: newAuthorizationConfig smart constructor.
Constructors
| AuthorizationConfig' (Maybe AwsIamConfig) AuthorizationType |
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 settings.
$sel:authorizationType:AuthorizationConfig', authorizationConfig_authorizationType - The authorization type required by the HTTP endpoint.
- AWS_IAM: The authorization type is Sigv4.
AwsIamConfig
data AwsIamConfig Source #
The Identity and Access Management configuration.
See: newAwsIamConfig smart constructor.
Constructors
| 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:signingServiceName:AwsIamConfig', awsIamConfig_signingServiceName - The signing service name for Identity and Access Management
authorization.
$sel:signingRegion:AwsIamConfig', awsIamConfig_signingRegion - The signing region for Identity and Access Management authorization.
CachingConfig
data CachingConfig Source #
The caching configuration for a resolver that has caching enabled.
See: newCachingConfig smart constructor.
Constructors
| CachingConfig' (Maybe Integer) (Maybe [Text]) |
Instances
newCachingConfig :: CachingConfig Source #
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:ttl:CachingConfig', cachingConfig_ttl - The TTL in seconds for a resolver that has caching enabled.
Valid values are between 1 and 3600 seconds.
$sel:cachingKeys:CachingConfig', cachingConfig_cachingKeys - The caching keys for a resolver that has caching enabled.
Valid values are entries from the $context.arguments,
$context.source, and $context.identity maps.
CognitoUserPoolConfig
data CognitoUserPoolConfig Source #
Describes an Amazon Cognito user pool configuration.
See: newCognitoUserPoolConfig smart constructor.
Constructors
| CognitoUserPoolConfig' (Maybe Text) Text Text |
Instances
newCognitoUserPoolConfig Source #
Arguments
| :: 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.
$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.
Constructors
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:serviceRoleArn:DataSource', dataSource_serviceRoleArn - The Identity and Access Management service role ARN for the data source.
The system assumes this role when accessing the data source.
$sel:relationalDatabaseConfig:DataSource', dataSource_relationalDatabaseConfig - Relational database settings.
$sel:dataSourceArn:DataSource', dataSource_dataSourceArn - The data source ARN.
$sel:dynamodbConfig:DataSource', dataSource_dynamodbConfig - Amazon DynamoDB settings.
$sel:name:DataSource', dataSource_name - The name of the data source.
$sel:httpConfig:DataSource', dataSource_httpConfig - HTTP endpoint settings.
$sel:openSearchServiceConfig:DataSource', dataSource_openSearchServiceConfig - Amazon OpenSearch Service settings.
$sel:lambdaConfig:DataSource', dataSource_lambdaConfig - Amazon Web Services Lambda settings.
$sel:type':DataSource', dataSource_type - The type of the data source.
- AWS_LAMBDA: The data source is an Amazon Web Services 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. This type is used when you wish to invoke a GraphQL operation without connecting to a data source, such as performing data transformation with resolvers or triggering a subscription to be invoked from a mutation.
- HTTP: The data source is an HTTP endpoint.
- RELATIONAL_DATABASE: The data source is a relational database.
$sel:description:DataSource', dataSource_description - The description of the data source.
$sel:elasticsearchConfig:DataSource', dataSource_elasticsearchConfig - Amazon OpenSearch Service settings.
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 an Item is stored in the datasource.
$sel:deltaSyncTableName:DeltaSyncConfig', deltaSyncConfig_deltaSyncTableName - The Delta Sync table name.
$sel:deltaSyncTableTTL:DeltaSyncConfig', deltaSyncConfig_deltaSyncTableTTL - The number of minutes a Delta Sync log entry is stored in the Delta Sync
table.
DynamodbDataSourceConfig
data DynamodbDataSourceConfig Source #
Describes an Amazon DynamoDB data source configuration.
See: newDynamodbDataSourceConfig smart constructor.
Constructors
| DynamodbDataSourceConfig' (Maybe Bool) (Maybe Bool) (Maybe DeltaSyncConfig) Text Text |
Instances
newDynamodbDataSourceConfig Source #
Arguments
| :: 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:versioned:DynamodbDataSourceConfig', dynamodbDataSourceConfig_versioned - Set to TRUE to use Conflict Detection and Resolution with this data
source.
$sel:useCallerCredentials:DynamodbDataSourceConfig', dynamodbDataSourceConfig_useCallerCredentials - Set to TRUE to use Amazon Cognito credentials with this data source.
$sel:deltaSyncConfig:DynamodbDataSourceConfig', dynamodbDataSourceConfig_deltaSyncConfig - The DeltaSyncConfig for a versioned datasource.
$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.
Constructors
| ElasticsearchDataSourceConfig' Text Text |
Instances
newElasticsearchDataSourceConfig Source #
Arguments
| :: Text | |
| -> Text | |
| -> ElasticsearchDataSourceConfig |
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.
FunctionConfiguration
data FunctionConfiguration Source #
A function is a reusable entity. Multiple functions can be used to compose the resolver logic.
See: newFunctionConfiguration smart constructor.
Constructors
| FunctionConfiguration' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe SyncConfig) (Maybe Text) (Maybe Text) |
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:functionArn:FunctionConfiguration', functionConfiguration_functionArn - The ARN of the Function object.
$sel:dataSourceName:FunctionConfiguration', functionConfiguration_dataSourceName - The name of the DataSource.
$sel:requestMappingTemplate:FunctionConfiguration', functionConfiguration_requestMappingTemplate - The Function request mapping template. Functions support only the
2018-05-29 version of the request mapping template.
$sel:name:FunctionConfiguration', functionConfiguration_name - The name of the Function object.
$sel:functionId:FunctionConfiguration', functionConfiguration_functionId - A unique ID representing the Function object.
$sel:responseMappingTemplate:FunctionConfiguration', functionConfiguration_responseMappingTemplate - The Function response mapping template.
$sel:syncConfig:FunctionConfiguration', functionConfiguration_syncConfig - Undocumented member.
$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:description:FunctionConfiguration', functionConfiguration_description - The Function description.
GraphqlApi
data GraphqlApi Source #
Describes a GraphQL API.
See: newGraphqlApi smart constructor.
Constructors
| GraphqlApi' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe OpenIDConnectConfig) (Maybe Text) (Maybe [AdditionalAuthenticationProvider]) (Maybe LambdaAuthorizerConfig) (Maybe Text) (Maybe UserPoolConfig) (Maybe AuthenticationType) (Maybe LogConfig) (Maybe (HashMap Text Text)) |
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:xrayEnabled:GraphqlApi', graphqlApi_xrayEnabled - A flag representing whether X-Ray tracing is enabled for this
GraphqlApi.
$sel:arn:GraphqlApi', graphqlApi_arn - The ARN.
$sel:apiId:GraphqlApi', graphqlApi_apiId - The API ID.
$sel:uris:GraphqlApi', graphqlApi_uris - The URIs.
$sel:openIDConnectConfig:GraphqlApi', graphqlApi_openIDConnectConfig - The OpenID Connect configuration.
$sel:wafWebAclArn:GraphqlApi', graphqlApi_wafWebAclArn - The ARN of the WAF ACL associated with this GraphqlApi, if one exists.
$sel:additionalAuthenticationProviders:GraphqlApi', graphqlApi_additionalAuthenticationProviders - A list of additional authentication providers for the GraphqlApi API.
$sel:lambdaAuthorizerConfig:GraphqlApi', graphqlApi_lambdaAuthorizerConfig - Configuration for Amazon Web Services Lambda function authorization.
$sel:name:GraphqlApi', graphqlApi_name - The API name.
$sel:userPoolConfig:GraphqlApi', graphqlApi_userPoolConfig - The Amazon Cognito user pool configuration.
$sel:authenticationType:GraphqlApi', graphqlApi_authenticationType - The authentication type.
$sel:logConfig:GraphqlApi', graphqlApi_logConfig - The Amazon CloudWatch Logs configuration.
$sel:tags:GraphqlApi', graphqlApi_tags - The tags.
HttpDataSourceConfig
data HttpDataSourceConfig Source #
Describes an HTTP data source configuration.
See: newHttpDataSourceConfig smart constructor.
Constructors
| HttpDataSourceConfig' (Maybe AuthorizationConfig) (Maybe Text) |
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 config in case the HTTP endpoint requires
authorization.
$sel:endpoint:HttpDataSourceConfig', httpDataSourceConfig_endpoint - The HTTP URL endpoint. You can either specify the domain name or IP, and
port combination, and the URL scheme must be HTTP or HTTPS. If the port
is not specified, AppSync uses the default port 80 for the HTTP endpoint
and port 443 for HTTPS endpoints.
LambdaAuthorizerConfig
data LambdaAuthorizerConfig Source #
A LambdaAuthorizerConfig holds configuration on how to authorize
AppSync API access when using the AWS_LAMBDA authorizer mode. Be aware
that an AppSync API may 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:identityValidationExpression:LambdaAuthorizerConfig', lambdaAuthorizerConfig_identityValidationExpression - A regular expression for validation of tokens before the Lambda function
is called.
$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:authorizerUri:LambdaAuthorizerConfig', lambdaAuthorizerConfig_authorizerUri - The ARN of the Lambda function to be called for authorization. This may
be a standard Lambda ARN, a version ARN (.../v3) or 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 do so with the Amazon Web Services 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.
Constructors
| LambdaConflictHandlerConfig' (Maybe Text) |
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 Arn for the Lambda function to use as the Conflict Handler.
LambdaDataSourceConfig
data LambdaDataSourceConfig Source #
Describes an Amazon Web Services Lambda data source configuration.
See: newLambdaDataSourceConfig smart constructor.
Constructors
| LambdaDataSourceConfig' Text |
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 ARN for the Lambda function.
LogConfig
The CloudWatch Logs configuration.
See: newLogConfig smart constructor.
Constructors
| LogConfig' (Maybe Bool) FieldLogLevel Text |
Instances
| Eq LogConfig Source # | |
| Read LogConfig Source # | |
| Show LogConfig Source # | |
| Generic LogConfig Source # | |
| NFData LogConfig Source # | |
Defined in Amazonka.AppSync.Types.LogConfig | |
| Hashable LogConfig Source # | |
Defined in Amazonka.AppSync.Types.LogConfig | |
| ToJSON LogConfig Source # | |
Defined in Amazonka.AppSync.Types.LogConfig | |
| FromJSON LogConfig Source # | |
| type Rep LogConfig Source # | |
Defined in Amazonka.AppSync.Types.LogConfig type Rep LogConfig = D1 ('MetaData "LogConfig" "Amazonka.AppSync.Types.LogConfig" "libZSservicesZSamazonka-appsyncZSamazonka-appsync" '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)))) | |
Arguments
| :: 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 will assume to publish to Amazon
CloudWatch logs in your account.
OpenIDConnectConfig
data OpenIDConnectConfig Source #
Describes an OpenID Connect configuration.
See: newOpenIDConnectConfig smart constructor.
Instances
newOpenIDConnectConfig Source #
Arguments
| :: Text | |
| -> OpenIDConnectConfig |
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 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 the AppSync can validate against multiple client
identifiers at a time.
$sel:iatTTL:OpenIDConnectConfig', openIDConnectConfig_iatTTL - The number of milliseconds a token is valid after being issued to a
user.
$sel:issuer:OpenIDConnectConfig', openIDConnectConfig_issuer - The issuer for the OpenID Connect 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.
Constructors
| OpenSearchServiceDataSourceConfig' Text Text |
Instances
newOpenSearchServiceDataSourceConfig Source #
Arguments
| :: Text | |
| -> Text | |
| -> OpenSearchServiceDataSourceConfig |
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.
Constructors
| 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 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:dbClusterIdentifier:RdsHttpEndpointConfig', rdsHttpEndpointConfig_dbClusterIdentifier - Amazon RDS cluster ARN.
$sel:schema:RdsHttpEndpointConfig', rdsHttpEndpointConfig_schema - Logical schema name.
$sel:databaseName:RdsHttpEndpointConfig', rdsHttpEndpointConfig_databaseName - Logical database name.
$sel:awsRegion:RdsHttpEndpointConfig', rdsHttpEndpointConfig_awsRegion - Amazon Web Services Region for RDS HTTP endpoint.
$sel:awsSecretStoreArn:RdsHttpEndpointConfig', rdsHttpEndpointConfig_awsSecretStoreArn - Amazon Web Services secret store ARN for database credentials.
RelationalDatabaseDataSourceConfig
data RelationalDatabaseDataSourceConfig Source #
Describes a relational database data source configuration.
See: newRelationalDatabaseDataSourceConfig smart constructor.
Constructors
| RelationalDatabaseDataSourceConfig' (Maybe RelationalDatabaseSourceType) (Maybe RdsHttpEndpointConfig) |
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:relationalDatabaseSourceType:RelationalDatabaseDataSourceConfig', relationalDatabaseDataSourceConfig_relationalDatabaseSourceType - Source type for the relational database.
- RDS_HTTP_ENDPOINT: The relational database source type is an Amazon RDS HTTP endpoint.
$sel:rdsHttpEndpointConfig:RelationalDatabaseDataSourceConfig', relationalDatabaseDataSourceConfig_rdsHttpEndpointConfig - Amazon RDS HTTP endpoint settings.
Resolver
Describes a resolver.
See: newResolver smart constructor.
Constructors
| Resolver' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ResolverKind) (Maybe Text) (Maybe CachingConfig) (Maybe Text) (Maybe Text) (Maybe SyncConfig) (Maybe PipelineConfig) |
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:typeName:Resolver', resolver_typeName - The resolver type name.
$sel:dataSourceName:Resolver', resolver_dataSourceName - The resolver data source name.
$sel:requestMappingTemplate:Resolver', resolver_requestMappingTemplate - The request mapping template.
$sel:kind:Resolver', resolver_kind - The resolver type.
- UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source.
- PIPELINE: A PIPELINE resolver type. A PIPELINE resolver enables
you to execute a series of
Functionin a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.
$sel:resolverArn:Resolver', resolver_resolverArn - The resolver ARN.
$sel:cachingConfig:Resolver', resolver_cachingConfig - The caching configuration for the resolver.
$sel:responseMappingTemplate:Resolver', resolver_responseMappingTemplate - The response mapping template.
$sel:fieldName:Resolver', resolver_fieldName - The resolver field name.
$sel:syncConfig:Resolver', resolver_syncConfig - The SyncConfig for a resolver attached to a versioned datasource.
$sel:pipelineConfig:Resolver', resolver_pipelineConfig - The PipelineConfig.
SyncConfig
data SyncConfig Source #
Describes a Sync configuration for a resolver.
Contains information on which Conflict Detection as well as Resolution strategy should be performed when the resolver is invoked.
See: newSyncConfig smart constructor.
Constructors
| SyncConfig' (Maybe ConflictHandlerType) (Maybe ConflictDetectionType) (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: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 do not match the latest version at the server.
- AUTOMERGE: Resolve conflicts with the Automerge conflict resolution strategy.
- LAMBDA: Resolve conflicts with a Lambda function supplied in the LambdaConflictHandlerConfig.
$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 executing this resolver.
$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 ARN.
$sel:definition:Type', type_definition - The type definition.
$sel:format:Type', type_format - The type format: SDL or JSON.
$sel:name:Type', type_name - The type name.
$sel:description:Type', type_description - The type description.
UserPoolConfig
data UserPoolConfig Source #
Describes an Amazon Cognito user pool configuration.
See: newUserPoolConfig smart constructor.
Constructors
| UserPoolConfig' (Maybe Text) Text Text DefaultAction |
Instances
Arguments
| :: 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.
$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.