Skip to content

Appsync Classes

AdditionalAuthenticationProvider

authenticationType

  • Type: typing.Optional[typing.Literal['AMAZON_COGNITO_USER_POOLS', 'API_KEY', 'AWS_IAM', 'AWS_LAMBDA', 'OPENID_CONNECT']]

openIDConnectConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.OpenIDConnectConfig]

userPoolConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.CognitoUserPoolConfig]

lambdaAuthorizerConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.LambdaAuthorizerConfig]

Api

apiId

  • Type: typing.Optional[str]

name

  • Type: typing.Optional[str]

ownerContact

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

dns

  • Type: typing.Optional[typing.Dict[str, str]]

apiArn

  • Type: typing.Optional[str]

created

  • Type: typing.Optional[datetime.datetime]

xrayEnabled

  • Type: typing.Optional[bool]

wafWebAclArn

  • Type: typing.Optional[str]

eventConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.EventConfigOutput]

ApiAssociation

domainName

  • Type: typing.Optional[str]

apiId

  • Type: typing.Optional[str]

associationStatus

  • Type: typing.Optional[typing.Literal['FAILED', 'PROCESSING', 'SUCCESS']]

deploymentDetail

  • Type: typing.Optional[str]

ApiCache

ttl

  • Type: typing.Optional[int]

apiCachingBehavior

  • Type: typing.Optional[typing.Literal['FULL_REQUEST_CACHING', 'OPERATION_LEVEL_CACHING', 'PER_RESOLVER_CACHING']]

transitEncryptionEnabled

  • Type: typing.Optional[bool]

atRestEncryptionEnabled

  • Type: typing.Optional[bool]

type

  • Type: typing.Optional[typing.Literal['LARGE', 'LARGE_12X', 'LARGE_2X', 'LARGE_4X', 'LARGE_8X', 'MEDIUM', 'R4_2XLARGE', 'R4_4XLARGE', 'R4_8XLARGE', 'R4_LARGE', 'R4_XLARGE', 'SMALL', 'T2_MEDIUM', 'T2_SMALL', 'XLARGE']]

status

  • Type: typing.Optional[typing.Literal['AVAILABLE', 'CREATING', 'DELETING', 'FAILED', 'MODIFYING']]

healthMetricsConfig

  • Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED']]

ApiKey

id

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

expires

  • Type: typing.Optional[int]

deletes

  • Type: typing.Optional[int]

AppSyncRuntime

name

  • Type: typing.Literal['APPSYNC_JS']
  • Required: Yes

runtimeVersion

  • Type:
  • Required: Yes

AssociateApiRequest

domainName

  • Type:
  • Required: Yes

apiId

  • Type:
  • Required: Yes

AssociateApiResponse

apiAssociation

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

AssociateMergedGraphqlApiRequest

sourceApiIdentifier

  • Type:
  • Required: Yes

mergedApiIdentifier

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

sourceApiAssociationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.SourceApiAssociationConfig]

AssociateMergedGraphqlApiResponse

sourceApiAssociation

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

AssociateSourceGraphqlApiRequest

mergedApiIdentifier

  • Type:
  • Required: Yes

sourceApiIdentifier

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

sourceApiAssociationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.SourceApiAssociationConfig]

AssociateSourceGraphqlApiResponse

sourceApiAssociation

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

AuthMode

authType

  • Type: typing.Literal['AMAZON_COGNITO_USER_POOLS', 'API_KEY', 'AWS_IAM', 'AWS_LAMBDA', 'OPENID_CONNECT']
  • Required: Yes

AuthProvider

authType

  • Type: typing.Literal['AMAZON_COGNITO_USER_POOLS', 'API_KEY', 'AWS_IAM', 'AWS_LAMBDA', 'OPENID_CONNECT']
  • Required: Yes

cognitoConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.CognitoConfig]

openIDConnectConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.OpenIDConnectConfig]

lambdaAuthorizerConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.LambdaAuthorizerConfig]

AuthorizationConfig

authorizationType

  • Type: typing.Literal['AWS_IAM']
  • Required: Yes

awsIamConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.AwsIamConfig]

AwsIamConfig

signingRegion

  • Type: typing.Optional[str]

signingServiceName

  • Type: typing.Optional[str]

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

CachingConfig

ttl

  • Type:
  • Required: Yes

cachingKeys

  • Type: typing.Optional[typing.List[str]]

CachingConfigOutput

ttl

  • Type:
  • Required: Yes

cachingKeys

  • Type: typing.Optional[typing.List[str]]

ChannelNamespace

apiId

  • Type: typing.Optional[str]

name

  • Type: typing.Optional[str]

subscribeAuthModes

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.appsync.appsync_classes.AuthMode]]

publishAuthModes

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.appsync.appsync_classes.AuthMode]]

codeHandlers

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

channelNamespaceArn

  • Type: typing.Optional[str]

created

  • Type: typing.Optional[datetime.datetime]

lastModified

  • Type: typing.Optional[datetime.datetime]

CodeError

errorType

  • Type: typing.Optional[str]

value

  • Type: typing.Optional[str]

location

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.CodeErrorLocation]

CodeErrorLocation

line

  • Type: typing.Optional[int]

column

  • Type: typing.Optional[int]

span

  • Type: typing.Optional[int]

CognitoConfig

userPoolId

  • Type:
  • Required: Yes

awsRegion

  • Type:
  • Required: Yes

appIdClientRegex

  • Type: typing.Optional[str]

CognitoUserPoolConfig

userPoolId

  • Type:
  • Required: Yes

awsRegion

  • Type:
  • Required: Yes

appIdClientRegex

  • Type: typing.Optional[str]

CreateApiCacheRequest

apiId

  • Type:
  • Required: Yes

ttl

  • Type:
  • Required: Yes

apiCachingBehavior

  • Type: typing.Literal['FULL_REQUEST_CACHING', 'OPERATION_LEVEL_CACHING', 'PER_RESOLVER_CACHING']
  • Required: Yes

type

  • Type: typing.Literal['LARGE', 'LARGE_12X', 'LARGE_2X', 'LARGE_4X', 'LARGE_8X', 'MEDIUM', 'R4_2XLARGE', 'R4_4XLARGE', 'R4_8XLARGE', 'R4_LARGE', 'R4_XLARGE', 'SMALL', 'T2_MEDIUM', 'T2_SMALL', 'XLARGE']
  • Required: Yes

transitEncryptionEnabled

  • Type: typing.Optional[bool]

atRestEncryptionEnabled

  • Type: typing.Optional[bool]

healthMetricsConfig

  • Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED']]

CreateApiCacheResponse

apiCache

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateApiKeyRequest

apiId

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

expires

  • Type: typing.Optional[int]

CreateApiKeyResponse

apiKey

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateApiRequest

name

  • Type:
  • Required: Yes

ownerContact

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

eventConfig

  • Type: typing.Union[aws_resource_validator.pydantic_models.appsync.appsync_classes.EventConfig, aws_resource_validator.pydantic_models.appsync.appsync_classes.EventConfigOutput, NoneType]

CreateApiResponse

api

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateChannelNamespaceRequest

apiId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

subscribeAuthModes

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.appsync.appsync_classes.AuthMode]]

publishAuthModes

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.appsync.appsync_classes.AuthMode]]

codeHandlers

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

CreateChannelNamespaceResponse

channelNamespace

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateDataSourceRequest

apiId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

type

  • Type: typing.Literal['AMAZON_BEDROCK_RUNTIME', 'AMAZON_DYNAMODB', 'AMAZON_ELASTICSEARCH', 'AMAZON_EVENTBRIDGE', 'AMAZON_OPENSEARCH_SERVICE', 'AWS_LAMBDA', 'HTTP', 'NONE', 'RELATIONAL_DATABASE']
  • Required: Yes

description

  • Type: typing.Optional[str]

serviceRoleArn

  • Type: typing.Optional[str]

dynamodbConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.DynamodbDataSourceConfig]

lambdaConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.LambdaDataSourceConfig]

elasticsearchConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.ElasticsearchDataSourceConfig]

openSearchServiceConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.OpenSearchServiceDataSourceConfig]

httpConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.HttpDataSourceConfig]

relationalDatabaseConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.RelationalDatabaseDataSourceConfig]

eventBridgeConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.EventBridgeDataSourceConfig]

metricsConfig

  • Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED']]

CreateDataSourceResponse

dataSource

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateDomainNameRequest

domainName

  • Type:
  • Required: Yes

certificateArn

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

CreateDomainNameResponse

domainNameConfig

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateFunctionRequest

apiId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

dataSourceName

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

requestMappingTemplate

  • Type: typing.Optional[str]

responseMappingTemplate

  • Type: typing.Optional[str]

functionVersion

  • Type: typing.Optional[str]

syncConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.SyncConfig]

maxBatchSize

  • Type: typing.Optional[int]

runtime

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.AppSyncRuntime]

code

  • Type: typing.Optional[str]

CreateFunctionResponse

functionConfiguration

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateGraphqlApiRequest

name

  • Type:
  • Required: Yes

authenticationType

  • Type: typing.Literal['AMAZON_COGNITO_USER_POOLS', 'API_KEY', 'AWS_IAM', 'AWS_LAMBDA', 'OPENID_CONNECT']
  • Required: Yes

logConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.LogConfig]

userPoolConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.UserPoolConfig]

openIDConnectConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.OpenIDConnectConfig]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

additionalAuthenticationProviders

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.appsync.appsync_classes.AdditionalAuthenticationProvider]]

xrayEnabled

  • Type: typing.Optional[bool]

lambdaAuthorizerConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.LambdaAuthorizerConfig]

apiType

  • Type: typing.Optional[typing.Literal['GRAPHQL', 'MERGED']]

mergedApiExecutionRoleArn

  • Type: typing.Optional[str]

visibility

  • Type: typing.Optional[typing.Literal['GLOBAL', 'PRIVATE']]

ownerContact

  • Type: typing.Optional[str]

introspectionConfig

  • Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED']]

queryDepthLimit

  • Type: typing.Optional[int]

resolverCountLimit

  • Type: typing.Optional[int]

enhancedMetricsConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.EnhancedMetricsConfig]

CreateGraphqlApiResponse

graphqlApi

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateResolverRequest

apiId

  • Type:
  • Required: Yes

typeName

  • Type:
  • Required: Yes

fieldName

  • Type:
  • Required: Yes

dataSourceName

  • Type: typing.Optional[str]

requestMappingTemplate

  • Type: typing.Optional[str]

responseMappingTemplate

  • Type: typing.Optional[str]

kind

  • Type: typing.Optional[typing.Literal['PIPELINE', 'UNIT']]

