Aws Namespace Reference

Namespaces

namespace  Auth

 

namespace  Client

 

namespace  Config

 

namespace  Crt

 

namespace  Endpoint

 

namespace  Environment

 

namespace  External

 

namespace  FileSystem

 

namespace  Http

 

namespace  Internal

 

namespace  Monitoring

 

namespace  Net

 

namespace  OSVersionInfo

 

namespace  Region

 

namespace  Security

 

namespace  Time

 

namespace  Utils

 

namespace  Version

 

Classes

class  AmazonSerializableWebServiceRequest

 

class  AmazonStreamingWebServiceRequest

 

class  AmazonWebServiceRequest

 

class  AmazonWebServiceResult

 

struct  ArrayDeleter

 

struct  CompareStrings

 

struct  CryptoOptions

 

struct  Deleter

 

struct  HttpOptions

 

struct  IoOptions

 

struct  LoggingOptions

 

struct  MemoryManagementOptions

 

struct  MonitoringOptions

 

class  NoResult

 

struct  SDKOptions

 

class  SimpleIStringStream

 

class  SimpleOStringStream

 

class  SimpleStringStream

 

class  UniquePtrSafeDeleted

 

Typedefs

typedef std::function< void(const AmazonWebServiceRequest &)> RequestRetryHandler

 

typedef std::function< void(const Aws::Http::HttpRequest &)> RequestSignedHandler

 

template<typename T , typename D = Deleter< T >>

using UniquePtr = std::unique_ptr< T, D >

 

template<typename T >

using UniqueArrayPtr = std::unique_ptr< T, ArrayDeleter< T > >

 

template<typename T >

using Allocator = std::allocator< T >

 

template<typename T , std::size_t N>

using Array = std::array< T, N >

 

template<typename T >

using Deque = std::deque< T, Aws::Allocator< T > >

 

template<typename T >

using List = std::list< T, Aws::Allocator< T > >

 

template<typename K , typename V >

using Map = std::map< K, V, std::less< K >, Aws::Allocator< std::pair< const K, V > > >

 

template<typename K , typename V >

using UnorderedMap = std::unordered_map< K, V, std::hash< K >, std::equal_to< K >, Aws::Allocator< std::pair< const K, V > > >

 

template<typename K , typename V >

using MultiMap = std::multimap< K, V, std::less< K >, Aws::Allocator< std::pair< const K, V > > >

 

template<typename V >

using CStringMap = std::map< const char *, V, CompareStrings, Aws::Allocator< std::pair< const char *, V > > >

 

template<typename T >

using Queue = std::queue< T, Deque< T > >

 

template<typename T >

using Set = std::set< T, std::less< T >, Aws::Allocator< T > >

 

template<typename T >

using UnorderedSet = std::unordered_set< T, std::hash< T >, std::equal_to< T >, Aws::Allocator< T > >

 

template<typename T >

using Stack = std::stack< T, Deque< T > >

 

typedef std::basic_ifstream< char, std::char_traits< char > > IFStream

 

typedef std::basic_ofstream< char, std::char_traits< char > > OFStream

 

typedef std::basic_fstream< char, std::char_traits< char > > FStream

 

typedef std::basic_istream< char, std::char_traits< char > > IStream

 

typedef std::basic_ostream< char, std::char_traits< char > > OStream

 

typedef std::basic_iostream< char, std::char_traits< char > > IOStream

 

typedef std::istreambuf_iterator< char, std::char_traits< char > > IStreamBufIterator

 

using IOStreamFactory = std::function< Aws::IOStream *(void) >

 

using String = std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > >

 

typedef std::basic_stringstream< char, std::char_traits< char >, Aws::Allocator< char > > StringStream

 

typedef std::basic_istringstream< char, std::char_traits< char >, Aws::Allocator< char > > IStringStream

 

typedef std::basic_ostringstream< char, std::char_traits< char >, Aws::Allocator< char > > OStringStream

 

typedef std::basic_stringbuf< char, std::char_traits< char >, Aws::Allocator< char > > StringBuf

 

template<typename T >

using Vector = std::vector< T, Aws::Allocator< T > >

 

Functions

AWS_CORE_API void InitAPI (const SDKOptions &options)

 

AWS_CORE_API void ShutdownAPI (const SDKOptions &options)

 

AWS_CORE_API Aws::Crt::ApiHandle * GetApiHandle ()

 

AWS_CORE_API void SetDefaultClientBootstrap (const std::shared_ptr< Aws::Crt::Io::ClientBootstrap > &clientBootstrap)

 

