WAFV2 / Client / list_api_keys

list_api_keys#

WAFV2.Client.list_api_keys(**kwargs)#

Retrieves a list of the API keys that you’ve defined for the specified scope.

API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.list_api_keys(
    Scope='CLOUDFRONT'|'REGIONAL',
    NextMarker='string',
    Limit=123
)
Parameters:

  • Scope (string) –

    [REQUIRED]

    Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    • API and SDKs - For all calls, use the Region endpoint us-east-1.

  • NextMarker (string) – When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

  • Limit (integer) – The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

Return type:

dict

Returns:

Response Syntax

{
    'NextMarker': 'string',
    'APIKeySummaries': [
        {
            'TokenDomains': [
                'string',
            ],
            'APIKey': 'string',
            'CreationTimestamp': datetime(2015, 1, 1),
            'Version': 123
        },
    ],
    'ApplicationIntegrationURL': 'string'
}

Response Structure

  • (dict) –

    • NextMarker (string) –

      When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

    • APIKeySummaries (list) –

      The array of key summaries. If you specified a Limit in your request, this might not be the full list.

      • (dict) –

        Information for a single API key.

        API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.

        • TokenDomains (list) –

          The token domains that are defined in this API key.

          • (string) –

        • APIKey (string) –

          The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.

        • CreationTimestamp (datetime) –

          The date and time that the key was created.

        • Version (integer) –

          Internal value used by WAF to manage the key.

    • ApplicationIntegrationURL (string) –

      The CAPTCHA application integration URL, for use in your JavaScript implementation.

Exceptions

  • WAFV2.Client.exceptions.WAFInternalErrorException

  • WAFV2.Client.exceptions.WAFInvalidParameterException

  • WAFV2.Client.exceptions.WAFInvalidOperationException

  • WAFV2.Client.exceptions.WAFInvalidResourceException