pipelineConfig

  • Type: typing.Union[aws_resource_validator.pydantic_models.appsync.appsync_classes.PipelineConfig, aws_resource_validator.pydantic_models.appsync.appsync_classes.PipelineConfigOutput, NoneType]

syncConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.SyncConfig]

cachingConfig

  • Type: typing.Union[aws_resource_validator.pydantic_models.appsync.appsync_classes.CachingConfig, aws_resource_validator.pydantic_models.appsync.appsync_classes.CachingConfigOutput, NoneType]

maxBatchSize

  • Type: typing.Optional[int]

runtime

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.AppSyncRuntime]

code

  • Type: typing.Optional[str]

metricsConfig

  • Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED']]

CreateResolverResponse

resolver

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateTypeRequest

apiId

  • Type:
  • Required: Yes

definition

  • Type:
  • Required: Yes

format

  • Type: typing.Literal['JSON', 'SDL']
  • Required: Yes

CreateTypeResponse

type

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DataSource

dataSourceArn

  • Type: typing.Optional[str]

name

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

type

  • Type: typing.Optional[typing.Literal['AMAZON_BEDROCK_RUNTIME', 'AMAZON_DYNAMODB', 'AMAZON_ELASTICSEARCH', 'AMAZON_EVENTBRIDGE', 'AMAZON_OPENSEARCH_SERVICE', 'AWS_LAMBDA', 'HTTP', 'NONE', 'RELATIONAL_DATABASE']]

serviceRoleArn

  • Type: typing.Optional[str]

dynamodbConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.DynamodbDataSourceConfig]

lambdaConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.LambdaDataSourceConfig]

elasticsearchConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.ElasticsearchDataSourceConfig]

openSearchServiceConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.OpenSearchServiceDataSourceConfig]

httpConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.HttpDataSourceConfig]

relationalDatabaseConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.RelationalDatabaseDataSourceConfig]

eventBridgeConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.EventBridgeDataSourceConfig]

metricsConfig

  • Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED']]

DataSourceIntrospectionModel

name

  • Type: typing.Optional[str]

fields

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.appsync.appsync_classes.DataSourceIntrospectionModelField]]

primaryKey

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.DataSourceIntrospectionModelIndex]

indexes

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.appsync.appsync_classes.DataSourceIntrospectionModelIndex]]

sdl

  • Type: typing.Optional[str]

DataSourceIntrospectionModelField

name

  • Type: typing.Optional[str]

type

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.DataSourceIntrospectionModelFieldType]

length

  • Type: typing.Optional[int]

DataSourceIntrospectionModelFieldType

kind

  • Type: typing.Optional[str]

name

  • Type: typing.Optional[str]

type

  • Type: typing.Optional[typing.Dict[str, typing.Any]]

values

  • Type: typing.Optional[typing.List[str]]

DataSourceIntrospectionModelIndex

name

  • Type: typing.Optional[str]

fields

  • Type: typing.Optional[typing.List[str]]

DataSourceIntrospectionResult

models

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.appsync.appsync_classes.DataSourceIntrospectionModel]]

nextToken

  • Type: typing.Optional[str]

DeleteApiCacheRequest

apiId

  • Type:
  • Required: Yes

DeleteApiKeyRequest

apiId

  • Type:
  • Required: Yes

id

  • Type:
  • Required: Yes

DeleteApiRequest

apiId

  • Type:
  • Required: Yes

DeleteChannelNamespaceRequest

apiId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

DeleteDataSourceRequest

apiId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

DeleteDomainNameRequest

domainName

  • Type:
  • Required: Yes

DeleteFunctionRequest

apiId

  • Type:
  • Required: Yes

functionId

  • Type:
  • Required: Yes

DeleteGraphqlApiRequest

apiId

  • Type:
  • Required: Yes

DeleteResolverRequest

apiId

  • Type:
  • Required: Yes

typeName

  • Type:
  • Required: Yes

fieldName

  • Type:
  • Required: Yes

DeleteTypeRequest

apiId

  • Type:
  • Required: Yes

typeName

  • Type:
  • Required: Yes

DeltaSyncConfig

baseTableTTL

  • Type: typing.Optional[int]

deltaSyncTableName

  • Type: typing.Optional[str]

deltaSyncTableTTL

  • Type: typing.Optional[int]

DisassociateApiRequest

domainName

  • Type:
  • Required: Yes

DisassociateMergedGraphqlApiRequest

sourceApiIdentifier

  • Type:
  • Required: Yes

associationId

  • Type:
  • Required: Yes

DisassociateMergedGraphqlApiResponse

sourceApiAssociationStatus

  • Type: typing.Literal['AUTO_MERGE_SCHEDULE_FAILED', 'DELETION_FAILED', 'DELETION_IN_PROGRESS', 'DELETION_SCHEDULED', 'MERGE_FAILED', 'MERGE_IN_PROGRESS', 'MERGE_SCHEDULED', 'MERGE_SUCCESS']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DisassociateSourceGraphqlApiRequest

mergedApiIdentifier

  • Type:
  • Required: Yes

associationId

  • Type:
  • Required: Yes

DisassociateSourceGraphqlApiResponse