AWS_CORE_API Aws::Crt::Io::ClientBootstrap * GetDefaultClientBootstrap ()

 

AWS_CORE_API void SetDefaultTlsConnectionOptions (const std::shared_ptr< Aws::Crt::Io::TlsConnectionOptions > &tlsConnectionOptions)

 

AWS_CORE_API Aws::Crt::Io::TlsConnectionOptions * GetDefaultTlsConnectionOptions ()

 

void InitializeCrt ()

 

void CleanupCrt ()

 

AWS_CORE_API Utils::EnumParseOverflowContainer * GetEnumOverflowContainer ()

 

void InitializeEnumOverflowContainer ()

 

void CleanupEnumOverflowContainer ()

 

AWS_CORE_API void * Malloc (const char *allocationTag, size_t allocationSize)

 

AWS_CORE_API void Free (void *memoryPtr)

 

AWS_CORE_API aws_allocator * get_aws_allocator ()

 

template<typename T , typename ... ArgTypes>

T * New (const char *allocationTag, ArgTypes &&... args)

 

template<typename T >

std::enable_if<!std::is_polymorphic< T >::value >::type Delete (T *pointerToT)

 

template<typename T >

std::enable_if< std::is_polymorphic< T >::value >::type Delete (T *pointerToT)

 

template<typename T >

bool ShouldConstructArrayMembers ()

 

template<typename T >

bool ShouldDestroyArrayMembers ()

 

template<typename T >

T * NewArray (std::size_t amount, const char *allocationTag)

 

template<typename T >

void DeleteArray (T *pointerToTArray)

 

template<typename T , typename ... ArgTypes>

UniquePtr< T > MakeUnique (const char *allocationTag, ArgTypes &&... args)

 

template<typename T , typename D = Deleter<T>, typename ... ArgTypes>

UniquePtrSafeDeleted< T, D > MakeUniqueSafeDeleted (const char *allocationTag, ArgTypes &&... args)

 

template<typename T , typename ... ArgTypes>

UniqueArrayPtr< T > MakeUniqueArray (std::size_t amount, const char *allocationTag, ArgTypes &&... args)

 

template<typename T , typename ... ArgTypes>

std::shared_ptr< T > MakeShared (const char *allocationTag, ArgTypes &&... args)

 

template<typename Key , typename SourceValue , typename DestinationValue >

void TransformAndInsert (const Aws::UnorderedMap< Key, SourceValue > &src, Aws::Map< Key, DestinationValue > &dst, std::function< DestinationValue(const SourceValue &)> mappingFunc)

 

template<typename K , typename V >

V GetWithDefault (const Aws::Map< K, V > &map, const K &key, V &&defaultValue)

 

Variables

static const char JSON_CONTENT_TYPE [] = "application/json"

 

static const char AMZN_JSON_CONTENT_TYPE_1_0 [] = "application/x-amz-json-1.0"

 

static const char AMZN_JSON_CONTENT_TYPE_1_1 [] = "application/x-amz-json-1.1"

 

static const char FORM_CONTENT_TYPE [] = "application/x-www-form-urlencoded"

 

static const char AMZN_XML_CONTENT_TYPE [] = "application/xml"

 

static const char AMZN_EVENTSTREAM_CONTENT_TYPE [] = "application/vnd.amazon.eventstream"

 

static const char * DEFAULT_CONTENT_TYPE = "binary/octet-stream"

 

static const char * DEFAULT_LOG_PREFIX = "aws_sdk_"

 

Detailed Description

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0.

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0. Please note that this file is autogenerated. The backwards compatibility of the default values provided by new client configuration defaults is not guaranteed; the values might change over time.

Typedef Documentation

Allocator

template<typename T >

using Aws::Allocator = typedef std::allocator<T>

Definition at line 98 of file AWSAllocator.h.

Array

template<typename T , std::size_t N>

using Aws::Array = typedef std::array< T, N >

Definition at line 11 of file AWSArray.h.

CStringMap

template<typename V >

using Aws::CStringMap = typedef std::map<const char*, V, CompareStrings, Aws::Allocator<std::pair<const char*, V> > >

Definition at line 32 of file AWSMap.h.

Deque

template<typename T >

using Aws::Deque = typedef std::deque< T, Aws::Allocator< T > >

Definition at line 17 of file AWSDeque.h.

FStream

typedef std::basic_fstream< char, std::char_traits< char > > Aws::FStream

Definition at line 19 of file AWSStreamFwd.h.

IFStream

typedef std::basic_ifstream< char, std::char_traits< char > > Aws::IFStream

Definition at line 17 of file AWSStreamFwd.h.

