Enumerated Types

Enumerated types of the SigV4 library. More...

Enumerations
enum	SigV4Status_t {   SigV4Success , SigV4InvalidParameter , SigV4InsufficientMemory , SigV4ISOFormattingError ,   SigV4MaxHeaderPairCountExceeded , SigV4MaxQueryPairCountExceeded , SigV4HashError , SigV4InvalidHttpHeaders }
	Return status of the SigV4 Library. More...

Detailed Description

Enumerated types of the SigV4 library.

Enumeration Type Documentation

SigV4Status_t

enum SigV4Status_t

Return status of the SigV4 Library.

Enumerator
SigV4Success	The SigV4 library function completed successfully. Functions that may return this value: SigV4_GenerateHTTPAuthorization SigV4_AwsIotDateToIso8601 SigV4_EncodeURI
SigV4InvalidParameter	The SigV4 library function received an invalid input parameter. Functions that may return this value: SigV4_GenerateHTTPAuthorization SigV4_AwsIotDateToIso8601
SigV4InsufficientMemory	The application buffer was not large enough for the specified hash function. Functions that may return this value: SigV4_GenerateHTTPAuthorization SigV4_EncodeURI
SigV4ISOFormattingError	An error occurred while formatting the provided date header. Functions that may return this value: SigV4_AwsIotDateToIso8601
SigV4MaxHeaderPairCountExceeded	The maximum number of header parameters was exceeded while parsing the http header string passed to the library. The maximum number of supported HTTP headers can be configured with the SIGV4_MAX_HTTP_HEADER_COUNT macro in the library config file passed by the application. Functions that may return this value: SigV4_GenerateHTTPAuthorization
SigV4MaxQueryPairCountExceeded	The maximum number of query parameters was exceeded while parsing the query string passed to the library. The maximum number of supported query parameters can be configured with the SIGV4_MAX_QUERY_PAIR_COUNT macro in the library config file passed by the application. Functions that may return this value: SigV4_GenerateHTTPAuthorization
SigV4HashError	An error occurred while performing a hash operation. Functions that may return this value: SigV4_GenerateHTTPAuthorization
SigV4InvalidHttpHeaders	HTTP headers parsed to the library are invalid. Functions that may return this value: SigV4_GenerateHTTPAuthorization