AppSync ¶

Table of Contents

AppSync
- Client
- Paginators

Client ¶

class AppSync.Client¶

A low-level client representing AWS AppSync:

import boto3

client = boto3.client('appsync')

These are the available methods:

can_paginate(operation_name)¶

Check if an operation can be paginated.

Parameters: operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns: True if the operation can be paginated, False otherwise.

create_api_cache(**kwargs)¶

Creates a cache for the GraphQL API.

See also: AWS API Documentation

Request Syntax

response = client.create_api_cache(
    apiId='string',
    ttl=123,
    transitEncryptionEnabled=True|False,
    atRestEncryptionEnabled=True|False,
    apiCachingBehavior='FULL_REQUEST_CACHING'|'PER_RESOLVER_CACHING',
    type='T2_SMALL'|'T2_MEDIUM'|'R4_LARGE'|'R4_XLARGE'|'R4_2XLARGE'|'R4_4XLARGE'|'R4_8XLARGE'
)

Parameters

apiId (string) --
[REQUIRED]

The GraphQL API Id.
ttl (integer) --
[REQUIRED]

TTL in seconds for cache entries.

Valid values are between 1 and 3600 seconds.
transitEncryptionEnabled (boolean) -- Transit encryption flag when connecting to cache. This setting cannot be updated after creation.
atRestEncryptionEnabled (boolean) -- At rest encryption flag for cache. This setting cannot be updated after creation.
apiCachingBehavior (string) --
[REQUIRED]

Caching behavior.
- FULL_REQUEST_CACHING : All requests are fully cached.
- PER_RESOLVER_CACHING : Individual resovlers that you specify are cached.
type (string) --
[REQUIRED]

The cache instance type.
- T2_SMALL : A t2.small instance type.
- T2_MEDIUM : A t2.medium instance type.
- R4_LARGE : A r4.large instance type.
- R4_XLARGE : A r4.xlarge instance type.
- R4_2XLARGE : A r4.2xlarge instance type.
- R4_4XLARGE : A r4.4xlarge instance type.
- R4_8XLARGE : A r4.8xlarge instance type.

Return type

dict

Returns

Response Syntax

{
    'apiCache': {
        'ttl': 123,
        'apiCachingBehavior': 'FULL_REQUEST_CACHING'|'PER_RESOLVER_CACHING',
        'transitEncryptionEnabled': True|False,
        'atRestEncryptionEnabled': True|False,
        'type': 'T2_SMALL'|'T2_MEDIUM'|'R4_LARGE'|'R4_XLARGE'|'R4_2XLARGE'|'R4_4XLARGE'|'R4_8XLARGE',
        'status': 'AVAILABLE'|'CREATING'|'DELETING'|'MODIFYING'|'FAILED'
    }
}

Response Structure

(dict) --

Represents the output of a CreateApiCache operation.
- apiCache (dict) --
  
  The ApiCache object.
  - ttl (integer) --
    
    TTL in seconds for cache entries.
    
    Valid values are between 1 and 3600 seconds.
  - apiCachingBehavior (string) --
    
    Caching behavior.
    - FULL_REQUEST_CACHING : All requests are fully cached.
    - PER_RESOLVER_CACHING : Individual resovlers that you specify are cached.
  - transitEncryptionEnabled (boolean) --
    
    Transit encryption flag when connecting to cache. This setting cannot be updated after creation.
  - atRestEncryptionEnabled (boolean) --
    
    At rest encryption flag for cache. This setting cannot be updated after creation.
  - type (string) --
    
    The cache instance type.
    - T2_SMALL : A t2.small instance type.
    - T2_MEDIUM : A t2.medium instance type.
    - R4_LARGE : A r4.large instance type.
    - R4_XLARGE : A r4.xlarge instance type.
    - R4_2XLARGE : A r4.2xlarge instance type.
    - R4_4XLARGE : A r4.4xlarge instance type.
    - R4_8XLARGE : A r4.8xlarge instance type.
  - status (string) --
    
    The cache instance status.
    - AVAILABLE : The instance is available for use.
    - CREATING : The instance is currently creating.
    - DELETING : The instance is currently deleting.
    - MODIFYING : The instance is currently modifying.
    - FAILED : The instance has failed creation.

Exceptions

AppSync.Client.exceptions.BadRequestException
AppSync.Client.exceptions.ConcurrentModificationException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException

create_api_key(**kwargs)¶

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
)

Parameters

apiId (string) --
[REQUIRED]

The ID for your GraphQL API.
description (string) -- A description of the purpose of the API key.
expires (integer) -- The time from creation time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour. The default value for this parameter is 7 days from creation time. For more information, see .

Return type

dict

Returns

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.

Exceptions

AppSync.Client.exceptions.BadRequestException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.LimitExceededException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.LimitExceededException
AppSync.Client.exceptions.InternalFailureException
AppSync.Client.exceptions.ApiKeyLimitExceededException
AppSync.Client.exceptions.ApiKeyValidityOutOfBoundsException

create_data_source(**kwargs)¶

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,
        'deltaSyncConfig': {
            'baseTableTTL': 123,
            'deltaSyncTableName': 'string',
            'deltaSyncTableTTL': 123
        },
        'versioned': 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'
        }
    }
)

Parameters

apiId (string) --
[REQUIRED]

The API ID for the GraphQL API for the DataSource .
name (string) --
[REQUIRED]

A user-supplied name for the DataSource .
description (string) -- A description of the DataSource .
type (string) --
[REQUIRED]

The type of the DataSource .
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) -- [REQUIRED]
  The table name.
- awsRegion (string) -- [REQUIRED]
  The AWS Region.
- useCallerCredentials (boolean) --
  Set to TRUE to use Amazon Cognito credentials with this data source.
- deltaSyncConfig (dict) --
  The DeltaSyncConfig for a versioned datasource.
  - baseTableTTL (integer) --
    The number of minutes an Item is stored in the datasource.
  - deltaSyncTableName (string) --
    The Delta Sync table name.
  - deltaSyncTableTTL (integer) --
    The number of minutes a Delta Sync log entry is stored in the Delta Sync table.
- versioned (boolean) --
  Set to TRUE to use Conflict Detection and Resolution with this data source.
lambdaConfig (dict) --
AWS Lambda settings.
- lambdaFunctionArn (string) -- [REQUIRED]
  The ARN for the Lambda function.
elasticsearchConfig (dict) --
Amazon Elasticsearch Service settings.
- endpoint (string) -- [REQUIRED]
  The endpoint.
- awsRegion (string) -- [REQUIRED]
  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) -- [REQUIRED]
    The authorization type required by the HTTP endpoint.
    - AWS_IAM : The authorization type is Sigv4.
  - 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.
  - RDS_HTTP_ENDPOINT : The relational database source type is an Amazon RDS HTTP endpoint.
- 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.

Return type

dict

Returns

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,
            'deltaSyncConfig': {
                'baseTableTTL': 123,
                'deltaSyncTableName': 'string',
                'deltaSyncTableTTL': 123
            },
            'versioned': 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.
    - AMAZON_DYNAMODB : The data source is an Amazon DynamoDB table.
    - AMAZON_ELASTICSEARCH : The data source is an Amazon Elasticsearch Service domain.
    - AWS_LAMBDA : The data source is an AWS Lambda function.
    - NONE : There is no data source. This type is used when you wish to invoke a GraphQL operation without connecting to a data source, such as performing data transformation with resolvers or triggering a subscription to be invoked from a mutation.
    - HTTP : The data source is an HTTP endpoint.
    - RELATIONAL_DATABASE : The data source is a relational database.
  - 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.
    - deltaSyncConfig (dict) --
      
      The DeltaSyncConfig for a versioned datasource.
      - baseTableTTL (integer) --
        
        The number of minutes an Item is stored in the datasource.
      - deltaSyncTableName (string) --
        
        The Delta Sync table name.
      - deltaSyncTableTTL (integer) --
        
        The number of minutes a Delta Sync log entry is stored in the Delta Sync table.
    - versioned (boolean) --
      
      Set to TRUE to use Conflict Detection and Resolution 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.
        
        AWS_IAM : The authorization type is Sigv4.
      - 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.
      - RDS_HTTP_ENDPOINT : The relational database source type is an Amazon RDS HTTP endpoint.
    - 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.

Exceptions

AppSync.Client.exceptions.BadRequestException
AppSync.Client.exceptions.ConcurrentModificationException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException

create_function(**kwargs)¶

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'
)

Parameters

apiId (string) --
[REQUIRED]

The GraphQL API ID.
name (string) --
[REQUIRED]

The Function name. The function name does not have to be unique.
description (string) -- The Function description.
dataSourceName (string) --
[REQUIRED]

The Function DataSource name.
requestMappingTemplate (string) --
[REQUIRED]

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) --
[REQUIRED]

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

Return type

dict

Returns

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.

Exceptions

AppSync.Client.exceptions.ConcurrentModificationException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException

create_graphql_api(**kwargs)¶

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',
        'excludeVerboseContent': True|False
    },
    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'
            }
        },
    ],
    xrayEnabled=True|False
)

Parameters

name (string) --
[REQUIRED]

A user-supplied name for the GraphqlApi .
logConfig (dict) --
The Amazon CloudWatch Logs configuration.
- fieldLogLevel (string) -- [REQUIRED]
  The field logging level. Values can be NONE, ERROR, or ALL.
  - NONE : No field-level logs are captured.
  - ERROR : Logs the following information only for the fields that are in error:
    - The error section in the server response.
    - Field-level errors.
    - The generated request/response functions that got resolved for error fields.
  - ALL : The following information is logged for all fields in the query:
    - Field-level tracing information.
    - The generated request/response functions that got resolved for each field.
- cloudWatchLogsRoleArn (string) -- [REQUIRED]
  The service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in your account.
- excludeVerboseContent (boolean) --
  Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.
authenticationType (string) --
[REQUIRED]

The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.
userPoolConfig (dict) --
The Amazon Cognito user pool configuration.
- userPoolId (string) -- [REQUIRED]
  The user pool ID.
- awsRegion (string) -- [REQUIRED]
  The AWS Region in which the user pool was created.
- defaultAction (string) -- [REQUIRED]
  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) -- [REQUIRED]
  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.
tags (dict) --
A TagMap object.
- (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) -- [REQUIRED]
      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) -- [REQUIRED]
      The user pool ID.
    - awsRegion (string) -- [REQUIRED]
      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.
xrayEnabled (boolean) -- A flag indicating whether to enable X-Ray tracing for the GraphqlApi .

Return type

dict

Returns

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',
            'excludeVerboseContent': True|False
        },
        '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'
                }
            },
        ],
        'xrayEnabled': True|False
    }
}

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.
      - NONE : No field-level logs are captured.
      - ERROR : Logs the following information only for the fields that are in error:
        
        The error section in the server response.
        
        Field-level errors.
        
        The generated request/response functions that got resolved for error fields.
      - ALL : The following information is logged for all fields in the query:
        
        Field-level tracing information.
        
        The generated request/response functions that got resolved for each field.
    - cloudWatchLogsRoleArn (string) --
      
      The service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in your account.
    - excludeVerboseContent (boolean) --
      
      Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.
  - 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.
    - (string) --
      - (string) --
  - 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.
  - xrayEnabled (boolean) --
    
    A flag representing whether X-Ray tracing is enabled for this GraphqlApi .

Exceptions

AppSync.Client.exceptions.BadRequestException
AppSync.Client.exceptions.LimitExceededException
AppSync.Client.exceptions.ConcurrentModificationException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException
AppSync.Client.exceptions.ApiLimitExceededException

create_resolver(**kwargs)¶

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',
        ]
    },
    syncConfig={
        'conflictHandler': 'OPTIMISTIC_CONCURRENCY'|'LAMBDA'|'AUTOMERGE'|'NONE',
        'conflictDetection': 'VERSION'|'NONE',
        'lambdaConflictHandlerConfig': {
            'lambdaConflictHandlerArn': 'string'
        }
    },
    cachingConfig={
        'ttl': 123,
        'cachingKeys': [
            'string',
        ]
    }
)

Parameters

apiId (string) --
[REQUIRED]

The ID for the GraphQL API for which the resolver is being created.
typeName (string) --
[REQUIRED]

The name of the Type .
fieldName (string) --
[REQUIRED]

The name of the field to attach the resolver to.
dataSourceName (string) -- The name of the data source for which the resolver is being created.
requestMappingTemplate (string) --
[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).
responseMappingTemplate (string) -- The mapping template to be used for responses from the data source.
kind (string) --
The resolver type.
- UNIT : A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source.
- PIPELINE : A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series of Function in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.
pipelineConfig (dict) --
The PipelineConfig .
- functions (list) --
  A list of Function objects.
  - (string) --
syncConfig (dict) --
The SyncConfig for a resolver attached to a versioned datasource.
- conflictHandler (string) --
  The Conflict Resolution strategy to perform in the event of a conflict.
  - OPTIMISTIC_CONCURRENCY : Resolve conflicts by rejecting mutations when versions do not match the latest version at the server.
  - AUTOMERGE : Resolve conflicts with the Automerge conflict resolution strategy.
  - LAMBDA : Resolve conflicts with a Lambda function supplied in the LambdaConflictHandlerConfig.
- conflictDetection (string) --
  The Conflict Detection strategy to use.
  - VERSION : Detect conflicts based on object versions for this resolver.
  - NONE : Do not detect conflicts when executing this resolver.
- lambdaConflictHandlerConfig (dict) --
  The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.
  - lambdaConflictHandlerArn (string) --
    The Arn for the Lambda function to use as the Conflict Handler.
cachingConfig (dict) --
The caching configuration for the resolver.
- ttl (integer) --
  The TTL in seconds for a resolver that has caching enabled.
  
  Valid values are between 1 and 3600 seconds.
- cachingKeys (list) --
  The caching keys for a resolver that has caching enabled.
  
  Valid values are entries from the $context.identity and $context.arguments maps.
  - (string) --

Return type

dict

Returns

Response Syntax

{
    'resolver': {
        'typeName': 'string',
        'fieldName': 'string',
        'dataSourceName': 'string',
        'resolverArn': 'string',
        'requestMappingTemplate': 'string',
        'responseMappingTemplate': 'string',
        'kind': 'UNIT'|'PIPELINE',
        'pipelineConfig': {
            'functions': [
                'string',
            ]
        },
        'syncConfig': {
            'conflictHandler': 'OPTIMISTIC_CONCURRENCY'|'LAMBDA'|'AUTOMERGE'|'NONE',
            'conflictDetection': 'VERSION'|'NONE',
            'lambdaConflictHandlerConfig': {
                'lambdaConflictHandlerArn': 'string'
            }
        },
        'cachingConfig': {
            'ttl': 123,
            'cachingKeys': [
                '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.
    - UNIT : A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source.
    - PIPELINE : A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series of Function in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.
  - pipelineConfig (dict) --
    
    The PipelineConfig .
    - functions (list) --
      
      A list of Function objects.
      - (string) --
  - syncConfig (dict) --
    
    The SyncConfig for a resolver attached to a versioned datasource.
    - conflictHandler (string) --
      
      The Conflict Resolution strategy to perform in the event of a conflict.
      - OPTIMISTIC_CONCURRENCY : Resolve conflicts by rejecting mutations when versions do not match the latest version at the server.
      - AUTOMERGE : Resolve conflicts with the Automerge conflict resolution strategy.
      - LAMBDA : Resolve conflicts with a Lambda function supplied in the LambdaConflictHandlerConfig.
    - conflictDetection (string) --
      
      The Conflict Detection strategy to use.
      - VERSION : Detect conflicts based on object versions for this resolver.
      - NONE : Do not detect conflicts when executing this resolver.
    - lambdaConflictHandlerConfig (dict) --
      
      The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.
      - lambdaConflictHandlerArn (string) --
        
        The Arn for the Lambda function to use as the Conflict Handler.
  - cachingConfig (dict) --
    
    The caching configuration for the resolver.
    - ttl (integer) --
      
      The TTL in seconds for a resolver that has caching enabled.
      
      Valid values are between 1 and 3600 seconds.
    - cachingKeys (list) --
      
      The caching keys for a resolver that has caching enabled.
      
      Valid values are entries from the $context.identity and $context.arguments maps.
      - (string) --

Exceptions

AppSync.Client.exceptions.ConcurrentModificationException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException

create_type(**kwargs)¶

Creates a Type object.

See also: AWS API Documentation

Request Syntax

response = client.create_type(
    apiId='string',
    definition='string',
    format='SDL'|'JSON'
)

Parameters

apiId (string) --
[REQUIRED]

The API ID.
definition (string) --
[REQUIRED]

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

For more information, see the GraphQL SDL documentation .
format (string) --
[REQUIRED]

The type format: SDL or JSON.

Return type

dict

Returns

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.

Exceptions

AppSync.Client.exceptions.BadRequestException
AppSync.Client.exceptions.ConcurrentModificationException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException

delete_api_cache(**kwargs)¶

Deletes an ApiCache object.

See also: AWS API Documentation

Request Syntax

response = client.delete_api_cache(
    apiId='string'
)

Parameters

apiId (string) --

[REQUIRED]

The API ID.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --
Represents the output of a DeleteApiCache operation.

Exceptions

AppSync.Client.exceptions.BadRequestException
AppSync.Client.exceptions.ConcurrentModificationException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException

delete_api_key(**kwargs)¶

Deletes an API key.

See also: AWS API Documentation

Request Syntax

response = client.delete_api_key(
    apiId='string',
    id='string'
)

Parameters

apiId (string) --
[REQUIRED]

The API ID.
id (string) --
[REQUIRED]

The ID for the API key.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

AppSync.Client.exceptions.BadRequestException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException

delete_data_source(**kwargs)¶

Deletes a DataSource object.

See also: AWS API Documentation

Request Syntax

response = client.delete_data_source(
    apiId='string',
    name='string'
)

Parameters

apiId (string) --
[REQUIRED]

The API ID.
name (string) --
[REQUIRED]

The name of the data source.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

AppSync.Client.exceptions.BadRequestException
AppSync.Client.exceptions.ConcurrentModificationException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException

delete_function(**kwargs)¶

Deletes a Function .

See also: AWS API Documentation

Request Syntax

response = client.delete_function(
    apiId='string',
    functionId='string'
)

Parameters

apiId (string) --
[REQUIRED]

The GraphQL API ID.
functionId (string) --
[REQUIRED]

The Function ID.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

AppSync.Client.exceptions.ConcurrentModificationException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException

delete_graphql_api(**kwargs)¶

Deletes a GraphqlApi object.

See also: AWS API Documentation

Request Syntax

response = client.delete_graphql_api(
    apiId='string'
)

Parameters

apiId (string) --

[REQUIRED]

The API ID.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

AppSync.Client.exceptions.BadRequestException
AppSync.Client.exceptions.ConcurrentModificationException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException
AppSync.Client.exceptions.AccessDeniedException

delete_resolver(**kwargs)¶

Deletes a Resolver object.

See also: AWS API Documentation

Request Syntax

response = client.delete_resolver(
    apiId='string',
    typeName='string',
    fieldName='string'
)

Parameters

apiId (string) --
[REQUIRED]

The API ID.
typeName (string) --
[REQUIRED]

The name of the resolver type.
fieldName (string) --
[REQUIRED]

The resolver field name.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

AppSync.Client.exceptions.ConcurrentModificationException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException

delete_type(**kwargs)¶

Deletes a Type object.

See also: AWS API Documentation

Request Syntax

response = client.delete_type(
    apiId='string',
    typeName='string'
)

Parameters

apiId (string) --
[REQUIRED]

The API ID.
typeName (string) --
[REQUIRED]

The type name.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

AppSync.Client.exceptions.BadRequestException
AppSync.Client.exceptions.ConcurrentModificationException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException

flush_api_cache(**kwargs)¶

Flushes an ApiCache object.

See also: AWS API Documentation

Request Syntax

response = client.flush_api_cache(
    apiId='string'
)

Parameters

apiId (string) --

[REQUIRED]

The API ID.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --
Represents the output of a FlushApiCache operation.

Exceptions

AppSync.Client.exceptions.BadRequestException
AppSync.Client.exceptions.ConcurrentModificationException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶

Generate a presigned url given a client, its method, and arguments

Parameters

ClientMethod (string) -- The client method to presign for
Params (dict) -- The parameters normally passed to ClientMethod.
ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.

Returns

The presigned url

get_api_cache(**kwargs)¶

Retrieves an ApiCache object.

See also: AWS API Documentation

Request Syntax

response = client.get_api_cache(
    apiId='string'
)

Parameters

apiId (string) --

[REQUIRED]

The API ID.

Return type

dict

Returns

Response Syntax

{
    'apiCache': {
        'ttl': 123,
        'apiCachingBehavior': 'FULL_REQUEST_CACHING'|'PER_RESOLVER_CACHING',
        'transitEncryptionEnabled': True|False,
        'atRestEncryptionEnabled': True|False,
        'type': 'T2_SMALL'|'T2_MEDIUM'|'R4_LARGE'|'R4_XLARGE'|'R4_2XLARGE'|'R4_4XLARGE'|'R4_8XLARGE',
        'status': 'AVAILABLE'|'CREATING'|'DELETING'|'MODIFYING'|'FAILED'
    }
}

Response Structure

(dict) --
Represents the output of a GetApiCache operation.
- apiCache (dict) --
  The ApiCache object.
  - ttl (integer) --
    TTL in seconds for cache entries.
    
    Valid values are between 1 and 3600 seconds.
  - apiCachingBehavior (string) --
    Caching behavior.
    - FULL_REQUEST_CACHING : All requests are fully cached.
    - PER_RESOLVER_CACHING : Individual resovlers that you specify are cached.
  - transitEncryptionEnabled (boolean) --
    Transit encryption flag when connecting to cache. This setting cannot be updated after creation.
  - atRestEncryptionEnabled (boolean) --
    At rest encryption flag for cache. This setting cannot be updated after creation.
  - type (string) --
    The cache instance type.
    - T2_SMALL : A t2.small instance type.
    - T2_MEDIUM : A t2.medium instance type.
    - R4_LARGE : A r4.large instance type.
    - R4_XLARGE : A r4.xlarge instance type.
    - R4_2XLARGE : A r4.2xlarge instance type.
    - R4_4XLARGE : A r4.4xlarge instance type.
    - R4_8XLARGE : A r4.8xlarge instance type.
  - status (string) --
    The cache instance status.
    - AVAILABLE : The instance is available for use.
    - CREATING : The instance is currently creating.
    - DELETING : The instance is currently deleting.
    - MODIFYING : The instance is currently modifying.
    - FAILED : The instance has failed creation.

Exceptions

AppSync.Client.exceptions.BadRequestException
AppSync.Client.exceptions.ConcurrentModificationException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException

get_data_source(**kwargs)¶

Retrieves a DataSource object.

See also: AWS API Documentation

Request Syntax

response = client.get_data_source(
    apiId='string',
    name='string'
)

Parameters

apiId (string) --
[REQUIRED]

The API ID.
name (string) --
[REQUIRED]

The name of the data source.

Return type

dict

Returns

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,
            'deltaSyncConfig': {
                'baseTableTTL': 123,
                'deltaSyncTableName': 'string',
                'deltaSyncTableTTL': 123
            },
            'versioned': 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.
    - AMAZON_DYNAMODB : The data source is an Amazon DynamoDB table.
    - AMAZON_ELASTICSEARCH : The data source is an Amazon Elasticsearch Service domain.
    - AWS_LAMBDA : The data source is an AWS Lambda function.
    - NONE : There is no data source. This type is used when you wish to invoke a GraphQL operation without connecting to a data source, such as performing data transformation with resolvers or triggering a subscription to be invoked from a mutation.
    - HTTP : The data source is an HTTP endpoint.
    - RELATIONAL_DATABASE : The data source is a relational database.
  - 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.
    - deltaSyncConfig (dict) --
      
      The DeltaSyncConfig for a versioned datasource.
      - baseTableTTL (integer) --
        
        The number of minutes an Item is stored in the datasource.
      - deltaSyncTableName (string) --
        
        The Delta Sync table name.
      - deltaSyncTableTTL (integer) --
        
        The number of minutes a Delta Sync log entry is stored in the Delta Sync table.
    - versioned (boolean) --
      
      Set to TRUE to use Conflict Detection and Resolution 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.
        
        AWS_IAM : The authorization type is Sigv4.
      - 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.
      - RDS_HTTP_ENDPOINT : The relational database source type is an Amazon RDS HTTP endpoint.
    - 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.

Exceptions

AppSync.Client.exceptions.BadRequestException
AppSync.Client.exceptions.ConcurrentModificationException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException

get_function(**kwargs)¶

Get a Function .

See also: AWS API Documentation

Request Syntax

response = client.get_function(
    apiId='string',
    functionId='string'
)

Parameters

apiId (string) --
[REQUIRED]

The GraphQL API ID.
functionId (string) --
[REQUIRED]

The Function ID.

Return type

dict

Returns

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.

Exceptions

AppSync.Client.exceptions.ConcurrentModificationException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.UnauthorizedException

get_graphql_api(**kwargs)¶

Retrieves a GraphqlApi object.

See also: AWS API Documentation

Request Syntax

response = client.get_graphql_api(
    apiId='string'
)

Parameters

apiId (string) --

[REQUIRED]

The API ID for the GraphQL API.

Return type

dict

Returns

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',
            'excludeVerboseContent': True|False
        },
        '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'
                }
            },
        ],
        'xrayEnabled': True|False
    }
}

Response Structure

(dict) --
- graphqlApi (dict) --
  The 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.
      - NONE : No field-level logs are captured.
      - ERROR : Logs the following information only for the fields that are in error:
        
        The error section in the server response.
        
        Field-level errors.
        
        The generated request/response functions that got resolved for error fields.
      - ALL : The following information is logged for all fields in the query:
        
        Field-level tracing information.
        
        The generated request/response functions that got resolved for each field.
    - cloudWatchLogsRoleArn (string) --
      The service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in your account.
    - excludeVerboseContent (boolean) --
      Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.
  - 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.
    - (string) --
      - (string) --
  - 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.
  - xrayEnabled (boolean) --
    A flag representing whether X-Ray tracing is enabled for this GraphqlApi .

Exceptions

AppSync.Client.exceptions.BadRequestException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException
AppSync.Client.exceptions.AccessDeniedException

get_introspection_schema(**kwargs)¶

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
)

Parameters

apiId (string) --
[REQUIRED]

The API ID.
format (string) --
[REQUIRED]