IOStream

typedef std::basic_iostream< char, std::char_traits< char > > Aws::IOStream

Definition at line 22 of file AWSStreamFwd.h.

IOStreamFactory

using Aws::IOStreamFactory = typedef std::function< Aws::IOStream*(void) >

Definition at line 25 of file AWSStreamFwd.h.

IStream

typedef std::basic_istream< char, std::char_traits< char > > Aws::IStream

Definition at line 20 of file AWSStreamFwd.h.

IStreamBufIterator

typedef std::istreambuf_iterator< char, std::char_traits< char > > Aws::IStreamBufIterator

Definition at line 23 of file AWSStreamFwd.h.

IStringStream

typedef std::basic_istringstream< char, std::char_traits< char >, Aws::Allocator< char > > Aws::IStringStream

Definition at line 36 of file AWSStringStream.h.

List

template<typename T >

using Aws::List = typedef std::list< T, Aws::Allocator< T > >

Definition at line 17 of file AWSList.h.

Map

template<typename K , typename V >

using Aws::Map = typedef std::map< K, V, std::less< K >, Aws::Allocator< std::pair< const K, V > > >

Definition at line 20 of file AWSMap.h.

MultiMap

template<typename K , typename V >

using Aws::MultiMap = typedef std::multimap< K, V, std::less< K >, Aws::Allocator< std::pair< const K, V > > >

Definition at line 22 of file AWSMap.h.

OFStream

typedef std::basic_ofstream< char, std::char_traits< char > > Aws::OFStream

Definition at line 18 of file AWSStreamFwd.h.

OStream

typedef std::basic_ostream< char, std::char_traits< char > > Aws::OStream

Definition at line 21 of file AWSStreamFwd.h.

OStringStream

typedef std::basic_ostringstream< char, std::char_traits< char >, Aws::Allocator< char > > Aws::OStringStream

Definition at line 37 of file AWSStringStream.h.

Queue

template<typename T >

using Aws::Queue = typedef std::queue< T, Deque< T > >

Definition at line 19 of file AWSQueue.h.

RequestRetryHandler

typedef std::function<void(const AmazonWebServiceRequest&)> Aws::RequestRetryHandler

Closure definition for handling a retry notification. This is only for if you want to be notified that a particular request is being retried.

Definition at line 34 of file AmazonWebServiceRequest.h.

RequestSignedHandler

typedef std::function<void(const Aws::Http::HttpRequest&)> Aws::RequestSignedHandler

Definition at line 35 of file AmazonWebServiceRequest.h.

Set

template<typename T >

using Aws::Set = typedef std::set< T, std::less< T >, Aws::Allocator< T > >

Definition at line 18 of file AWSSet.h.

Stack

template<typename T >

using Aws::Stack = typedef std::stack< T, Deque< T > >

Definition at line 19 of file AWSStack.h.

String

using Aws::String = typedef std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > >

Definition at line 97 of file AWSString.h.

StringBuf

typedef std::basic_stringbuf< char, std::char_traits< char >, Aws::Allocator< char > > Aws::StringBuf

Definition at line 38 of file AWSStringStream.h.

StringStream

typedef std::basic_stringstream< char, std::char_traits< char >, Aws::Allocator< char > > Aws::StringStream

Definition at line 35 of file AWSStringStream.h.

UniqueArrayPtr

template<typename T >

using Aws::UniqueArrayPtr = typedef std::unique_ptr< T, ArrayDeleter< T > >

Definition at line 338 of file AWSMemory.h.

UniquePtr

template<typename T , typename D = Deleter< T >>

using Aws::UniquePtr = typedef std::unique_ptr< T, D >

Definition at line 255 of file AWSMemory.h.

UnorderedMap

template<typename K , typename V >

using Aws::UnorderedMap = typedef std::unordered_map< K, V, std::hash< K >, std::equal_to< K >, Aws::Allocator< std::pair< const K, V > > >

Definition at line 21 of file AWSMap.h.

UnorderedSet

template<typename T >

using Aws::UnorderedSet = typedef std::unordered_set< T, std::hash< T >, std::equal_to< T >, Aws::Allocator< T > >

Definition at line 19 of file AWSSet.h.

Vector

template<typename T >

using Aws::Vector = typedef std::vector< T, Aws::Allocator< T > >

Definition at line 17 of file AWSVector.h.

Function Documentation

CleanupCrt()

void Aws::CleanupCrt ( )

Clean up ApiHandle in aws-crt-cpp.

CleanupEnumOverflowContainer()

void Aws::CleanupEnumOverflowContainer ( )

