2021-12-15 11:06:27 -05:00
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
2021-07-15 14:56:24 -04:00
# include <iostream>
# include <aws/core/Aws.h>
# include <aws/s3/S3Client.h>
# include <aws/s3/model/DeleteObjectRequest.h>
2024-07-03 09:52:38 -04:00
# include "s3_examples.h"
2021-07-15 14:56:24 -04:00
2022-09-15 09:33:04 -04:00
/**
* Before running this C++ code example, set up your development environment, including your credentials.
2021-07-15 14:56:24 -04:00
*
2022-09-15 09:33:04 -04:00
* For more information, see the following documentation topic:
*
2022-09-26 14:24:21 -04:00
* https://docs.aws.amazon.com/sdk-for-cpp/v1/developer-guide/getting-started.html
2022-09-15 09:33:04 -04:00
*
* Purpose
*
* Demonstrates using the AWS SDK for C++ to delete an object in an S3 bucket.
2021-07-15 14:56:24 -04:00
*
2021-12-15 11:06:27 -05:00
*/
2021-07-15 14:56:24 -04:00
2022-09-15 09:33:04 -04:00
//! Routine which demonstrates deleting an object in an S3 bucket.
/*!
2024-07-03 09:52:38 -04:00
\param objectKey: Name of an object.
\param fromBucket: Name of a bucket with an object to delete.
\param clientConfig: Aws client configuration.
\return bool: Function succeeded.
2022-09-15 09:33:04 -04:00
*/
2022-07-28 18:11:43 -04:00
2022-09-15 09:33:04 -04:00
// snippet-start:[s3.cpp.delete_object.code]
2024-07-03 09:52:38 -04:00
bool AwsDoc : : S3 : : deleteObject ( const Aws : : String & objectKey ,
2022-09-15 09:33:04 -04:00
const Aws : : String & fromBucket ,
2024-07-03 09:52:38 -04:00
const Aws : : S3 : : S3ClientConfiguration & clientConfig ) {
2022-07-28 18:11:43 -04:00
Aws : : S3 : : S3Client client ( clientConfig ) ;
Aws : : S3 : : Model : : DeleteObjectRequest request ;
request . WithKey ( objectKey )
. WithBucket ( fromBucket ) ;
Aws : : S3 : : Model : : DeleteObjectOutcome outcome =
client . DeleteObject ( request ) ;
2022-09-15 09:33:04 -04:00
if ( ! outcome . IsSuccess ( ) ) {
2022-07-28 18:11:43 -04:00
auto err = outcome . GetError ( ) ;
2024-07-03 09:52:38 -04:00
std : : cerr < < " Error: deleteObject: " < <
2022-07-28 18:11:43 -04:00
err . GetExceptionName ( ) < < " : " < < err . GetMessage ( ) < < std : : endl ;
2024-07-03 09:52:38 -04:00
} else {
2022-07-28 18:11:43 -04:00
std : : cout < < " Successfully deleted the object. " < < std : : endl ;
}
2022-09-15 09:33:04 -04:00
return outcome . IsSuccess ( ) ;
2022-07-28 18:11:43 -04:00
}
2022-09-15 09:33:04 -04:00
// snippet-end:[s3.cpp.delete_object.code]
2021-07-15 14:56:24 -04:00
2022-09-15 09:33:04 -04:00
/*
*
* main function
*
2024-07-03 09:52:38 -04:00
* usage: 'run_delete_object <object_key> <from_bucket>'
2022-09-15 09:33:04 -04:00
*
2024-07-03 09:52:38 -04:00
* Prerequisites: The bucket containing the object to delete.
2022-09-15 09:33:04 -04:00
*
*/
2024-07-24 10:52:59 -04:00
# ifndef EXCLUDE_MAIN_FUNCTION
2022-09-15 09:33:04 -04:00
2024-07-03 09:52:38 -04:00
int main ( int argc , char * argv [ ] ) {
2021-07-15 14:56:24 -04:00
Aws : : SDKOptions options ;
Aws : : InitAPI ( options ) ;
2024-07-03 09:52:38 -04:00
if ( argc ! = 3 ) {
std : : cout < < R " (
Usage :
run_delete_object < object_key > < from_bucket >
Where :
object_key - The unique identifier for the object in the bucket .
from_bucket - The name of the bucket containing the object .
) " << std::endl;
return 1 ;
}
Aws : : String objectKey = argv [ 1 ] ;
Aws : : String fromBucket = argv [ 2 ] ;
2022-09-15 09:33:04 -04:00
{
2024-07-03 09:52:38 -04:00
Aws : : S3 : : S3ClientConfiguration clientConfig ;
2022-09-15 09:33:04 -04:00
// Optional: Set to the AWS Region in which the bucket was created (overrides config file).
// clientConfig.region = "us-east-1";
2024-07-03 09:52:38 -04:00
AwsDoc : : S3 : : deleteObject ( objectKey , fromBucket , clientConfig ) ;
2022-09-15 09:33:04 -04:00
}
2021-12-15 11:06:27 -05:00
2021-07-15 14:56:24 -04:00
ShutdownAPI ( options ) ;
return 0 ;
}
2022-09-15 09:33:04 -04:00
2024-07-24 10:52:59 -04:00
# endif // EXCLUDE_MAIN_FUNCTION