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

Amazonka.AppSync.Lens

Description

 
Synopsis

Operations

UpdateDataSource

updateDataSource_serviceRoleArn :: Lens' UpdateDataSource (Maybe Text) Source #

The new service role ARN for the data source.

updateDataSource_relationalDatabaseConfig :: Lens' UpdateDataSource (Maybe RelationalDatabaseDataSourceConfig) Source #

The new relational database configuration.

updateDataSource_dynamodbConfig :: Lens' UpdateDataSource (Maybe DynamodbDataSourceConfig) Source #

The new Amazon DynamoDB configuration.

updateDataSource_httpConfig :: Lens' UpdateDataSource (Maybe HttpDataSourceConfig) Source #

The new HTTP endpoint configuration.

updateDataSource_openSearchServiceConfig :: Lens' UpdateDataSource (Maybe OpenSearchServiceDataSourceConfig) Source #

The new OpenSearch configuration.

updateDataSource_lambdaConfig :: Lens' UpdateDataSource (Maybe LambdaDataSourceConfig) Source #

The new Amazon Web Services Lambda configuration.

updateDataSource_description :: Lens' UpdateDataSource (Maybe Text) Source #

The new description for the data source.

updateDataSource_elasticsearchConfig :: Lens' UpdateDataSource (Maybe ElasticsearchDataSourceConfig) Source #

The new OpenSearch configuration.

As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is deprecated. Instead, use UpdateDataSourceRequest$openSearchServiceConfig to update an OpenSearch data source.

updateDataSource_apiId :: Lens' UpdateDataSource Text Source #

The API ID.

updateDataSource_name :: Lens' UpdateDataSource Text Source #

The new name for the data source.

updateDataSource_type :: Lens' UpdateDataSource DataSourceType Source #

The new data source type.

updateDataSourceResponse_dataSource :: Lens' UpdateDataSourceResponse (Maybe DataSource) Source #

The updated DataSource object.

updateDataSourceResponse_httpStatus :: Lens' UpdateDataSourceResponse Int Source #

The response's http status code.

DeleteDataSource

deleteDataSource_apiId :: Lens' DeleteDataSource Text Source #

The API ID.

deleteDataSource_name :: Lens' DeleteDataSource Text Source #

The name of the data source.

deleteDataSourceResponse_httpStatus :: Lens' DeleteDataSourceResponse Int Source #

The response's http status code.

CreateType

createType_apiId :: Lens' CreateType Text Source #

The API ID.

createType_definition :: Lens' CreateType Text Source #

The type definition, in GraphQL Schema Definition Language (SDL) format.

For more information, see the GraphQL SDL documentation.

createType_format :: Lens' CreateType TypeDefinitionFormat Source #

The type format: SDL or JSON.

createTypeResponse_type :: Lens' CreateTypeResponse (Maybe Type) Source #

The Type object.

createTypeResponse_httpStatus :: Lens' CreateTypeResponse Int Source #

The response's http status code.

GetGraphqlApi

getGraphqlApi_apiId :: Lens' GetGraphqlApi Text Source #

The API ID for the GraphQL API.

getGraphqlApiResponse_graphqlApi :: Lens' GetGraphqlApiResponse (Maybe GraphqlApi) Source #

The GraphqlApi object.

getGraphqlApiResponse_httpStatus :: Lens' GetGraphqlApiResponse Int Source #

The response's http status code.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The GraphqlApi ARN.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #

A TagMap object.

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #

The response's http status code.

CreateGraphqlApi

createGraphqlApi_xrayEnabled :: Lens' CreateGraphqlApi (Maybe Bool) Source #

A flag indicating whether to enable X-Ray tracing for the GraphqlApi.

createGraphqlApi_openIDConnectConfig :: Lens' CreateGraphqlApi (Maybe OpenIDConnectConfig) Source #

The OpenID Connect configuration.

createGraphqlApi_additionalAuthenticationProviders :: Lens' CreateGraphqlApi (Maybe [AdditionalAuthenticationProvider]) Source #

A list of additional authentication providers for the GraphqlApi API.

createGraphqlApi_lambdaAuthorizerConfig :: Lens' CreateGraphqlApi (Maybe LambdaAuthorizerConfig) Source #

Configuration for Amazon Web Services Lambda function authorization.

createGraphqlApi_userPoolConfig :: Lens' CreateGraphqlApi (Maybe UserPoolConfig) Source #

The Amazon Cognito user pool configuration.

createGraphqlApi_logConfig :: Lens' CreateGraphqlApi (Maybe LogConfig) Source #

The Amazon CloudWatch Logs configuration.

createGraphqlApi_tags :: Lens' CreateGraphqlApi (Maybe (HashMap Text Text)) Source #

A TagMap object.

createGraphqlApi_name :: Lens' CreateGraphqlApi Text Source #

A user-supplied name for the GraphqlApi.

createGraphqlApi_authenticationType :: Lens' CreateGraphqlApi AuthenticationType Source #

The authentication type: API key, Identity and Access Management, OIDC, Amazon Cognito user pools, or Amazon Web Services Lambda.

createGraphqlApiResponse_graphqlApi :: Lens' CreateGraphqlApiResponse (Maybe GraphqlApi) Source #

The GraphqlApi.

createGraphqlApiResponse_httpStatus :: Lens' CreateGraphqlApiResponse Int Source #

The response's http status code.

StartSchemaCreation

startSchemaCreation_apiId :: Lens' StartSchemaCreation Text Source #

The API ID.

startSchemaCreation_definition :: Lens' StartSchemaCreation ByteString Source #

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.

startSchemaCreationResponse_status :: Lens' StartSchemaCreationResponse (Maybe SchemaStatus) Source #

The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data.

startSchemaCreationResponse_httpStatus :: Lens' StartSchemaCreationResponse Int Source #

The response's http status code.

FlushApiCache

flushApiCache_apiId :: Lens' FlushApiCache Text Source #

The API ID.

flushApiCacheResponse_httpStatus :: Lens' FlushApiCacheResponse Int Source #

The response's http status code.

DeleteGraphqlApi

deleteGraphqlApi_apiId :: Lens' DeleteGraphqlApi Text Source #

The API ID.

deleteGraphqlApiResponse_httpStatus :: Lens' DeleteGraphqlApiResponse Int Source #

The response's http status code.

UpdateGraphqlApi

updateGraphqlApi_xrayEnabled :: Lens' UpdateGraphqlApi (Maybe Bool) Source #

A flag indicating whether to enable X-Ray tracing for the GraphqlApi.

updateGraphqlApi_openIDConnectConfig :: Lens' UpdateGraphqlApi (Maybe OpenIDConnectConfig) Source #

The OpenID Connect configuration for the GraphqlApi object.

updateGraphqlApi_additionalAuthenticationProviders :: Lens' UpdateGraphqlApi (Maybe [AdditionalAuthenticationProvider]) Source #

A list of additional authentication providers for the GraphqlApi API.

updateGraphqlApi_lambdaAuthorizerConfig :: Lens' UpdateGraphqlApi (Maybe LambdaAuthorizerConfig) Source #

Configuration for Amazon Web Services Lambda function authorization.

updateGraphqlApi_userPoolConfig :: Lens' UpdateGraphqlApi (Maybe UserPoolConfig) Source #

The new Amazon Cognito user pool configuration for the GraphqlApi object.

updateGraphqlApi_authenticationType :: Lens' UpdateGraphqlApi (Maybe AuthenticationType) Source #

The new authentication type for the GraphqlApi object.

updateGraphqlApi_logConfig :: Lens' UpdateGraphqlApi (Maybe LogConfig) Source #

The Amazon CloudWatch Logs configuration for the GraphqlApi object.

updateGraphqlApi_apiId :: Lens' UpdateGraphqlApi Text Source #

The API ID.

updateGraphqlApi_name :: Lens' UpdateGraphqlApi Text Source #

The new name for the GraphqlApi object.

updateGraphqlApiResponse_graphqlApi :: Lens' UpdateGraphqlApiResponse (Maybe GraphqlApi) Source #

The updated GraphqlApi object.

updateGraphqlApiResponse_httpStatus :: Lens' UpdateGraphqlApiResponse Int Source #

The response's http status code.

GetIntrospectionSchema

getIntrospectionSchema_includeDirectives :: Lens' GetIntrospectionSchema (Maybe Bool) Source #

A flag that specifies whether the schema introspection should contain directives.

getIntrospectionSchema_apiId :: Lens' GetIntrospectionSchema Text Source #

The API ID.

getIntrospectionSchema_format :: Lens' GetIntrospectionSchema OutputType Source #

The schema format: SDL or JSON.

getIntrospectionSchemaResponse_schema :: Lens' GetIntrospectionSchemaResponse (Maybe ByteString) Source #

The schema, in GraphQL Schema Definition Language (SDL) format.

For more information, see the GraphQL SDL documentation.

getIntrospectionSchemaResponse_httpStatus :: Lens' GetIntrospectionSchemaResponse Int Source #

The response's http status code.

GetDataSource

getDataSource_apiId :: Lens' GetDataSource Text Source #

The API ID.

getDataSource_name :: Lens' GetDataSource Text Source #

The name of the data source.

getDataSourceResponse_dataSource :: Lens' GetDataSourceResponse (Maybe DataSource) Source #

The DataSource object.

getDataSourceResponse_httpStatus :: Lens' GetDataSourceResponse Int Source #

The response's http status code.

ListResolversByFunction

listResolversByFunction_nextToken :: Lens' ListResolversByFunction (Maybe Text) Source #

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

listResolversByFunction_maxResults :: Lens' ListResolversByFunction (Maybe Natural) Source #

The maximum number of results you want the request to return.

listResolversByFunction_apiId :: Lens' ListResolversByFunction Text Source #

The API ID.

listResolversByFunction_functionId :: Lens' ListResolversByFunction Text Source #

The Function ID.

listResolversByFunctionResponse_nextToken :: Lens' ListResolversByFunctionResponse (Maybe Text) Source #

An identifier that can be used to return the next set of items in the list.

listResolversByFunctionResponse_resolvers :: Lens' ListResolversByFunctionResponse (Maybe [Resolver]) Source #

The list of resolvers.

listResolversByFunctionResponse_httpStatus :: Lens' ListResolversByFunctionResponse Int Source #

The response's http status code.

CreateFunction

createFunction_requestMappingTemplate :: Lens' CreateFunction (Maybe Text) Source #

The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.

createFunction_responseMappingTemplate :: Lens' CreateFunction (Maybe Text) Source #

The Function response mapping template.

createFunction_syncConfig :: Lens' CreateFunction (Maybe SyncConfig) Source #

Undocumented member.

createFunction_description :: Lens' CreateFunction (Maybe Text) Source #

The Function description.

createFunction_apiId :: Lens' CreateFunction Text Source #

The GraphQL API ID.

createFunction_name :: Lens' CreateFunction Text Source #

The Function name. The function name does not have to be unique.

createFunction_dataSourceName :: Lens' CreateFunction Text Source #

The Function DataSource name.

createFunction_functionVersion :: Lens' CreateFunction Text Source #

The version of the request mapping template. Currently the supported value is 2018-05-29.

createFunctionResponse_functionConfiguration :: Lens' CreateFunctionResponse (Maybe FunctionConfiguration) Source #

The Function object.

createFunctionResponse_httpStatus :: Lens' CreateFunctionResponse Int Source #

The response's http status code.

DeleteApiKey

deleteApiKey_apiId :: Lens' DeleteApiKey Text Source #

The API ID.

deleteApiKey_id :: Lens' DeleteApiKey Text Source #

