@datafire/amazonaws_appsync

Client library for AWS AppSync

Installation and Usage

npm install --save @datafire/amazonaws_appsync

let amazonaws_appsync = require('@datafire/amazonaws_appsync').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_appsync.ListGraphqlApis({}).then(data => {
  console.log(data);
});

Description

AWS AppSync provides API actions for creating and interacting with data sources using GraphQL from your application.

Actions

ListGraphqlApis

amazonaws_appsync.ListGraphqlApis({}, context)

Input

• input object

Output

• output ListGraphqlApisResponse

CreateGraphqlApi

amazonaws_appsync.CreateGraphqlApi({
  "name": "",
  "authenticationType": ""
}, context)

Input

• input object
  • authenticationType required AuthenticationType
  • name required String
  • userPoolConfig UserPoolConfig

Output

• output CreateGraphqlApiResponse

DeleteGraphqlApi

amazonaws_appsync.DeleteGraphqlApi({
  "apiId": ""
}, context)

Input

• input object
  • apiId required string

Output

• output DeleteGraphqlApiResponse

GetGraphqlApi

amazonaws_appsync.GetGraphqlApi({
  "apiId": ""
}, context)

Input

• input object
  • apiId required string

Output

• output GetGraphqlApiResponse

UpdateGraphqlApi

amazonaws_appsync.UpdateGraphqlApi({
  "apiId": "",
  "name": ""
}, context)

Input

• input object
  • apiId required string
  • authenticationType AuthenticationType
  • name required String
  • userPoolConfig UserPoolConfig

Output

• output UpdateGraphqlApiResponse

ListApiKeys

amazonaws_appsync.ListApiKeys({
  "apiId": ""
}, context)

Input

• input object
  • apiId required string

Output

• output ListApiKeysResponse

CreateApiKey

amazonaws_appsync.CreateApiKey({
  "apiId": ""
}, context)

Input

• input object
  • apiId required string
  • description String
  • expires Long

Output

• output CreateApiKeyResponse

DeleteApiKey

amazonaws_appsync.DeleteApiKey({
  "apiId": "",
  "id": ""
}, context)

Input

• input object
  • apiId required string
  • id required string

Output

• output DeleteApiKeyResponse

UpdateApiKey

amazonaws_appsync.UpdateApiKey({
  "apiId": "",
  "id": ""
}, context)

Input

• input object
  • apiId required string
  • id required string
  • description String
  • expires Long

Output

• output UpdateApiKeyResponse

ListDataSources

amazonaws_appsync.ListDataSources({
  "apiId": ""
}, context)

Input

• input object
  • apiId required string

Output

• output ListDataSourcesResponse

CreateDataSource

amazonaws_appsync.CreateDataSource({
  "apiId": "",
  "name": "",
  "type": ""
}, context)

Input

• input object
  • apiId required string
  • description String
  • dynamodbConfig DynamodbDataSourceConfig
  • elasticsearchConfig ElasticsearchDataSourceConfig
  • lambdaConfig LambdaDataSourceConfig
  • name required ResourceName
  • serviceRoleArn String
  • type required DataSourceType

Output

• output CreateDataSourceResponse

DeleteDataSource

amazonaws_appsync.DeleteDataSource({
  "apiId": "",
  "name": ""
}, context)

Input

• input object
  • apiId required string
  • name required string

Output

• output DeleteDataSourceResponse

GetDataSource

amazonaws_appsync.GetDataSource({
  "apiId": "",
  "name": ""
}, context)

Input

• input object
  • apiId required string
  • name required string

Output

• output GetDataSourceResponse

UpdateDataSource

amazonaws_appsync.UpdateDataSource({
  "apiId": "",
  "name": "",
  "type": ""
}, context)

Input

• input object
  • apiId required string
  • name required string
  • description String
  • dynamodbConfig DynamodbDataSourceConfig
  • elasticsearchConfig ElasticsearchDataSourceConfig
  • lambdaConfig LambdaDataSourceConfig
  • serviceRoleArn String
  • type required DataSourceType

Output

• output UpdateDataSourceResponse

GetIntrospectionSchema

amazonaws_appsync.GetIntrospectionSchema({
  "apiId": ""
}, context)

Input

• input object
  • apiId required string

Output

• output GetIntrospectionSchemaResponse

GetSchemaCreationStatus

amazonaws_appsync.GetSchemaCreationStatus({
  "apiId": ""
}, context)

Input

• input object
  • apiId required string

Output

• output GetSchemaCreationStatusResponse

StartSchemaCreation

amazonaws_appsync.StartSchemaCreation({
  "apiId": "",
  "definition": ""
}, context)

Input

• input object
  • apiId required string
  • definition required Blob

Output

• output StartSchemaCreationResponse

ListTypes

amazonaws_appsync.ListTypes({
  "apiId": ""
}, context)

Input

• input object
  • apiId required string

Output

• output ListTypesResponse

CreateType

amazonaws_appsync.CreateType({
  "apiId": "",
  "definition": "",
  "format": ""
}, context)

Input

• input object
  • apiId required string
  • definition required String
  • format required TypeDefinitionFormat

Output

• output CreateTypeResponse

DeleteType

amazonaws_appsync.DeleteType({
  "apiId": "",
  "typeName": ""
}, context)

Input

• input object
  • apiId required string
  • typeName required string

Output

• output DeleteTypeResponse

GetType

amazonaws_appsync.GetType({
  "apiId": "",
  "typeName": ""
}, context)

Input

• input object
  • apiId required string
  • typeName required string

Output

• output GetTypeResponse

UpdateType

amazonaws_appsync.UpdateType({
  "apiId": "",
  "typeName": "",
  "format": ""
}, context)

Input

• input object
  • apiId required string
  • typeName required string
  • definition String
  • format required TypeDefinitionFormat

Output

• output UpdateTypeResponse

ListResolvers

amazonaws_appsync.ListResolvers({
  "apiId": "",
  "typeName": ""
}, context)

Input

• input object
  • apiId required string
  • typeName required string

Output

• output ListResolversResponse

CreateResolver

amazonaws_appsync.CreateResolver({
  "apiId": "",
  "typeName": "",
  "fieldName": "",
  "dataSourceName": "",
  "requestMappingTemplate": ""
}, context)

Input

• input object
  • apiId required string
  • typeName required string
  • dataSourceName required ResourceName
  • fieldName required ResourceName
  • requestMappingTemplate required MappingTemplate
  • responseMappingTemplate MappingTemplate

Output

• output CreateResolverResponse

DeleteResolver

amazonaws_appsync.DeleteResolver({
  "apiId": "",
  "typeName": "",
  "fieldName": ""
}, context)

Input

• input object
  • apiId required string
  • typeName required string
  • fieldName required string

Output

• output DeleteResolverResponse

GetResolver

amazonaws_appsync.GetResolver({
  "apiId": "",
  "typeName": "",
  "fieldName": ""
}, context)

Input

• input object
  • apiId required string
  • typeName required string
  • fieldName required string

Output

• output GetResolverResponse

UpdateResolver

amazonaws_appsync.UpdateResolver({
  "apiId": "",
  "typeName": "",
  "fieldName": "",
  "dataSourceName": "",
  "requestMappingTemplate": ""
}, context)

Input

• input object
  • apiId required string
  • typeName required string
  • fieldName required string
  • dataSourceName required ResourceName
  • requestMappingTemplate required MappingTemplate
  • responseMappingTemplate MappingTemplate

Output

• output UpdateResolverResponse

Definitions

ApiKey

• ApiKey object: Describes an API key.
  • description String
  • expires Long
  • id String

ApiKeyLimitExceededException

• ApiKeyLimitExceededException object: The API key exceeded a limit. Try your request again.
  • message String

ApiKeyValidityOutOfBoundsException

• ApiKeyValidityOutOfBoundsException object: The API key expiration must be set to a value between 1 and 365 days.
  • message String

ApiKeys

• ApiKeys array
  • items ApiKey

ApiLimitExceededException

• ApiLimitExceededException object: The GraphQL API exceeded a limit. Try your request again.
  • message String

AuthenticationType

• AuthenticationType string (values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS)

BadRequestException

• BadRequestException object: The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
  • message ErrorMessage

Blob

• Blob string

Boolean

• Boolean boolean

ConcurrentModificationException

• ConcurrentModificationException object: Another modification is being made. That modification must complete before you can make your change.
  • message ErrorMessage

CreateApiKeyRequest

• CreateApiKeyRequest object
  • description String
  • expires Long

CreateApiKeyResponse

• CreateApiKeyResponse object
  • apiKey ApiKey

