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
# include <aws/core/Aws.h>
# include <aws/dynamodb/DynamoDBClient.h>
# include <aws/dynamodb/model/AttributeDefinition.h>
# include <aws/dynamodb/model/DeleteItemRequest.h>
# include <iostream>
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:[cpp.example_code.dynamodb.delete_item]
//! Delete an item from an Amazon DynamoDB table.
/*!
\sa deleteItem()
\param tableName: The table name.
\param partitionKey: The partition key.
\param partitionValue: The value for the partition key.
\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 : : deleteItem ( const Aws : : String & tableName ,
const Aws : : String & partitionKey ,
const Aws : : String & partitionValue ,
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 : : DeleteItemRequest request ;
2021-12-02 15:10:47 -05:00
2022-12-20 11:23:09 -05:00
request . AddKey ( partitionKey ,
Aws : : DynamoDB : : Model : : AttributeValue ( ) . SetS ( partitionValue ) ) ;
request . SetTableName ( tableName ) ;
2021-12-02 15:10:47 -05:00
2022-12-20 11:23:09 -05:00
const Aws : : DynamoDB : : Model : : DeleteItemOutcome & outcome = dynamoClient . DeleteItem (
request ) ;
if ( outcome . IsSuccess ( ) ) {
std : : cout < < " Item \" " < < partitionValue < < " \" deleted! " < < std : : endl ;
}
else {
std : : cerr < < " Failed to delete item: " < < outcome . GetError ( ) . GetMessage ( )
< < std : : endl ;
2024-10-01 15:30:45 -04:00
return false ;
2022-12-20 11:23:09 -05:00
}
2024-10-01 15:30:45 -04:00
return waitTableActive ( tableName , dynamoClient ) ;
2022-12-20 11:23:09 -05:00
}
// snippet-end:[cpp.example_code.dynamodb.delete_item]
/*
*
* main function
*
* Usage: 'run_delete_item <table_name> <partition_key> <partition_value>'
*
* Prerequisites: Create a DynamoDB table named <table_name> that contains an
* item with <partition_value> for its <partition_key>.
*
*/
# ifndef TESTING_BUILD
int main ( int argc , char * * argv ) {
if ( argc < 4 ) {
std : : cout < < R " ( " Usage :
run_delete_item < table_name > < partition_key > < partition_value >
Where :
table - The table to delete the item from .
partition_key - The partition key of the table ,
partition_value - The item value for the partition key .
Example :
run_delete_item HelloTable Name Joe
* * Warning * * This program will actually delete the item
that you specify ! ) " ;
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 ] ) ;
const Aws : : String partitionKey = ( argv [ 2 ] ) ;
const Aws : : String partitionValue = ( argv [ 3 ] ) ;
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";
2021-12-02 15:10:47 -05:00
2022-12-20 11:23:09 -05:00
AwsDoc : : DynamoDB : : deleteItem ( tableName , partitionKey , partitionValue ,
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