The ID for the API key.

deleteApiKeyResponse_httpStatus :: Lens' DeleteApiKeyResponse Int Source #

The response's http status code.

UpdateApiKey

updateApiKey_expires :: Lens' UpdateApiKey (Maybe Integer) Source #

The time from update time after which the API key expires. The date is represented as seconds since the epoch. For more information, see .

updateApiKey_description :: Lens' UpdateApiKey (Maybe Text) Source #

A description of the purpose of the API key.

updateApiKey_apiId :: Lens' UpdateApiKey Text Source #

The ID for the GraphQL API.

updateApiKey_id :: Lens' UpdateApiKey Text Source #

The API key ID.

updateApiKeyResponse_apiKey :: Lens' UpdateApiKeyResponse (Maybe ApiKey) Source #

The API key.

updateApiKeyResponse_httpStatus :: Lens' UpdateApiKeyResponse Int Source #

The response's http status code.

UpdateType

updateType_definition :: Lens' UpdateType (Maybe Text) Source #

The new definition.

updateType_apiId :: Lens' UpdateType Text Source #

The API ID.

updateType_typeName :: Lens' UpdateType Text Source #

The new type name.

updateType_format :: Lens' UpdateType TypeDefinitionFormat Source #

The new type format: SDL or JSON.

updateTypeResponse_type :: Lens' UpdateTypeResponse (Maybe Type) Source #

The updated Type object.

updateTypeResponse_httpStatus :: Lens' UpdateTypeResponse Int Source #

The response's http status code.

DeleteType

deleteType_apiId :: Lens' DeleteType Text Source #

The API ID.

deleteType_typeName :: Lens' DeleteType Text Source #

The type name.

deleteTypeResponse_httpStatus :: Lens' DeleteTypeResponse Int Source #

The response's http status code.

CreateDataSource

createDataSource_serviceRoleArn :: Lens' CreateDataSource (Maybe Text) Source #

The Identity and Access Management service role ARN for the data source. The system assumes this role when accessing the data source.

createDataSource_relationalDatabaseConfig :: Lens' CreateDataSource (Maybe RelationalDatabaseDataSourceConfig) Source #

Relational database settings.

createDataSource_dynamodbConfig :: Lens' CreateDataSource (Maybe DynamodbDataSourceConfig) Source #

Amazon DynamoDB settings.

createDataSource_httpConfig :: Lens' CreateDataSource (Maybe HttpDataSourceConfig) Source #

HTTP endpoint settings.

createDataSource_openSearchServiceConfig :: Lens' CreateDataSource (Maybe OpenSearchServiceDataSourceConfig) Source #

Amazon OpenSearch Service settings.

createDataSource_lambdaConfig :: Lens' CreateDataSource (Maybe LambdaDataSourceConfig) Source #

Amazon Web Services Lambda settings.

createDataSource_description :: Lens' CreateDataSource (Maybe Text) Source #

A description of the DataSource.

createDataSource_elasticsearchConfig :: Lens' CreateDataSource (Maybe ElasticsearchDataSourceConfig) Source #

Amazon OpenSearch Service settings.

As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is deprecated. For new data sources, use CreateDataSourceRequest$openSearchServiceConfig to create an OpenSearch data source.

createDataSource_apiId :: Lens' CreateDataSource Text Source #

The API ID for the GraphQL API for the DataSource.

createDataSource_name :: Lens' CreateDataSource Text Source #

A user-supplied name for the DataSource.

createDataSource_type :: Lens' CreateDataSource DataSourceType Source #

The type of the DataSource.

createDataSourceResponse_dataSource :: Lens' CreateDataSourceResponse (Maybe DataSource) Source #

The DataSource object.

createDataSourceResponse_httpStatus :: Lens' CreateDataSourceResponse Int Source #

The response's http status code.

ListTypes

listTypes_nextToken :: Lens' ListTypes (Maybe Text) Source #

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.

listTypes_maxResults :: Lens' ListTypes (Maybe Natural) Source #

The maximum number of results you want the request to return.

listTypes_apiId :: Lens' ListTypes Text Source #

The API ID.

listTypes_format :: Lens' ListTypes TypeDefinitionFormat Source #

The type format: SDL or JSON.

listTypesResponse_types :: Lens' ListTypesResponse (Maybe [Type]) Source #

The Type objects.

listTypesResponse_nextToken :: Lens' ListTypesResponse (Maybe Text) Source #

An identifier to be passed in the next request to this operation to return the next set of items in the list.

listTypesResponse_httpStatus :: Lens' ListTypesResponse Int Source #

The response's http status code.

GetFunction

getFunction_apiId :: Lens' GetFunction Text Source #

The GraphQL API ID.

getFunction_functionId :: Lens' GetFunction Text Source #

The Function ID.

getFunctionResponse_functionConfiguration :: Lens' GetFunctionResponse (Maybe FunctionConfiguration) Source #

The Function object.

getFunctionResponse_httpStatus :: Lens' GetFunctionResponse Int Source #

The response's http status code.

ListDataSources

listDataSources_nextToken :: Lens' ListDataSources (Maybe Text) Source #

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.

listDataSources_maxResults :: Lens' ListDataSources (Maybe Natural) Source #

The maximum number of results you want the request to return.

listDataSources_apiId :: Lens' ListDataSources Text Source #

The API ID.

listDataSourcesResponse_dataSources :: Lens' ListDataSourcesResponse (Maybe [DataSource]) Source #

The DataSource objects.

listDataSourcesResponse_nextToken :: Lens' ListDataSourcesResponse (Maybe Text) Source #

An identifier to be passed in the next request to this operation to return the next set of items in the list.

listDataSourcesResponse_httpStatus :: Lens' ListDataSourcesResponse Int Source #

The response's http status code.

UpdateResolver

updateResolver_dataSourceName :: Lens' UpdateResolver (Maybe Text) Source #

