Methods
deserializeJsonBytesToObj(bytes, type)
Deserialize the json byte array to an instance of class
Parameters:
| Name |
Type |
Description |
bytes |
|
a bytes array |
type |
|
instance type |
- Source:
Returns:
object
validateAndSerializeToJsonBytes(o)
Validate And Serialize an instance of class to Json bytes
Parameters:
| Name |
Type |
Description |
o |
|
a instance object |
- Source:
Throws:
throws ValidationException
Returns:
byte array
Type Definitions
iotDataCallback(err, data)
Called when a response from the service is returned.
Parameters:
| Name |
Type |
Description |
err |
Error
|
The error object returned from the request. Set to null if the request is successful. |
data |
Object
|
The de-serialized data returned from the request. Set to null if a request error occurs.
Properties
| Name |
Type |
Description |
payload |
Buffer
|
TypedArray
|
Blob
|
String
|
The state information in JSON format |
|
- Source:
lambdaCallback(err, data)
Called when a response from the service is returned.
Parameters:
| Name |
Type |
Description |
err |
Error
|
The error object returned from the request. Set to null if the request is successful. |
data |
Object
|
The de-serialized data returned from the request. Set to null if a request error occurs.
Properties
| Name |
Type |
Description |
StatusCode |
Integer
|
The HTTP status code will be in the 200 range for successful request. For the RequestResponse invocation type this status code will be 200.
For the Event invocation type this status code will be 202. |
FunctionError |
String
|
Indicates whether an error occurred while executing the Lambda function. If an error occurred this field will have one of two values; Handled or Unhandled.
Handled errors are errors that are reported by the function while the Unhandled errors are those detected and reported by AWS Lambda.
Unhandled errors include out of memory errors and function timeouts. For information about how to report an Handled error,
see Programming Model. |
Payload |
Buffer
|
TypedArray
|
Blob
|
String
|
It is the result returned by the Lambda function. This is present only if the invocation type is RequestResponse.
In the event of a function error this field contains a message describing the error. For the Handled errors the Lambda function will report this message. For Unhandled errors AWS Lambda reports the message. |
|
- Source:
Logger
Type:
Properties:
| Name |
Type |
Description |
error |
function
|
|
info |
function
|
|
debug |
function
|
|
- Source:
secretsManagerCallback(err, data)
Called when a response from the service is returned.
Parameters:
| Name |
Type |
Description |
err |
Error
|
The error object returned from the request. Set to null if the request is successful. |
data |
Object
|
String
|
data returned from the request. Return type is decided on DeStringifyResultFlag flag in request. Set to null if a request error occurs.
Properties
| Name |
Type |
Description |
ARN |
String
|
The ARN of the secret. |
Name |
String
|
The friendly name of the secret. |
VersionId |
String
|
The unique identifier of this version of the secret. |
SecretBinary |
Buffer
|
TypedArray
|
Blob
|
String
|
The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array.
The response parameter represents the binary data as a base64-encoded string. |
SecretString |
String
|
The decrypted part of the protected secret information that was originally provided as a string. |
VersionStages |
Array.<String>
|
Specifies the secret version that you want to retrieve by the staging label attached to the version.
Staging labels are used to keep track of different versions during the rotation process. |
|
- Source: