Utilisation de DescribeTimeToLive avec un kit AWS SDK ou une interface de ligne de commande

Les exemples de code suivants illustrent comment utiliser DescribeTimeToLive.

Les exemples d’actions sont des extraits de code de programmes de plus grande envergure et doivent être exécutés en contexte. Vous pouvez voir cette action en contexte dans l’exemple de code suivant :

• Utilisation de Streams et Time-to-Live

CLI

AWS CLI

Pour afficher les paramètres Durée de vie (TTL) d’une table

L’exemple describe-time-to-live suivant affiche les paramètres Durée de vie (TTL) de la table MusicCollection.

aws dynamodb describe-time-to-live \
    --table-name MusicCollection

Sortie :

{
    "TimeToLiveDescription": {
        "TimeToLiveStatus": "ENABLED",
        "AttributeName": "ttl"
    }
}

Pour plus d’informations, consultez Durée de vie dans le Guide du développeur Amazon DynamoDB.

• Pour plus de détails sur l’API, consultez DescribeTimeToLive dans la Référence des commandes de l’AWS CLI.

Java

SDK pour Java 2.x

Décrire la configuration Durée de vie (TTL) sur une table DynamoDB existante à l’aide du kit AWS SDK for Java 2.x.

import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.dynamodb.DynamoDbClient;
import software.amazon.awssdk.services.dynamodb.model.DescribeTimeToLiveRequest;
import software.amazon.awssdk.services.dynamodb.model.DescribeTimeToLiveResponse;
import software.amazon.awssdk.services.dynamodb.model.DynamoDbException;
import software.amazon.awssdk.services.dynamodb.model.ResourceNotFoundException;

import java.util.logging.Level;
import java.util.logging.Logger;

    public DescribeTimeToLiveResponse describeTTL(final String tableName, final Region region) {
        final DescribeTimeToLiveRequest request =
            DescribeTimeToLiveRequest.builder().tableName(tableName).build();

        try (DynamoDbClient ddb = dynamoDbClient != null
            ? dynamoDbClient
            : DynamoDbClient.builder().region(region).build()) {
            return ddb.describeTimeToLive(request);
        } catch (ResourceNotFoundException e) {
            System.err.format(TABLE_NOT_FOUND_ERROR, tableName);
            throw e;
        } catch (DynamoDbException e) {
            System.err.println(e.getMessage());
            throw e;
        }
    }

• Pour plus de détails sur l’API, consultez DescribeTimeToLive dans la Référence des API du kit AWS SDK for Java 2.x.

JavaScript

Kit SDK pour JavaScript (v3)

Décrire la configuration Durée de vie (TTL) sur une table DynamoDB existante à l’aide du kit AWS SDK pour JavaScript.

import { DynamoDBClient, DescribeTimeToLiveCommand } from "@aws-sdk/client-dynamodb";

export const describeTTL = async (tableName, region) => {
    const client = new DynamoDBClient({
        region: region,
        endpoint: `https://dynamodb.${region}.amazonaws.com`
    });

    try {
        const ttlDescription = await client.send(new DescribeTimeToLiveCommand({ TableName: tableName }));

        if (ttlDescription.TimeToLiveDescription.TimeToLiveStatus === 'ENABLED') {
            console.log("TTL is enabled for table %s.", tableName);
        } else {
            console.log("TTL is not enabled for table %s.", tableName);
        }

        return ttlDescription;
    } catch (e) {
        console.error(`Error describing table: ${e}`);
        throw e;
    }
}

// Example usage (commented out for testing)
// describeTTL('your-table-name', 'us-east-1');

• Pour plus de détails sur l’API, consultez DescribeTimeToLive dans la Référence des API du kit AWS SDK pour JavaScript.

Python

Kit SDK pour Python (Boto3)

Décrire la configuration Durée de vie (TTL) sur une table DynamoDB existante à l’aide du kit AWS SDK pour Python (Boto3).

import boto3


def describe_ttl(table_name, region):
    """
    Describes TTL on an existing table, as well as a region.

    :param table_name: String representing the name of the table
    :param region: AWS Region of the table - example `us-east-1`
    :return: Time to live description.
    """
    try:
        dynamodb = boto3.resource("dynamodb", region_name=region)
        ttl_description = dynamodb.describe_time_to_live(TableName=table_name)
        print(
            f"TimeToLive for table {table_name} is status {ttl_description['TimeToLiveDescription']['TimeToLiveStatus']}"
        )

        return ttl_description
    except Exception as e:
        print(f"Error describing table: {e}")
        raise


# Enter your own table name and AWS region
describe_ttl("your-table-name", "us-east-1")

• Pour plus de détails sur l’API, consultez DescribeTimeToLive dans la Référence des API du kit AWS SDK for Python (Boto3).