The new data source name.

updateResolver_requestMappingTemplate :: Lens' UpdateResolver (Maybe Text) Source #

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.

updateResolver_kind :: Lens' UpdateResolver (Maybe ResolverKind) Source #

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 Function in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.

updateResolver_cachingConfig :: Lens' UpdateResolver (Maybe CachingConfig) Source #

The caching configuration for the resolver.

updateResolver_responseMappingTemplate :: Lens' UpdateResolver (Maybe Text) Source #

The new response mapping template.

updateResolver_syncConfig :: Lens' UpdateResolver (Maybe SyncConfig) Source #

The SyncConfig for a resolver attached to a versioned datasource.

updateResolver_pipelineConfig :: Lens' UpdateResolver (Maybe PipelineConfig) Source #

The PipelineConfig.

updateResolver_apiId :: Lens' UpdateResolver Text Source #

The API ID.

updateResolver_typeName :: Lens' UpdateResolver Text Source #

The new type name.

updateResolver_fieldName :: Lens' UpdateResolver Text Source #

The new field name.

updateResolverResponse_resolver :: Lens' UpdateResolverResponse (Maybe Resolver) Source #

The updated Resolver object.

updateResolverResponse_httpStatus :: Lens' UpdateResolverResponse Int Source #

The response's http status code.

DeleteResolver

deleteResolver_apiId :: Lens' DeleteResolver Text Source #

The API ID.

deleteResolver_typeName :: Lens' DeleteResolver Text Source #

The name of the resolver type.

deleteResolver_fieldName :: Lens' DeleteResolver Text Source #

The resolver field name.

deleteResolverResponse_httpStatus :: Lens' DeleteResolverResponse Int Source #

The response's http status code.

ListResolvers

listResolvers_nextToken :: Lens' ListResolvers (Maybe Text) Source #

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.

listResolvers_maxResults :: Lens' ListResolvers (Maybe Natural) Source #

The maximum number of results you want the request to return.

listResolvers_apiId :: Lens' ListResolvers Text Source #

The API ID.

listResolvers_typeName :: Lens' ListResolvers Text Source #

The type name.

listResolversResponse_nextToken :: Lens' ListResolversResponse (Maybe Text) Source #

An identifier to be passed in the next request to this operation to return the next set of items in the list.

listResolversResponse_resolvers :: Lens' ListResolversResponse (Maybe [Resolver]) Source #

The Resolver objects.

listResolversResponse_httpStatus :: Lens' ListResolversResponse Int Source #

The response's http status code.

CreateResolver

createResolver_dataSourceName :: Lens' CreateResolver (Maybe Text) Source #

The name of the data source for which the resolver is being created.

createResolver_requestMappingTemplate :: Lens' CreateResolver (Maybe Text) Source #

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.

createResolver_kind :: Lens' CreateResolver (Maybe ResolverKind) Source #

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 Function in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.

createResolver_cachingConfig :: Lens' CreateResolver (Maybe CachingConfig) Source #

The caching configuration for the resolver.

createResolver_responseMappingTemplate :: Lens' CreateResolver (Maybe Text) Source #

The mapping template to be used for responses from the data source.

createResolver_syncConfig :: Lens' CreateResolver (Maybe SyncConfig) Source #

The SyncConfig for a resolver attached to a versioned datasource.

createResolver_pipelineConfig :: Lens' CreateResolver (Maybe PipelineConfig) Source #

The PipelineConfig.

createResolver_apiId :: Lens' CreateResolver Text Source #

The ID for the GraphQL API for which the resolver is being created.

createResolver_typeName :: Lens' CreateResolver Text Source #

The name of the Type.

createResolver_fieldName :: Lens' CreateResolver Text Source #

The name of the field to attach the resolver to.

createResolverResponse_resolver :: Lens' CreateResolverResponse (Maybe Resolver) Source #

The Resolver object.

createResolverResponse_httpStatus :: Lens' CreateResolverResponse Int Source #

The response's http status code.

GetSchemaCreationStatus

getSchemaCreationStatus_apiId :: Lens' GetSchemaCreationStatus Text Source #

The API ID.

getSchemaCreationStatusResponse_status :: Lens' GetSchemaCreationStatusResponse (Maybe SchemaStatus) Source #

The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data.

getSchemaCreationStatusResponse_details :: Lens' GetSchemaCreationStatusResponse (Maybe Text) Source #

Detailed information about the status of the schema creation operation.

getSchemaCreationStatusResponse_httpStatus :: Lens' GetSchemaCreationStatusResponse Int Source #

The response's http status code.

GetApiCache

getApiCache_apiId :: Lens' GetApiCache Text Source #

The API ID.

getApiCacheResponse_apiCache :: Lens' GetApiCacheResponse (Maybe ApiCache) Source #

The ApiCache object.

getApiCacheResponse_httpStatus :: Lens' GetApiCacheResponse Int Source #

The response's http status code.

UpdateApiCache

updateApiCache_apiId :: Lens' UpdateApiCache Text Source #

The GraphQL API Id.

updateApiCache_ttl :: Lens' UpdateApiCache Integer Source #

TTL in seconds for cache entries.

Valid values are between 1 and 3600 seconds.

updateApiCache_apiCachingBehavior :: Lens' UpdateApiCache ApiCachingBehavior Source #

Caching behavior.

  • FULL_REQUEST_CACHING: All requests are fully cached.
  • PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.

updateApiCache_type :: Lens' UpdateApiCache ApiCacheType Source #

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.

updateApiCacheResponse_apiCache :: Lens' UpdateApiCacheResponse (Maybe ApiCache) Source #

The ApiCache object.

updateApiCacheResponse_httpStatus :: Lens' UpdateApiCacheResponse Int Source #

The response's http status code.

DeleteApiCache

deleteApiCache_apiId :: Lens' DeleteApiCache Text Source #

The API ID.

deleteApiCacheResponse_httpStatus :: Lens' DeleteApiCacheResponse Int Source #

The response's http status code.

ListGraphqlApis

listGraphqlApis_nextToken :: Lens' ListGraphqlApis (Maybe Text) Source #

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.

listGraphqlApis_maxResults :: Lens' ListGraphqlApis (Maybe Natural) Source #

The maximum number of results you want the request to return.

listGraphqlApisResponse_nextToken :: Lens' ListGraphqlApisResponse (Maybe Text) Source #

An identifier to be passed in the next request to this operation to return the next set of items in the list.

listGraphqlApisResponse_graphqlApis :: Lens' ListGraphqlApisResponse (Maybe [GraphqlApi]) Source #

The GraphqlApi objects.

listGraphqlApisResponse_httpStatus :: Lens' ListGraphqlApisResponse Int Source #

The response's http status code.

CreateApiCache

createApiCache_atRestEncryptionEnabled :: Lens' CreateApiCache (Maybe Bool) Source #

At rest encryption flag for cache. This setting cannot be updated after creation.

createApiCache_transitEncryptionEnabled :: Lens' CreateApiCache (Maybe Bool) Source #

Transit encryption flag when connecting to cache. This setting cannot be updated after creation.

createApiCache_apiId :: Lens' CreateApiCache Text Source #

The GraphQL API Id.

createApiCache_ttl :: Lens' CreateApiCache Integer Source #

TTL in seconds for cache entries.

Valid values are between 1 and 3600 seconds.

createApiCache_apiCachingBehavior :: Lens' CreateApiCache ApiCachingBehavior Source #

Caching behavior.

  • FULL_REQUEST_CACHING: All requests are fully cached.
  • PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.

createApiCache_type :: Lens' CreateApiCache ApiCacheType Source #

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.

createApiCacheResponse_apiCache :: Lens' CreateApiCacheResponse (Maybe ApiCache) Source #

The ApiCache object.

createApiCacheResponse_httpStatus :: Lens' CreateApiCacheResponse Int Source #

The response's http status code.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The GraphqlApi ARN.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

A TagMap object.

tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #

The response's http status code.

GetResolver

getResolver_apiId :: Lens' GetResolver Text Source #

The API ID.

getResolver_typeName :: Lens' GetResolver Text Source #

The resolver type name.

getResolver_fieldName :: Lens' GetResolver Text Source #

The resolver field name.

getResolverResponse_resolver :: Lens' GetResolverResponse (Maybe Resolver) Source #

The Resolver object.

getResolverResponse_httpStatus :: Lens' GetResolverResponse Int Source #

The response's http status code.

UpdateFunction

updateFunction_requestMappingTemplate :: Lens' UpdateFunction (Maybe Text) Source #

The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.

updateFunction_responseMappingTemplate :: Lens' UpdateFunction (Maybe Text) Source #

The Function request mapping template.

updateFunction_syncConfig :: Lens' UpdateFunction (Maybe SyncConfig) Source #

Undocumented member.

updateFunction_description :: Lens' UpdateFunction (Maybe Text) Source #

The Function description.

updateFunction_apiId :: Lens' UpdateFunction Text Source #

The GraphQL API ID.

updateFunction_name :: Lens' UpdateFunction Text Source #

The Function name.

updateFunction_functionId :: Lens' UpdateFunction Text Source #

The function ID.

updateFunction_dataSourceName :: Lens' UpdateFunction Text Source #

The Function DataSource name.

updateFunction_functionVersion :: Lens' UpdateFunction Text Source #

The version of the request mapping template. Currently the supported value is 2018-05-29.

updateFunctionResponse_functionConfiguration :: Lens' UpdateFunctionResponse (Maybe FunctionConfiguration) Source #

The Function object.

updateFunctionResponse_httpStatus :: Lens' UpdateFunctionResponse Int Source #

The response's http status code.

DeleteFunction

deleteFunction_apiId :: Lens' DeleteFunction Text Source #

The GraphQL API ID.

deleteFunction_functionId :: Lens' DeleteFunction Text Source #

The Function ID.

deleteFunctionResponse_httpStatus :: Lens' DeleteFunctionResponse Int Source #

The response's http status code.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The GraphqlApi ARN.

untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #

A list of TagKey objects.

untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #

The response's http status code.

CreateApiKey

createApiKey_expires :: Lens' CreateApiKey (Maybe Integer) Source #

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 .

createApiKey_description :: Lens' CreateApiKey (Maybe Text) Source #

A description of the purpose of the API key.

createApiKey_apiId :: Lens' CreateApiKey Text Source #

The ID for your GraphQL API.

createApiKeyResponse_apiKey :: Lens' CreateApiKeyResponse (Maybe ApiKey) Source #

The API key.

createApiKeyResponse_httpStatus :: Lens' CreateApiKeyResponse Int Source #

The response's http status code.

ListFunctions

listFunctions_nextToken :: Lens' ListFunctions (Maybe Text) Source #

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.

listFunctions_maxResults :: Lens' ListFunctions (Maybe Natural) Source #

The maximum number of results you want the request to return.

listFunctions_apiId :: Lens' ListFunctions Text Source #

The GraphQL API ID.

listFunctionsResponse_nextToken :: Lens' ListFunctionsResponse (Maybe Text) Source #

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.

listFunctionsResponse_functions :: Lens' ListFunctionsResponse (Maybe [FunctionConfiguration]) Source #

A list of Function objects.

listFunctionsResponse_httpStatus :: Lens' ListFunctionsResponse Int Source #

The response's http status code.

ListApiKeys

listApiKeys_nextToken :: Lens' ListApiKeys (Maybe Text) Source #

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.

listApiKeys_maxResults :: Lens' ListApiKeys (Maybe Natural) Source #

The maximum number of results you want the request to return.

listApiKeys_apiId :: Lens' ListApiKeys Text Source #