The schema format: SDL or JSON.
includeDirectives (boolean) -- A flag that specifies whether the schema introspection should contain directives.

Return type

dict

Returns

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 .

Exceptions

AppSync.Client.exceptions.GraphQLSchemaException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException

get_paginator(operation_name)¶

Create a paginator for an operation.

Parameters: operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError: Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type: L{botocore.paginate.Paginator}
Returns: A paginator object.

get_resolver(**kwargs)¶

Retrieves a Resolver object.

See also: AWS API Documentation

Request Syntax

response = client.get_resolver(
    apiId='string',
    typeName='string',
    fieldName='string'
)

Parameters

apiId (string) --
[REQUIRED]

The API ID.
typeName (string) --
[REQUIRED]

The resolver type name.
fieldName (string) --
[REQUIRED]

The resolver field name.

Return type

dict

Returns

Response Syntax

{
    'resolver': {
        'typeName': 'string',
        'fieldName': 'string',
        'dataSourceName': 'string',
        'resolverArn': 'string',
        'requestMappingTemplate': 'string',
        'responseMappingTemplate': 'string',
        'kind': 'UNIT'|'PIPELINE',
        'pipelineConfig': {
            'functions': [
                'string',
            ]
        },
        'syncConfig': {
            'conflictHandler': 'OPTIMISTIC_CONCURRENCY'|'LAMBDA'|'AUTOMERGE'|'NONE',
            'conflictDetection': 'VERSION'|'NONE',
            'lambdaConflictHandlerConfig': {
                'lambdaConflictHandlerArn': 'string'
            }
        },
        'cachingConfig': {
            'ttl': 123,
            'cachingKeys': [
                '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.
    - UNIT : A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source.
    - PIPELINE : A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series of Function in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.
  - pipelineConfig (dict) --
    
    The PipelineConfig .
    - functions (list) --
      
      A list of Function objects.
      - (string) --
  - syncConfig (dict) --
    
    The SyncConfig for a resolver attached to a versioned datasource.
    - conflictHandler (string) --
      
      The Conflict Resolution strategy to perform in the event of a conflict.
      - OPTIMISTIC_CONCURRENCY : Resolve conflicts by rejecting mutations when versions do not match the latest version at the server.
      - AUTOMERGE : Resolve conflicts with the Automerge conflict resolution strategy.
      - LAMBDA : Resolve conflicts with a Lambda function supplied in the LambdaConflictHandlerConfig.
    - conflictDetection (string) --
      
      The Conflict Detection strategy to use.
      - VERSION : Detect conflicts based on object versions for this resolver.
      - NONE : Do not detect conflicts when executing this resolver.
    - lambdaConflictHandlerConfig (dict) --
      
      The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.
      - lambdaConflictHandlerArn (string) --
        
        The Arn for the Lambda function to use as the Conflict Handler.
  - cachingConfig (dict) --
    
    The caching configuration for the resolver.
    - ttl (integer) --
      
      The TTL in seconds for a resolver that has caching enabled.
      
      Valid values are between 1 and 3600 seconds.
    - cachingKeys (list) --
      
      The caching keys for a resolver that has caching enabled.
      
      Valid values are entries from the $context.identity and $context.arguments maps.
      - (string) --

Exceptions

AppSync.Client.exceptions.ConcurrentModificationException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.UnauthorizedException

get_schema_creation_status(**kwargs)¶

Retrieves the current status of a schema creation operation.

See also: AWS API Documentation

Request Syntax

response = client.get_schema_creation_status(
    apiId='string'
)

Parameters

apiId (string) --

[REQUIRED]

The API ID.

Return type

dict

Returns

Response Syntax

{
    'status': 'PROCESSING'|'ACTIVE'|'DELETING'|'FAILED'|'SUCCESS'|'NOT_APPLICABLE',
    'details': 'string'
}

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.
- details (string) --
  Detailed information about the status of the schema creation operation.

Exceptions

AppSync.Client.exceptions.BadRequestException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException

get_type(**kwargs)¶

Retrieves a Type object.

See also: AWS API Documentation

Request Syntax

response = client.get_type(
    apiId='string',
    typeName='string',
    format='SDL'|'JSON'
)

Parameters

apiId (string) --
[REQUIRED]

The API ID.
typeName (string) --
[REQUIRED]

The type name.
format (string) --
[REQUIRED]

The type format: SDL or JSON.

Return type

dict

Returns

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.

Exceptions

AppSync.Client.exceptions.BadRequestException
AppSync.Client.exceptions.ConcurrentModificationException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException

get_waiter(waiter_name)¶

Returns an object that can wait for some condition.

Parameters: waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns: The specified waiter object.
Return type: botocore.waiter.Waiter

list_api_keys(**kwargs)¶

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
)

Parameters

apiId (string) --
[REQUIRED]

The API ID.
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.
maxResults (integer) -- The maximum number of results you want the request to return.

Return type

dict

Returns

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.
    - ListApiKeys returns the expiration time in milliseconds.
    - CreateApiKey returns the expiration time in milliseconds.
    - UpdateApiKey is not available for this key version.
    - DeleteApiKey deletes the item from the table.
    - Expiration is stored in Amazon DynamoDB as milliseconds. This results in a bug where keys are not automatically deleted because DynamoDB expects the TTL to be stored in seconds. As a one-time action, we will delete these keys from the table after February 21, 2018.
    da2 : This version was introduced in February 2018 when AppSync added support to extend key expiration.
    - ListApiKeys returns the expiration time in seconds.
    - CreateApiKey returns the expiration time in seconds and accepts a user-provided expiration time in seconds.
    - UpdateApiKey returns the expiration time in seconds and accepts a user-provided expiration time in seconds. Key expiration can only be updated while the key has not expired.
    - DeleteApiKey deletes the item from the table.
    - Expiration is stored in Amazon DynamoDB as seconds.
    - 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.

Exceptions

AppSync.Client.exceptions.BadRequestException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException

list_data_sources(**kwargs)¶

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
)

Parameters

apiId (string) --
[REQUIRED]

The API ID.
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.
maxResults (integer) -- The maximum number of results you want the request to return.

Return type

dict

Returns

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,
                'deltaSyncConfig': {
                    'baseTableTTL': 123,
                    'deltaSyncTableName': 'string',
                    'deltaSyncTableTTL': 123
                },
                'versioned': 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.
      - AMAZON_DYNAMODB : The data source is an Amazon DynamoDB table.
      - AMAZON_ELASTICSEARCH : The data source is an Amazon Elasticsearch Service domain.
      - AWS_LAMBDA : The data source is an AWS Lambda function.
      - NONE : There is no data source. This type is used when you wish to invoke a GraphQL operation without connecting to a data source, such as performing data transformation with resolvers or triggering a subscription to be invoked from a mutation.
      - HTTP : The data source is an HTTP endpoint.
      - RELATIONAL_DATABASE : The data source is a relational database.
    - 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.
      - deltaSyncConfig (dict) --
        
        The DeltaSyncConfig for a versioned datasource.
        
        baseTableTTL (integer) --
        
        The number of minutes an Item is stored in the datasource.
        
        deltaSyncTableName (string) --
        
        The Delta Sync table name.
        
        deltaSyncTableTTL (integer) --
        
        The number of minutes a Delta Sync log entry is stored in the Delta Sync table.
      - versioned (boolean) --
        
        Set to TRUE to use Conflict Detection and Resolution 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.
        
        AWS_IAM : The authorization type is Sigv4.
        
        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.
        
        RDS_HTTP_ENDPOINT : The relational database source type is an Amazon RDS HTTP endpoint.
      - 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.

Exceptions

AppSync.Client.exceptions.BadRequestException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException

list_functions(**kwargs)¶

List multiple functions.

See also: AWS API Documentation

Request Syntax

response = client.list_functions(
    apiId='string',
    nextToken='string',
    maxResults=123
)

Parameters

apiId (string) --
[REQUIRED]

The GraphQL API ID.
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.
maxResults (integer) -- The maximum number of results you want the request to return.

Return type

dict

Returns

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.

Exceptions

AppSync.Client.exceptions.BadRequestException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException

list_graphql_apis(**kwargs)¶

Lists your GraphQL APIs.

See also: AWS API Documentation

Request Syntax

response = client.list_graphql_apis(
    nextToken='string',
    maxResults=123
)

Parameters

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.
maxResults (integer) -- The maximum number of results you want the request to return.

Return type

dict

Returns

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',
                'excludeVerboseContent': True|False
            },
            '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'
                    }
                },
            ],
            'xrayEnabled': True|False
        },
    ],
    '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.
        
        NONE : No field-level logs are captured.
        
        ERROR : Logs the following information only for the fields that are in error:
        
        The error section in the server response.
        
        Field-level errors.
        
        The generated request/response functions that got resolved for error fields.
        
        ALL : The following information is logged for all fields in the query:
        
        Field-level tracing information.
        
        The generated request/response functions that got resolved for each field.
      - cloudWatchLogsRoleArn (string) --
        
        The service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in your account.
      - excludeVerboseContent (boolean) --
        
        Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.
    - 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.
      - (string) --
        
        (string) --
    - 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.
    - xrayEnabled (boolean) --
      
      A flag representing whether X-Ray tracing is enabled for this GraphqlApi .
- nextToken (string) --
  
  An identifier to be passed in the next request to this operation to return the next set of items in the list.

Exceptions

AppSync.Client.exceptions.BadRequestException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException

list_resolvers(**kwargs)¶

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
)

Parameters

apiId (string) --
[REQUIRED]

The API ID.
typeName (string) --
[REQUIRED]

The type name.
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.
maxResults (integer) -- The maximum number of results you want the request to return.

Return type

dict

Returns

Response Syntax

{
    'resolvers': [
        {
            'typeName': 'string',
            'fieldName': 'string',
            'dataSourceName': 'string',
            'resolverArn': 'string',
            'requestMappingTemplate': 'string',
            'responseMappingTemplate': 'string',
            'kind': 'UNIT'|'PIPELINE',
            'pipelineConfig': {
                'functions': [
                    'string',
                ]
            },
            'syncConfig': {
                'conflictHandler': 'OPTIMISTIC_CONCURRENCY'|'LAMBDA'|'AUTOMERGE'|'NONE',
                'conflictDetection': 'VERSION'|'NONE',
                'lambdaConflictHandlerConfig': {
                    'lambdaConflictHandlerArn': 'string'
                }
            },
            'cachingConfig': {
                'ttl': 123,
                'cachingKeys': [
                    '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.
      - UNIT : A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source.
      - PIPELINE : A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series of Function in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.
    - pipelineConfig (dict) --
      
      The PipelineConfig .
      - functions (list) --
        
        A list of Function objects.
        
        (string) --
    - syncConfig (dict) --
      
      The SyncConfig for a resolver attached to a versioned datasource.
      - conflictHandler (string) --
        
        The Conflict Resolution strategy to perform in the event of a conflict.
        
        OPTIMISTIC_CONCURRENCY : Resolve conflicts by rejecting mutations when versions do not match the latest version at the server.
        
        AUTOMERGE : Resolve conflicts with the Automerge conflict resolution strategy.
        
        LAMBDA : Resolve conflicts with a Lambda function supplied in the LambdaConflictHandlerConfig.
      - conflictDetection (string) --
        
        The Conflict Detection strategy to use.
        
        VERSION : Detect conflicts based on object versions for this resolver.
        
        NONE : Do not detect conflicts when executing this resolver.
      - lambdaConflictHandlerConfig (dict) --
        
        The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.
        
        lambdaConflictHandlerArn (string) --
        
        The Arn for the Lambda function to use as the Conflict Handler.
    - cachingConfig (dict) --
      
      The caching configuration for the resolver.
      - ttl (integer) --
        
        The TTL in seconds for a resolver that has caching enabled.
        
        Valid values are between 1 and 3600 seconds.
      - cachingKeys (list) --
        
        The caching keys for a resolver that has caching enabled.
        
        Valid values are entries from the $context.identity and $context.arguments maps.
        
        (string) --
- nextToken (string) --
  
  An identifier to be passed in the next request to this operation to return the next set of items in the list.

Exceptions

AppSync.Client.exceptions.BadRequestException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException

list_resolvers_by_function(**kwargs)¶

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
)

Parameters

apiId (string) --
[REQUIRED]

The API ID.
functionId (string) --
[REQUIRED]

The Function ID.
nextToken (string) -- An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.
maxResults (integer) -- The maximum number of results you want the request to return.

Return type

dict

Returns

Response Syntax

{
    'resolvers': [
        {
            'typeName': 'string',
            'fieldName': 'string',
            'dataSourceName': 'string',
            'resolverArn': 'string',
            'requestMappingTemplate': 'string',
            'responseMappingTemplate': 'string',
            'kind': 'UNIT'|'PIPELINE',
            'pipelineConfig': {
                'functions': [
                    'string',
                ]
            },
            'syncConfig': {
                'conflictHandler': 'OPTIMISTIC_CONCURRENCY'|'LAMBDA'|'AUTOMERGE'|'NONE',
                'conflictDetection': 'VERSION'|'NONE',
                'lambdaConflictHandlerConfig': {
                    'lambdaConflictHandlerArn': 'string'
                }
            },
            'cachingConfig': {
                'ttl': 123,
                'cachingKeys': [
                    '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.
      - UNIT : A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source.
      - PIPELINE : A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series of Function in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.
    - pipelineConfig (dict) --
      
      The PipelineConfig .
      - functions (list) --
        
        A list of Function objects.
        
        (string) --
    - syncConfig (dict) --
      
      The SyncConfig for a resolver attached to a versioned datasource.
      - conflictHandler (string) --
        
        The Conflict Resolution strategy to perform in the event of a conflict.
        
        OPTIMISTIC_CONCURRENCY : Resolve conflicts by rejecting mutations when versions do not match the latest version at the server.
        
        AUTOMERGE : Resolve conflicts with the Automerge conflict resolution strategy.
        
        LAMBDA : Resolve conflicts with a Lambda function supplied in the LambdaConflictHandlerConfig.
      - conflictDetection (string) --
        
        The Conflict Detection strategy to use.
        
        VERSION : Detect conflicts based on object versions for this resolver.
        
        NONE : Do not detect conflicts when executing this resolver.
      - lambdaConflictHandlerConfig (dict) --
        
        The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.
        
        lambdaConflictHandlerArn (string) --
        
        The Arn for the Lambda function to use as the Conflict Handler.
    - cachingConfig (dict) --
      
      The caching configuration for the resolver.
      - ttl (integer) --
        
        The TTL in seconds for a resolver that has caching enabled.
        
        Valid values are between 1 and 3600 seconds.
      - cachingKeys (list) --
        
        The caching keys for a resolver that has caching enabled.
        
        Valid values are entries from the $context.identity and $context.arguments maps.
        
        (string) --
- nextToken (string) --
  
  An identifier that can be used to return the next set of items in the list.

Exceptions

AppSync.Client.exceptions.BadRequestException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException

list_tags_for_resource(**kwargs)¶

Lists the tags for a resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    resourceArn='string'
)

Parameters

resourceArn (string) --

[REQUIRED]

The GraphqlApi ARN.

Return type

dict

Returns

Response Syntax

{
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- tags (dict) --
  A TagMap object.
  - (string) --
    The key for the tag.
    - (string) --
      The value for the tag.

Exceptions

AppSync.Client.exceptions.BadRequestException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.LimitExceededException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException
AppSync.Client.exceptions.AccessDeniedException

list_types(**kwargs)¶

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
)

Parameters

apiId (string) --
[REQUIRED]

The API ID.
format (string) --
[REQUIRED]

The type format: SDL or JSON.
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.
maxResults (integer) -- The maximum number of results you want the request to return.

Return type

dict

Returns

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.

Exceptions

AppSync.Client.exceptions.BadRequestException
AppSync.Client.exceptions.ConcurrentModificationException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException

start_schema_creation(**kwargs)¶

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'
)

Parameters

apiId (string) --
[REQUIRED]

The API ID.
definition (bytes) --
[REQUIRED]

The schema definition, in GraphQL schema language format.

Return type

dict

Returns

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.

Exceptions

AppSync.Client.exceptions.BadRequestException
AppSync.Client.exceptions.ConcurrentModificationException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException

tag_resource(**kwargs)¶

Tags a resource with user-supplied tags.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    resourceArn='string',
    tags={
        'string': 'string'
    }
)

Parameters

resourceArn (string) --
[REQUIRED]

The GraphqlApi ARN.
tags (dict) --
[REQUIRED]

A TagMap object.
- (string) --
  The key for the tag.
  - (string) --
    The value for the tag.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

AppSync.Client.exceptions.BadRequestException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.LimitExceededException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException
AppSync.Client.exceptions.AccessDeniedException

untag_resource(**kwargs)¶

Untags a resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)

Parameters

resourceArn (string) --
[REQUIRED]

The GraphqlApi ARN.
tagKeys (list) --
[REQUIRED]

A list of TagKey objects.
- (string) --
  The key for the tag.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

AppSync.Client.exceptions.BadRequestException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.LimitExceededException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException
AppSync.Client.exceptions.AccessDeniedException

update_api_cache(**kwargs)¶

Updates the cache for the GraphQL API.

See also: AWS API Documentation

Request Syntax

response = client.update_api_cache(
    apiId='string',
    ttl=123,
    apiCachingBehavior='FULL_REQUEST_CACHING'|'PER_RESOLVER_CACHING',
    type='T2_SMALL'|'T2_MEDIUM'|'R4_LARGE'|'R4_XLARGE'|'R4_2XLARGE'|'R4_4XLARGE'|'R4_8XLARGE'
)

Parameters

apiId (string) --
[REQUIRED]

The GraphQL API Id.
ttl (integer) --
[REQUIRED]

TTL in seconds for cache entries.

Valid values are between 1 and 3600 seconds.
apiCachingBehavior (string) --
[REQUIRED]

Caching behavior.
- FULL_REQUEST_CACHING : All requests are fully cached.
- PER_RESOLVER_CACHING : Individual resovlers that you specify are cached.
type (string) --
[REQUIRED]

The cache instance type.
- T2_SMALL : A t2.small instance type.
- T2_MEDIUM : A t2.medium instance type.
- R4_LARGE : A r4.large instance type.
- R4_XLARGE : A r4.xlarge instance type.
- R4_2XLARGE : A r4.2xlarge instance type.
- R4_4XLARGE : A r4.4xlarge instance type.
- R4_8XLARGE : A r4.8xlarge instance type.

Return type

dict

Returns

Response Syntax

{
    'apiCache': {
        'ttl': 123,
        'apiCachingBehavior': 'FULL_REQUEST_CACHING'|'PER_RESOLVER_CACHING',
        'transitEncryptionEnabled': True|False,
        'atRestEncryptionEnabled': True|False,
        'type': 'T2_SMALL'|'T2_MEDIUM'|'R4_LARGE'|'R4_XLARGE'|'R4_2XLARGE'|'R4_4XLARGE'|'R4_8XLARGE',
        'status': 'AVAILABLE'|'CREATING'|'DELETING'|'MODIFYING'|'FAILED'
    }
}

Response Structure

(dict) --

Represents the output of a UpdateApiCache operation.
- apiCache (dict) --
  
  The ApiCache object.
  - ttl (integer) --
    
    TTL in seconds for cache entries.
    
    Valid values are between 1 and 3600 seconds.
  - apiCachingBehavior (string) --
    
    Caching behavior.
    - FULL_REQUEST_CACHING : All requests are fully cached.
    - PER_RESOLVER_CACHING : Individual resovlers that you specify are cached.
  - transitEncryptionEnabled (boolean) --
    
    Transit encryption flag when connecting to cache. This setting cannot be updated after creation.
  - atRestEncryptionEnabled (boolean) --
    
    At rest encryption flag for cache. This setting cannot be updated after creation.
  - type (string) --
    
    The cache instance type.
    - T2_SMALL : A t2.small instance type.
    - T2_MEDIUM : A t2.medium instance type.
    - R4_LARGE : A r4.large instance type.
    - R4_XLARGE : A r4.xlarge instance type.
    - R4_2XLARGE : A r4.2xlarge instance type.
    - R4_4XLARGE : A r4.4xlarge instance type.
    - R4_8XLARGE : A r4.8xlarge instance type.
  - status (string) --
    
    The cache instance status.
    - AVAILABLE : The instance is available for use.
    - CREATING : The instance is currently creating.
    - DELETING : The instance is currently deleting.
    - MODIFYING : The instance is currently modifying.
    - FAILED : The instance has failed creation.

Exceptions

AppSync.Client.exceptions.BadRequestException
AppSync.Client.exceptions.ConcurrentModificationException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException

update_api_key(**kwargs)¶

Updates an API key.

See also: AWS API Documentation

Request Syntax

response = client.update_api_key(
    apiId='string',
    id='string',
    description='string',
    expires=123
)

Parameters

apiId (string) --
[REQUIRED]

The ID for the GraphQL API.
id (string) --
[REQUIRED]

The API key ID.
description (string) -- A description of the purpose of the API key.
expires (integer) -- The time from update time after which the API key expires. The date is represented as seconds since the epoch. For more information, see .

Return type

dict

Returns

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.

Exceptions

AppSync.Client.exceptions.BadRequestException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.LimitExceededException
AppSync.Client.exceptions.InternalFailureException
AppSync.Client.exceptions.ApiKeyValidityOutOfBoundsException

update_data_source(**kwargs)¶

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,
        'deltaSyncConfig': {
            'baseTableTTL': 123,
            'deltaSyncTableName': 'string',
            'deltaSyncTableTTL': 123
        },
        'versioned': 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'
        }
    }
)

Parameters

apiId (string) --
[REQUIRED]

The API ID.
name (string) --
[REQUIRED]

The new name for the data source.
description (string) -- The new description for the data source.
type (string) --
[REQUIRED]

The new data source type.
serviceRoleArn (string) -- The new service role ARN for the data source.
dynamodbConfig (dict) --
The new Amazon DynamoDB configuration.
- tableName (string) -- [REQUIRED]
  The table name.
- awsRegion (string) -- [REQUIRED]
  The AWS Region.
- useCallerCredentials (boolean) --
  Set to TRUE to use Amazon Cognito credentials with this data source.
- deltaSyncConfig (dict) --
  The DeltaSyncConfig for a versioned datasource.
  - baseTableTTL (integer) --
    The number of minutes an Item is stored in the datasource.
  - deltaSyncTableName (string) --
    The Delta Sync table name.
  - deltaSyncTableTTL (integer) --
    The number of minutes a Delta Sync log entry is stored in the Delta Sync table.
- versioned (boolean) --
  Set to TRUE to use Conflict Detection and Resolution with this data source.
lambdaConfig (dict) --
The new AWS Lambda configuration.
- lambdaFunctionArn (string) -- [REQUIRED]
  The ARN for the Lambda function.
elasticsearchConfig (dict) --
The new Elasticsearch Service configuration.
- endpoint (string) -- [REQUIRED]
  The endpoint.
- awsRegion (string) -- [REQUIRED]
  The AWS Region.
httpConfig (dict) --
The new HTTP endpoint configuration.
- 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) -- [REQUIRED]
    The authorization type required by the HTTP endpoint.
    - AWS_IAM : The authorization type is Sigv4.
  - 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) --
The new relational database configuration.
- relationalDatabaseSourceType (string) --
  Source type for the relational database.
  - RDS_HTTP_ENDPOINT : The relational database source type is an Amazon RDS HTTP endpoint.
- 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.

Return type

dict

Returns

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,
            'deltaSyncConfig': {
                'baseTableTTL': 123,
                'deltaSyncTableName': 'string',
                'deltaSyncTableTTL': 123
            },
            'versioned': 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.
    - AMAZON_DYNAMODB : The data source is an Amazon DynamoDB table.
    - AMAZON_ELASTICSEARCH : The data source is an Amazon Elasticsearch Service domain.
    - AWS_LAMBDA : The data source is an AWS Lambda function.
    - NONE : There is no data source. This type is used when you wish to invoke a GraphQL operation without connecting to a data source, such as performing data transformation with resolvers or triggering a subscription to be invoked from a mutation.
    - HTTP : The data source is an HTTP endpoint.
    - RELATIONAL_DATABASE : The data source is a relational database.
  - 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.
    - deltaSyncConfig (dict) --
      
      The DeltaSyncConfig for a versioned datasource.
      - baseTableTTL (integer) --
        
        The number of minutes an Item is stored in the datasource.
      - deltaSyncTableName (string) --
        
        The Delta Sync table name.
      - deltaSyncTableTTL (integer) --
        
        The number of minutes a Delta Sync log entry is stored in the Delta Sync table.
    - versioned (boolean) --
      
      Set to TRUE to use Conflict Detection and Resolution 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.
        
        AWS_IAM : The authorization type is Sigv4.
      - 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.
      - RDS_HTTP_ENDPOINT : The relational database source type is an Amazon RDS HTTP endpoint.
    - 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.

Exceptions

AppSync.Client.exceptions.BadRequestException
AppSync.Client.exceptions.ConcurrentModificationException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException

update_function(**kwargs)¶

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'
)

Parameters

apiId (string) --
[REQUIRED]

The GraphQL API ID.
name (string) --
[REQUIRED]

The Function name.
description (string) -- The Function description.
functionId (string) --
[REQUIRED]

The function ID.
dataSourceName (string) --
[REQUIRED]

The Function DataSource name.
requestMappingTemplate (string) --
[REQUIRED]

The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
responseMappingTemplate (string) -- The Function request mapping template.
functionVersion (string) --
[REQUIRED]

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

Return type

dict

Returns

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.

Exceptions

AppSync.Client.exceptions.ConcurrentModificationException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException

update_graphql_api(**kwargs)¶

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',
        'excludeVerboseContent': True|False
    },
    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'
            }
        },
    ],
    xrayEnabled=True|False
)

Parameters

apiId (string) --
[REQUIRED]

The API ID.
name (string) --
[REQUIRED]

The new name for the GraphqlApi object.
logConfig (dict) --
The Amazon CloudWatch Logs configuration for the GraphqlApi object.
- fieldLogLevel (string) -- [REQUIRED]
  The field logging level. Values can be NONE, ERROR, or ALL.
  - NONE : No field-level logs are captured.
  - ERROR : Logs the following information only for the fields that are in error:
    - The error section in the server response.
    - Field-level errors.
    - The generated request/response functions that got resolved for error fields.
  - ALL : The following information is logged for all fields in the query:
    - Field-level tracing information.
    - The generated request/response functions that got resolved for each field.