sourceApiAssociationStatus

  • Type: typing.Literal['AUTO_MERGE_SCHEDULE_FAILED', 'DELETION_FAILED', 'DELETION_IN_PROGRESS', 'DELETION_SCHEDULED', 'MERGE_FAILED', 'MERGE_IN_PROGRESS', 'MERGE_SCHEDULED', 'MERGE_SUCCESS']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DomainNameConfig

domainName

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

certificateArn

  • Type: typing.Optional[str]

appsyncDomainName

  • Type: typing.Optional[str]

hostedZoneId

  • Type: typing.Optional[str]

DynamodbDataSourceConfig

tableName

  • Type:
  • Required: Yes

awsRegion

  • Type:
  • Required: Yes

useCallerCredentials

  • Type: typing.Optional[bool]

deltaSyncConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.DeltaSyncConfig]

versioned

  • Type: typing.Optional[bool]

ElasticsearchDataSourceConfig

endpoint

  • Type:
  • Required: Yes

awsRegion

  • Type:
  • Required: Yes

EnhancedMetricsConfig

resolverLevelMetricsBehavior

  • Type: typing.Literal['FULL_REQUEST_RESOLVER_METRICS', 'PER_RESOLVER_METRICS']
  • Required: Yes

dataSourceLevelMetricsBehavior

  • Type: typing.Literal['FULL_REQUEST_DATA_SOURCE_METRICS', 'PER_DATA_SOURCE_METRICS']
  • Required: Yes

operationLevelMetricsConfig

  • Type: typing.Literal['DISABLED', 'ENABLED']
  • Required: Yes

ErrorDetail

message

  • Type: typing.Optional[str]

EvaluateCodeErrorDetail

message

  • Type: typing.Optional[str]

codeErrors

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.appsync.appsync_classes.CodeError]]

EvaluateCodeRequest

runtime

  • Type:
  • Required: Yes

code

  • Type:
  • Required: Yes

context

  • Type:
  • Required: Yes

function

  • Type: typing.Optional[str]

EvaluateCodeResponse

evaluationResult

  • Type:
  • Required: Yes

error

  • Type:
  • Required: Yes

logs

  • Type: typing.List[str]
  • Required: Yes

stash

  • Type:
  • Required: Yes

outErrors

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

EvaluateMappingTemplateRequest

template

  • Type:
  • Required: Yes

context

  • Type:
  • Required: Yes

EvaluateMappingTemplateResponse

evaluationResult

  • Type:
  • Required: Yes

error

  • Type:
  • Required: Yes

logs

  • Type: typing.List[str]
  • Required: Yes

stash

  • Type:
  • Required: Yes

outErrors

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

EventBridgeDataSourceConfig

eventBusArn

  • Type:
  • Required: Yes

EventConfig

authProviders

  • Type: typing.List[aws_resource_validator.pydantic_models.appsync.appsync_classes.AuthProvider]
  • Required: Yes

connectionAuthModes

  • Type: typing.List[aws_resource_validator.pydantic_models.appsync.appsync_classes.AuthMode]
  • Required: Yes

defaultPublishAuthModes

  • Type: typing.List[aws_resource_validator.pydantic_models.appsync.appsync_classes.AuthMode]
  • Required: Yes

defaultSubscribeAuthModes

  • Type: typing.List[aws_resource_validator.pydantic_models.appsync.appsync_classes.AuthMode]
  • Required: Yes

logConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.EventLogConfig]

EventConfigOutput

authProviders

  • Type: typing.List[aws_resource_validator.pydantic_models.appsync.appsync_classes.AuthProvider]
  • Required: Yes

connectionAuthModes

  • Type: typing.List[aws_resource_validator.pydantic_models.appsync.appsync_classes.AuthMode]
  • Required: Yes

defaultPublishAuthModes

  • Type: typing.List[aws_resource_validator.pydantic_models.appsync.appsync_classes.AuthMode]
  • Required: Yes

defaultSubscribeAuthModes

  • Type: typing.List[aws_resource_validator.pydantic_models.appsync.appsync_classes.AuthMode]
  • Required: Yes

logConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.EventLogConfig]

EventLogConfig

logLevel

  • Type: typing.Literal['ALL', 'DEBUG', 'ERROR', 'INFO', 'NONE']
  • Required: Yes

cloudWatchLogsRoleArn

  • Type:
  • Required: Yes

FlushApiCacheRequest

apiId

  • Type:
  • Required: Yes

FunctionConfiguration

functionId

  • Type: typing.Optional[str]

functionArn

  • Type: typing.Optional[str]

name

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

dataSourceName

  • Type: typing.Optional[str]

requestMappingTemplate

  • Type: typing.Optional[str]

responseMappingTemplate

  • Type: typing.Optional[str]

functionVersion

  • Type: typing.Optional[str]

syncConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.SyncConfig]

maxBatchSize

  • Type: typing.Optional[int]

runtime

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.AppSyncRuntime]

code

  • Type: typing.Optional[str]

GetApiAssociationRequest

domainName

  • Type:
  • Required: Yes

GetApiAssociationResponse

apiAssociation

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetApiCacheRequest

apiId

  • Type:
  • Required: Yes

GetApiCacheResponse

apiCache

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetApiRequest

apiId

  • Type:
  • Required: Yes

GetApiResponse

api

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetChannelNamespaceRequest

apiId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

GetChannelNamespaceResponse

channelNamespace

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetDataSourceIntrospectionRequest

introspectionId

  • Type:
  • Required: Yes

includeModelsSDL

  • Type: typing.Optional[bool]

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

GetDataSourceIntrospectionResponse

introspectionId

  • Type:
  • Required: Yes

introspectionStatus

  • Type: typing.Literal['FAILED', 'PROCESSING', 'SUCCESS']
  • Required: Yes

introspectionStatusDetail

  • Type:
  • Required: Yes

introspectionResult

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetDataSourceRequest

apiId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

GetDataSourceResponse

dataSource

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetDomainNameRequest

domainName

  • Type:
  • Required: Yes

GetDomainNameResponse

domainNameConfig

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetFunctionRequest

apiId

  • Type:
  • Required: Yes

functionId

  • Type:
  • Required: Yes

GetFunctionResponse

functionConfiguration

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetGraphqlApiEnvironmentVariablesRequest

apiId

  • Type:
  • Required: Yes

GetGraphqlApiEnvironmentVariablesResponse

environmentVariables

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetGraphqlApiRequest

apiId

  • Type:
  • Required: Yes

GetGraphqlApiResponse

graphqlApi

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetIntrospectionSchemaRequest

apiId

  • Type:
  • Required: Yes

format

  • Type: typing.Literal['JSON', 'SDL']
  • Required: Yes

includeDirectives

  • Type: typing.Optional[bool]

GetIntrospectionSchemaResponse

schema

  • Type:
  • Default: >

ResponseMetadata

  • Type:
  • Required: Yes

GetResolverRequest

apiId

  • Type:
  • Required: Yes

typeName

  • Type:
  • Required: Yes

fieldName

  • Type:
  • Required: Yes

GetResolverResponse

resolver

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetSchemaCreationStatusRequest

apiId

  • Type:
  • Required: Yes

GetSchemaCreationStatusResponse

status

  • Type: typing.Literal['ACTIVE', 'DELETING', 'FAILED', 'NOT_APPLICABLE', 'PROCESSING', 'SUCCESS']
  • Required: Yes

details

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetSourceApiAssociationRequest

mergedApiIdentifier

  • Type:
  • Required: Yes

associationId

  • Type:
  • Required: Yes

GetSourceApiAssociationResponse

sourceApiAssociation

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetTypeRequest

apiId

  • Type:
  • Required: Yes

typeName

  • Type:
  • Required: Yes

format

  • Type: typing.Literal['JSON', 'SDL']
  • Required: Yes

GetTypeResponse

type

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GraphqlApi

name

  • Type: typing.Optional[str]

apiId

  • Type: typing.Optional[str]

authenticationType

  • Type: typing.Optional[typing.Literal['AMAZON_COGNITO_USER_POOLS', 'API_KEY', 'AWS_IAM', 'AWS_LAMBDA', 'OPENID_CONNECT']]

logConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.LogConfig]

userPoolConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.UserPoolConfig]

openIDConnectConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.OpenIDConnectConfig]

arn

  • Type: typing.Optional[str]

uris

  • Type: typing.Optional[typing.Dict[str, str]]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

additionalAuthenticationProviders

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.appsync.appsync_classes.AdditionalAuthenticationProvider]]

xrayEnabled

  • Type: typing.Optional[bool]

wafWebAclArn

  • Type: typing.Optional[str]

lambdaAuthorizerConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.LambdaAuthorizerConfig]

dns

  • Type: typing.Optional[typing.Dict[str, str]]

visibility

  • Type: typing.Optional[typing.Literal['GLOBAL', 'PRIVATE']]

apiType

  • Type: typing.Optional[typing.Literal['GRAPHQL', 'MERGED']]

mergedApiExecutionRoleArn

  • Type: typing.Optional[str]

owner

  • Type: typing.Optional[str]

ownerContact

  • Type: typing.Optional[str]

introspectionConfig

  • Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED']]

queryDepthLimit

  • Type: typing.Optional[int]

resolverCountLimit

  • Type: typing.Optional[int]

enhancedMetricsConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.EnhancedMetricsConfig]

HttpDataSourceConfig

endpoint

  • Type: typing.Optional[str]

authorizationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.AuthorizationConfig]

LambdaAuthorizerConfig

authorizerUri

  • Type:
  • Required: Yes

authorizerResultTtlInSeconds

  • Type: typing.Optional[int]

identityValidationExpression

  • Type: typing.Optional[str]

LambdaConflictHandlerConfig

lambdaConflictHandlerArn

  • Type: typing.Optional[str]

LambdaDataSourceConfig

lambdaFunctionArn

  • Type:
  • Required: Yes

ListApiKeysRequest

apiId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListApiKeysRequestPaginate

apiId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.PaginatorConfig]

ListApiKeysResponse

apiKeys

  • Type: typing.List[aws_resource_validator.pydantic_models.appsync.appsync_classes.ApiKey]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListApisRequest

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListApisRequestPaginate

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.PaginatorConfig]

ListApisResponse

apis

  • Type: typing.List[aws_resource_validator.pydantic_models.appsync.appsync_classes.Api]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListChannelNamespacesRequest

apiId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListChannelNamespacesRequestPaginate

apiId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.PaginatorConfig]

ListChannelNamespacesResponse

channelNamespaces

  • Type: typing.List[aws_resource_validator.pydantic_models.appsync.appsync_classes.ChannelNamespace]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListDataSourcesRequest

apiId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListDataSourcesRequestPaginate

apiId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.PaginatorConfig]

ListDataSourcesResponse

