2021-12-02 15:10:47 -05:00
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
2022-12-20 11:23:09 -05:00
/**
* Before running this C++ code example, set up your development environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-cpp/v1/developer-guide/getting-started.html
*
* For information on the structure of the code examples and how to build and run the examples, see
* https://docs.aws.amazon.com/sdk-for-cpp/v1/developer-guide/getting-started-code-examples.html.
*
**/
2021-12-02 15:10:47 -05:00
// snippet-start:[dynamodb.cpp.describe_table.inc]
# include <aws/core/Aws.h>
# include <aws/dynamodb/DynamoDBClient.h>
# include <aws/dynamodb/model/DescribeTableRequest.h>
# include <iostream>
// snippet-end:[dynamodb.cpp.describe_table.inc]
2022-12-20 11:23:09 -05:00
# include "dynamodb_samples.h"
2021-12-02 15:10:47 -05:00
2022-12-20 11:23:09 -05:00
// snippet-start:[dynamodb.cpp.describe_table.code]
//! Describe an Amazon DynamoDB table.
/*!
\sa describeTable()
\param tableName: The DynamoDB table name.
\param clientConfiguration: AWS client configuration.
\return bool: Function succeeded.
2021-12-02 15:10:47 -05:00
*/
2022-12-20 11:23:09 -05:00
bool AwsDoc : : DynamoDB : : describeTable ( const Aws : : String & tableName ,
const Aws : : Client : : ClientConfiguration & clientConfiguration ) {
Aws : : DynamoDB : : DynamoDBClient dynamoClient ( clientConfiguration ) ;
2021-12-02 15:10:47 -05:00
2022-12-20 11:23:09 -05:00
Aws : : DynamoDB : : Model : : DescribeTableRequest request ;
request . SetTableName ( tableName ) ;
2021-12-02 15:10:47 -05:00
2022-12-20 11:23:09 -05:00
const Aws : : DynamoDB : : Model : : DescribeTableOutcome & outcome = dynamoClient . DescribeTable (
request ) ;
if ( outcome . IsSuccess ( ) ) {
const Aws : : DynamoDB : : Model : : TableDescription & td = outcome . GetResult ( ) . GetTable ( ) ;
std : : cout < < " Table name : " < < td . GetTableName ( ) < < std : : endl ;
std : : cout < < " Table ARN : " < < td . GetTableArn ( ) < < std : : endl ;
std : : cout < < " Status : "
< < Aws : : DynamoDB : : Model : : TableStatusMapper : : GetNameForTableStatus (
td . GetTableStatus ( ) ) < < std : : endl ;
std : : cout < < " Item count : " < < td . GetItemCount ( ) < < std : : endl ;
std : : cout < < " Size (bytes): " < < td . GetTableSizeBytes ( ) < < std : : endl ;
const Aws : : DynamoDB : : Model : : ProvisionedThroughputDescription & ptd = td . GetProvisionedThroughput ( ) ;
std : : cout < < " Throughput " < < std : : endl ;
std : : cout < < " Read Capacity : " < < ptd . GetReadCapacityUnits ( ) < < std : : endl ;
std : : cout < < " Write Capacity: " < < ptd . GetWriteCapacityUnits ( ) < < std : : endl ;
const Aws : : Vector < Aws : : DynamoDB : : Model : : AttributeDefinition > & ad = td . GetAttributeDefinitions ( ) ;
std : : cout < < " Attributes " < < std : : endl ;
for ( const auto & a : ad )
std : : cout < < " " < < a . GetAttributeName ( ) < < " ( " < <
Aws : : DynamoDB : : Model : : ScalarAttributeTypeMapper : : GetNameForScalarAttributeType (
a . GetAttributeType ( ) ) < <
" ) " < < std : : endl ;
}
else {
std : : cerr < < " Failed to describe table: " < < outcome . GetError ( ) . GetMessage ( ) ;
}
return outcome . IsSuccess ( ) ;
}
// snippet-end:[dynamodb.cpp.describe_table.code]
/*
*
* main function
*
* Usage: 'run_describe_table <table_name>'
*
* Prerequisites: Create a DynamoDB table named <table_name>.
*
*/
# ifndef TESTING_BUILD
int main ( int argc , char * * argv ) {
if ( argc < 1 ) {
std : : cout < < R " (
Usage :
run_describe_table < table_name >
Where :
table_name - The table to describe .
) " ;
2021-12-02 15:10:47 -05:00
return 1 ;
}
Aws : : SDKOptions options ;
Aws : : InitAPI ( options ) ;
{
2022-12-20 11:23:09 -05:00
const Aws : : String tableName = ( argv [ 1 ] ) ;
2021-12-02 15:10:47 -05:00
Aws : : Client : : ClientConfiguration clientConfig ;
2022-12-20 11:23:09 -05:00
// Optional: Set to the AWS Region (overrides config file).
// clientConfig.region = "us-east-1";
AwsDoc : : DynamoDB : : describeTable ( tableName , clientConfig ) ;
2021-12-02 15:10:47 -05:00
}
Aws : : ShutdownAPI ( options ) ;
return 0 ;
2022-12-20 11:23:09 -05:00
}
# endif // TESTING_BUILD