The API ID.

listApiKeysResponse_apiKeys :: Lens' ListApiKeysResponse (Maybe [ApiKey]) Source #

The ApiKey objects.

listApiKeysResponse_nextToken :: Lens' ListApiKeysResponse (Maybe Text) Source #

An identifier to be passed in the next request to this operation to return the next set of items in the list.

listApiKeysResponse_httpStatus :: Lens' ListApiKeysResponse Int Source #

The response's http status code.

GetType

getType_apiId :: Lens' GetType Text Source #

The API ID.

getType_typeName :: Lens' GetType Text Source #

The type name.

getType_format :: Lens' GetType TypeDefinitionFormat Source #

The type format: SDL or JSON.

getTypeResponse_type :: Lens' GetTypeResponse (Maybe Type) Source #

The Type object.

getTypeResponse_httpStatus :: Lens' GetTypeResponse Int Source #

The response's http status code.

Types

AdditionalAuthenticationProvider

additionalAuthenticationProvider_openIDConnectConfig :: Lens' AdditionalAuthenticationProvider (Maybe OpenIDConnectConfig) Source #

The OpenID Connect configuration.

additionalAuthenticationProvider_lambdaAuthorizerConfig :: Lens' AdditionalAuthenticationProvider (Maybe LambdaAuthorizerConfig) Source #

Configuration for Amazon Web Services Lambda function authorization.

additionalAuthenticationProvider_userPoolConfig :: Lens' AdditionalAuthenticationProvider (Maybe CognitoUserPoolConfig) Source #

The Amazon Cognito user pool configuration.

additionalAuthenticationProvider_authenticationType :: Lens' AdditionalAuthenticationProvider (Maybe AuthenticationType) Source #

The authentication type: API key, Identity and Access Management, OIDC, Amazon Cognito user pools, or Amazon Web Services Lambda.

ApiCache

apiCache_ttl :: Lens' ApiCache (Maybe Integer) Source #

TTL in seconds for cache entries.

Valid values are between 1 and 3600 seconds.

apiCache_status :: Lens' ApiCache (Maybe ApiCacheStatus) Source #

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.

apiCache_atRestEncryptionEnabled :: Lens' ApiCache (Maybe Bool) Source #

At rest encryption flag for cache. This setting cannot be updated after creation.

apiCache_transitEncryptionEnabled :: Lens' ApiCache (Maybe Bool) Source #

Transit encryption flag when connecting to cache. This setting cannot be updated after creation.

apiCache_apiCachingBehavior :: Lens' ApiCache (Maybe ApiCachingBehavior) Source #

Caching behavior.

  • FULL_REQUEST_CACHING: All requests are fully cached.
  • PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.

apiCache_type :: Lens' ApiCache (Maybe ApiCacheType) Source #

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

apiKey_expires :: Lens' ApiKey (Maybe Integer) Source #

The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour.

apiKey_deletes :: Lens' ApiKey (Maybe Integer) Source #

The time after which the API key is deleted. The date is represented as seconds since the epoch, rounded down to the nearest hour.

apiKey_id :: Lens' ApiKey (Maybe Text) Source #

The API key ID.

apiKey_description :: Lens' ApiKey (Maybe Text) Source #

A description of the purpose of the API key.

AuthorizationConfig

authorizationConfig_awsIamConfig :: Lens' AuthorizationConfig (Maybe AwsIamConfig) Source #

The Identity and Access Management settings.

authorizationConfig_authorizationType :: Lens' AuthorizationConfig AuthorizationType Source #

The authorization type required by the HTTP endpoint.

  • AWS_IAM: The authorization type is Sigv4.

AwsIamConfig

awsIamConfig_signingServiceName :: Lens' AwsIamConfig (Maybe Text) Source #

The signing service name for Identity and Access Management authorization.

awsIamConfig_signingRegion :: Lens' AwsIamConfig (Maybe Text) Source #

The signing region for Identity and Access Management authorization.

CachingConfig

cachingConfig_ttl :: Lens' CachingConfig (Maybe Integer) Source #

The TTL in seconds for a resolver that has caching enabled.

Valid values are between 1 and 3600 seconds.

cachingConfig_cachingKeys :: Lens' CachingConfig (Maybe [Text]) Source #

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

cognitoUserPoolConfig_appIdClientRegex :: Lens' CognitoUserPoolConfig (Maybe Text) Source #

A regular expression for validating the incoming Amazon Cognito user pool app client ID.

cognitoUserPoolConfig_userPoolId :: Lens' CognitoUserPoolConfig Text Source #

The user pool ID.

cognitoUserPoolConfig_awsRegion :: Lens' CognitoUserPoolConfig Text Source #

The Amazon Web Services Region in which the user pool was created.

DataSource

dataSource_serviceRoleArn :: Lens' DataSource (Maybe Text) Source #

The Identity and Access Management service role ARN for the data source. The system assumes this role when accessing the data source.

dataSource_relationalDatabaseConfig :: Lens' DataSource (Maybe RelationalDatabaseDataSourceConfig) Source #

Relational database settings.

dataSource_dataSourceArn :: Lens' DataSource (Maybe Text) Source #

The data source ARN.

dataSource_dynamodbConfig :: Lens' DataSource (Maybe DynamodbDataSourceConfig) Source #

Amazon DynamoDB settings.

dataSource_name :: Lens' DataSource (Maybe Text) Source #

The name of the data source.

dataSource_httpConfig :: Lens' DataSource (Maybe HttpDataSourceConfig) Source #

HTTP endpoint settings.

dataSource_openSearchServiceConfig :: Lens' DataSource (Maybe OpenSearchServiceDataSourceConfig) Source #

Amazon OpenSearch Service settings.

dataSource_lambdaConfig :: Lens' DataSource (Maybe LambdaDataSourceConfig) Source #

Amazon Web Services Lambda settings.