dataSources

  • Type: typing.List[aws_resource_validator.pydantic_models.appsync.appsync_classes.DataSource]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListDomainNamesRequest

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListDomainNamesRequestPaginate

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.PaginatorConfig]

ListDomainNamesResponse

domainNameConfigs

  • Type: typing.List[aws_resource_validator.pydantic_models.appsync.appsync_classes.DomainNameConfig]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListFunctionsRequest

apiId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListFunctionsRequestPaginate

apiId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.PaginatorConfig]

ListFunctionsResponse

functions

  • Type: typing.List[aws_resource_validator.pydantic_models.appsync.appsync_classes.FunctionConfiguration]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListGraphqlApisRequest

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

apiType

  • Type: typing.Optional[typing.Literal['GRAPHQL', 'MERGED']]

owner

  • Type: typing.Optional[typing.Literal['CURRENT_ACCOUNT', 'OTHER_ACCOUNTS']]

ListGraphqlApisRequestPaginate

apiType

  • Type: typing.Optional[typing.Literal['GRAPHQL', 'MERGED']]

owner

  • Type: typing.Optional[typing.Literal['CURRENT_ACCOUNT', 'OTHER_ACCOUNTS']]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.PaginatorConfig]

ListGraphqlApisResponse

graphqlApis

  • Type: typing.List[aws_resource_validator.pydantic_models.appsync.appsync_classes.GraphqlApi]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListResolversByFunctionRequest

apiId

  • Type:
  • Required: Yes

functionId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListResolversByFunctionRequestPaginate

apiId

  • Type:
  • Required: Yes

functionId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.PaginatorConfig]

ListResolversByFunctionResponse

resolvers

  • Type: typing.List[aws_resource_validator.pydantic_models.appsync.appsync_classes.Resolver]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListResolversRequest

apiId

  • Type:
  • Required: Yes

typeName

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListResolversRequestPaginate

apiId

  • Type:
  • Required: Yes

typeName

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.PaginatorConfig]

ListResolversResponse

resolvers

  • Type: typing.List[aws_resource_validator.pydantic_models.appsync.appsync_classes.Resolver]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListSourceApiAssociationsRequest

apiId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListSourceApiAssociationsRequestPaginate

apiId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.PaginatorConfig]

ListSourceApiAssociationsResponse

sourceApiAssociationSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.appsync.appsync_classes.SourceApiAssociationSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListTagsForResourceRequest

resourceArn

  • Type:
  • Required: Yes

ListTagsForResourceResponse

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListTypesByAssociationRequest

mergedApiIdentifier

  • Type:
  • Required: Yes

associationId

  • Type:
  • Required: Yes

format

  • Type: typing.Literal['JSON', 'SDL']
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListTypesByAssociationRequestPaginate

mergedApiIdentifier

  • Type:
  • Required: Yes

associationId

  • Type:
  • Required: Yes

format

  • Type: typing.Literal['JSON', 'SDL']
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.PaginatorConfig]

ListTypesByAssociationResponse

types

  • Type: typing.List[aws_resource_validator.pydantic_models.appsync.appsync_classes.Type]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListTypesRequest

apiId

  • Type:
  • Required: Yes

format

  • Type: typing.Literal['JSON', 'SDL']
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListTypesRequestPaginate

apiId

  • Type:
  • Required: Yes

format

  • Type: typing.Literal['JSON', 'SDL']
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.PaginatorConfig]

ListTypesResponse

types

  • Type: typing.List[aws_resource_validator.pydantic_models.appsync.appsync_classes.Type]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

LogConfig

fieldLogLevel

  • Type: typing.Literal['ALL', 'DEBUG', 'ERROR', 'INFO', 'NONE']
  • Required: Yes

cloudWatchLogsRoleArn

  • Type:
  • Required: Yes

excludeVerboseContent

  • Type: typing.Optional[bool]

OpenIDConnectConfig

issuer

  • Type:
  • Required: Yes

clientId

  • Type: typing.Optional[str]

iatTTL

  • Type: typing.Optional[int]

authTTL

  • Type: typing.Optional[int]

OpenSearchServiceDataSourceConfig

endpoint

  • Type:
  • Required: Yes

awsRegion

  • Type:
  • Required: Yes

PaginatorConfig

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

PipelineConfig

functions

  • Type: typing.Optional[typing.List[str]]

PipelineConfigOutput

functions

  • Type: typing.Optional[typing.List[str]]

PutGraphqlApiEnvironmentVariablesRequest

apiId

  • Type:
  • Required: Yes

environmentVariables

  • Type: typing.Dict[str, str]
  • Required: Yes

PutGraphqlApiEnvironmentVariablesResponse

environmentVariables

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

RdsDataApiConfig

resourceArn

  • Type:
  • Required: Yes

secretArn

  • Type:
  • Required: Yes

databaseName

  • Type:
  • Required: Yes

RdsHttpEndpointConfig

awsRegion

  • Type: typing.Optional[str]

dbClusterIdentifier

  • Type: typing.Optional[str]

databaseName

  • Type: typing.Optional[str]

schema

  • Type: typing.Optional[str]

awsSecretStoreArn

  • Type: typing.Optional[str]

RelationalDatabaseDataSourceConfig

relationalDatabaseSourceType

  • Type: typing.Optional[typing.Literal['RDS_HTTP_ENDPOINT']]

rdsHttpEndpointConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.RdsHttpEndpointConfig]

Resolver