- cloudWatchLogsRoleArn (string) -- [REQUIRED]
  The service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in your account.
- excludeVerboseContent (boolean) --
  Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.
authenticationType (string) -- The new authentication type for the GraphqlApi object.
userPoolConfig (dict) --
The new Amazon Cognito user pool configuration for the GraphqlApi object.
- userPoolId (string) -- [REQUIRED]
  The user pool ID.
- awsRegion (string) -- [REQUIRED]
  The AWS Region in which the user pool was created.
- defaultAction (string) -- [REQUIRED]
  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 for the GraphqlApi object.
- issuer (string) -- [REQUIRED]
  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.
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) -- [REQUIRED]
      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) -- [REQUIRED]
      The user pool ID.
    - awsRegion (string) -- [REQUIRED]
      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.
xrayEnabled (boolean) -- A flag indicating whether to enable X-Ray tracing for the GraphqlApi .

Return type

dict

Returns

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',
            'excludeVerboseContent': True|False
        },
        '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'
                }
            },
        ],
        'xrayEnabled': True|False
    }
}

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.
      - NONE : No field-level logs are captured.
      - ERROR : Logs the following information only for the fields that are in error:
        
        The error section in the server response.
        
        Field-level errors.
        
        The generated request/response functions that got resolved for error fields.
      - ALL : The following information is logged for all fields in the query:
        
        Field-level tracing information.
        
        The generated request/response functions that got resolved for each field.
    - cloudWatchLogsRoleArn (string) --
      
      The service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in your account.
    - excludeVerboseContent (boolean) --
      
      Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.
  - 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.
    - (string) --
      - (string) --
  - 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.
  - xrayEnabled (boolean) --
    
    A flag representing whether X-Ray tracing is enabled for this GraphqlApi .

Exceptions

AppSync.Client.exceptions.BadRequestException
AppSync.Client.exceptions.ConcurrentModificationException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException
AppSync.Client.exceptions.AccessDeniedException

update_resolver(**kwargs)¶

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',
        ]
    },
    syncConfig={
        'conflictHandler': 'OPTIMISTIC_CONCURRENCY'|'LAMBDA'|'AUTOMERGE'|'NONE',
        'conflictDetection': 'VERSION'|'NONE',
        'lambdaConflictHandlerConfig': {
            'lambdaConflictHandlerArn': 'string'
        }
    },
    cachingConfig={
        'ttl': 123,
        'cachingKeys': [
            'string',
        ]
    }
)

Parameters

apiId (string) --
[REQUIRED]

The API ID.
typeName (string) --
[REQUIRED]

The new type name.
fieldName (string) --
[REQUIRED]

The new field name.
dataSourceName (string) -- The new data source name.
requestMappingTemplate (string) --
[REQUIRED]

The new request mapping template.
responseMappingTemplate (string) -- The new response mapping template.
kind (string) --
The resolver type.
- UNIT : A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source.
- PIPELINE : A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series of Function in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.
pipelineConfig (dict) --
The PipelineConfig .
- functions (list) --
  A list of Function objects.
  - (string) --
syncConfig (dict) --
The SyncConfig for a resolver attached to a versioned datasource.
- conflictHandler (string) --
  The Conflict Resolution strategy to perform in the event of a conflict.
  - OPTIMISTIC_CONCURRENCY : Resolve conflicts by rejecting mutations when versions do not match the latest version at the server.
  - AUTOMERGE : Resolve conflicts with the Automerge conflict resolution strategy.
  - LAMBDA : Resolve conflicts with a Lambda function supplied in the LambdaConflictHandlerConfig.
- conflictDetection (string) --
  The Conflict Detection strategy to use.
  - VERSION : Detect conflicts based on object versions for this resolver.
  - NONE : Do not detect conflicts when executing this resolver.
- lambdaConflictHandlerConfig (dict) --
  The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.
  - lambdaConflictHandlerArn (string) --
    The Arn for the Lambda function to use as the Conflict Handler.
cachingConfig (dict) --
The caching configuration for the resolver.
- ttl (integer) --
  The TTL in seconds for a resolver that has caching enabled.
  
  Valid values are between 1 and 3600 seconds.
- cachingKeys (list) --
  The caching keys for a resolver that has caching enabled.
  
  Valid values are entries from the $context.identity and $context.arguments maps.
  - (string) --

Return type

dict

Returns

Response Syntax

{
    'resolver': {
        'typeName': 'string',
        'fieldName': 'string',
        'dataSourceName': 'string',
        'resolverArn': 'string',
        'requestMappingTemplate': 'string',
        'responseMappingTemplate': 'string',
        'kind': 'UNIT'|'PIPELINE',
        'pipelineConfig': {
            'functions': [
                'string',
            ]
        },
        'syncConfig': {
            'conflictHandler': 'OPTIMISTIC_CONCURRENCY'|'LAMBDA'|'AUTOMERGE'|'NONE',
            'conflictDetection': 'VERSION'|'NONE',
            'lambdaConflictHandlerConfig': {
                'lambdaConflictHandlerArn': 'string'
            }
        },
        'cachingConfig': {
            'ttl': 123,
            'cachingKeys': [
                '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.
    - UNIT : A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source.
    - PIPELINE : A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series of Function in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.
  - pipelineConfig (dict) --
    
    The PipelineConfig .
    - functions (list) --
      
      A list of Function objects.
      - (string) --
  - syncConfig (dict) --
    
    The SyncConfig for a resolver attached to a versioned datasource.
    - conflictHandler (string) --
      
      The Conflict Resolution strategy to perform in the event of a conflict.
      - OPTIMISTIC_CONCURRENCY : Resolve conflicts by rejecting mutations when versions do not match the latest version at the server.
      - AUTOMERGE : Resolve conflicts with the Automerge conflict resolution strategy.
      - LAMBDA : Resolve conflicts with a Lambda function supplied in the LambdaConflictHandlerConfig.
    - conflictDetection (string) --
      
      The Conflict Detection strategy to use.
      - VERSION : Detect conflicts based on object versions for this resolver.
      - NONE : Do not detect conflicts when executing this resolver.
    - lambdaConflictHandlerConfig (dict) --
      
      The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.
      - lambdaConflictHandlerArn (string) --
        
        The Arn for the Lambda function to use as the Conflict Handler.
  - cachingConfig (dict) --
    
    The caching configuration for the resolver.
    - ttl (integer) --
      
      The TTL in seconds for a resolver that has caching enabled.
      
      Valid values are between 1 and 3600 seconds.
    - cachingKeys (list) --
      
      The caching keys for a resolver that has caching enabled.
      
      Valid values are entries from the $context.identity and $context.arguments maps.
      - (string) --

Exceptions

AppSync.Client.exceptions.ConcurrentModificationException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException

update_type(**kwargs)¶

Updates a Type object.

See also: AWS API Documentation

Request Syntax

response = client.update_type(
    apiId='string',
    typeName='string',
    definition='string',
    format='SDL'|'JSON'
)

Parameters

apiId (string) --
[REQUIRED]

The API ID.
typeName (string) --
[REQUIRED]

The new type name.
definition (string) -- The new definition.
format (string) --
[REQUIRED]

The new type format: SDL or JSON.

Return type

dict

Returns

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.

Exceptions

AppSync.Client.exceptions.BadRequestException
AppSync.Client.exceptions.ConcurrentModificationException
AppSync.Client.exceptions.NotFoundException
AppSync.Client.exceptions.UnauthorizedException
AppSync.Client.exceptions.InternalFailureException

Paginators ¶

The available paginators are:

AppSync.Paginator.ListApiKeys
AppSync.Paginator.ListDataSources
AppSync.Paginator.ListFunctions
AppSync.Paginator.ListGraphqlApis
AppSync.Paginator.ListResolvers
AppSync.Paginator.ListResolversByFunction
AppSync.Paginator.ListTypes

class AppSync.Paginator.ListApiKeys¶

paginator = client.get_paginator('list_api_keys')

paginate(**kwargs)¶

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'
    }
)

Parameters

apiId (string) --
[REQUIRED]

The API ID.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  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.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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.
    - ListApiKeys returns the expiration time in milliseconds.
    - CreateApiKey returns the expiration time in milliseconds.
    - UpdateApiKey is not available for this key version.
    - DeleteApiKey deletes the item from the table.
    - Expiration is stored in Amazon DynamoDB as milliseconds. This results in a bug where keys are not automatically deleted because DynamoDB expects the TTL to be stored in seconds. As a one-time action, we will delete these keys from the table after February 21, 2018.
    da2 : This version was introduced in February 2018 when AppSync added support to extend key expiration.
    - ListApiKeys returns the expiration time in seconds.
    - CreateApiKey returns the expiration time in seconds and accepts a user-provided expiration time in seconds.
    - UpdateApiKey returns the expiration time in seconds and accepts a user-provided expiration time in seconds. Key expiration can only be updated while the key has not expired.
    - DeleteApiKey deletes the item from the table.
    - Expiration is stored in Amazon DynamoDB as seconds.
    - 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.

class AppSync.Paginator.ListDataSources¶

paginator = client.get_paginator('list_data_sources')

paginate(**kwargs)¶

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'
    }
)