Destroys the global overflow container instance. This should only be called once from within Aws::ShutdownAPI

Delete() [1/2]

template<typename T >

std::enable_if<!std::is_polymorphic< T >::value >::type Aws::Delete ( T *  pointerToT)

::new, ::delete, ::malloc, ::free, std::make_shared, and std::make_unique should not be used in SDK code use these functions instead or Aws::MakeShared

Definition at line 100 of file AWSMemory.h.

Delete() [2/2]

template<typename T >

std::enable_if< std::is_polymorphic< T >::value >::type Aws::Delete ( T *  pointerToT)

Definition at line 112 of file AWSMemory.h.

DeleteArray()

template<typename T >

void Aws::DeleteArray ( T *  pointerToTArray)

::new, ::delete, ::malloc, ::free, std::make_shared, and std::make_unique should not be used in SDK code use these functions instead or Aws::MakeShared

Definition at line 200 of file AWSMemory.h.

Free()

AWS_CORE_API void Aws::Free ( void *  memoryPtr)

::new, ::delete, ::malloc, ::free, std::make_shared, and std::make_unique should not be used in SDK code use these functions instead or Aws::MakeShared

get_aws_allocator()

AWS_CORE_API aws_allocator * Aws::get_aws_allocator ( )

GetApiHandle()

AWS_CORE_API Aws::Crt::ApiHandle * Aws::GetApiHandle ( )

Like we need to call InitAPI() to initialize aws-sdk-cpp, we need ApiHandle to initialize aws-crt-cpp, which is a wrapper of a collection of common runtime libraries. We will wrap the memory management system and pass it to common runtime libraries via ApiHandle.

GetDefaultClientBootstrap()

AWS_CORE_API Aws::Crt::Io::ClientBootstrap * Aws::GetDefaultClientBootstrap ( )

Get the default ClientBootStrap for AWS common runtime libraries in the global scope.

GetDefaultTlsConnectionOptions()

AWS_CORE_API Aws::Crt::Io::TlsConnectionOptions * Aws::GetDefaultTlsConnectionOptions ( )

Get the default TlsConnectionOptions for AWS common runtime libraries in the global scope.

GetEnumOverflowContainer()

AWS_CORE_API Utils::EnumParseOverflowContainer * Aws::GetEnumOverflowContainer ( )

This is used to handle the Enum round tripping problem for when a service updates their enumerations, but the user does not have an up to date client. This container will be initialized during Aws::InitAPI and will be cleaned on Aws::ShutdownAPI.

GetWithDefault()

template<typename K , typename V >

V Aws::GetWithDefault ( const Aws::Map< K, V > &  map,

const K &  key,

V &&  defaultValue 

)

Definition at line 46 of file AWSMap.h.

InitAPI()

AWS_CORE_API void Aws::InitAPI ( const SDKOptions &  options)

InitializeCrt()

void Aws::InitializeCrt ( )

Initialize ApiHandle in aws-crt-cpp.

InitializeEnumOverflowContainer()

void Aws::InitializeEnumOverflowContainer ( )

Initializes a global overflow container to a new instance. This should only be called once from within Aws::InitAPI

MakeShared()

template<typename T , typename ... ArgTypes>

std::shared_ptr< T > Aws::MakeShared ( const char *  allocationTag,

ArgTypes &&...  args 

)

Creates a shared_ptr using AWS Allocator hooks. allocationTag is for memory tracking purposes.

Definition at line 106 of file AWSAllocator.h.

MakeUnique()

template<typename T , typename ... ArgTypes>

UniquePtr< T > Aws::MakeUnique ( const char *  allocationTag,

ArgTypes &&...  args 

)

::new, ::delete, ::malloc, ::free, std::make_shared, and std::make_unique should not be used in SDK code use these functions instead or Aws::MakeShared

Definition at line 305 of file AWSMemory.h.

MakeUniqueArray()

template<typename T , typename ... ArgTypes>

UniqueArrayPtr< T > Aws::MakeUniqueArray ( std::size_t  amount,

const char *  allocationTag,

ArgTypes &&...  args 

)

::new, ::delete, ::malloc, ::free, std::make_shared, and std::make_unique should not be used in SDK code use these functions instead or Aws::MakeShared

Definition at line 345 of file AWSMemory.h.

MakeUniqueSafeDeleted()

template<typename T , typename D = Deleter<T>, typename ... ArgTypes>

UniquePtrSafeDeleted< T, D > Aws::MakeUniqueSafeDeleted ( const char *  allocationTag,

ArgTypes &&...  args 

)

