AppSync / Client / create_graphql_api

create_graphql_api#

AppSync.Client.create_graphql_api(**kwargs)#

Creates a GraphqlApi object.

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'|'AWS_LAMBDA',
    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'|'AWS_LAMBDA',
            'openIDConnectConfig': {
                'issuer': 'string',
                'clientId': 'string',
                'iatTTL': 123,
                'authTTL': 123
            },
            'userPoolConfig': {
                'userPoolId': 'string',
                'awsRegion': 'string',
                'appIdClientRegex': 'string'
            },
            'lambdaAuthorizerConfig': {
                'authorizerResultTtlInSeconds': 123,
                'authorizerUri': 'string',
                'identityValidationExpression': 'string'
            }
        },
    ],
    xrayEnabled=True|False,
    lambdaAuthorizerConfig={
        'authorizerResultTtlInSeconds': 123,
        'authorizerUri': 'string',
        'identityValidationExpression': 'string'
    },
    visibility='GLOBAL'|'PRIVATE'
)

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 AppSync assumes to publish to 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, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
userPoolConfig (dict) –
The Amazon Cognito user pool configuration.
- userPoolId (string) – [REQUIRED]
  
  The user pool ID.
- awsRegion (string) – [REQUIRED]
  
  The Amazon Web Services 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. If this value isn’t set, no filtering is applied.
openIDConnectConfig (dict) –
The OIDC configuration.
- issuer (string) – [REQUIRED]
  
  The issuer for the OIDC 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 that AppSync can validate against multiple client identifiers at a time.
- iatTTL (integer) –
  
  The number of milliseconds that a token is valid after it’s issued to a user.
- authTTL (integer) –
  
  The number of milliseconds that 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, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
  - openIDConnectConfig (dict) –
    
    The OIDC configuration.
    - issuer (string) – [REQUIRED]
      
      The issuer for the OIDC 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 that AppSync can validate against multiple client identifiers at a time.
    - iatTTL (integer) –
      
      The number of milliseconds that a token is valid after it’s issued to a user.
    - authTTL (integer) –
      
      The number of milliseconds that 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 Amazon Web Services Region in which the user pool was created.
    - appIdClientRegex (string) –
      
      A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn’t set, no filtering is applied.
  - lambdaAuthorizerConfig (dict) –
    
    Configuration for Lambda function authorization.
    - authorizerResultTtlInSeconds (integer) –
      
      The number of seconds a response should be cached for. The default is 0 seconds, which disables caching. If you don’t specify a value for authorizerResultTtlInSeconds, the default value is used. The maximum value is one hour (3600 seconds). The Lambda function can override this by returning a ttlOverride key in its response.
    - authorizerUri (string) – [REQUIRED]
      
      The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can be a standard Lambda ARN, a version ARN ( .../v3), or an alias ARN.
      
      Note: This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is done for you. To use the Command Line Interface (CLI), run the following:
      
      aws lambda add-permission --function-name "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id "appsync" --principal appsync.amazonaws.com --action lambda:InvokeFunction
    - identityValidationExpression (string) –
      
      A regular expression for validation of tokens before the Lambda function is called.
xrayEnabled (boolean) – A flag indicating whether to use X-Ray tracing for the GraphqlApi.
lambdaAuthorizerConfig (dict) –
Configuration for Lambda function authorization.
- authorizerResultTtlInSeconds (integer) –
  
  The number of seconds a response should be cached for. The default is 0 seconds, which disables caching. If you don’t specify a value for authorizerResultTtlInSeconds, the default value is used. The maximum value is one hour (3600 seconds). The Lambda function can override this by returning a ttlOverride key in its response.
- authorizerUri (string) – [REQUIRED]
  
  The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can be a standard Lambda ARN, a version ARN ( .../v3), or an alias ARN.
  
  Note: This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is done for you. To use the Command Line Interface (CLI), run the following:
  
  aws lambda add-permission --function-name "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id "appsync" --principal appsync.amazonaws.com --action lambda:InvokeFunction
- identityValidationExpression (string) –
  
  A regular expression for validation of tokens before the Lambda function is called.
visibility (string) – Sets the value of the GraphQL API to public ( GLOBAL) or private ( PRIVATE). If no value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed once the API has been created.

Return type:

dict

Returns:

Response Syntax

