Table of Contents
A low-level client representing AWS AppSync:
import boto3
client = boto3.client('appsync')
These are the available methods:
Check if an operation can be paginated.
Creates a unique key that you can distribute to clients who are executing your API.
See also: AWS API Documentation
Request Syntax
response = client.create_api_key(
apiId='string',
description='string',
expires=123
)
[REQUIRED]
The ID for your GraphQL API.
dict
Response Syntax
{
'apiKey': {
'id': 'string',
'description': 'string',
'expires': 123
}
}
Response Structure
(dict) --
apiKey (dict) --
The API key.
id (string) --
The API key ID.
description (string) --
A description of the purpose of the API key.
expires (integer) --
The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour.
Creates a DataSource object.
See also: AWS API Documentation
Request Syntax
response = client.create_data_source(
apiId='string',
name='string',
description='string',
type='AWS_LAMBDA'|'AMAZON_DYNAMODB'|'AMAZON_ELASTICSEARCH'|'NONE'|'HTTP'|'RELATIONAL_DATABASE',
serviceRoleArn='string',
dynamodbConfig={
'tableName': 'string',
'awsRegion': 'string',
'useCallerCredentials': True|False
},
lambdaConfig={
'lambdaFunctionArn': 'string'
},
elasticsearchConfig={
'endpoint': 'string',
'awsRegion': 'string'
},
httpConfig={
'endpoint': 'string',
'authorizationConfig': {
'authorizationType': 'AWS_IAM',
'awsIamConfig': {
'signingRegion': 'string',
'signingServiceName': 'string'
}
}
},
relationalDatabaseConfig={
'relationalDatabaseSourceType': 'RDS_HTTP_ENDPOINT',
'rdsHttpEndpointConfig': {
'awsRegion': 'string',
'dbClusterIdentifier': 'string',
'databaseName': 'string',
'schema': 'string',
'awsSecretStoreArn': 'string'
}
}
)
[REQUIRED]
The API ID for the GraphQL API for the DataSource .
[REQUIRED]
A user-supplied name for the DataSource .
[REQUIRED]
The type of the DataSource .
Amazon DynamoDB settings.
The table name.
The AWS Region.
Set to TRUE to use Amazon Cognito credentials with this data source.
AWS Lambda settings.
The ARN for the Lambda function.
Amazon Elasticsearch Service settings.
The endpoint.
The AWS Region.
HTTP endpoint settings.
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, AWS AppSync uses the default port 80 for the HTTP endpoint and port 443 for HTTPS endpoints.
The authorization config in case the HTTP endpoint requires authorization.
The authorization type required by the HTTP endpoint.
The AWS IAM settings.
The signing region for AWS IAM authorization.
The signing service name for AWS IAM authorization.
Relational database settings.
Source type for the relational database.
Amazon RDS HTTP endpoint settings.
AWS Region for RDS HTTP endpoint.
Amazon RDS cluster identifier.
Logical database name.
Logical schema name.
AWS secret store ARN for database credentials.
dict
Response Syntax
{
'dataSource': {
'dataSourceArn': 'string',
'name': 'string',
'description': 'string',
'type': 'AWS_LAMBDA'|'AMAZON_DYNAMODB'|'AMAZON_ELASTICSEARCH'|'NONE'|'HTTP'|'RELATIONAL_DATABASE',
'serviceRoleArn': 'string',
'dynamodbConfig': {
'tableName': 'string',
'awsRegion': 'string',
'useCallerCredentials': True|False
},
'lambdaConfig': {
'lambdaFunctionArn': 'string'
},
'elasticsearchConfig': {
'endpoint': 'string',
'awsRegion': 'string'
},
'httpConfig': {
'endpoint': 'string',
'authorizationConfig': {
'authorizationType': 'AWS_IAM',
'awsIamConfig': {
'signingRegion': 'string',
'signingServiceName': 'string'
}
}
},
'relationalDatabaseConfig': {
'relationalDatabaseSourceType': 'RDS_HTTP_ENDPOINT',
'rdsHttpEndpointConfig': {
'awsRegion': 'string',
'dbClusterIdentifier': 'string',
'databaseName': 'string',
'schema': 'string',
'awsSecretStoreArn': 'string'
}
}
}
}
Response Structure
(dict) --
dataSource (dict) --
The DataSource object.
dataSourceArn (string) --
The data source ARN.
name (string) --
The name of the data source.
description (string) --
The description of the data source.
type (string) --
The type of the data source.
serviceRoleArn (string) --
The AWS IAM service role ARN for the data source. The system assumes this role when accessing the data source.
dynamodbConfig (dict) --
Amazon DynamoDB settings.
tableName (string) --
The table name.
awsRegion (string) --
The AWS Region.
useCallerCredentials (boolean) --
Set to TRUE to use Amazon Cognito credentials with this data source.
lambdaConfig (dict) --
AWS Lambda settings.
lambdaFunctionArn (string) --
The ARN for the Lambda function.
elasticsearchConfig (dict) --
Amazon Elasticsearch Service settings.
endpoint (string) --
The endpoint.
awsRegion (string) --
The AWS Region.
httpConfig (dict) --
HTTP endpoint settings.
endpoint (string) --
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, AWS AppSync uses the default port 80 for the HTTP endpoint and port 443 for HTTPS endpoints.
authorizationConfig (dict) --
The authorization config in case the HTTP endpoint requires authorization.
authorizationType (string) --
The authorization type required by the HTTP endpoint.
awsIamConfig (dict) --
The AWS IAM settings.
signingRegion (string) --
The signing region for AWS IAM authorization.
signingServiceName (string) --
The signing service name for AWS IAM authorization.
relationalDatabaseConfig (dict) --
Relational database settings.
relationalDatabaseSourceType (string) --
Source type for the relational database.
rdsHttpEndpointConfig (dict) --
Amazon RDS HTTP endpoint settings.
awsRegion (string) --
AWS Region for RDS HTTP endpoint.
dbClusterIdentifier (string) --
Amazon RDS cluster identifier.
databaseName (string) --
Logical database name.
schema (string) --
Logical schema name.
awsSecretStoreArn (string) --
AWS secret store ARN for database credentials.
Creates a Function object.
A function is a reusable entity. Multiple functions can be used to compose the resolver logic.
See also: AWS API Documentation
Request Syntax
response = client.create_function(
apiId='string',
name='string',
description='string',
dataSourceName='string',
requestMappingTemplate='string',
responseMappingTemplate='string',
functionVersion='string'
)
[REQUIRED]
The GraphQL API ID.
[REQUIRED]
The Function name. The function name does not have to be unique.
[REQUIRED]
The Function DataSource name.
[REQUIRED]
The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
[REQUIRED]
The version of the request mapping template. Currently the supported value is 2018-05-29.
dict
Response Syntax
{
'functionConfiguration': {
'functionId': 'string',
'functionArn': 'string',
'name': 'string',
'description': 'string',
'dataSourceName': 'string',
'requestMappingTemplate': 'string',
'responseMappingTemplate': 'string',
'functionVersion': 'string'
}
}
Response Structure
(dict) --
functionConfiguration (dict) --
The Function object.
functionId (string) --
A unique ID representing the Function object.
functionArn (string) --
The ARN of the Function object.
name (string) --
The name of the Function object.
description (string) --
The Function description.
dataSourceName (string) --
The name of the DataSource .
requestMappingTemplate (string) --
The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
responseMappingTemplate (string) --
The Function response mapping template.
functionVersion (string) --
The version of the request mapping template. Currently only the 2018-05-29 version of the template is supported.
Creates a GraphqlApi object.
See also: AWS API Documentation
Request Syntax
response = client.create_graphql_api(
name='string',
logConfig={
'fieldLogLevel': 'NONE'|'ERROR'|'ALL',
'cloudWatchLogsRoleArn': 'string'
},
authenticationType='API_KEY'|'AWS_IAM'|'AMAZON_COGNITO_USER_POOLS'|'OPENID_CONNECT',
userPoolConfig={
'userPoolId': 'string',
'awsRegion': 'string',
'defaultAction': 'ALLOW'|'DENY',
'appIdClientRegex': 'string'
},
openIDConnectConfig={
'issuer': 'string',
'clientId': 'string',
'iatTTL': 123,
'authTTL': 123
},
tags={
'string': 'string'
},
additionalAuthenticationProviders=[
{
'authenticationType': 'API_KEY'|'AWS_IAM'|'AMAZON_COGNITO_USER_POOLS'|'OPENID_CONNECT',
'openIDConnectConfig': {
'issuer': 'string',
'clientId': 'string',
'iatTTL': 123,
'authTTL': 123
},
'userPoolConfig': {
'userPoolId': 'string',
'awsRegion': 'string',
'appIdClientRegex': 'string'
}
},
]
)
[REQUIRED]
A user-supplied name for the GraphqlApi .
The Amazon CloudWatch Logs configuration.
The field logging level. Values can be NONE, ERROR, or ALL.
The service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in your account.
[REQUIRED]
The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.
The Amazon Cognito user pool configuration.
The user pool ID.
The AWS Region in which the user pool was created.
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.
A regular expression for validating the incoming Amazon Cognito user pool app client ID.
The OpenID Connect configuration.
The issuer for the OpenID Connect configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.
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 AWS AppSync can validate against multiple client identifiers at a time.
The number of milliseconds a token is valid after being issued to a user.
The number of milliseconds a token is valid after being authenticated.
A TagMap object.
The key for the tag.
The value for the tag.
A list of additional authentication providers for the GraphqlApi API.
Describes an additional authentication provider.
The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.
The OpenID Connect configuration.
The issuer for the OpenID Connect configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.
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 AWS AppSync can validate against multiple client identifiers at a time.
The number of milliseconds a token is valid after being issued to a user.
The number of milliseconds a token is valid after being authenticated.
The Amazon Cognito user pool configuration.
The user pool ID.
The AWS Region in which the user pool was created.
A regular expression for validating the incoming Amazon Cognito user pool app client ID.
dict
Response Syntax
{
'graphqlApi': {
'name': 'string',
'apiId': 'string',
'authenticationType': 'API_KEY'|'AWS_IAM'|'AMAZON_COGNITO_USER_POOLS'|'OPENID_CONNECT',
'logConfig': {
'fieldLogLevel': 'NONE'|'ERROR'|'ALL',
'cloudWatchLogsRoleArn': 'string'
},
'userPoolConfig': {
'userPoolId': 'string',
'awsRegion': 'string',
'defaultAction': 'ALLOW'|'DENY',
'appIdClientRegex': 'string'
},
'openIDConnectConfig': {
'issuer': 'string',
'clientId': 'string',
'iatTTL': 123,
'authTTL': 123
},
'arn': 'string',
'uris': {
'string': 'string'
},
'tags': {
'string': 'string'
},
'additionalAuthenticationProviders': [
{
'authenticationType': 'API_KEY'|'AWS_IAM'|'AMAZON_COGNITO_USER_POOLS'|'OPENID_CONNECT',
'openIDConnectConfig': {
'issuer': 'string',
'clientId': 'string',
'iatTTL': 123,
'authTTL': 123
},
'userPoolConfig': {
'userPoolId': 'string',
'awsRegion': 'string',
'appIdClientRegex': 'string'
}
},
]
}
}
Response Structure
(dict) --
graphqlApi (dict) --
The GraphqlApi .
name (string) --
The API name.
apiId (string) --
The API ID.
authenticationType (string) --
The authentication type.
logConfig (dict) --
The Amazon CloudWatch Logs configuration.
fieldLogLevel (string) --
The field logging level. Values can be NONE, ERROR, or ALL.
cloudWatchLogsRoleArn (string) --
The service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in your account.
userPoolConfig (dict) --
The Amazon Cognito user pool configuration.
userPoolId (string) --
The user pool ID.
awsRegion (string) --
The AWS Region in which the user pool was created.
defaultAction (string) --
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.
appIdClientRegex (string) --
A regular expression for validating the incoming Amazon Cognito user pool app client ID.
openIDConnectConfig (dict) --
The OpenID Connect configuration.
issuer (string) --
The issuer for the OpenID Connect configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.
clientId (string) --
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 AWS AppSync can validate against multiple client identifiers at a time.
iatTTL (integer) --
The number of milliseconds a token is valid after being issued to a user.
authTTL (integer) --
The number of milliseconds a token is valid after being authenticated.
arn (string) --
The ARN.
uris (dict) --
The URIs.
tags (dict) --
The tags.
(string) --
The key for the tag.
(string) --
The value for the tag.
additionalAuthenticationProviders (list) --
A list of additional authentication providers for the GraphqlApi API.
(dict) --
Describes an additional authentication provider.
authenticationType (string) --
The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.
openIDConnectConfig (dict) --
The OpenID Connect configuration.
issuer (string) --
The issuer for the OpenID Connect configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.
clientId (string) --
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 AWS AppSync can validate against multiple client identifiers at a time.
iatTTL (integer) --
The number of milliseconds a token is valid after being issued to a user.
authTTL (integer) --
The number of milliseconds a token is valid after being authenticated.
userPoolConfig (dict) --
The Amazon Cognito user pool configuration.
userPoolId (string) --
The user pool ID.
awsRegion (string) --
The AWS Region in which the user pool was created.
appIdClientRegex (string) --
A regular expression for validating the incoming Amazon Cognito user pool app client ID.
Creates a Resolver object.
A resolver converts incoming requests into a format that a data source can understand and converts the data source's responses into GraphQL.
See also: AWS API Documentation
Request Syntax
response = client.create_resolver(
apiId='string',
typeName='string',
fieldName='string',
dataSourceName='string',
requestMappingTemplate='string',
responseMappingTemplate='string',
kind='UNIT'|'PIPELINE',
pipelineConfig={
'functions': [
'string',
]
}
)
[REQUIRED]
The ID for the GraphQL API for which the resolver is being created.
[REQUIRED]
The name of the Type .
[REQUIRED]
The name of the field to attach the resolver to.
[REQUIRED]
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).
The resolver type.
The PipelineConfig .
A list of Function objects.
dict
Response Syntax
{
'resolver': {
'typeName': 'string',
'fieldName': 'string',
'dataSourceName': 'string',
'resolverArn': 'string',
'requestMappingTemplate': 'string',
'responseMappingTemplate': 'string',
'kind': 'UNIT'|'PIPELINE',
'pipelineConfig': {
'functions': [
'string',
]
}
}
}
Response Structure
(dict) --
resolver (dict) --
The Resolver object.
typeName (string) --
The resolver type name.
fieldName (string) --
The resolver field name.
dataSourceName (string) --
The resolver data source name.
resolverArn (string) --
The resolver ARN.
requestMappingTemplate (string) --
The request mapping template.
responseMappingTemplate (string) --
The response mapping template.
kind (string) --
The resolver type.
pipelineConfig (dict) --
The PipelineConfig .
functions (list) --
A list of Function objects.
Creates a Type object.
See also: AWS API Documentation
Request Syntax
response = client.create_type(
apiId='string',
definition='string',
format='SDL'|'JSON'
)
[REQUIRED]
The API ID.
[REQUIRED]
The type definition, in GraphQL Schema Definition Language (SDL) format.
For more information, see the GraphQL SDL documentation .
[REQUIRED]
The type format: SDL or JSON.
dict
Response Syntax
{
'type': {
'name': 'string',
'description': 'string',
'arn': 'string',
'definition': 'string',
'format': 'SDL'|'JSON'
}
}
Response Structure
(dict) --
type (dict) --
The Type object.
name (string) --
The type name.
description (string) --
The type description.
arn (string) --
The type ARN.
definition (string) --
The type definition.
format (string) --
The type format: SDL or JSON.
Deletes an API key.
See also: AWS API Documentation
Request Syntax
response = client.delete_api_key(
apiId='string',
id='string'
)
[REQUIRED]
The API ID.
[REQUIRED]
The ID for the API key.
dict
Response Syntax
{}
Response Structure
Deletes a DataSource object.
See also: AWS API Documentation
Request Syntax
response = client.delete_data_source(
apiId='string',
name='string'
)
[REQUIRED]
The API ID.
[REQUIRED]
The name of the data source.
dict
Response Syntax
{}
Response Structure
Deletes a Function .
See also: AWS API Documentation
Request Syntax
response = client.delete_function(
apiId='string',
functionId='string'
)
[REQUIRED]
The GraphQL API ID.
[REQUIRED]
The Function ID.
dict
Response Syntax
{}
Response Structure
Deletes a GraphqlApi object.
See also: AWS API Documentation
Request Syntax
response = client.delete_graphql_api(
apiId='string'
)
[REQUIRED]
The API ID.
{}
Response Structure
Deletes a Resolver object.
See also: AWS API Documentation
Request Syntax
response = client.delete_resolver(
apiId='string',
typeName='string',
fieldName='string'
)
[REQUIRED]
The API ID.
[REQUIRED]
The name of the resolver type.
[REQUIRED]
The resolver field name.
dict
Response Syntax
{}
Response Structure
Deletes a Type object.
See also: AWS API Documentation
Request Syntax
response = client.delete_type(
apiId='string',
typeName='string'
)
[REQUIRED]
The API ID.
[REQUIRED]
The type name.
dict
Response Syntax
{}
Response Structure
Generate a presigned url given a client, its method, and arguments
The presigned url
Retrieves a DataSource object.
See also: AWS API Documentation
Request Syntax
response = client.get_data_source(
apiId='string',
name='string'
)
[REQUIRED]
The API ID.
[REQUIRED]
The name of the data source.
dict
Response Syntax
{
'dataSource': {
'dataSourceArn': 'string',
'name': 'string',
'description': 'string',
'type': 'AWS_LAMBDA'|'AMAZON_DYNAMODB'|'AMAZON_ELASTICSEARCH'|'NONE'|'HTTP'|'RELATIONAL_DATABASE',
'serviceRoleArn': 'string',
'dynamodbConfig': {
'tableName': 'string',
'awsRegion': 'string',
'useCallerCredentials': True|False
},
'lambdaConfig': {
'lambdaFunctionArn': 'string'
},
'elasticsearchConfig': {
'endpoint': 'string',
'awsRegion': 'string'
},
'httpConfig': {
'endpoint': 'string',
'authorizationConfig': {
'authorizationType': 'AWS_IAM',
'awsIamConfig': {
'signingRegion': 'string',
'signingServiceName': 'string'
}
}
},
'relationalDatabaseConfig': {
'relationalDatabaseSourceType': 'RDS_HTTP_ENDPOINT',
'rdsHttpEndpointConfig': {
'awsRegion': 'string',
'dbClusterIdentifier': 'string',
'databaseName': 'string',
'schema': 'string',
'awsSecretStoreArn': 'string'
}
}
}
}
Response Structure
(dict) --
dataSource (dict) --
The DataSource object.
dataSourceArn (string) --
The data source ARN.
name (string) --
The name of the data source.
description (string) --
The description of the data source.
type (string) --
The type of the data source.
serviceRoleArn (string) --
The AWS IAM service role ARN for the data source. The system assumes this role when accessing the data source.
dynamodbConfig (dict) --
Amazon DynamoDB settings.
tableName (string) --
The table name.
awsRegion (string) --
The AWS Region.
useCallerCredentials (boolean) --
Set to TRUE to use Amazon Cognito credentials with this data source.
lambdaConfig (dict) --
AWS Lambda settings.
lambdaFunctionArn (string) --
The ARN for the Lambda function.
elasticsearchConfig (dict) --
Amazon Elasticsearch Service settings.
endpoint (string) --
The endpoint.
awsRegion (string) --
The AWS Region.
httpConfig (dict) --
HTTP endpoint settings.
endpoint (string) --
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, AWS AppSync uses the default port 80 for the HTTP endpoint and port 443 for HTTPS endpoints.
authorizationConfig (dict) --
The authorization config in case the HTTP endpoint requires authorization.
authorizationType (string) --
The authorization type required by the HTTP endpoint.
awsIamConfig (dict) --
The AWS IAM settings.
signingRegion (string) --
The signing region for AWS IAM authorization.
signingServiceName (string) --
The signing service name for AWS IAM authorization.
relationalDatabaseConfig (dict) --
Relational database settings.
relationalDatabaseSourceType (string) --
Source type for the relational database.
rdsHttpEndpointConfig (dict) --
Amazon RDS HTTP endpoint settings.
awsRegion (string) --
AWS Region for RDS HTTP endpoint.
dbClusterIdentifier (string) --
Amazon RDS cluster identifier.
databaseName (string) --
Logical database name.
schema (string) --
Logical schema name.
awsSecretStoreArn (string) --
AWS secret store ARN for database credentials.
Get a Function .
See also: AWS API Documentation
Request Syntax
response = client.get_function(
apiId='string',
functionId='string'
)
[REQUIRED]
The GraphQL API ID.
[REQUIRED]
The Function ID.
dict
Response Syntax
{
'functionConfiguration': {
'functionId': 'string',
'functionArn': 'string',
'name': 'string',
'description': 'string',
'dataSourceName': 'string',
'requestMappingTemplate': 'string',
'responseMappingTemplate': 'string',
'functionVersion': 'string'
}
}
Response Structure
(dict) --
functionConfiguration (dict) --
The Function object.
functionId (string) --
A unique ID representing the Function object.
functionArn (string) --
The ARN of the Function object.
name (string) --
The name of the Function object.
description (string) --
The Function description.
dataSourceName (string) --
The name of the DataSource .
requestMappingTemplate (string) --
The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
responseMappingTemplate (string) --
The Function response mapping template.
functionVersion (string) --
The version of the request mapping template. Currently only the 2018-05-29 version of the template is supported.
Retrieves a GraphqlApi object.
See also: AWS API Documentation
Request Syntax
response = client.get_graphql_api(
apiId='string'
)
[REQUIRED]
The API ID for the GraphQL API.
{
'graphqlApi': {
'name': 'string',
'apiId': 'string',
'authenticationType': 'API_KEY'|'AWS_IAM'|'AMAZON_COGNITO_USER_POOLS'|'OPENID_CONNECT',
'logConfig': {
'fieldLogLevel': 'NONE'|'ERROR'|'ALL',
'cloudWatchLogsRoleArn': 'string'
},
'userPoolConfig': {
'userPoolId': 'string',
'awsRegion': 'string',
'defaultAction': 'ALLOW'|'DENY',
'appIdClientRegex': 'string'
},
'openIDConnectConfig': {
'issuer': 'string',
'clientId': 'string',
'iatTTL': 123,
'authTTL': 123
},
'arn': 'string',
'uris': {
'string': 'string'
},
'tags': {
'string': 'string'
},
'additionalAuthenticationProviders': [
{
'authenticationType': 'API_KEY'|'AWS_IAM'|'AMAZON_COGNITO_USER_POOLS'|'OPENID_CONNECT',
'openIDConnectConfig': {
'issuer': 'string',
'clientId': 'string',
'iatTTL': 123,
'authTTL': 123
},
'userPoolConfig': {
'userPoolId': 'string',
'awsRegion': 'string',
'appIdClientRegex': 'string'
}
},
]
}
}
Response Structure
The GraphqlApi object.
The API name.
The API ID.
The authentication type.
The Amazon CloudWatch Logs configuration.
The field logging level. Values can be NONE, ERROR, or ALL.
The service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in your account.
The Amazon Cognito user pool configuration.
The user pool ID.
The AWS Region in which the user pool was created.
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.
A regular expression for validating the incoming Amazon Cognito user pool app client ID.
The OpenID Connect configuration.
The issuer for the OpenID Connect configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.
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 AWS AppSync can validate against multiple client identifiers at a time.
The number of milliseconds a token is valid after being issued to a user.
The number of milliseconds a token is valid after being authenticated.
The ARN.
The URIs.
The tags.
The key for the tag.
The value for the tag.
A list of additional authentication providers for the GraphqlApi API.
Describes an additional authentication provider.
The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.
The OpenID Connect configuration.
The issuer for the OpenID Connect configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.
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 AWS AppSync can validate against multiple client identifiers at a time.
The number of milliseconds a token is valid after being issued to a user.
The number of milliseconds a token is valid after being authenticated.
The Amazon Cognito user pool configuration.
The user pool ID.
The AWS Region in which the user pool was created.
A regular expression for validating the incoming Amazon Cognito user pool app client ID.
Retrieves the introspection schema for a GraphQL API.
See also: AWS API Documentation
Request Syntax
response = client.get_introspection_schema(
apiId='string',
format='SDL'|'JSON',
includeDirectives=True|False
)
[REQUIRED]
The API ID.
[REQUIRED]
The schema format: SDL or JSON.
dict
Response Syntax
{
'schema': StreamingBody()
}
Response Structure
(dict) --
schema (StreamingBody) --
The schema, in GraphQL Schema Definition Language (SDL) format.
For more information, see the GraphQL SDL documentation .
Create a paginator for an operation.
Retrieves a Resolver object.
See also: AWS API Documentation
Request Syntax
response = client.get_resolver(
apiId='string',
typeName='string',
fieldName='string'
)
[REQUIRED]
The API ID.
[REQUIRED]
The resolver type name.
[REQUIRED]
The resolver field name.
dict
Response Syntax
{
'resolver': {
'typeName': 'string',
'fieldName': 'string',
'dataSourceName': 'string',
'resolverArn': 'string',
'requestMappingTemplate': 'string',
'responseMappingTemplate': 'string',
'kind': 'UNIT'|'PIPELINE',
'pipelineConfig': {
'functions': [
'string',
]
}
}
}
Response Structure
(dict) --
resolver (dict) --
The Resolver object.
typeName (string) --
The resolver type name.
fieldName (string) --
The resolver field name.
dataSourceName (string) --
The resolver data source name.
resolverArn (string) --
The resolver ARN.
requestMappingTemplate (string) --
The request mapping template.
responseMappingTemplate (string) --
The response mapping template.
kind (string) --
The resolver type.
pipelineConfig (dict) --
The PipelineConfig .
functions (list) --
A list of Function objects.
Retrieves the current status of a schema creation operation.
See also: AWS API Documentation
Request Syntax
response = client.get_schema_creation_status(
apiId='string'
)
[REQUIRED]
The API ID.
{
'status': 'PROCESSING'|'ACTIVE'|'DELETING'|'FAILED'|'SUCCESS'|'NOT_APPLICABLE',
'details': 'string'
}
Response Structure
The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data.
Detailed information about the status of the schema creation operation.
Retrieves a Type object.
See also: AWS API Documentation
Request Syntax
response = client.get_type(
apiId='string',
typeName='string',
format='SDL'|'JSON'
)
[REQUIRED]
The API ID.
[REQUIRED]
The type name.
[REQUIRED]
The type format: SDL or JSON.
dict
Response Syntax
{
'type': {
'name': 'string',
'description': 'string',
'arn': 'string',
'definition': 'string',
'format': 'SDL'|'JSON'
}
}
Response Structure
(dict) --
type (dict) --
The Type object.
name (string) --
The type name.
description (string) --
The type description.
arn (string) --
The type ARN.
definition (string) --
The type definition.
format (string) --
The type format: SDL or JSON.
Returns an object that can wait for some condition.
Lists the API keys for a given API.
Note
API keys are deleted automatically sometime after they expire. However, they may still be included in the response until they have actually been deleted. You can safely call DeleteApiKey to manually delete a key before it's automatically deleted.
See also: AWS API Documentation
Request Syntax
response = client.list_api_keys(
apiId='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
The API ID.
dict
Response Syntax
{
'apiKeys': [
{
'id': 'string',
'description': 'string',
'expires': 123
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
apiKeys (list) --
The ApiKey objects.
(dict) --
Describes an API key.
Customers invoke AWS AppSync GraphQL API operations with API keys as an identity mechanism. There are two key versions:
da1 : This version was introduced at launch in November 2017. These keys always expire after 7 days. Key expiration is managed by Amazon DynamoDB TTL. The keys ceased to be valid after February 21, 2018 and should not be used after that date.
da2 : This version was introduced in February 2018 when AppSync added support to extend key expiration.
id (string) --
The API key ID.
description (string) --
A description of the purpose of the API key.
expires (integer) --
The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour.
nextToken (string) --
An identifier to be passed in the next request to this operation to return the next set of items in the list.
Lists the data sources for a given API.
See also: AWS API Documentation
Request Syntax
response = client.list_data_sources(
apiId='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
The API ID.
dict
Response Syntax
{
'dataSources': [
{
'dataSourceArn': 'string',
'name': 'string',
'description': 'string',
'type': 'AWS_LAMBDA'|'AMAZON_DYNAMODB'|'AMAZON_ELASTICSEARCH'|'NONE'|'HTTP'|'RELATIONAL_DATABASE',
'serviceRoleArn': 'string',
'dynamodbConfig': {
'tableName': 'string',
'awsRegion': 'string',
'useCallerCredentials': True|False
},
'lambdaConfig': {
'lambdaFunctionArn': 'string'
},
'elasticsearchConfig': {
'endpoint': 'string',
'awsRegion': 'string'
},
'httpConfig': {
'endpoint': 'string',
'authorizationConfig': {
'authorizationType': 'AWS_IAM',
'awsIamConfig': {
'signingRegion': 'string',
'signingServiceName': 'string'
}
}
},
'relationalDatabaseConfig': {
'relationalDatabaseSourceType': 'RDS_HTTP_ENDPOINT',
'rdsHttpEndpointConfig': {
'awsRegion': 'string',
'dbClusterIdentifier': 'string',
'databaseName': 'string',
'schema': 'string',
'awsSecretStoreArn': 'string'
}
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
dataSources (list) --
The DataSource objects.
(dict) --
Describes a data source.
dataSourceArn (string) --
The data source ARN.
name (string) --
The name of the data source.
description (string) --
The description of the data source.
type (string) --
The type of the data source.
serviceRoleArn (string) --
The AWS IAM service role ARN for the data source. The system assumes this role when accessing the data source.
dynamodbConfig (dict) --
Amazon DynamoDB settings.
tableName (string) --
The table name.
awsRegion (string) --
The AWS Region.
useCallerCredentials (boolean) --
Set to TRUE to use Amazon Cognito credentials with this data source.
lambdaConfig (dict) --
AWS Lambda settings.
lambdaFunctionArn (string) --
The ARN for the Lambda function.
elasticsearchConfig (dict) --
Amazon Elasticsearch Service settings.
endpoint (string) --
The endpoint.
awsRegion (string) --
The AWS Region.
httpConfig (dict) --
HTTP endpoint settings.
endpoint (string) --
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, AWS AppSync uses the default port 80 for the HTTP endpoint and port 443 for HTTPS endpoints.
authorizationConfig (dict) --
The authorization config in case the HTTP endpoint requires authorization.
authorizationType (string) --
The authorization type required by the HTTP endpoint.
awsIamConfig (dict) --
The AWS IAM settings.
signingRegion (string) --
The signing region for AWS IAM authorization.
signingServiceName (string) --
The signing service name for AWS IAM authorization.
relationalDatabaseConfig (dict) --
Relational database settings.
relationalDatabaseSourceType (string) --
Source type for the relational database.
rdsHttpEndpointConfig (dict) --
Amazon RDS HTTP endpoint settings.
awsRegion (string) --
AWS Region for RDS HTTP endpoint.
dbClusterIdentifier (string) --
Amazon RDS cluster identifier.
databaseName (string) --
Logical database name.
schema (string) --
Logical schema name.
awsSecretStoreArn (string) --
AWS secret store ARN for database credentials.
nextToken (string) --
An identifier to be passed in the next request to this operation to return the next set of items in the list.
List multiple functions.
See also: AWS API Documentation
Request Syntax
response = client.list_functions(
apiId='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
The GraphQL API ID.
dict
Response Syntax
{
'functions': [
{
'functionId': 'string',
'functionArn': 'string',
'name': 'string',
'description': 'string',
'dataSourceName': 'string',
'requestMappingTemplate': 'string',
'responseMappingTemplate': 'string',
'functionVersion': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
functions (list) --
A list of Function objects.
(dict) --
A function is a reusable entity. Multiple functions can be used to compose the resolver logic.
functionId (string) --
A unique ID representing the Function object.
functionArn (string) --
The ARN of the Function object.
name (string) --
The name of the Function object.
description (string) --
The Function description.
dataSourceName (string) --
The name of the DataSource .
requestMappingTemplate (string) --
The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
responseMappingTemplate (string) --
The Function response mapping template.
functionVersion (string) --
The version of the request mapping template. Currently only the 2018-05-29 version of the template is supported.
nextToken (string) --
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.
Lists your GraphQL APIs.
See also: AWS API Documentation
Request Syntax
response = client.list_graphql_apis(
nextToken='string',
maxResults=123
)
dict
Response Syntax
{
'graphqlApis': [
{
'name': 'string',
'apiId': 'string',
'authenticationType': 'API_KEY'|'AWS_IAM'|'AMAZON_COGNITO_USER_POOLS'|'OPENID_CONNECT',
'logConfig': {
'fieldLogLevel': 'NONE'|'ERROR'|'ALL',
'cloudWatchLogsRoleArn': 'string'
},
'userPoolConfig': {
'userPoolId': 'string',
'awsRegion': 'string',
'defaultAction': 'ALLOW'|'DENY',
'appIdClientRegex': 'string'
},
'openIDConnectConfig': {
'issuer': 'string',
'clientId': 'string',
'iatTTL': 123,
'authTTL': 123
},
'arn': 'string',
'uris': {
'string': 'string'
},
'tags': {
'string': 'string'
},
'additionalAuthenticationProviders': [
{
'authenticationType': 'API_KEY'|'AWS_IAM'|'AMAZON_COGNITO_USER_POOLS'|'OPENID_CONNECT',
'openIDConnectConfig': {
'issuer': 'string',
'clientId': 'string',
'iatTTL': 123,
'authTTL': 123
},
'userPoolConfig': {
'userPoolId': 'string',
'awsRegion': 'string',
'appIdClientRegex': 'string'
}
},
]
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
graphqlApis (list) --
The GraphqlApi objects.
(dict) --
Describes a GraphQL API.
name (string) --
The API name.
apiId (string) --
The API ID.
authenticationType (string) --
The authentication type.
logConfig (dict) --
The Amazon CloudWatch Logs configuration.
fieldLogLevel (string) --
The field logging level. Values can be NONE, ERROR, or ALL.
cloudWatchLogsRoleArn (string) --
The service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in your account.
userPoolConfig (dict) --
The Amazon Cognito user pool configuration.
userPoolId (string) --
The user pool ID.
awsRegion (string) --
The AWS Region in which the user pool was created.
defaultAction (string) --
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.
appIdClientRegex (string) --
A regular expression for validating the incoming Amazon Cognito user pool app client ID.
openIDConnectConfig (dict) --
The OpenID Connect configuration.
issuer (string) --
The issuer for the OpenID Connect configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.
clientId (string) --
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 AWS AppSync can validate against multiple client identifiers at a time.
iatTTL (integer) --
The number of milliseconds a token is valid after being issued to a user.
authTTL (integer) --
The number of milliseconds a token is valid after being authenticated.
arn (string) --
The ARN.
uris (dict) --
The URIs.
tags (dict) --
The tags.
(string) --
The key for the tag.
(string) --
The value for the tag.
additionalAuthenticationProviders (list) --
A list of additional authentication providers for the GraphqlApi API.
(dict) --
Describes an additional authentication provider.
authenticationType (string) --
The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.
openIDConnectConfig (dict) --
The OpenID Connect configuration.
issuer (string) --
The issuer for the OpenID Connect configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.
clientId (string) --
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 AWS AppSync can validate against multiple client identifiers at a time.
iatTTL (integer) --
The number of milliseconds a token is valid after being issued to a user.
authTTL (integer) --
The number of milliseconds a token is valid after being authenticated.
userPoolConfig (dict) --
The Amazon Cognito user pool configuration.
userPoolId (string) --
The user pool ID.
awsRegion (string) --
The AWS Region in which the user pool was created.
appIdClientRegex (string) --
A regular expression for validating the incoming Amazon Cognito user pool app client ID.
nextToken (string) --
An identifier to be passed in the next request to this operation to return the next set of items in the list.
Lists the resolvers for a given API and type.
See also: AWS API Documentation
Request Syntax
response = client.list_resolvers(
apiId='string',
typeName='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
The API ID.
[REQUIRED]
The type name.
dict
Response Syntax
{
'resolvers': [
{
'typeName': 'string',
'fieldName': 'string',
'dataSourceName': 'string',
'resolverArn': 'string',
'requestMappingTemplate': 'string',
'responseMappingTemplate': 'string',
'kind': 'UNIT'|'PIPELINE',
'pipelineConfig': {
'functions': [
'string',
]
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
resolvers (list) --
The Resolver objects.
(dict) --
Describes a resolver.
typeName (string) --
The resolver type name.
fieldName (string) --
The resolver field name.
dataSourceName (string) --
The resolver data source name.
resolverArn (string) --
The resolver ARN.
requestMappingTemplate (string) --
The request mapping template.
responseMappingTemplate (string) --
The response mapping template.
kind (string) --
The resolver type.
pipelineConfig (dict) --
The PipelineConfig .
functions (list) --
A list of Function objects.
nextToken (string) --
An identifier to be passed in the next request to this operation to return the next set of items in the list.
List the resolvers that are associated with a specific function.
See also: AWS API Documentation
Request Syntax
response = client.list_resolvers_by_function(
apiId='string',
functionId='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
The API ID.
[REQUIRED]
The Function ID.
dict
Response Syntax
{
'resolvers': [
{
'typeName': 'string',
'fieldName': 'string',
'dataSourceName': 'string',
'resolverArn': 'string',
'requestMappingTemplate': 'string',
'responseMappingTemplate': 'string',
'kind': 'UNIT'|'PIPELINE',
'pipelineConfig': {
'functions': [
'string',
]
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
resolvers (list) --
The list of resolvers.
(dict) --
Describes a resolver.
typeName (string) --
The resolver type name.
fieldName (string) --
The resolver field name.
dataSourceName (string) --
The resolver data source name.
resolverArn (string) --
The resolver ARN.
requestMappingTemplate (string) --
The request mapping template.
responseMappingTemplate (string) --
The response mapping template.
kind (string) --
The resolver type.
pipelineConfig (dict) --
The PipelineConfig .
functions (list) --
A list of Function objects.
nextToken (string) --
An identifier that can be used to return the next set of items in the list.
Lists the tags for a resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
[REQUIRED]
The GraphqlApi ARN.
{
'tags': {
'string': 'string'
}
}
Response Structure
A TagMap object.
The key for the tag.
The value for the tag.
Lists the types for a given API.
See also: AWS API Documentation
Request Syntax
response = client.list_types(
apiId='string',
format='SDL'|'JSON',
nextToken='string',
maxResults=123
)
[REQUIRED]
The API ID.
[REQUIRED]
The type format: SDL or JSON.
dict
Response Syntax
{
'types': [
{
'name': 'string',
'description': 'string',
'arn': 'string',
'definition': 'string',
'format': 'SDL'|'JSON'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
types (list) --
The Type objects.
(dict) --
Describes a type.
name (string) --
The type name.
description (string) --
The type description.
arn (string) --
The type ARN.
definition (string) --
The type definition.
format (string) --
The type format: SDL or JSON.
nextToken (string) --
An identifier to be passed in the next request to this operation to return the next set of items in the list.
Adds a new schema to your GraphQL API.
This operation is asynchronous. Use to determine when it has completed.
See also: AWS API Documentation
Request Syntax
response = client.start_schema_creation(
apiId='string',
definition=b'bytes'
)
[REQUIRED]
The API ID.
[REQUIRED]
The schema definition, in GraphQL schema language format.
dict
Response Syntax
{
'status': 'PROCESSING'|'ACTIVE'|'DELETING'|'FAILED'|'SUCCESS'|'NOT_APPLICABLE'
}
Response Structure
(dict) --
status (string) --
The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data.
Tags a resource with user-supplied tags.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The GraphqlApi ARN.
[REQUIRED]
A TagMap object.
The key for the tag.
The value for the tag.
dict
Response Syntax
{}
Response Structure
Untags a resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
The GraphqlApi ARN.
[REQUIRED]
A list of TagKey objects.
The key for the tag.
dict
Response Syntax
{}
Response Structure
Updates an API key.
See also: AWS API Documentation
Request Syntax
response = client.update_api_key(
apiId='string',
id='string',
description='string',
expires=123
)
[REQUIRED]
The ID for the GraphQL API.
[REQUIRED]
The API key ID.
dict
Response Syntax
{
'apiKey': {
'id': 'string',
'description': 'string',
'expires': 123
}
}
Response Structure
(dict) --
apiKey (dict) --
The API key.
id (string) --
The API key ID.
description (string) --
A description of the purpose of the API key.
expires (integer) --
The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour.
Updates a DataSource object.
See also: AWS API Documentation
Request Syntax
response = client.update_data_source(
apiId='string',
name='string',
description='string',
type='AWS_LAMBDA'|'AMAZON_DYNAMODB'|'AMAZON_ELASTICSEARCH'|'NONE'|'HTTP'|'RELATIONAL_DATABASE',
serviceRoleArn='string',
dynamodbConfig={
'tableName': 'string',
'awsRegion': 'string',
'useCallerCredentials': True|False
},
lambdaConfig={
'lambdaFunctionArn': 'string'
},
elasticsearchConfig={
'endpoint': 'string',
'awsRegion': 'string'
},
httpConfig={
'endpoint': 'string',
'authorizationConfig': {
'authorizationType': 'AWS_IAM',
'awsIamConfig': {
'signingRegion': 'string',
'signingServiceName': 'string'
}
}
},
relationalDatabaseConfig={
'relationalDatabaseSourceType': 'RDS_HTTP_ENDPOINT',
'rdsHttpEndpointConfig': {
'awsRegion': 'string',
'dbClusterIdentifier': 'string',
'databaseName': 'string',
'schema': 'string',
'awsSecretStoreArn': 'string'
}
}
)
[REQUIRED]
The API ID.
[REQUIRED]
The new name for the data source.
[REQUIRED]
The new data source type.
The new Amazon DynamoDB configuration.
The table name.
The AWS Region.
Set to TRUE to use Amazon Cognito credentials with this data source.
The new AWS Lambda configuration.
The ARN for the Lambda function.
The new Elasticsearch Service configuration.
The endpoint.
The AWS Region.
The new HTTP endpoint configuration.
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, AWS AppSync uses the default port 80 for the HTTP endpoint and port 443 for HTTPS endpoints.
The authorization config in case the HTTP endpoint requires authorization.
The authorization type required by the HTTP endpoint.
The AWS IAM settings.
The signing region for AWS IAM authorization.
The signing service name for AWS IAM authorization.
The new relational database configuration.
Source type for the relational database.
Amazon RDS HTTP endpoint settings.
AWS Region for RDS HTTP endpoint.
Amazon RDS cluster identifier.
Logical database name.
Logical schema name.
AWS secret store ARN for database credentials.
dict
Response Syntax
{
'dataSource': {
'dataSourceArn': 'string',
'name': 'string',
'description': 'string',
'type': 'AWS_LAMBDA'|'AMAZON_DYNAMODB'|'AMAZON_ELASTICSEARCH'|'NONE'|'HTTP'|'RELATIONAL_DATABASE',
'serviceRoleArn': 'string',
'dynamodbConfig': {
'tableName': 'string',
'awsRegion': 'string',
'useCallerCredentials': True|False
},
'lambdaConfig': {
'lambdaFunctionArn': 'string'
},
'elasticsearchConfig': {
'endpoint': 'string',
'awsRegion': 'string'
},
'httpConfig': {
'endpoint': 'string',
'authorizationConfig': {
'authorizationType': 'AWS_IAM',
'awsIamConfig': {
'signingRegion': 'string',
'signingServiceName': 'string'
}
}
},
'relationalDatabaseConfig': {
'relationalDatabaseSourceType': 'RDS_HTTP_ENDPOINT',
'rdsHttpEndpointConfig': {
'awsRegion': 'string',
'dbClusterIdentifier': 'string',
'databaseName': 'string',
'schema': 'string',
'awsSecretStoreArn': 'string'
}
}
}
}
Response Structure
(dict) --
dataSource (dict) --
The updated DataSource object.
dataSourceArn (string) --
The data source ARN.
name (string) --
The name of the data source.
description (string) --
The description of the data source.
type (string) --
The type of the data source.
serviceRoleArn (string) --
The AWS IAM service role ARN for the data source. The system assumes this role when accessing the data source.
dynamodbConfig (dict) --
Amazon DynamoDB settings.
tableName (string) --
The table name.
awsRegion (string) --
The AWS Region.
useCallerCredentials (boolean) --
Set to TRUE to use Amazon Cognito credentials with this data source.
lambdaConfig (dict) --
AWS Lambda settings.
lambdaFunctionArn (string) --
The ARN for the Lambda function.
elasticsearchConfig (dict) --
Amazon Elasticsearch Service settings.
endpoint (string) --
The endpoint.
awsRegion (string) --
The AWS Region.
httpConfig (dict) --
HTTP endpoint settings.
endpoint (string) --
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, AWS AppSync uses the default port 80 for the HTTP endpoint and port 443 for HTTPS endpoints.
authorizationConfig (dict) --
The authorization config in case the HTTP endpoint requires authorization.
authorizationType (string) --
The authorization type required by the HTTP endpoint.
awsIamConfig (dict) --
The AWS IAM settings.
signingRegion (string) --
The signing region for AWS IAM authorization.
signingServiceName (string) --
The signing service name for AWS IAM authorization.
relationalDatabaseConfig (dict) --
Relational database settings.
relationalDatabaseSourceType (string) --
Source type for the relational database.
rdsHttpEndpointConfig (dict) --
Amazon RDS HTTP endpoint settings.
awsRegion (string) --
AWS Region for RDS HTTP endpoint.
dbClusterIdentifier (string) --
Amazon RDS cluster identifier.
databaseName (string) --
Logical database name.
schema (string) --
Logical schema name.
awsSecretStoreArn (string) --
AWS secret store ARN for database credentials.
Updates a Function object.
See also: AWS API Documentation
Request Syntax
response = client.update_function(
apiId='string',
name='string',
description='string',
functionId='string',
dataSourceName='string',
requestMappingTemplate='string',
responseMappingTemplate='string',
functionVersion='string'
)
[REQUIRED]
The GraphQL API ID.
[REQUIRED]
The Function name.
[REQUIRED]
The function ID.
[REQUIRED]
The Function DataSource name.
[REQUIRED]
The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
[REQUIRED]
The version of the request mapping template. Currently the supported value is 2018-05-29.
dict
Response Syntax
{
'functionConfiguration': {
'functionId': 'string',
'functionArn': 'string',
'name': 'string',
'description': 'string',
'dataSourceName': 'string',
'requestMappingTemplate': 'string',
'responseMappingTemplate': 'string',
'functionVersion': 'string'
}
}
Response Structure
(dict) --
functionConfiguration (dict) --
The Function object.
functionId (string) --
A unique ID representing the Function object.
functionArn (string) --
The ARN of the Function object.
name (string) --
The name of the Function object.
description (string) --
The Function description.
dataSourceName (string) --
The name of the DataSource .
requestMappingTemplate (string) --
The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
responseMappingTemplate (string) --
The Function response mapping template.
functionVersion (string) --
The version of the request mapping template. Currently only the 2018-05-29 version of the template is supported.
Updates a GraphqlApi object.
See also: AWS API Documentation
Request Syntax
response = client.update_graphql_api(
apiId='string',
name='string',
logConfig={
'fieldLogLevel': 'NONE'|'ERROR'|'ALL',
'cloudWatchLogsRoleArn': 'string'
},
authenticationType='API_KEY'|'AWS_IAM'|'AMAZON_COGNITO_USER_POOLS'|'OPENID_CONNECT',
userPoolConfig={
'userPoolId': 'string',
'awsRegion': 'string',
'defaultAction': 'ALLOW'|'DENY',
'appIdClientRegex': 'string'
},
openIDConnectConfig={
'issuer': 'string',
'clientId': 'string',
'iatTTL': 123,
'authTTL': 123
},
additionalAuthenticationProviders=[
{
'authenticationType': 'API_KEY'|'AWS_IAM'|'AMAZON_COGNITO_USER_POOLS'|'OPENID_CONNECT',
'openIDConnectConfig': {
'issuer': 'string',
'clientId': 'string',
'iatTTL': 123,
'authTTL': 123
},
'userPoolConfig': {
'userPoolId': 'string',
'awsRegion': 'string',
'appIdClientRegex': 'string'
}
},
]
)
[REQUIRED]
The API ID.
[REQUIRED]
The new name for the GraphqlApi object.
The Amazon CloudWatch Logs configuration for the GraphqlApi object.
The field logging level. Values can be NONE, ERROR, or ALL.
The service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in your account.
The new Amazon Cognito user pool configuration for the GraphqlApi object.
The user pool ID.
The AWS Region in which the user pool was created.
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.
A regular expression for validating the incoming Amazon Cognito user pool app client ID.
The OpenID Connect configuration for the GraphqlApi object.
The issuer for the OpenID Connect configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.
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 AWS AppSync can validate against multiple client identifiers at a time.
The number of milliseconds a token is valid after being issued to a user.
The number of milliseconds a token is valid after being authenticated.
A list of additional authentication providers for the GraphqlApi API.
Describes an additional authentication provider.
The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.
The OpenID Connect configuration.
The issuer for the OpenID Connect configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.
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 AWS AppSync can validate against multiple client identifiers at a time.
The number of milliseconds a token is valid after being issued to a user.
The number of milliseconds a token is valid after being authenticated.
The Amazon Cognito user pool configuration.
The user pool ID.
The AWS Region in which the user pool was created.
A regular expression for validating the incoming Amazon Cognito user pool app client ID.
dict
Response Syntax
{
'graphqlApi': {
'name': 'string',
'apiId': 'string',
'authenticationType': 'API_KEY'|'AWS_IAM'|'AMAZON_COGNITO_USER_POOLS'|'OPENID_CONNECT',
'logConfig': {
'fieldLogLevel': 'NONE'|'ERROR'|'ALL',
'cloudWatchLogsRoleArn': 'string'
},
'userPoolConfig': {
'userPoolId': 'string',
'awsRegion': 'string',
'defaultAction': 'ALLOW'|'DENY',
'appIdClientRegex': 'string'
},
'openIDConnectConfig': {
'issuer': 'string',
'clientId': 'string',
'iatTTL': 123,
'authTTL': 123
},
'arn': 'string',
'uris': {
'string': 'string'
},
'tags': {
'string': 'string'
},
'additionalAuthenticationProviders': [
{
'authenticationType': 'API_KEY'|'AWS_IAM'|'AMAZON_COGNITO_USER_POOLS'|'OPENID_CONNECT',
'openIDConnectConfig': {
'issuer': 'string',
'clientId': 'string',
'iatTTL': 123,
'authTTL': 123
},
'userPoolConfig': {
'userPoolId': 'string',
'awsRegion': 'string',
'appIdClientRegex': 'string'
}
},
]
}
}
Response Structure
(dict) --
graphqlApi (dict) --
The updated GraphqlApi object.
name (string) --
The API name.
apiId (string) --
The API ID.
authenticationType (string) --
The authentication type.
logConfig (dict) --
The Amazon CloudWatch Logs configuration.
fieldLogLevel (string) --
The field logging level. Values can be NONE, ERROR, or ALL.
cloudWatchLogsRoleArn (string) --
The service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in your account.
userPoolConfig (dict) --
The Amazon Cognito user pool configuration.
userPoolId (string) --
The user pool ID.
awsRegion (string) --
The AWS Region in which the user pool was created.
defaultAction (string) --
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.
appIdClientRegex (string) --
A regular expression for validating the incoming Amazon Cognito user pool app client ID.
openIDConnectConfig (dict) --
The OpenID Connect configuration.
issuer (string) --
The issuer for the OpenID Connect configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.
clientId (string) --
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 AWS AppSync can validate against multiple client identifiers at a time.
iatTTL (integer) --
The number of milliseconds a token is valid after being issued to a user.
authTTL (integer) --
The number of milliseconds a token is valid after being authenticated.
arn (string) --
The ARN.
uris (dict) --
The URIs.
tags (dict) --
The tags.
(string) --
The key for the tag.
(string) --
The value for the tag.
additionalAuthenticationProviders (list) --
A list of additional authentication providers for the GraphqlApi API.
(dict) --
Describes an additional authentication provider.
authenticationType (string) --
The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.
openIDConnectConfig (dict) --
The OpenID Connect configuration.
issuer (string) --
The issuer for the OpenID Connect configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.
clientId (string) --
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 AWS AppSync can validate against multiple client identifiers at a time.
iatTTL (integer) --
The number of milliseconds a token is valid after being issued to a user.
authTTL (integer) --
The number of milliseconds a token is valid after being authenticated.
userPoolConfig (dict) --
The Amazon Cognito user pool configuration.
userPoolId (string) --
The user pool ID.
awsRegion (string) --
The AWS Region in which the user pool was created.
appIdClientRegex (string) --
A regular expression for validating the incoming Amazon Cognito user pool app client ID.
Updates a Resolver object.
See also: AWS API Documentation
Request Syntax
response = client.update_resolver(
apiId='string',
typeName='string',
fieldName='string',
dataSourceName='string',
requestMappingTemplate='string',
responseMappingTemplate='string',
kind='UNIT'|'PIPELINE',
pipelineConfig={
'functions': [
'string',
]
}
)
[REQUIRED]
The API ID.
[REQUIRED]
The new type name.
[REQUIRED]
The new field name.
[REQUIRED]
The new request mapping template.
The resolver type.
The PipelineConfig .
A list of Function objects.
dict
Response Syntax
{
'resolver': {
'typeName': 'string',
'fieldName': 'string',
'dataSourceName': 'string',
'resolverArn': 'string',
'requestMappingTemplate': 'string',
'responseMappingTemplate': 'string',
'kind': 'UNIT'|'PIPELINE',
'pipelineConfig': {
'functions': [
'string',
]
}
}
}
Response Structure
(dict) --
resolver (dict) --
The updated Resolver object.
typeName (string) --
The resolver type name.
fieldName (string) --
The resolver field name.
dataSourceName (string) --
The resolver data source name.
resolverArn (string) --
The resolver ARN.
requestMappingTemplate (string) --
The request mapping template.
responseMappingTemplate (string) --
The response mapping template.
kind (string) --
The resolver type.
pipelineConfig (dict) --
The PipelineConfig .
functions (list) --
A list of Function objects.
Updates a Type object.
See also: AWS API Documentation
Request Syntax
response = client.update_type(
apiId='string',
typeName='string',
definition='string',
format='SDL'|'JSON'
)
[REQUIRED]
The API ID.
[REQUIRED]
The new type name.
[REQUIRED]
The new type format: SDL or JSON.
dict
Response Syntax
{
'type': {
'name': 'string',
'description': 'string',
'arn': 'string',
'definition': 'string',
'format': 'SDL'|'JSON'
}
}
Response Structure
(dict) --
type (dict) --
The updated Type object.
name (string) --
The type name.
description (string) --
The type description.
arn (string) --
The type ARN.
definition (string) --
The type definition.
format (string) --
The type format: SDL or JSON.
The available paginators are:
paginator = client.get_paginator('list_api_keys')
Creates an iterator that will paginate through responses from AppSync.Client.list_api_keys().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
apiId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The API ID.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'apiKeys': [
{
'id': 'string',
'description': 'string',
'expires': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
apiKeys (list) --
The ApiKey objects.
(dict) --
Describes an API key.
Customers invoke AWS AppSync GraphQL API operations with API keys as an identity mechanism. There are two key versions:
da1 : This version was introduced at launch in November 2017. These keys always expire after 7 days. Key expiration is managed by Amazon DynamoDB TTL. The keys ceased to be valid after February 21, 2018 and should not be used after that date.
da2 : This version was introduced in February 2018 when AppSync added support to extend key expiration.
id (string) --
The API key ID.
description (string) --
A description of the purpose of the API key.
expires (integer) --
The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_data_sources')
Creates an iterator that will paginate through responses from AppSync.Client.list_data_sources().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
apiId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The API ID.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'dataSources': [
{
'dataSourceArn': 'string',
'name': 'string',
'description': 'string',
'type': 'AWS_LAMBDA'|'AMAZON_DYNAMODB'|'AMAZON_ELASTICSEARCH'|'NONE'|'HTTP'|'RELATIONAL_DATABASE',
'serviceRoleArn': 'string',
'dynamodbConfig': {
'tableName': 'string',
'awsRegion': 'string',
'useCallerCredentials': True|False
},
'lambdaConfig': {
'lambdaFunctionArn': 'string'
},
'elasticsearchConfig': {
'endpoint': 'string',
'awsRegion': 'string'
},
'httpConfig': {
'endpoint': 'string',
'authorizationConfig': {
'authorizationType': 'AWS_IAM',
'awsIamConfig': {
'signingRegion': 'string',
'signingServiceName': 'string'
}
}
},
'relationalDatabaseConfig': {
'relationalDatabaseSourceType': 'RDS_HTTP_ENDPOINT',
'rdsHttpEndpointConfig': {
'awsRegion': 'string',
'dbClusterIdentifier': 'string',
'databaseName': 'string',
'schema': 'string',
'awsSecretStoreArn': 'string'
}
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
dataSources (list) --
The DataSource objects.
(dict) --
Describes a data source.
dataSourceArn (string) --
The data source ARN.
name (string) --
The name of the data source.
description (string) --
The description of the data source.
type (string) --
The type of the data source.
serviceRoleArn (string) --
The AWS IAM service role ARN for the data source. The system assumes this role when accessing the data source.
dynamodbConfig (dict) --
Amazon DynamoDB settings.
tableName (string) --
The table name.
awsRegion (string) --
The AWS Region.
useCallerCredentials (boolean) --
Set to TRUE to use Amazon Cognito credentials with this data source.
lambdaConfig (dict) --
AWS Lambda settings.
lambdaFunctionArn (string) --
The ARN for the Lambda function.
elasticsearchConfig (dict) --
Amazon Elasticsearch Service settings.
endpoint (string) --
The endpoint.
awsRegion (string) --
The AWS Region.
httpConfig (dict) --
HTTP endpoint settings.
endpoint (string) --
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, AWS AppSync uses the default port 80 for the HTTP endpoint and port 443 for HTTPS endpoints.
authorizationConfig (dict) --
The authorization config in case the HTTP endpoint requires authorization.
authorizationType (string) --
The authorization type required by the HTTP endpoint.
awsIamConfig (dict) --
The AWS IAM settings.
signingRegion (string) --
The signing region for AWS IAM authorization.
signingServiceName (string) --
The signing service name for AWS IAM authorization.
relationalDatabaseConfig (dict) --
Relational database settings.
relationalDatabaseSourceType (string) --
Source type for the relational database.
rdsHttpEndpointConfig (dict) --
Amazon RDS HTTP endpoint settings.
awsRegion (string) --
AWS Region for RDS HTTP endpoint.
dbClusterIdentifier (string) --
Amazon RDS cluster identifier.
databaseName (string) --
Logical database name.
schema (string) --
Logical schema name.
awsSecretStoreArn (string) --
AWS secret store ARN for database credentials.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_functions')
Creates an iterator that will paginate through responses from AppSync.Client.list_functions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
apiId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The GraphQL API ID.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'functions': [
{
'functionId': 'string',
'functionArn': 'string',
'name': 'string',
'description': 'string',
'dataSourceName': 'string',
'requestMappingTemplate': 'string',
'responseMappingTemplate': 'string',
'functionVersion': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
functions (list) --
A list of Function objects.
(dict) --
A function is a reusable entity. Multiple functions can be used to compose the resolver logic.
functionId (string) --
A unique ID representing the Function object.
functionArn (string) --
The ARN of the Function object.
name (string) --
The name of the Function object.
description (string) --
The Function description.
dataSourceName (string) --
The name of the DataSource .
requestMappingTemplate (string) --
The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
responseMappingTemplate (string) --
The Function response mapping template.
functionVersion (string) --
The version of the request mapping template. Currently only the 2018-05-29 version of the template is supported.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_graphql_apis')
Creates an iterator that will paginate through responses from AppSync.Client.list_graphql_apis().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'graphqlApis': [
{
'name': 'string',
'apiId': 'string',
'authenticationType': 'API_KEY'|'AWS_IAM'|'AMAZON_COGNITO_USER_POOLS'|'OPENID_CONNECT',
'logConfig': {
'fieldLogLevel': 'NONE'|'ERROR'|'ALL',
'cloudWatchLogsRoleArn': 'string'
},
'userPoolConfig': {
'userPoolId': 'string',
'awsRegion': 'string',
'defaultAction': 'ALLOW'|'DENY',
'appIdClientRegex': 'string'
},
'openIDConnectConfig': {
'issuer': 'string',
'clientId': 'string',
'iatTTL': 123,
'authTTL': 123
},
'arn': 'string',
'uris': {
'string': 'string'
},
'tags': {
'string': 'string'
},
'additionalAuthenticationProviders': [
{
'authenticationType': 'API_KEY'|'AWS_IAM'|'AMAZON_COGNITO_USER_POOLS'|'OPENID_CONNECT',
'openIDConnectConfig': {
'issuer': 'string',
'clientId': 'string',
'iatTTL': 123,
'authTTL': 123
},
'userPoolConfig': {
'userPoolId': 'string',
'awsRegion': 'string',
'appIdClientRegex': 'string'
}
},
]
},
],
'NextToken': 'string'
}
Response Structure
The GraphqlApi objects.
Describes a GraphQL API.
The API name.
The API ID.
The authentication type.
The Amazon CloudWatch Logs configuration.
The field logging level. Values can be NONE, ERROR, or ALL.
The service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in your account.
The Amazon Cognito user pool configuration.
The user pool ID.
The AWS Region in which the user pool was created.
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.
A regular expression for validating the incoming Amazon Cognito user pool app client ID.
The OpenID Connect configuration.
The issuer for the OpenID Connect configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.
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 AWS AppSync can validate against multiple client identifiers at a time.
The number of milliseconds a token is valid after being issued to a user.
The number of milliseconds a token is valid after being authenticated.
The ARN.
The URIs.
The tags.
The key for the tag.
The value for the tag.
A list of additional authentication providers for the GraphqlApi API.
Describes an additional authentication provider.
The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.
The OpenID Connect configuration.
The issuer for the OpenID Connect configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.
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 AWS AppSync can validate against multiple client identifiers at a time.
The number of milliseconds a token is valid after being issued to a user.
The number of milliseconds a token is valid after being authenticated.
The Amazon Cognito user pool configuration.
The user pool ID.
The AWS Region in which the user pool was created.
A regular expression for validating the incoming Amazon Cognito user pool app client ID.
A token to resume pagination.
paginator = client.get_paginator('list_resolvers')
Creates an iterator that will paginate through responses from AppSync.Client.list_resolvers().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
apiId='string',
typeName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The API ID.
[REQUIRED]
The type name.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'resolvers': [
{
'typeName': 'string',
'fieldName': 'string',
'dataSourceName': 'string',
'resolverArn': 'string',
'requestMappingTemplate': 'string',
'responseMappingTemplate': 'string',
'kind': 'UNIT'|'PIPELINE',
'pipelineConfig': {
'functions': [
'string',
]
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
resolvers (list) --
The Resolver objects.
(dict) --
Describes a resolver.
typeName (string) --
The resolver type name.
fieldName (string) --
The resolver field name.
dataSourceName (string) --
The resolver data source name.
resolverArn (string) --
The resolver ARN.
requestMappingTemplate (string) --
The request mapping template.
responseMappingTemplate (string) --
The response mapping template.
kind (string) --
The resolver type.
pipelineConfig (dict) --
The PipelineConfig .
functions (list) --
A list of Function objects.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_resolvers_by_function')
Creates an iterator that will paginate through responses from AppSync.Client.list_resolvers_by_function().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
apiId='string',
functionId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The API ID.
[REQUIRED]
The Function ID.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'resolvers': [
{
'typeName': 'string',
'fieldName': 'string',
'dataSourceName': 'string',
'resolverArn': 'string',
'requestMappingTemplate': 'string',
'responseMappingTemplate': 'string',
'kind': 'UNIT'|'PIPELINE',
'pipelineConfig': {
'functions': [
'string',
]
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
resolvers (list) --
The list of resolvers.
(dict) --
Describes a resolver.
typeName (string) --
The resolver type name.
fieldName (string) --
The resolver field name.
dataSourceName (string) --
The resolver data source name.
resolverArn (string) --
The resolver ARN.
requestMappingTemplate (string) --
The request mapping template.
responseMappingTemplate (string) --
The response mapping template.
kind (string) --
The resolver type.
pipelineConfig (dict) --
The PipelineConfig .
functions (list) --
A list of Function objects.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_types')
Creates an iterator that will paginate through responses from AppSync.Client.list_types().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
apiId='string',
format='SDL'|'JSON',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The API ID.
[REQUIRED]
The type format: SDL or JSON.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'types': [
{
'name': 'string',
'description': 'string',
'arn': 'string',
'definition': 'string',
'format': 'SDL'|'JSON'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
types (list) --
The Type objects.
(dict) --
Describes a type.
name (string) --
The type name.
description (string) --
The type description.
arn (string) --
The type ARN.
definition (string) --
The type definition.
format (string) --
The type format: SDL or JSON.
NextToken (string) --
A token to resume pagination.