CreateDataSourceRequest

• CreateDataSourceRequest object
  • description String
  • dynamodbConfig DynamodbDataSourceConfig
  • elasticsearchConfig ElasticsearchDataSourceConfig
  • lambdaConfig LambdaDataSourceConfig
  • name required ResourceName
  • serviceRoleArn String
  • type required DataSourceType

CreateDataSourceResponse

• CreateDataSourceResponse object
  • dataSource DataSource

CreateGraphqlApiRequest

• CreateGraphqlApiRequest object
  • authenticationType required AuthenticationType
  • name required String
  • userPoolConfig UserPoolConfig

CreateGraphqlApiResponse

• CreateGraphqlApiResponse object
  • graphqlApi GraphqlApi

CreateResolverRequest

• CreateResolverRequest object
  • dataSourceName required ResourceName
  • fieldName required ResourceName
  • requestMappingTemplate required MappingTemplate
  • responseMappingTemplate MappingTemplate

CreateResolverResponse

• CreateResolverResponse object
  • resolver Resolver

CreateTypeRequest

• CreateTypeRequest object
  • definition required String
  • format required TypeDefinitionFormat

CreateTypeResponse

• CreateTypeResponse object
  • type Type

DataSource

• DataSource object: Describes a data source.
  • dataSourceArn String
  • description String
  • dynamodbConfig DynamodbDataSourceConfig
  • elasticsearchConfig ElasticsearchDataSourceConfig
  • lambdaConfig LambdaDataSourceConfig
  • name ResourceName
  • serviceRoleArn String
  • type DataSourceType

DataSourceType

• DataSourceType string (values: AWS_LAMBDA, AMAZON_DYNAMODB, AMAZON_ELASTICSEARCH, NONE)

DataSources

• DataSources array
  • items DataSource

DefaultAction

• DefaultAction string (values: ALLOW, DENY)

DeleteApiKeyRequest

• DeleteApiKeyRequest object

DeleteApiKeyResponse

• DeleteApiKeyResponse object

DeleteDataSourceRequest

• DeleteDataSourceRequest object

DeleteDataSourceResponse

• DeleteDataSourceResponse object

DeleteGraphqlApiRequest

• DeleteGraphqlApiRequest object

DeleteGraphqlApiResponse

• DeleteGraphqlApiResponse object

DeleteResolverRequest

• DeleteResolverRequest object

DeleteResolverResponse

• DeleteResolverResponse object

DeleteTypeRequest

• DeleteTypeRequest object

DeleteTypeResponse

• DeleteTypeResponse object

DynamodbDataSourceConfig

• DynamodbDataSourceConfig object: Describes a DynamoDB data source configuration.
  • awsRegion required String
  • tableName required String
  • useCallerCredentials Boolean

ElasticsearchDataSourceConfig

• ElasticsearchDataSourceConfig object: Describes an Elasticsearch data source configuration.
  • awsRegion required String
  • endpoint required String

ErrorMessage

• ErrorMessage string

GetDataSourceRequest

• GetDataSourceRequest object

GetDataSourceResponse

• GetDataSourceResponse object
  • dataSource DataSource

GetGraphqlApiRequest

• GetGraphqlApiRequest object

GetGraphqlApiResponse

• GetGraphqlApiResponse object
  • graphqlApi GraphqlApi

GetIntrospectionSchemaRequest

• GetIntrospectionSchemaRequest object

GetIntrospectionSchemaResponse

• GetIntrospectionSchemaResponse object
  • schema Blob

GetResolverRequest

• GetResolverRequest object

GetResolverResponse

• GetResolverResponse object
  • resolver Resolver

GetSchemaCreationStatusRequest

• GetSchemaCreationStatusRequest object

GetSchemaCreationStatusResponse

• GetSchemaCreationStatusResponse object
  • details String
  • status SchemaStatus

GetTypeRequest

• GetTypeRequest object

GetTypeResponse

• GetTypeResponse object
  • type Type

GraphQLSchemaException

• GraphQLSchemaException object: The GraphQL schema is not valid.
  • message ErrorMessage

GraphqlApi

• GraphqlApi object: Describes a GraphQL API.
  • apiId String
  • arn String
  • authenticationType AuthenticationType
  • name ResourceName
  • uris MapOfStringToString
  • userPoolConfig UserPoolConfig

GraphqlApis

• GraphqlApis array
  • items GraphqlApi

