AppSync / Client / update_api_key

update_api_key#

AppSync.Client.update_api_key(**kwargs)#

Updates an API key. You can update the key as long as it’s not deleted.

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) – From the update time, the 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,
        '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.

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