Definition at line 313 of file AWSMemory.h.

Malloc()

AWS_CORE_API void * Aws::Malloc ( const char *  allocationTag,

size_t  allocationSize 

)

::new, ::delete, ::malloc, ::free, std::make_shared, and std::make_unique should not be used in SDK code use these functions instead or Aws::MakeShared

New()

template<typename T , typename ... ArgTypes>

T * Aws::New ( const char *  allocationTag,

ArgTypes &&...  args 

)

::new, ::delete, ::malloc, ::free, std::make_shared, and std::make_unique should not be used in SDK code use these functions instead or Aws::MakeShared

Definition at line 68 of file AWSMemory.h.

NewArray()

template<typename T >

T * Aws::NewArray ( std::size_t  amount,

const char *  allocationTag 

)

::new, ::delete, ::malloc, ::free, std::make_shared, and std::make_unique should not be used in SDK code use these functions instead or Aws::MakeShared

Definition at line 146 of file AWSMemory.h.

SetDefaultClientBootstrap()

AWS_CORE_API void Aws::SetDefaultClientBootstrap ( const std::shared_ptr< Aws::Crt::Io::ClientBootstrap > &  clientBootstrap)

Set the default ClientBootStrap for AWS common runtime libraries in the global scope.

SetDefaultTlsConnectionOptions()

AWS_CORE_API void Aws::SetDefaultTlsConnectionOptions ( const std::shared_ptr< Aws::Crt::Io::TlsConnectionOptions > &  tlsConnectionOptions)

Set the default TlsConnectionOptions for AWS common runtime libraries in the global scope.

ShouldConstructArrayMembers()

template<typename T >

bool Aws::ShouldConstructArrayMembers ( )

Definition at line 130 of file AWSMemory.h.

ShouldDestroyArrayMembers()

template<typename T >

bool Aws::ShouldDestroyArrayMembers ( )

Definition at line 136 of file AWSMemory.h.

ShutdownAPI()

AWS_CORE_API void Aws::ShutdownAPI ( const SDKOptions &  options)

Shutdown SDK wide state for the SDK. This method must be called when you are finished using the SDK. Notes: 1) Please call this from the same thread from which InitAPI() has been called (use a dedicated thread if necessary). This avoids problems in initializing the dependent Common RunTime C libraries. 2) Do not call any other SDK methods after calling ShutdownAPI.

TransformAndInsert()

template<typename Key , typename SourceValue , typename DestinationValue >

void Aws::TransformAndInsert ( const Aws::UnorderedMap< Key, SourceValue > &  src,

Aws::Map< Key, DestinationValue > &  dst,

std::function< DestinationValue(const SourceValue &)>  mappingFunc 

)

Definition at line 35 of file AWSMap.h.

Variable Documentation

AMZN_EVENTSTREAM_CONTENT_TYPE

const char Aws::AMZN_EVENTSTREAM_CONTENT_TYPE[] = "application/vnd.amazon.eventstream"

static

Definition at line 22 of file AmazonSerializableWebServiceRequest.h.

AMZN_JSON_CONTENT_TYPE_1_0

const char Aws::AMZN_JSON_CONTENT_TYPE_1_0[] = "application/x-amz-json-1.0"

static

Definition at line 18 of file AmazonSerializableWebServiceRequest.h.

AMZN_JSON_CONTENT_TYPE_1_1

const char Aws::AMZN_JSON_CONTENT_TYPE_1_1[] = "application/x-amz-json-1.1"

static

Definition at line 19 of file AmazonSerializableWebServiceRequest.h.

AMZN_XML_CONTENT_TYPE

const char Aws::AMZN_XML_CONTENT_TYPE[] = "application/xml"

static

Definition at line 21 of file AmazonSerializableWebServiceRequest.h.

DEFAULT_CONTENT_TYPE

const char* Aws::DEFAULT_CONTENT_TYPE = "binary/octet-stream"

static

Definition at line 19 of file AmazonStreamingWebServiceRequest.h.

DEFAULT_LOG_PREFIX

const char* Aws::DEFAULT_LOG_PREFIX = "aws_sdk_"

static

Definition at line 21 of file Aws.h.

FORM_CONTENT_TYPE

const char Aws::FORM_CONTENT_TYPE[] = "application/x-www-form-urlencoded"

static

Definition at line 20 of file AmazonSerializableWebServiceRequest.h.

JSON_CONTENT_TYPE

const char Aws::JSON_CONTENT_TYPE[] = "application/json"

static

Definition at line 17 of file AmazonSerializableWebServiceRequest.h.