AWS SDK for C++  1.9.66
AWS SDK for C++
Public Member Functions | List of all members
Aws::Rekognition::Model::S3Object Class Reference

#include <S3Object.h>

Public Member Functions

 S3Object ()
 
 S3Object (Aws::Utils::Json::JsonView jsonValue)
 
S3Objectoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetBucket () const
 
bool BucketHasBeenSet () const
 
void SetBucket (const Aws::String &value)
 
void SetBucket (Aws::String &&value)
 
void SetBucket (const char *value)
 
S3ObjectWithBucket (const Aws::String &value)
 
S3ObjectWithBucket (Aws::String &&value)
 
S3ObjectWithBucket (const char *value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
S3ObjectWithName (const Aws::String &value)
 
S3ObjectWithName (Aws::String &&value)
 
S3ObjectWithName (const char *value)
 
const Aws::StringGetVersion () const
 
bool VersionHasBeenSet () const
 
void SetVersion (const Aws::String &value)
 
void SetVersion (Aws::String &&value)
 
void SetVersion (const char *value)
 
S3ObjectWithVersion (const Aws::String &value)
 
S3ObjectWithVersion (Aws::String &&value)
 
S3ObjectWithVersion (const char *value)
 

Detailed Description

Provides the S3 bucket name and object name.

The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition Developer Guide.

See Also:

AWS API Reference

Definition at line 36 of file S3Object.h.

Constructor & Destructor Documentation

◆ S3Object() [1/2]

Aws::Rekognition::Model::S3Object::S3Object ( )

◆ S3Object() [2/2]

Aws::Rekognition::Model::S3Object::S3Object ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ BucketHasBeenSet()

bool Aws::Rekognition::Model::S3Object::BucketHasBeenSet ( ) const
inline

Name of the S3 bucket.

Definition at line 53 of file S3Object.h.

◆ GetBucket()

const Aws::String& Aws::Rekognition::Model::S3Object::GetBucket ( ) const
inline

Name of the S3 bucket.

Definition at line 48 of file S3Object.h.

◆ GetName()

const Aws::String& Aws::Rekognition::Model::S3Object::GetName ( ) const
inline

S3 object key name.

Definition at line 89 of file S3Object.h.

◆ GetVersion()

const Aws::String& Aws::Rekognition::Model::S3Object::GetVersion ( ) const
inline

If the bucket is versioning enabled, you can specify the object version.

Definition at line 130 of file S3Object.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Rekognition::Model::S3Object::Jsonize ( ) const

◆ NameHasBeenSet()

bool Aws::Rekognition::Model::S3Object::NameHasBeenSet ( ) const
inline

S3 object key name.

Definition at line 94 of file S3Object.h.

◆ operator=()

S3Object& Aws::Rekognition::Model::S3Object::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetBucket() [1/3]

void Aws::Rekognition::Model::S3Object::SetBucket ( Aws::String &&  value)
inline

Name of the S3 bucket.

Definition at line 63 of file S3Object.h.

◆ SetBucket() [2/3]

void Aws::Rekognition::Model::S3Object::SetBucket ( const Aws::String value)
inline

Name of the S3 bucket.

Definition at line 58 of file S3Object.h.

◆ SetBucket() [3/3]

void Aws::Rekognition::Model::S3Object::SetBucket ( const char *  value)
inline

Name of the S3 bucket.

Definition at line 68 of file S3Object.h.

◆ SetName() [1/3]

void Aws::Rekognition::Model::S3Object::SetName ( Aws::String &&  value)
inline

S3 object key name.

Definition at line 104 of file S3Object.h.

◆ SetName() [2/3]

void Aws::Rekognition::Model::S3Object::SetName ( const Aws::String value)
inline

S3 object key name.

Definition at line 99 of file S3Object.h.

◆ SetName() [3/3]

void Aws::Rekognition::Model::S3Object::SetName ( const char *  value)
inline

S3 object key name.

Definition at line 109 of file S3Object.h.

◆ SetVersion() [1/3]

void Aws::Rekognition::Model::S3Object::SetVersion ( Aws::String &&  value)
inline

If the bucket is versioning enabled, you can specify the object version.

Definition at line 145 of file S3Object.h.

◆ SetVersion() [2/3]

void Aws::Rekognition::Model::S3Object::SetVersion ( const Aws::String value)
inline

If the bucket is versioning enabled, you can specify the object version.

Definition at line 140 of file S3Object.h.

◆ SetVersion() [3/3]

void Aws::Rekognition::Model::S3Object::SetVersion ( const char *  value)
inline

If the bucket is versioning enabled, you can specify the object version.

Definition at line 150 of file S3Object.h.

◆ VersionHasBeenSet()

bool Aws::Rekognition::Model::S3Object::VersionHasBeenSet ( ) const
inline

If the bucket is versioning enabled, you can specify the object version.

Definition at line 135 of file S3Object.h.

◆ WithBucket() [1/3]

S3Object& Aws::Rekognition::Model::S3Object::WithBucket ( Aws::String &&  value)
inline

Name of the S3 bucket.

Definition at line 78 of file S3Object.h.

◆ WithBucket() [2/3]

S3Object& Aws::Rekognition::Model::S3Object::WithBucket ( const Aws::String value)
inline

Name of the S3 bucket.

Definition at line 73 of file S3Object.h.

◆ WithBucket() [3/3]

S3Object& Aws::Rekognition::Model::S3Object::WithBucket ( const char *  value)
inline

Name of the S3 bucket.

Definition at line 83 of file S3Object.h.

◆ WithName() [1/3]

S3Object& Aws::Rekognition::Model::S3Object::WithName ( Aws::String &&  value)
inline

S3 object key name.

Definition at line 119 of file S3Object.h.

◆ WithName() [2/3]

S3Object& Aws::Rekognition::Model::S3Object::WithName ( const Aws::String value)
inline

S3 object key name.

Definition at line 114 of file S3Object.h.

◆ WithName() [3/3]

S3Object& Aws::Rekognition::Model::S3Object::WithName ( const char *  value)
inline

S3 object key name.

Definition at line 124 of file S3Object.h.

◆ WithVersion() [1/3]

S3Object& Aws::Rekognition::Model::S3Object::WithVersion ( Aws::String &&  value)
inline

If the bucket is versioning enabled, you can specify the object version.

Definition at line 160 of file S3Object.h.

◆ WithVersion() [2/3]

S3Object& Aws::Rekognition::Model::S3Object::WithVersion ( const Aws::String value)
inline

If the bucket is versioning enabled, you can specify the object version.

Definition at line 155 of file S3Object.h.

◆ WithVersion() [3/3]

S3Object& Aws::Rekognition::Model::S3Object::WithVersion ( const char *  value)
inline

If the bucket is versioning enabled, you can specify the object version.

Definition at line 165 of file S3Object.h.


The documentation for this class was generated from the following file: