Utilisation DescribeTimeToLive avec un AWS SDK ou une CLI

Les exemples de code suivants montrent comment utiliserDescribeTimeToLive.

CLI

AWS CLI

Pour afficher les paramètres Time to Live d'une table

L'describe-time-to-liveexemple suivant affiche les paramètres Time to Live de la MusicCollection table.

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

Sortie :

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

Pour plus d'informations, consultez Time to Live dans le manuel du développeur Amazon DynamoDB.

• Pour plus de détails sur l'API, reportez-vous DescribeTimeToLiveà la section Référence des AWS CLI commandes.

Java

SDK pour Java 2.x

Décrivez la configuration TTL sur une table DynamoDB existante.

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.Optional;

        final DescribeTimeToLiveRequest request = DescribeTimeToLiveRequest.builder()
                .tableName(tableName)
                .build();
        try (DynamoDbClient ddb = DynamoDbClient.builder()
                .region(region)
                .build()) {
            final DescribeTimeToLiveResponse response = ddb.describeTimeToLive(request);
            System.out.println(tableName + " description of time to live is "
                    + response.toString());
        } catch (ResourceNotFoundException e) {
            System.err.format("Error: The Amazon DynamoDB table \"%s\" can't be found.\n", tableName);
            System.exit(1);
        } catch (DynamoDbException e) {
            System.err.println(e.getMessage());
            System.exit(1);
        }
        System.exit(0);

• Pour plus de détails sur l'API, reportez-vous DescribeTimeToLiveà la section Référence des AWS SDK for Java 2.x API.

JavaScript

SDK pour JavaScript (v3)

// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
import { DynamoDBClient, DescribeTimeToLiveCommand } from "@aws-sdk/client-dynamodb";

const describeTableTTL = 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;
    }
}

// enter table name and change region if desired.
describeTableTTL('your-table-name', 'us-east-1');

• Pour plus de détails sur l'API, reportez-vous DescribeTimeToLiveà la section Référence des AWS SDK for JavaScript API.

Python

SDK pour Python (Boto3)

# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
# SPDX-License-Identifier: Apache-2.0
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 DescribeTimeToLivele AWS manuel de référence de l'API SDK for Python (Boto3).

Pour obtenir la liste complète des guides de développement du AWS SDK et des exemples de code, consultezUtilisation de DynamoDB avec un SDK AWS. Cette rubrique comprend également des informations sur le démarrage et sur les versions précédentes de SDK.