{
    'graphqlApi': {
        'name': 'string',
        'apiId': 'string',
        'authenticationType': 'API_KEY'|'AWS_IAM'|'AMAZON_COGNITO_USER_POOLS'|'OPENID_CONNECT'|'AWS_LAMBDA',
        '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'|'AWS_LAMBDA',
                'openIDConnectConfig': {
                    'issuer': 'string',
                    'clientId': 'string',
                    'iatTTL': 123,
                    'authTTL': 123
                },
                'userPoolConfig': {
                    'userPoolId': 'string',
                    'awsRegion': 'string',
                    'appIdClientRegex': 'string'
                },
                'lambdaAuthorizerConfig': {
                    'authorizerResultTtlInSeconds': 123,
                    'authorizerUri': 'string',
                    'identityValidationExpression': 'string'
                }
            },
        ],
        'xrayEnabled': True|False,
        'wafWebAclArn': 'string',
        'lambdaAuthorizerConfig': {
            'authorizerResultTtlInSeconds': 123,
            'authorizerUri': 'string',
            'identityValidationExpression': 'string'
        },
        'dns': {
            'string': 'string'
        },
        'visibility': 'GLOBAL'|'PRIVATE'
    }
}

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 AppSync assumes to publish to 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 Amazon Web Services 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. If this value isn’t set, no filtering is applied.
  - openIDConnectConfig (dict) –
    
    The OpenID Connect configuration.
    - issuer (string) –
      
      The issuer for the OIDC 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 that AppSync can validate against multiple client identifiers at a time.
    - iatTTL (integer) –
      
      The number of milliseconds that a token is valid after it’s issued to a user.
    - authTTL (integer) –
      
      The number of milliseconds that a token is valid after being authenticated.
  - arn (string) –
    
    The Amazon Resource Name (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, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
      - openIDConnectConfig (dict) –
        
        The OIDC configuration.
        
        issuer (string) –
        
        The issuer for the OIDC 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 that AppSync can validate against multiple client identifiers at a time.
        
        iatTTL (integer) –
        
        The number of milliseconds that a token is valid after it’s issued to a user.
        
        authTTL (integer) –
        
        The number of milliseconds that a token is valid after being authenticated.
      - userPoolConfig (dict) –
        
        The Amazon Cognito user pool configuration.
        
        userPoolId (string) –
        
        The user pool ID.
        
        awsRegion (string) –
        
        The Amazon Web Services Region in which the user pool was created.
        
        appIdClientRegex (string) –
        
        A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn’t set, no filtering is applied.
      - lambdaAuthorizerConfig (dict) –
        
        Configuration for Lambda function authorization.
        
        authorizerResultTtlInSeconds (integer) –
        
        The number of seconds a response should be cached for. The default is 0 seconds, which disables caching. If you don’t specify a value for authorizerResultTtlInSeconds, the default value is used. The maximum value is one hour (3600 seconds). The Lambda function can override this by returning a ttlOverride key in its response.
        
        authorizerUri (string) –
        
        The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can be a standard Lambda ARN, a version ARN ( .../v3), or an alias ARN.
        
        Note: This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is done for you. To use the Command Line Interface (CLI), run the following:
        
        aws lambda add-permission --function-name "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id "appsync" --principal appsync.amazonaws.com --action lambda:InvokeFunction
        
        identityValidationExpression (string) –
        
        A regular expression for validation of tokens before the Lambda function is called.
  - xrayEnabled (boolean) –
    
    A flag indicating whether to use X-Ray tracing for this GraphqlApi.
  - wafWebAclArn (string) –
    
    The ARN of the WAF access control list (ACL) associated with this GraphqlApi, if one exists.
  - lambdaAuthorizerConfig (dict) –
    
    Configuration for Lambda function authorization.
    - authorizerResultTtlInSeconds (integer) –
      
      The number of seconds a response should be cached for. The default is 0 seconds, which disables caching. If you don’t specify a value for authorizerResultTtlInSeconds, the default value is used. The maximum value is one hour (3600 seconds). The Lambda function can override this by returning a ttlOverride key in its response.
    - authorizerUri (string) –
      
      The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can be a standard Lambda ARN, a version ARN ( .../v3), or an alias ARN.
      
      Note: This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is done for you. To use the Command Line Interface (CLI), run the following:
      
      aws lambda add-permission --function-name "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id "appsync" --principal appsync.amazonaws.com --action lambda:InvokeFunction
    - identityValidationExpression (string) –
      
      A regular expression for validation of tokens before the Lambda function is called.
  - dns (dict) –
    
    The DNS records for the API.
    - (string) –
      - (string) –
  - visibility (string) –
    
    Sets the value of the GraphQL API to public ( GLOBAL) or private ( PRIVATE). If no value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed once the API has been created.

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