typeName

  • Type: typing.Optional[str]

fieldName

  • Type: typing.Optional[str]

dataSourceName

  • Type: typing.Optional[str]

resolverArn

  • Type: typing.Optional[str]

requestMappingTemplate

  • Type: typing.Optional[str]

responseMappingTemplate

  • Type: typing.Optional[str]

kind

  • Type: typing.Optional[typing.Literal['PIPELINE', 'UNIT']]

pipelineConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.PipelineConfigOutput]

syncConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.SyncConfig]

cachingConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.CachingConfigOutput]

maxBatchSize

  • Type: typing.Optional[int]

runtime

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.AppSyncRuntime]

code

  • Type: typing.Optional[str]

metricsConfig

  • Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED']]

ResponseMetadata

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

SourceApiAssociation

associationId

  • Type: typing.Optional[str]

associationArn

  • Type: typing.Optional[str]

sourceApiId

  • Type: typing.Optional[str]

sourceApiArn

  • Type: typing.Optional[str]

mergedApiArn

  • Type: typing.Optional[str]

mergedApiId

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

sourceApiAssociationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.SourceApiAssociationConfig]

sourceApiAssociationStatus

  • Type: typing.Optional[typing.Literal['AUTO_MERGE_SCHEDULE_FAILED', 'DELETION_FAILED', 'DELETION_IN_PROGRESS', 'DELETION_SCHEDULED', 'MERGE_FAILED', 'MERGE_IN_PROGRESS', 'MERGE_SCHEDULED', 'MERGE_SUCCESS']]

sourceApiAssociationStatusDetail

  • Type: typing.Optional[str]

lastSuccessfulMergeDate

  • Type: typing.Optional[datetime.datetime]

SourceApiAssociationConfig

mergeType

  • Type: typing.Optional[typing.Literal['AUTO_MERGE', 'MANUAL_MERGE']]

SourceApiAssociationSummary

associationId

  • Type: typing.Optional[str]

associationArn

  • Type: typing.Optional[str]

sourceApiId

  • Type: typing.Optional[str]

sourceApiArn

  • Type: typing.Optional[str]

mergedApiId

  • Type: typing.Optional[str]

mergedApiArn

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

StartDataSourceIntrospectionRequest

rdsDataApiConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.RdsDataApiConfig]

StartDataSourceIntrospectionResponse

introspectionId

  • Type:
  • Required: Yes

introspectionStatus

  • Type: typing.Literal['FAILED', 'PROCESSING', 'SUCCESS']
  • Required: Yes

introspectionStatusDetail

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StartSchemaCreationRequest

apiId

  • Type:
  • Required: Yes

definition

  • Type: typing.Union[str, bytes, typing.IO[typing.Any], botocore.response.StreamingBody]
  • Required: Yes

StartSchemaCreationResponse

status

  • Type: typing.Literal['ACTIVE', 'DELETING', 'FAILED', 'NOT_APPLICABLE', 'PROCESSING', 'SUCCESS']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StartSchemaMergeRequest

associationId

  • Type:
  • Required: Yes

mergedApiIdentifier

  • Type:
  • Required: Yes

StartSchemaMergeResponse

sourceApiAssociationStatus

  • Type: typing.Literal['AUTO_MERGE_SCHEDULE_FAILED', 'DELETION_FAILED', 'DELETION_IN_PROGRESS', 'DELETION_SCHEDULED', 'MERGE_FAILED', 'MERGE_IN_PROGRESS', 'MERGE_SCHEDULED', 'MERGE_SUCCESS']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

SyncConfig

conflictHandler

  • Type: typing.Optional[typing.Literal['AUTOMERGE', 'LAMBDA', 'NONE', 'OPTIMISTIC_CONCURRENCY']]

conflictDetection

  • Type: typing.Optional[typing.Literal['NONE', 'VERSION']]

lambdaConflictHandlerConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.LambdaConflictHandlerConfig]

TagResourceRequest

resourceArn

  • Type:
  • Required: Yes

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

Type

name

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

arn

  • Type: typing.Optional[str]

definition

  • Type: typing.Optional[str]

format

  • Type: typing.Optional[typing.Literal['JSON', 'SDL']]

UntagResourceRequest

resourceArn

  • Type:
  • Required: Yes

tagKeys

  • Type: typing.List[str]
  • Required: Yes

UpdateApiCacheRequest

apiId

  • Type:
  • Required: Yes

ttl

  • Type:
  • Required: Yes

apiCachingBehavior

  • Type: typing.Literal['FULL_REQUEST_CACHING', 'OPERATION_LEVEL_CACHING', 'PER_RESOLVER_CACHING']
  • Required: Yes

type

  • Type: typing.Literal['LARGE', 'LARGE_12X', 'LARGE_2X', 'LARGE_4X', 'LARGE_8X', 'MEDIUM', 'R4_2XLARGE', 'R4_4XLARGE', 'R4_8XLARGE', 'R4_LARGE', 'R4_XLARGE', 'SMALL', 'T2_MEDIUM', 'T2_SMALL', 'XLARGE']
  • Required: Yes

healthMetricsConfig

  • Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED']]

UpdateApiCacheResponse

apiCache

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateApiKeyRequest

apiId

  • Type:
  • Required: Yes

id

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

expires

  • Type: typing.Optional[int]

UpdateApiKeyResponse

apiKey

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateApiRequest

apiId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