dataSource_type :: Lens' DataSource (Maybe DataSourceType) Source #

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.

dataSource_description :: Lens' DataSource (Maybe Text) Source #

The description of the data source.

dataSource_elasticsearchConfig :: Lens' DataSource (Maybe ElasticsearchDataSourceConfig) Source #

Amazon OpenSearch Service settings.

DeltaSyncConfig

deltaSyncConfig_baseTableTTL :: Lens' DeltaSyncConfig (Maybe Integer) Source #

The number of minutes an Item is stored in the datasource.

deltaSyncConfig_deltaSyncTableName :: Lens' DeltaSyncConfig (Maybe Text) Source #

The Delta Sync table name.

deltaSyncConfig_deltaSyncTableTTL :: Lens' DeltaSyncConfig (Maybe Integer) Source #

The number of minutes a Delta Sync log entry is stored in the Delta Sync table.

DynamodbDataSourceConfig

dynamodbDataSourceConfig_versioned :: Lens' DynamodbDataSourceConfig (Maybe Bool) Source #

Set to TRUE to use Conflict Detection and Resolution with this data source.

dynamodbDataSourceConfig_useCallerCredentials :: Lens' DynamodbDataSourceConfig (Maybe Bool) Source #

Set to TRUE to use Amazon Cognito credentials with this data source.

dynamodbDataSourceConfig_deltaSyncConfig :: Lens' DynamodbDataSourceConfig (Maybe DeltaSyncConfig) Source #

The DeltaSyncConfig for a versioned datasource.

dynamodbDataSourceConfig_tableName :: Lens' DynamodbDataSourceConfig Text Source #

The table name.

dynamodbDataSourceConfig_awsRegion :: Lens' DynamodbDataSourceConfig Text Source #

The Amazon Web Services Region.

ElasticsearchDataSourceConfig

elasticsearchDataSourceConfig_endpoint :: Lens' ElasticsearchDataSourceConfig Text Source #

The endpoint.

elasticsearchDataSourceConfig_awsRegion :: Lens' ElasticsearchDataSourceConfig Text Source #

The Amazon Web Services Region.

FunctionConfiguration

functionConfiguration_functionArn :: Lens' FunctionConfiguration (Maybe Text) Source #

The ARN of the Function object.

functionConfiguration_dataSourceName :: Lens' FunctionConfiguration (Maybe Text) Source #

The name of the DataSource.

functionConfiguration_requestMappingTemplate :: Lens' FunctionConfiguration (Maybe Text) Source #

The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.

functionConfiguration_name :: Lens' FunctionConfiguration (Maybe Text) Source #

The name of the Function object.

functionConfiguration_functionId :: Lens' FunctionConfiguration (Maybe Text) Source #

A unique ID representing the Function object.

functionConfiguration_responseMappingTemplate :: Lens' FunctionConfiguration (Maybe Text) Source #

The Function response mapping template.

functionConfiguration_syncConfig :: Lens' FunctionConfiguration (Maybe SyncConfig) Source #

Undocumented member.

functionConfiguration_functionVersion :: Lens' FunctionConfiguration (Maybe Text) Source #

The version of the request mapping template. Currently only the 2018-05-29 version of the template is supported.

functionConfiguration_description :: Lens' FunctionConfiguration (Maybe Text) Source #

The Function description.

GraphqlApi

graphqlApi_xrayEnabled :: Lens' GraphqlApi (Maybe Bool) Source #

A flag representing whether X-Ray tracing is enabled for this GraphqlApi.

graphqlApi_arn :: Lens' GraphqlApi (Maybe Text) Source #

The ARN.

graphqlApi_apiId :: Lens' GraphqlApi (Maybe Text) Source #

The API ID.

graphqlApi_uris :: Lens' GraphqlApi (Maybe (HashMap Text Text)) Source #

The URIs.

graphqlApi_openIDConnectConfig :: Lens' GraphqlApi (Maybe OpenIDConnectConfig) Source #

The OpenID Connect configuration.

graphqlApi_wafWebAclArn :: Lens' GraphqlApi (Maybe Text) Source #

The ARN of the WAF ACL associated with this GraphqlApi, if one exists.

graphqlApi_additionalAuthenticationProviders :: Lens' GraphqlApi (Maybe [AdditionalAuthenticationProvider]) Source #

A list of additional authentication providers for the GraphqlApi API.

graphqlApi_lambdaAuthorizerConfig :: Lens' GraphqlApi (Maybe LambdaAuthorizerConfig) Source #

Configuration for Amazon Web Services Lambda function authorization.

graphqlApi_name :: Lens' GraphqlApi (Maybe Text) Source #

The API name.

graphqlApi_userPoolConfig :: Lens' GraphqlApi (Maybe UserPoolConfig) Source #

The Amazon Cognito user pool configuration.

graphqlApi_authenticationType :: Lens' GraphqlApi (Maybe AuthenticationType) Source #

The authentication type.

graphqlApi_logConfig :: Lens' GraphqlApi (Maybe LogConfig) Source #

The Amazon CloudWatch Logs configuration.

graphqlApi_tags :: Lens' GraphqlApi (Maybe (HashMap Text Text)) Source #

The tags.

HttpDataSourceConfig

httpDataSourceConfig_authorizationConfig :: Lens' HttpDataSourceConfig (Maybe AuthorizationConfig) Source #

The authorization config in case the HTTP endpoint requires authorization.

httpDataSourceConfig_endpoint :: Lens' HttpDataSourceConfig (Maybe Text) Source #

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

lambdaAuthorizerConfig_identityValidationExpression :: Lens' LambdaAuthorizerConfig (Maybe Text) Source #

A regular expression for validation of tokens before the Lambda function is called.

lambdaAuthorizerConfig_authorizerResultTtlInSeconds :: Lens' LambdaAuthorizerConfig (Maybe Natural) Source #

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.

