AWS AppSync

2020/10/01 - AWS AppSync - 7 updated api methods

Changes  Exposes the wafWebAclArn field on GraphQL api records. The wafWebAclArn field contains the amazon resource name of a WAF Web ACL if the AWS AppSync API is associated with one.

CreateApiKey (updated) Link ¶
Changes (response) 
{'apiKey': {'deletes': 'long'}}

Creates a unique key that you can distribute to clients who are executing your API.

See also: AWS API Documentation

Request Syntax

client.create_api_key(
    apiId='string',
    description='string',
    expires=123
)
type apiId

string

param apiId

[REQUIRED]

The ID for your GraphQL API.

type description

string

param description

A description of the purpose of the API key.

type expires

integer

param expires

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 .

rtype

dict

returns

Response Syntax

{
    'apiKey': {
        'id': 'string',
        'description': 'string',
        'expires': 123,
        'deletes': 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.

      • deletes (integer) --

        The time after which the API key is deleted. The date is represented as seconds since the epoch, rounded down to the nearest hour.

CreateGraphqlApi (updated) Link ¶
Changes (response) 
{'graphqlApi': {'wafWebAclArn': 'string'}}

Creates a GraphqlApi object.

See also: AWS API Documentation

Request Syntax

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
)
type name

string

param name

[REQUIRED]

A user-supplied name for the GraphqlApi .

type logConfig

dict

param logConfig

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.

type authenticationType

string

param authenticationType

[REQUIRED]

The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.

type userPoolConfig

dict

param userPoolConfig

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.

type openIDConnectConfig

dict

param openIDConnectConfig

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.

type tags

dict

param tags

A TagMap object.

  • (string) --

    The key for the tag.

    • (string) --

      The value for the tag.

type additionalAuthenticationProviders

list

param additionalAuthenticationProviders

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.

type xrayEnabled

boolean

param xrayEnabled

A flag indicating whether to enable X-Ray tracing for the GraphqlApi .

rtype

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,
        'wafWebAclArn': 'string'
    }
}

Response Structure

  • (dict) --

    • graphqlApi (dict) --

      The GraphqlApi .

      • name (string) --

        The API name.

      • apiId (string) --

        The API ID.

      • authenticationType (string) --

        The authentication type.

      • logConfig (dict) --

        The Amazon CloudWatch Logs configuration.

        • fieldLogLevel (string) --

          The field logging level. Values can be NONE, ERROR, or ALL.

          • 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 .

      • wafWebAclArn (string) --

        The ARN of the AWS WAF ACL associated with this GraphqlApi if one exists.

GetGraphqlApi (updated) Link ¶
Changes (response) 
{'graphqlApi': {'wafWebAclArn': 'string'}}

Retrieves a GraphqlApi object.

See also: AWS API Documentation

Request Syntax

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

string

param apiId

[REQUIRED]

The API ID for the GraphQL API.

rtype

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,
        'wafWebAclArn': 'string'
    }
}

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 .

      • wafWebAclArn (string) --

        The ARN of the AWS WAF ACL associated with this GraphqlApi if one exists.

ListApiKeys (updated) Link ¶
Changes (response) 
{'apiKeys': {'deletes': 'long'}}

Lists the API keys for a given API.

Note

API keys are deleted automatically 60 days 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

client.list_api_keys(
    apiId='string',
    nextToken='string',
    maxResults=123
)
type apiId

string

param apiId

[REQUIRED]

The API ID.

type nextToken

string

param nextToken

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.

type maxResults

integer

param maxResults

The maximum number of results you want the request to return.

rtype

dict

returns

Response Syntax