ownerContact

  • Type: typing.Optional[str]

eventConfig

  • Type: typing.Union[aws_resource_validator.pydantic_models.appsync.appsync_classes.EventConfig, aws_resource_validator.pydantic_models.appsync.appsync_classes.EventConfigOutput, NoneType]

UpdateApiResponse

api

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateChannelNamespaceRequest

apiId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

subscribeAuthModes

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.appsync.appsync_classes.AuthMode]]

publishAuthModes

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.appsync.appsync_classes.AuthMode]]

codeHandlers

  • Type: typing.Optional[str]

UpdateChannelNamespaceResponse

channelNamespace

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateDataSourceRequest

apiId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

type

  • Type: typing.Literal['AMAZON_BEDROCK_RUNTIME', 'AMAZON_DYNAMODB', 'AMAZON_ELASTICSEARCH', 'AMAZON_EVENTBRIDGE', 'AMAZON_OPENSEARCH_SERVICE', 'AWS_LAMBDA', 'HTTP', 'NONE', 'RELATIONAL_DATABASE']
  • Required: Yes

description

  • Type: typing.Optional[str]

serviceRoleArn

  • Type: typing.Optional[str]

dynamodbConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.DynamodbDataSourceConfig]

lambdaConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.LambdaDataSourceConfig]

elasticsearchConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.ElasticsearchDataSourceConfig]

openSearchServiceConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.OpenSearchServiceDataSourceConfig]

httpConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.HttpDataSourceConfig]

relationalDatabaseConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.RelationalDatabaseDataSourceConfig]

eventBridgeConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.EventBridgeDataSourceConfig]

metricsConfig

  • Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED']]

UpdateDataSourceResponse

dataSource

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateDomainNameRequest

domainName

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

UpdateDomainNameResponse

domainNameConfig

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateFunctionRequest

apiId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

functionId

  • Type:
  • Required: Yes

dataSourceName

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

requestMappingTemplate

  • Type: typing.Optional[str]

responseMappingTemplate

  • Type: typing.Optional[str]

functionVersion

  • Type: typing.Optional[str]

syncConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.SyncConfig]

maxBatchSize

  • Type: typing.Optional[int]

runtime

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.AppSyncRuntime]

code

  • Type: typing.Optional[str]

UpdateFunctionResponse

functionConfiguration

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateGraphqlApiRequest

apiId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

authenticationType

  • Type: typing.Literal['AMAZON_COGNITO_USER_POOLS', 'API_KEY', 'AWS_IAM', 'AWS_LAMBDA', 'OPENID_CONNECT']
  • Required: Yes

logConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.LogConfig]

userPoolConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.UserPoolConfig]

openIDConnectConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.OpenIDConnectConfig]

additionalAuthenticationProviders

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.appsync.appsync_classes.AdditionalAuthenticationProvider]]

xrayEnabled

  • Type: typing.Optional[bool]

lambdaAuthorizerConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.LambdaAuthorizerConfig]

mergedApiExecutionRoleArn

  • Type: typing.Optional[str]

ownerContact

  • Type: typing.Optional[str]

introspectionConfig

  • Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED']]

queryDepthLimit

  • Type: typing.Optional[int]

resolverCountLimit

  • Type: typing.Optional[int]

enhancedMetricsConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.EnhancedMetricsConfig]

UpdateGraphqlApiResponse

graphqlApi

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateResolverRequest

apiId

  • Type:
  • Required: Yes

typeName

  • Type:
  • Required: Yes

fieldName

  • Type:
  • Required: Yes

dataSourceName

  • Type: typing.Optional[str]

requestMappingTemplate

  • Type: typing.Optional[str]

responseMappingTemplate

  • Type: typing.Optional[str]

kind

  • Type: typing.Optional[typing.Literal['PIPELINE', 'UNIT']]

pipelineConfig

  • Type: typing.Union[aws_resource_validator.pydantic_models.appsync.appsync_classes.PipelineConfig, aws_resource_validator.pydantic_models.appsync.appsync_classes.PipelineConfigOutput, NoneType]

syncConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.SyncConfig]

cachingConfig

  • Type: typing.Union[aws_resource_validator.pydantic_models.appsync.appsync_classes.CachingConfig, aws_resource_validator.pydantic_models.appsync.appsync_classes.CachingConfigOutput, NoneType]

maxBatchSize

  • Type: typing.Optional[int]

runtime

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.AppSyncRuntime]

code

  • Type: typing.Optional[str]

metricsConfig

  • Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED']]

UpdateResolverResponse

resolver

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateSourceApiAssociationRequest

associationId

  • Type:
  • Required: Yes

mergedApiIdentifier

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

sourceApiAssociationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.appsync.appsync_classes.SourceApiAssociationConfig]

UpdateSourceApiAssociationResponse

sourceApiAssociation

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateTypeRequest

apiId

  • Type:
  • Required: Yes

typeName

  • Type:
  • Required: Yes

format

  • Type: typing.Literal['JSON', 'SDL']
  • Required: Yes

definition

  • Type: typing.Optional[str]

UpdateTypeResponse

type

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UserPoolConfig

userPoolId

  • Type:
  • Required: Yes

awsRegion

  • Type:
  • Required: Yes

defaultAction

  • Type: typing.Literal['ALLOW', 'DENY']
  • Required: Yes

appIdClientRegex

  • Type: typing.Optional[str]