lambdaAuthorizerConfig_authorizerUri :: Lens' LambdaAuthorizerConfig Text Source #

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

lambdaConflictHandlerConfig_lambdaConflictHandlerArn :: Lens' LambdaConflictHandlerConfig (Maybe Text) Source #

The Arn for the Lambda function to use as the Conflict Handler.

LambdaDataSourceConfig

lambdaDataSourceConfig_lambdaFunctionArn :: Lens' LambdaDataSourceConfig Text Source #

The ARN for the Lambda function.

LogConfig

logConfig_excludeVerboseContent :: Lens' LogConfig (Maybe Bool) Source #

Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.

logConfig_fieldLogLevel :: Lens' LogConfig FieldLogLevel Source #

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.

logConfig_cloudWatchLogsRoleArn :: Lens' LogConfig Text Source #

The service role that AppSync will assume to publish to Amazon CloudWatch logs in your account.

OpenIDConnectConfig

openIDConnectConfig_authTTL :: Lens' OpenIDConnectConfig (Maybe Integer) Source #

The number of milliseconds a token is valid after being authenticated.

openIDConnectConfig_clientId :: Lens' OpenIDConnectConfig (Maybe Text) Source #

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.

openIDConnectConfig_iatTTL :: Lens' OpenIDConnectConfig (Maybe Integer) Source #

The number of milliseconds a token is valid after being issued to a user.

openIDConnectConfig_issuer :: Lens' OpenIDConnectConfig Text Source #

The issuer for the OpenID Connect configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.

OpenSearchServiceDataSourceConfig

openSearchServiceDataSourceConfig_endpoint :: Lens' OpenSearchServiceDataSourceConfig Text Source #

The endpoint.

openSearchServiceDataSourceConfig_awsRegion :: Lens' OpenSearchServiceDataSourceConfig Text Source #

The Amazon Web Services Region.

PipelineConfig

pipelineConfig_functions :: Lens' PipelineConfig (Maybe [Text]) Source #

A list of Function objects.

RdsHttpEndpointConfig

rdsHttpEndpointConfig_dbClusterIdentifier :: Lens' RdsHttpEndpointConfig (Maybe Text) Source #

Amazon RDS cluster ARN.

rdsHttpEndpointConfig_schema :: Lens' RdsHttpEndpointConfig (Maybe Text) Source #

Logical schema name.

rdsHttpEndpointConfig_databaseName :: Lens' RdsHttpEndpointConfig (Maybe Text) Source #

Logical database name.

rdsHttpEndpointConfig_awsRegion :: Lens' RdsHttpEndpointConfig (Maybe Text) Source #

Amazon Web Services Region for RDS HTTP endpoint.

rdsHttpEndpointConfig_awsSecretStoreArn :: Lens' RdsHttpEndpointConfig (Maybe Text) Source #

Amazon Web Services secret store ARN for database credentials.

RelationalDatabaseDataSourceConfig

relationalDatabaseDataSourceConfig_relationalDatabaseSourceType :: Lens' RelationalDatabaseDataSourceConfig (Maybe RelationalDatabaseSourceType) Source #

Source type for the relational database.

  • RDS_HTTP_ENDPOINT: The relational database source type is an Amazon RDS HTTP endpoint.

relationalDatabaseDataSourceConfig_rdsHttpEndpointConfig :: Lens' RelationalDatabaseDataSourceConfig (Maybe RdsHttpEndpointConfig) Source #

Amazon RDS HTTP endpoint settings.

Resolver

resolver_typeName :: Lens' Resolver (Maybe Text) Source #

The resolver type name.

resolver_dataSourceName :: Lens' Resolver (Maybe Text) Source #

The resolver data source name.

resolver_requestMappingTemplate :: Lens' Resolver (Maybe Text) Source #

The request mapping template.

resolver_kind :: Lens' Resolver (Maybe ResolverKind) Source #

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 Function in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.

resolver_resolverArn :: Lens' Resolver (Maybe Text) Source #

The resolver ARN.

resolver_cachingConfig :: Lens' Resolver (Maybe CachingConfig) Source #

The caching configuration for the resolver.

resolver_responseMappingTemplate :: Lens' Resolver (Maybe Text) Source #

The response mapping template.

resolver_fieldName :: Lens' Resolver (Maybe Text) Source #

The resolver field name.

resolver_syncConfig :: Lens' Resolver (Maybe SyncConfig) Source #

The SyncConfig for a resolver attached to a versioned datasource.

resolver_pipelineConfig :: Lens' Resolver (Maybe PipelineConfig) Source #

The PipelineConfig.

SyncConfig

syncConfig_conflictHandler :: Lens' SyncConfig (Maybe ConflictHandlerType) Source #

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.

syncConfig_conflictDetection :: Lens' SyncConfig (Maybe ConflictDetectionType) Source #

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.

syncConfig_lambdaConflictHandlerConfig :: Lens' SyncConfig (Maybe LambdaConflictHandlerConfig) Source #

The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.

Type

type_arn :: Lens' Type (Maybe Text) Source #

The type ARN.

type_definition :: Lens' Type (Maybe Text) Source #

The type definition.

type_format :: Lens' Type (Maybe TypeDefinitionFormat) Source #

The type format: SDL or JSON.

type_name :: Lens' Type (Maybe Text) Source #

The type name.

type_description :: Lens' Type (Maybe Text) Source #

The type description.

UserPoolConfig

userPoolConfig_appIdClientRegex :: Lens' UserPoolConfig (Maybe Text) Source #

A regular expression for validating the incoming Amazon Cognito user pool app client ID.

userPoolConfig_userPoolId :: Lens' UserPoolConfig Text Source #

The user pool ID.

userPoolConfig_awsRegion :: Lens' UserPoolConfig Text Source #

The Amazon Web Services Region in which the user pool was created.

userPoolConfig_defaultAction :: Lens' UserPoolConfig DefaultAction Source #

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.