{
    'apiKeys': [
        {
            'id': 'string',
            'description': 'string',
            'expires': 123,
            'deletes': 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 and deletion time in seconds.

        • CreateApiKey returns the expiration time and deletion time in seconds and accepts a user-provided expiration time in seconds.

        • UpdateApiKey returns the expiration time and and deletion time in seconds and accepts a user-provided expiration time in seconds. Expired API keys are kept for 60 days after the expiration time. Key expiration time can be updated while the key is not deleted.

        • DeleteApiKey deletes the item from the table.

        • Expiration is stored in Amazon DynamoDB as seconds. After the expiration time, using the key to authenticate will fail. But the key can be reinstated before deletion.

        • Deletion is stored in Amazon DynamoDB as seconds. The key will be deleted after deletion time.

        • 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.

        • deletes (integer) --

          The time after which the API key is deleted. 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.

ListGraphqlApis (updated) Link ¶
Changes (response) 
{'graphqlApis': {'wafWebAclArn': 'string'}}

Lists your GraphQL APIs.

See also: AWS API Documentation

Request Syntax

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

string

param nextToken

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.

type maxResults

integer

param maxResults

The maximum number of results you want the request to return.

rtype

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,
            'wafWebAclArn': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • graphqlApis (list) --

      The GraphqlApi objects.

      • (dict) --

        Describes a GraphQL API.

        • name (string) --

          The API name.

        • apiId (string) --

          The API ID.

        • authenticationType (string) --

          The authentication type.

        • logConfig (dict) --

          The Amazon CloudWatch Logs configuration.

          • fieldLogLevel (string) --

            The field logging level. Values can be NONE, ERROR, or ALL.

            • 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 .

        • wafWebAclArn (string) --

          The ARN of the AWS WAF ACL associated with this GraphqlApi if one exists.

    • nextToken (string) --

      An identifier to be passed in the next request to this operation to return the next set of items in the list.

UpdateApiKey (updated) Link ¶
Changes (response) 
{'apiKey': {'deletes': 'long'}}

Updates an API key. The key can be updated while it is not deleted.

See also: AWS API Documentation

Request Syntax

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

string

param apiId

[REQUIRED]

The ID for the GraphQL API.

type id

string

param id

[REQUIRED]

The API key ID.

type description

string

param description

A description of the purpose of the API key.

type expires

integer

param expires

The time from update time after which the API key expires. The date is represented as seconds since the epoch. For more information, see .

rtype

dict

returns

Response Syntax

{
    'apiKey': {
        'id': 'string',
        'description': 'string',
        'expires': 123,
        'deletes': 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.

      • deletes (integer) --

        The time after which the API key is deleted. The date is represented as seconds since the epoch, rounded down to the nearest hour.

UpdateGraphqlApi (updated) Link ¶
Changes (response) 
{'graphqlApi': {'wafWebAclArn': 'string'}}

Updates a GraphqlApi object.

See also: AWS API Documentation

Request Syntax

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
)
type apiId

string

param apiId

[REQUIRED]

The API ID.

type name

string

param name

[REQUIRED]

The new name for the GraphqlApi object.

type logConfig

dict

param logConfig

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.

type authenticationType

string

param authenticationType

The new authentication type for the GraphqlApi object.

type userPoolConfig

dict

param userPoolConfig

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.

type openIDConnectConfig

dict

param openIDConnectConfig

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.

type additionalAuthenticationProviders

list

param additionalAuthenticationProviders

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.

type xrayEnabled

boolean

param xrayEnabled

A flag indicating whether to enable X-Ray tracing for the GraphqlApi .

rtype

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,
        'wafWebAclArn': 'string'
    }
}

Response Structure

  • (dict) --

    • graphqlApi (dict) --

      The updated GraphqlApi object.

      • name (string) --

        The API name.

      • apiId (string) --

        The API ID.

      • authenticationType (string) --

        The authentication type.

      • logConfig (dict) --

        The Amazon CloudWatch Logs configuration.

        • fieldLogLevel (string) --

          The field logging level. Values can be NONE, ERROR, or ALL.

          • 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 .

      • wafWebAclArn (string) --

        The ARN of the AWS WAF ACL associated with this GraphqlApi if one exists.