Parameters

apiId (string) --
[REQUIRED]

The API ID.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  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.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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,
                'deltaSyncConfig': {
                    'baseTableTTL': 123,
                    'deltaSyncTableName': 'string',
                    'deltaSyncTableTTL': 123
                },
                'versioned': 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.
      - AMAZON_DYNAMODB : The data source is an Amazon DynamoDB table.
      - AMAZON_ELASTICSEARCH : The data source is an Amazon Elasticsearch Service domain.
      - AWS_LAMBDA : The data source is an AWS Lambda function.
      - NONE : There is no data source. This type is used when you wish to invoke a GraphQL operation without connecting to a data source, such as performing data transformation with resolvers or triggering a subscription to be invoked from a mutation.
      - HTTP : The data source is an HTTP endpoint.
      - RELATIONAL_DATABASE : The data source is a relational database.
    - 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.
      - deltaSyncConfig (dict) --
        
        The DeltaSyncConfig for a versioned datasource.
        
        baseTableTTL (integer) --
        
        The number of minutes an Item is stored in the datasource.
        
        deltaSyncTableName (string) --
        
        The Delta Sync table name.
        
        deltaSyncTableTTL (integer) --
        
        The number of minutes a Delta Sync log entry is stored in the Delta Sync table.
      - versioned (boolean) --
        
        Set to TRUE to use Conflict Detection and Resolution 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.
        
        AWS_IAM : The authorization type is Sigv4.
        
        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.
        
        RDS_HTTP_ENDPOINT : The relational database source type is an Amazon RDS HTTP endpoint.
      - 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.

class AppSync.Paginator.ListFunctions¶

paginator = client.get_paginator('list_functions')

paginate(**kwargs)¶

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'
    }
)

Parameters

apiId (string) --
[REQUIRED]

The GraphQL API ID.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  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.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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.

class AppSync.Paginator.ListGraphqlApis¶

paginator = client.get_paginator('list_graphql_apis')

paginate(**kwargs)¶

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'
    }
)

Parameters

PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

MaxItems (integer) --
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.
PageSize (integer) --
The size of each page.
StartingToken (string) --
A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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',
                'excludeVerboseContent': True|False
            },
            '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'
                    }
                },
            ],
            'xrayEnabled': True|False
        },
    ],
    '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.
        
        NONE : No field-level logs are captured.
        
        ERROR : Logs the following information only for the fields that are in error:
        
        The error section in the server response.
        
        Field-level errors.
        
        The generated request/response functions that got resolved for error fields.
        
        ALL : The following information is logged for all fields in the query:
        
        Field-level tracing information.
        
        The generated request/response functions that got resolved for each field.
      - cloudWatchLogsRoleArn (string) --
        The service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in your account.
      - excludeVerboseContent (boolean) --
        Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.
    - 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.
      - (string) --
        
        (string) --
    - 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.
    - xrayEnabled (boolean) --
      A flag representing whether X-Ray tracing is enabled for this GraphqlApi .
- NextToken (string) --
  A token to resume pagination.

class AppSync.Paginator.ListResolvers¶

paginator = client.get_paginator('list_resolvers')

paginate(**kwargs)¶

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'
    }
)

Parameters

apiId (string) --
[REQUIRED]

The API ID.
typeName (string) --
[REQUIRED]

The type name.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  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.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'resolvers': [
        {
            'typeName': 'string',
            'fieldName': 'string',
            'dataSourceName': 'string',
            'resolverArn': 'string',
            'requestMappingTemplate': 'string',
            'responseMappingTemplate': 'string',
            'kind': 'UNIT'|'PIPELINE',
            'pipelineConfig': {
                'functions': [
                    'string',
                ]
            },
            'syncConfig': {
                'conflictHandler': 'OPTIMISTIC_CONCURRENCY'|'LAMBDA'|'AUTOMERGE'|'NONE',
                'conflictDetection': 'VERSION'|'NONE',
                'lambdaConflictHandlerConfig': {
                    'lambdaConflictHandlerArn': 'string'
                }
            },
            'cachingConfig': {
                'ttl': 123,
                'cachingKeys': [
                    '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.
      - UNIT : A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source.
      - PIPELINE : A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series of Function in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.
    - pipelineConfig (dict) --
      
      The PipelineConfig .
      - functions (list) --
        
        A list of Function objects.
        
        (string) --
    - syncConfig (dict) --
      
      The SyncConfig for a resolver attached to a versioned datasource.
      - conflictHandler (string) --
        
        The Conflict Resolution strategy to perform in the event of a conflict.
        
        OPTIMISTIC_CONCURRENCY : Resolve conflicts by rejecting mutations when versions do not match the latest version at the server.
        
        AUTOMERGE : Resolve conflicts with the Automerge conflict resolution strategy.
        
        LAMBDA : Resolve conflicts with a Lambda function supplied in the LambdaConflictHandlerConfig.
      - conflictDetection (string) --
        
        The Conflict Detection strategy to use.
        
        VERSION : Detect conflicts based on object versions for this resolver.
        
        NONE : Do not detect conflicts when executing this resolver.
      - lambdaConflictHandlerConfig (dict) --
        
        The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.
        
        lambdaConflictHandlerArn (string) --
        
        The Arn for the Lambda function to use as the Conflict Handler.
    - cachingConfig (dict) --
      
      The caching configuration for the resolver.
      - ttl (integer) --
        
        The TTL in seconds for a resolver that has caching enabled.
        
        Valid values are between 1 and 3600 seconds.
      - cachingKeys (list) --
        
        The caching keys for a resolver that has caching enabled.
        
        Valid values are entries from the $context.identity and $context.arguments maps.
        
        (string) --
- NextToken (string) --
  
  A token to resume pagination.

class AppSync.Paginator.ListResolversByFunction¶

paginator = client.get_paginator('list_resolvers_by_function')

paginate(**kwargs)¶

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'
    }
)

Parameters

apiId (string) --
[REQUIRED]

The API ID.
functionId (string) --
[REQUIRED]

The Function ID.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  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.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'resolvers': [
        {
            'typeName': 'string',
            'fieldName': 'string',
            'dataSourceName': 'string',
            'resolverArn': 'string',
            'requestMappingTemplate': 'string',
            'responseMappingTemplate': 'string',
            'kind': 'UNIT'|'PIPELINE',
            'pipelineConfig': {
                'functions': [
                    'string',
                ]
            },
            'syncConfig': {
                'conflictHandler': 'OPTIMISTIC_CONCURRENCY'|'LAMBDA'|'AUTOMERGE'|'NONE',
                'conflictDetection': 'VERSION'|'NONE',
                'lambdaConflictHandlerConfig': {
                    'lambdaConflictHandlerArn': 'string'
                }
            },
            'cachingConfig': {
                'ttl': 123,
                'cachingKeys': [
                    '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.
      - UNIT : A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source.
      - PIPELINE : A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series of Function in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.
    - pipelineConfig (dict) --
      
      The PipelineConfig .
      - functions (list) --
        
        A list of Function objects.
        
        (string) --
    - syncConfig (dict) --
      
      The SyncConfig for a resolver attached to a versioned datasource.
      - conflictHandler (string) --
        
        The Conflict Resolution strategy to perform in the event of a conflict.
        
        OPTIMISTIC_CONCURRENCY : Resolve conflicts by rejecting mutations when versions do not match the latest version at the server.
        
        AUTOMERGE : Resolve conflicts with the Automerge conflict resolution strategy.
        
        LAMBDA : Resolve conflicts with a Lambda function supplied in the LambdaConflictHandlerConfig.
      - conflictDetection (string) --
        
        The Conflict Detection strategy to use.
        
        VERSION : Detect conflicts based on object versions for this resolver.
        
        NONE : Do not detect conflicts when executing this resolver.
      - lambdaConflictHandlerConfig (dict) --
        
        The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.
        
        lambdaConflictHandlerArn (string) --
        
        The Arn for the Lambda function to use as the Conflict Handler.
    - cachingConfig (dict) --
      
      The caching configuration for the resolver.
      - ttl (integer) --
        
        The TTL in seconds for a resolver that has caching enabled.
        
        Valid values are between 1 and 3600 seconds.
      - cachingKeys (list) --
        
        The caching keys for a resolver that has caching enabled.
        
        Valid values are entries from the $context.identity and $context.arguments maps.
        
        (string) --
- NextToken (string) --
  
  A token to resume pagination.

class AppSync.Paginator.ListTypes¶

paginator = client.get_paginator('list_types')

paginate(**kwargs)¶

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'
    }
)

Parameters

apiId (string) --
[REQUIRED]

The API ID.
format (string) --
[REQUIRED]

The type format: SDL or JSON.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  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.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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.

Navigation

Table Of Contents

AppSync¶

Client¶

Paginators¶

Navigation

AppSync ¶

Client ¶

Paginators ¶