InternalFailureException

• InternalFailureException object: An internal AWS AppSync error occurred. Try your request again.
  • message String

LambdaDataSourceConfig

• LambdaDataSourceConfig object: Describes a Lambda data source configuration.
  • lambdaFunctionArn required String

LimitExceededException

• LimitExceededException object: The request exceeded a limit. Try your request again.
  • message String

ListApiKeysRequest

• ListApiKeysRequest object

ListApiKeysResponse

• ListApiKeysResponse object
  • apiKeys ApiKeys
  • nextToken PaginationToken

ListDataSourcesRequest

• ListDataSourcesRequest object

ListDataSourcesResponse

• ListDataSourcesResponse object
  • dataSources DataSources
  • nextToken PaginationToken

ListGraphqlApisRequest

• ListGraphqlApisRequest object

ListGraphqlApisResponse

• ListGraphqlApisResponse object
  • graphqlApis GraphqlApis
  • nextToken PaginationToken

ListResolversRequest

• ListResolversRequest object

ListResolversResponse

• ListResolversResponse object
  • nextToken PaginationToken
  • resolvers Resolvers

ListTypesRequest

• ListTypesRequest object

ListTypesResponse

• ListTypesResponse object
  • nextToken PaginationToken
  • types TypeList

Long

• Long integer

MapOfStringToString

• MapOfStringToString array
  • items object
    • key String
    • value String

MappingTemplate

• MappingTemplate string

MaxResults

• MaxResults integer

NotFoundException

• NotFoundException object: The resource specified in the request was not found. Check the resource and try again.
  • message String

OutputType

• OutputType string (values: SDL, JSON)

PaginationToken

• PaginationToken string

Resolver

• Resolver object: Describes a resolver.
  • dataSourceName ResourceName
  • fieldName ResourceName
  • requestMappingTemplate MappingTemplate
  • resolverArn String
  • responseMappingTemplate MappingTemplate
  • typeName ResourceName

Resolvers

• Resolvers array
  • items Resolver

ResourceName

• ResourceName string

SchemaStatus

• SchemaStatus string (values: PROCESSING, ACTIVE, DELETING)

StartSchemaCreationRequest

• StartSchemaCreationRequest object
  • definition required Blob

StartSchemaCreationResponse

• StartSchemaCreationResponse object
  • status SchemaStatus

String

• String string

Type

• Type object: Describes a type.
  • arn String
  • definition String
  • description String
  • format TypeDefinitionFormat
  • name ResourceName

TypeDefinitionFormat

• TypeDefinitionFormat string (values: SDL, JSON)

TypeList

• TypeList array
  • items Type

UnauthorizedException

• UnauthorizedException object: You are not authorized to perform this operation.
  • message String

UpdateApiKeyRequest

• UpdateApiKeyRequest object
  • description String
  • expires Long

UpdateApiKeyResponse

• UpdateApiKeyResponse object
  • apiKey ApiKey

UpdateDataSourceRequest

• UpdateDataSourceRequest object
  • description String
  • dynamodbConfig DynamodbDataSourceConfig
  • elasticsearchConfig ElasticsearchDataSourceConfig
  • lambdaConfig LambdaDataSourceConfig
  • serviceRoleArn String
  • type required DataSourceType

UpdateDataSourceResponse

• UpdateDataSourceResponse object
  • dataSource DataSource

UpdateGraphqlApiRequest

• UpdateGraphqlApiRequest object
  • authenticationType AuthenticationType
  • name required String
  • userPoolConfig UserPoolConfig

UpdateGraphqlApiResponse

• UpdateGraphqlApiResponse object
  • graphqlApi GraphqlApi

UpdateResolverRequest

• UpdateResolverRequest object
  • dataSourceName required ResourceName
  • requestMappingTemplate required MappingTemplate
  • responseMappingTemplate MappingTemplate

UpdateResolverResponse

• UpdateResolverResponse object
  • resolver Resolver

UpdateTypeRequest

• UpdateTypeRequest object
  • definition String
  • format required TypeDefinitionFormat

UpdateTypeResponse

• UpdateTypeResponse object
  • type Type

UserPoolConfig

• UserPoolConfig object: Describes an Amazon Cognito User Pool configuration.
  • appIdClientRegex String
  • awsRegion required String
  • defaultAction required DefaultAction
  • userPoolId required String