Class: AWS.Greengrass

Inherits:
AWS.Service show all
Identifier:
greengrass
API Version:
2017-06-07
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Sending a Request Using Greengrass

var greengrass = new AWS.Greengrass();
greengrass.associateRoleToGroup(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Greengrass object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var greengrass = new AWS.Greengrass({apiVersion: '2017-06-07'});

You can also set the API version globally in AWS.config.apiVersions using the greengrass service identifier:

AWS.config.apiVersions = {
  greengrass: '2017-06-07',
  // other service API versions
};

var greengrass = new AWS.Greengrass();

Version:

  • 2017-06-07

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.Greengrass(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Greengrass object

var greengrass = new AWS.Greengrass({apiVersion: '2017-06-07'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.Greengrass.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.Greengrass.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.Greengrass.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

associateRoleToGroup(params = {}, callback) ⇒ AWS.Request

Associates a role with a group. The role will be used by the AWS Greengrass core in order to access AWS cloud services. The role's permissions will allow Greengrass core Lambda functions to perform actions against the cloud.

Service Reference:

Examples:

Calling the associateRoleToGroup operation

var params = {
  GroupId: 'STRING_VALUE', /* required */
  RoleArn: 'STRING_VALUE'
};
greengrass.associateRoleToGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GroupId — (String) The unique Id of the AWS Greengrass Group
    • RoleArn — (String) Role arn you wish to associate with this group.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • AssociatedAt — (String) Time the role arn was associated to your group.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

associateServiceRoleToAccount(params = {}, callback) ⇒ AWS.Request

Associates a role which is used by AWS Greengrass. AWS Greengrass uses the role to access your Lambda functions and AWS IoT resources. This is necessary for deployments to succeed. It needs to have minimum permissions in policy AWSGreengrassResourceAccessRolePolicy

Service Reference:

Examples:

Calling the associateServiceRoleToAccount operation

var params = {
  RoleArn: 'STRING_VALUE'
};
greengrass.associateServiceRoleToAccount(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • RoleArn — (String) Role arn you wish to associate with this account.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • AssociatedAt — (String) Time when the service role was associated to the account.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createCoreDefinition(params = {}, callback) ⇒ AWS.Request

Creates a core definition. You may optionally provide the initial version of the core definition or use ''CreateCoreDefinitionVersion'' at a later time. AWS Greengrass Groups must each contain exactly 1 AWS Greengrass Core.

Service Reference:

Examples:

Calling the createCoreDefinition operation

var params = {
  AmznClientToken: 'STRING_VALUE',
  InitialVersion: {
    Cores: [
      {
        CertificateArn: 'STRING_VALUE',
        Id: 'STRING_VALUE',
        SyncShadow: true || false,
        ThingArn: 'STRING_VALUE'
      },
      /* more items */
    ]
  },
  Name: 'STRING_VALUE'
};
greengrass.createCoreDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AmznClientToken — (String) The client token used to request idempotent operations.
    • InitialVersion — (map) Information on the initial version
      • Cores — (Array<map>) Cores in the definition version.
        • CertificateArn — (String) Certificate arn of the core.
        • Id — (String) Element Id for this entry in the list.
        • SyncShadow — (Boolean) If true, the local shadow value automatically syncs with the cloud's shadow state.
        • ThingArn — (String) Thing arn of the core.
    • Name — (String) name of the core definition

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Arn — (String) Arn of the definition.
      • CreationTimestamp — (String) Timestamp of when the definition was created.
      • Id — (String) Id of the definition.
      • LastUpdatedTimestamp — (String) Last updated timestamp of the definition.
      • LatestVersion — (String) Last version of the definition.
      • LatestVersionArn — (String) Latest version arn of the definition.
      • Name — (String) Name of the definition.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createCoreDefinitionVersion(params = {}, callback) ⇒ AWS.Request

Creates a version of a core definition that has already been defined. AWS Greengrass Groups must each contain exactly 1 AWS Greengrass Core.

Service Reference:

Examples:

Calling the createCoreDefinitionVersion operation

var params = {
  CoreDefinitionId: 'STRING_VALUE', /* required */
  AmznClientToken: 'STRING_VALUE',
  Cores: [
    {
      CertificateArn: 'STRING_VALUE',
      Id: 'STRING_VALUE',
      SyncShadow: true || false,
      ThingArn: 'STRING_VALUE'
    },
    /* more items */
  ]
};
greengrass.createCoreDefinitionVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AmznClientToken — (String) The client token used to request idempotent operations.
    • CoreDefinitionId — (String) core definition Id
    • Cores — (Array<map>) Cores in the definition version.
      • CertificateArn — (String) Certificate arn of the core.
      • Id — (String) Element Id for this entry in the list.
      • SyncShadow — (Boolean) If true, the local shadow value automatically syncs with the cloud's shadow state.
      • ThingArn — (String) Thing arn of the core.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Arn — (String) Arn of the version.
      • CreationTimestamp — (String) Timestamp of when the version was created.
      • Id — (String) Id of the resource container.
      • Version — (String) Unique Id of a version.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createDeployment(params = {}, callback) ⇒ AWS.Request

Creates a deployment.

Service Reference:

Examples:

Calling the createDeployment operation

var params = {
  GroupId: 'STRING_VALUE', /* required */
  AmznClientToken: 'STRING_VALUE',
  DeploymentId: 'STRING_VALUE',
  DeploymentType: NewDeployment | Redeployment | ResetDeployment | ForceResetDeployment,
  GroupVersionId: 'STRING_VALUE'
};
greengrass.createDeployment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AmznClientToken — (String) The client token used to request idempotent operations.
    • DeploymentId — (String) Id of the deployment if you wish to redeploy a previous deployment.
    • DeploymentType — (String) Type of deployment. When used in CreateDeployment, only NewDeployment and Redeployment are valid. Possible values include:
      • "NewDeployment"
      • "Redeployment"
      • "ResetDeployment"
      • "ForceResetDeployment"
    • GroupId — (String) The unique Id of the AWS Greengrass Group
    • GroupVersionId — (String) Group Version you wish to deploy.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • DeploymentArn — (String) The arn of the deployment.
      • DeploymentId — (String) The id of the deployment.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createDeviceDefinition(params = {}, callback) ⇒ AWS.Request

Creates a device definition. You may optinally provide the initial version of the device definition or use CreateDeviceDefinitionVersion at a later time.

Service Reference:

Examples:

Calling the createDeviceDefinition operation

var params = {
  AmznClientToken: 'STRING_VALUE',
  InitialVersion: {
    Devices: [
      {
        CertificateArn: 'STRING_VALUE',
        Id: 'STRING_VALUE',
        SyncShadow: true || false,
        ThingArn: 'STRING_VALUE'
      },
      /* more items */
    ]
  },
  Name: 'STRING_VALUE'
};
greengrass.createDeviceDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AmznClientToken — (String) The client token used to request idempotent operations.
    • InitialVersion — (map) Information on the initial version
      • Devices — (Array<map>) Devices in the definition version.
        • CertificateArn — (String) Certificate arn of the device.
        • Id — (String) Element Id for this entry in the list.
        • SyncShadow — (Boolean) If true, the local shadow value automatically syncs with the cloud's shadow state.
        • ThingArn — (String) Thing arn of the device.
    • Name — (String) name of the device definition

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Arn — (String) Arn of the definition.
      • CreationTimestamp — (String) Timestamp of when the definition was created.
      • Id — (String) Id of the definition.
      • LastUpdatedTimestamp — (String) Last updated timestamp of the definition.
      • LatestVersion — (String) Last version of the definition.
      • LatestVersionArn — (String) Latest version arn of the definition.
      • Name — (String) Name of the definition.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createDeviceDefinitionVersion(params = {}, callback) ⇒ AWS.Request

Creates a version of a device definition that has already been defined.

Service Reference:

Examples:

Calling the createDeviceDefinitionVersion operation

var params = {
  DeviceDefinitionId: 'STRING_VALUE', /* required */
  AmznClientToken: 'STRING_VALUE',
  Devices: [
    {
      CertificateArn: 'STRING_VALUE',
      Id: 'STRING_VALUE',
      SyncShadow: true || false,
      ThingArn: 'STRING_VALUE'
    },
    /* more items */
  ]
};
greengrass.createDeviceDefinitionVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AmznClientToken — (String) The client token used to request idempotent operations.
    • DeviceDefinitionId — (String) device definition Id
    • Devices — (Array<map>) Devices in the definition version.
      • CertificateArn — (String) Certificate arn of the device.
      • Id — (String) Element Id for this entry in the list.
      • SyncShadow — (Boolean) If true, the local shadow value automatically syncs with the cloud's shadow state.
      • ThingArn — (String) Thing arn of the device.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Arn — (String) Arn of the version.
      • CreationTimestamp — (String) Timestamp of when the version was created.
      • Id — (String) Id of the resource container.
      • Version — (String) Unique Id of a version.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createFunctionDefinition(params = {}, callback) ⇒ AWS.Request

Creates a Lambda function definition which contains a list of Lambda functions and their configurations to be used in a group. You can create an initial version of the definition by providing a list of Lambda functions and their configurations now, or use CreateFunctionDefinitionVersion later.

Service Reference:

Examples:

Calling the createFunctionDefinition operation

var params = {
  AmznClientToken: 'STRING_VALUE',
  InitialVersion: {
    Functions: [
      {
        FunctionArn: 'STRING_VALUE',
        FunctionConfiguration: {
          Environment: {
            AccessSysfs: true || false,
            ResourceAccessPolicies: [
              {
                Permission: ro | rw,
                ResourceId: 'STRING_VALUE'
              },
              /* more items */
            ],
            Variables: {
              '<__string>': 'STRING_VALUE',
              /* '<__string>': ... */
            }
          },
          ExecArgs: 'STRING_VALUE',
          Executable: 'STRING_VALUE',
          MemorySize: 0,
          Pinned: true || false,
          Timeout: 0
        },
        Id: 'STRING_VALUE'
      },
      /* more items */
    ]
  },
  Name: 'STRING_VALUE'
};
greengrass.createFunctionDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AmznClientToken — (String) The client token used to request idempotent operations.
    • InitialVersion — (map) Information on the initial version
      • Functions — (Array<map>) Lambda functions in this function definition version.
        • FunctionArn — (String) Arn of the Lambda function.
        • FunctionConfiguration — (map) Configuration of the function
          • Environment — (map) Environment of the function configuration
            • AccessSysfs — (Boolean) Flag to allow lambda access sys filesystem.
            • ResourceAccessPolicies — (Array<map>) Policies for the function to access resources.
              • Permission — (String) The function's access permission to the resource. Possible values include:
                • "ro"
                • "rw"
              • ResourceId — (String) Id of the resource. A reference to the resource definiton.
            • Variables — (map<String>) Environment variables for the lambda function.
          • ExecArgs — (String) Execution Arguments
          • Executable — (String) Executable
          • MemorySize — (Integer) The memory size, in KB, you configured for the function.
          • Pinned — (Boolean) Whether the function is pinned or not. Pinned means the function is long-lived and starts when the core starts.
          • Timeout — (Integer) The function execution time at which Lambda should terminate the function. This timeout still applies to pinned lambdas for each request.
        • Id — (String) Id of the function in this version.
    • Name — (String) name of the function definition

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Arn — (String) Arn of the definition.
      • CreationTimestamp — (String) Timestamp of when the definition was created.
      • Id — (String) Id of the definition.
      • LastUpdatedTimestamp — (String) Last updated timestamp of the definition.
      • LatestVersion — (String) Last version of the definition.
      • LatestVersionArn — (String) Latest version arn of the definition.
      • Name — (String) Name of the definition.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createFunctionDefinitionVersion(params = {}, callback) ⇒ AWS.Request

Create a version of a Lambda function definition that has already been defined.

Service Reference:

Examples:

Calling the createFunctionDefinitionVersion operation

var params = {
  FunctionDefinitionId: 'STRING_VALUE', /* required */
  AmznClientToken: 'STRING_VALUE',
  Functions: [
    {
      FunctionArn: 'STRING_VALUE',
      FunctionConfiguration: {
        Environment: {
          AccessSysfs: true || false,
          ResourceAccessPolicies: [
            {
              Permission: ro | rw,
              ResourceId: 'STRING_VALUE'
            },
            /* more items */
          ],
          Variables: {
            '<__string>': 'STRING_VALUE',
            /* '<__string>': ... */
          }
        },
        ExecArgs: 'STRING_VALUE',
        Executable: 'STRING_VALUE',
        MemorySize: 0,
        Pinned: true || false,
        Timeout: 0
      },
      Id: 'STRING_VALUE'
    },
    /* more items */
  ]
};
greengrass.createFunctionDefinitionVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AmznClientToken — (String) The client token used to request idempotent operations.
    • FunctionDefinitionId — (String) the unique Id of the lambda definition
    • Functions — (Array<map>) Lambda functions in this function definition version.
      • FunctionArn — (String) Arn of the Lambda function.
      • FunctionConfiguration — (map) Configuration of the function
        • Environment — (map) Environment of the function configuration
          • AccessSysfs — (Boolean) Flag to allow lambda access sys filesystem.
          • ResourceAccessPolicies — (Array<map>) Policies for the function to access resources.
            • Permission — (String) The function's access permission to the resource. Possible values include:
              • "ro"
              • "rw"
            • ResourceId — (String) Id of the resource. A reference to the resource definiton.
          • Variables — (map<String>) Environment variables for the lambda function.
        • ExecArgs — (String) Execution Arguments
        • Executable — (String) Executable
        • MemorySize — (Integer) The memory size, in KB, you configured for the function.
        • Pinned — (Boolean) Whether the function is pinned or not. Pinned means the function is long-lived and starts when the core starts.
        • Timeout — (Integer) The function execution time at which Lambda should terminate the function. This timeout still applies to pinned lambdas for each request.
      • Id — (String) Id of the function in this version.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Arn — (String) Arn of the version.
      • CreationTimestamp — (String) Timestamp of when the version was created.
      • Id — (String) Id of the resource container.
      • Version — (String) Unique Id of a version.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createGroup(params = {}, callback) ⇒ AWS.Request

Creates a group. You may optionally provide the initial version of the group or use ''CreateGroupVersion'' at a later time.

Service Reference:

Examples:

Calling the createGroup operation

var params = {
  AmznClientToken: 'STRING_VALUE',
  InitialVersion: {
    CoreDefinitionVersionArn: 'STRING_VALUE',
    DeviceDefinitionVersionArn: 'STRING_VALUE',
    FunctionDefinitionVersionArn: 'STRING_VALUE',
    LoggerDefinitionVersionArn: 'STRING_VALUE',
    ResourceDefinitionVersionArn: 'STRING_VALUE',
    SubscriptionDefinitionVersionArn: 'STRING_VALUE'
  },
  Name: 'STRING_VALUE'
};
greengrass.createGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AmznClientToken — (String) The client token used to request idempotent operations.
    • InitialVersion — (map) Information on the initial version
      • CoreDefinitionVersionArn — (String) Core definition version arn for this group.
      • DeviceDefinitionVersionArn — (String) Device definition version arn for this group.
      • FunctionDefinitionVersionArn — (String) Function definition version arn for this group.
      • LoggerDefinitionVersionArn — (String) Logger definition version arn for this group.
      • ResourceDefinitionVersionArn — (String) Resource definition version arn for this group.
      • SubscriptionDefinitionVersionArn — (String) Subscription definition version arn for this group.
    • Name — (String) name of the group

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Arn — (String) Arn of the definition.
      • CreationTimestamp — (String) Timestamp of when the definition was created.
      • Id — (String) Id of the definition.
      • LastUpdatedTimestamp — (String) Last updated timestamp of the definition.
      • LatestVersion — (String) Last version of the definition.
      • LatestVersionArn — (String) Latest version arn of the definition.
      • Name — (String) Name of the definition.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createGroupCertificateAuthority(params = {}, callback) ⇒ AWS.Request

Creates a CA for the group. If a CA already exists, it will rotate the existing CA.

Service Reference:

Examples:

Calling the createGroupCertificateAuthority operation

var params = {
  GroupId: 'STRING_VALUE', /* required */
  AmznClientToken: 'STRING_VALUE'
};
greengrass.createGroupCertificateAuthority(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AmznClientToken — (String) The client token used to request idempotent operations.
    • GroupId — (String) The unique Id of the AWS Greengrass Group

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • GroupCertificateAuthorityArn — (String) Arn of the group certificate authority.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createGroupVersion(params = {}, callback) ⇒ AWS.Request

Creates a version of a group which has already been defined.

Service Reference:

Examples:

Calling the createGroupVersion operation

var params = {
  GroupId: 'STRING_VALUE', /* required */
  AmznClientToken: 'STRING_VALUE',
  CoreDefinitionVersionArn: 'STRING_VALUE',
  DeviceDefinitionVersionArn: 'STRING_VALUE',
  FunctionDefinitionVersionArn: 'STRING_VALUE',
  LoggerDefinitionVersionArn: 'STRING_VALUE',
  ResourceDefinitionVersionArn: 'STRING_VALUE',
  SubscriptionDefinitionVersionArn: 'STRING_VALUE'
};
greengrass.createGroupVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AmznClientToken — (String) The client token used to request idempotent operations.
    • CoreDefinitionVersionArn — (String) Core definition version arn for this group.
    • DeviceDefinitionVersionArn — (String) Device definition version arn for this group.
    • FunctionDefinitionVersionArn — (String) Function definition version arn for this group.
    • GroupId — (String) The unique Id of the AWS Greengrass Group
    • LoggerDefinitionVersionArn — (String) Logger definition version arn for this group.
    • ResourceDefinitionVersionArn — (String) Resource definition version arn for this group.
    • SubscriptionDefinitionVersionArn — (String) Subscription definition version arn for this group.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Arn — (String) Arn of the version.
      • CreationTimestamp — (String) Timestamp of when the version was created.
      • Id — (String) Id of the resource container.
      • Version — (String) Unique Id of a version.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createLoggerDefinition(params = {}, callback) ⇒ AWS.Request

Creates a logger definition. You may optionally provide the initial version of the logger definition or use CreateLoggerDefinitionVersion at a later time.

Service Reference:

Examples:

Calling the createLoggerDefinition operation

var params = {
  AmznClientToken: 'STRING_VALUE',
  InitialVersion: {
    Loggers: [
      {
        Component: GreengrassSystem | Lambda,
        Id: 'STRING_VALUE',
        Level: DEBUG | INFO | WARN | ERROR | FATAL,
        Space: 0,
        Type: FileSystem | AWSCloudWatch
      },
      /* more items */
    ]
  },
  Name: 'STRING_VALUE'
};
greengrass.createLoggerDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AmznClientToken — (String) The client token used to request idempotent operations.
    • InitialVersion — (map) Information on the initial version
      • Loggers — (Array<map>) List of loggers.
        • Component — (String) The component that will be subject to logs Possible values include:
          • "GreengrassSystem"
          • "Lambda"
        • Id — (String) Element Id for this entry in the list.
        • Level — (String) The level of the logs Possible values include:
          • "DEBUG"
          • "INFO"
          • "WARN"
          • "ERROR"
          • "FATAL"
        • Space — (Integer) Amount of hardware space, in KB, to use if file system is used for logging purposes.
        • Type — (String) The type which will be use for log output Possible values include:
          • "FileSystem"
          • "AWSCloudWatch"
    • Name — (String) name of the logger definition

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Arn — (String) Arn of the definition.
      • CreationTimestamp — (String) Timestamp of when the definition was created.
      • Id — (String) Id of the definition.
      • LastUpdatedTimestamp — (String) Last updated timestamp of the definition.
      • LatestVersion — (String) Last version of the definition.
      • LatestVersionArn — (String) Latest version arn of the definition.
      • Name — (String) Name of the definition.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createLoggerDefinitionVersion(params = {}, callback) ⇒ AWS.Request

Creates a version of a logger definition that has already been defined.

Service Reference:

Examples:

Calling the createLoggerDefinitionVersion operation

var params = {
  LoggerDefinitionId: 'STRING_VALUE', /* required */
  AmznClientToken: 'STRING_VALUE',
  Loggers: [
    {
      Component: GreengrassSystem | Lambda,
      Id: 'STRING_VALUE',
      Level: DEBUG | INFO | WARN | ERROR | FATAL,
      Space: 0,
      Type: FileSystem | AWSCloudWatch
    },
    /* more items */
  ]
};
greengrass.createLoggerDefinitionVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AmznClientToken — (String) The client token used to request idempotent operations.
    • LoggerDefinitionId — (String) logger definition Id
    • Loggers — (Array<map>) List of loggers.
      • Component — (String) The component that will be subject to logs Possible values include:
        • "GreengrassSystem"
        • "Lambda"
      • Id — (String) Element Id for this entry in the list.
      • Level — (String) The level of the logs Possible values include:
        • "DEBUG"
        • "INFO"
        • "WARN"
        • "ERROR"
        • "FATAL"
      • Space — (Integer) Amount of hardware space, in KB, to use if file system is used for logging purposes.
      • Type — (String) The type which will be use for log output Possible values include:
        • "FileSystem"
        • "AWSCloudWatch"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Arn — (String) Arn of the version.
      • CreationTimestamp — (String) Timestamp of when the version was created.
      • Id — (String) Id of the resource container.
      • Version — (String) Unique Id of a version.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createResourceDefinition(params = {}, callback) ⇒ AWS.Request

Creates a resource definition which contains a list of resources to be used in a group. You can create an initial version of the definition by providing a list of resources now, or use CreateResourceDefinitionVersion later.

Service Reference:

Examples:

Calling the createResourceDefinition operation

var params = {
  AmznClientToken: 'STRING_VALUE',
  InitialVersion: {
    Resources: [
      {
        Id: 'STRING_VALUE',
        Name: 'STRING_VALUE',
        ResourceDataContainer: {
          LocalDeviceResourceData: {
            GroupOwnerSetting: {
              AutoAddGroupOwner: true || false,
              GroupOwner: 'STRING_VALUE'
            },
            SourcePath: 'STRING_VALUE'
          },
          LocalVolumeResourceData: {
            DestinationPath: 'STRING_VALUE',
            GroupOwnerSetting: {
              AutoAddGroupOwner: true || false,
              GroupOwner: 'STRING_VALUE'
            },
            SourcePath: 'STRING_VALUE'
          }
        }
      },
      /* more items */
    ]
  },
  Name: 'STRING_VALUE'
};
greengrass.createResourceDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AmznClientToken — (String) The client token used to request idempotent operations.
    • InitialVersion — (map) Information on the initial version
      • Resources — (Array<map>) List of resources.
        • Id — (String) Resource Id.
        • Name — (String) A descriptive resource name.
        • ResourceDataContainer — (map) A container of data for all resource types.
          • LocalDeviceResourceData — (map) Attributes that define the Local Device Resource.
            • GroupOwnerSetting — (map) Group owner related settings for local resources.
              • AutoAddGroupOwner — (Boolean) Eanble the auto added group owner.
              • GroupOwner — (String) Name of the group owner.
            • SourcePath — (String) Local source path of the resource.
          • LocalVolumeResourceData — (map) Attributes that define the Local Volume Resource.
            • DestinationPath — (String) Local destination path of the resource.
            • GroupOwnerSetting — (map) Group owner related settings for local resources.
              • AutoAddGroupOwner — (Boolean) Eanble the auto added group owner.
              • GroupOwner — (String) Name of the group owner.
            • SourcePath — (String) Local source path of the resource.
    • Name — (String) Name of the resource definition

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Arn — (String) Arn of the definition.
      • CreationTimestamp — (String) Timestamp of when the definition was created.
      • Id — (String) Id of the definition.
      • LastUpdatedTimestamp — (String) Last updated timestamp of the definition.
      • LatestVersion — (String) Last version of the definition.
      • LatestVersionArn — (String) Latest version arn of the definition.
      • Name — (String) Name of the definition.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createResourceDefinitionVersion(params = {}, callback) ⇒ AWS.Request

Create a version of a resource definition that has already been defined.

Service Reference:

Examples:

Calling the createResourceDefinitionVersion operation

var params = {
  ResourceDefinitionId: 'STRING_VALUE', /* required */
  AmznClientToken: 'STRING_VALUE',
  Resources: [
    {
      Id: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      ResourceDataContainer: {
        LocalDeviceResourceData: {
          GroupOwnerSetting: {
            AutoAddGroupOwner: true || false,
            GroupOwner: 'STRING_VALUE'
          },
          SourcePath: 'STRING_VALUE'
        },
        LocalVolumeResourceData: {
          DestinationPath: 'STRING_VALUE',
          GroupOwnerSetting: {
            AutoAddGroupOwner: true || false,
            GroupOwner: 'STRING_VALUE'
          },
          SourcePath: 'STRING_VALUE'
        }
      }
    },
    /* more items */
  ]
};
greengrass.createResourceDefinitionVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AmznClientToken — (String) The client token used to request idempotent operations.
    • ResourceDefinitionId — (String) Resource definition Id.
    • Resources — (Array<map>) List of resources.
      • Id — (String) Resource Id.
      • Name — (String) A descriptive resource name.
      • ResourceDataContainer — (map) A container of data for all resource types.
        • LocalDeviceResourceData — (map) Attributes that define the Local Device Resource.
          • GroupOwnerSetting — (map) Group owner related settings for local resources.
            • AutoAddGroupOwner — (Boolean) Eanble the auto added group owner.
            • GroupOwner — (String) Name of the group owner.
          • SourcePath — (String) Local source path of the resource.
        • LocalVolumeResourceData — (map) Attributes that define the Local Volume Resource.
          • DestinationPath — (String) Local destination path of the resource.
          • GroupOwnerSetting — (map) Group owner related settings for local resources.
            • AutoAddGroupOwner — (Boolean) Eanble the auto added group owner.
            • GroupOwner — (String) Name of the group owner.
          • SourcePath — (String) Local source path of the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Arn — (String) Arn of the version.
      • CreationTimestamp — (String) Timestamp of when the version was created.
      • Id — (String) Id of the resource container.
      • Version — (String) Unique Id of a version.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createSoftwareUpdateJob(params = {}, callback) ⇒ AWS.Request

Creates an Iot Job that will trigger your Greengrass Cores to update the software they are running.

Service Reference:

Examples:

Calling the createSoftwareUpdateJob operation

var params = {
  AmznClientToken: 'STRING_VALUE',
  S3UrlSignerRole: 'STRING_VALUE',
  SoftwareToUpdate: core | ota_agent,
  UpdateAgentLogLevel: NONE | TRACE | DEBUG | VERBOSE | INFO | WARN | ERROR | FATAL,
  UpdateTargets: [
    'STRING_VALUE',
    /* more items */
  ],
  UpdateTargetsArchitecture: armv7l | x86_64 | aarch64,
  UpdateTargetsOperatingSystem: ubuntu | raspbian | amazon_linux
};
greengrass.createSoftwareUpdateJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AmznClientToken — (String) The client token used to request idempotent operations.
    • S3UrlSignerRole — (String) The IAM Role that Greengrass will use to create pre-signed URLs pointing towards the update artifact.
    • SoftwareToUpdate — (String) The piece of software on the Greengrass Core that will be updated. Possible values include:
      • "core"
      • "ota_agent"
    • UpdateAgentLogLevel — (String) The minimum level of log statements that should be logged by the OTA Agent during an update. Possible values include:
      • "NONE"
      • "TRACE"
      • "DEBUG"
      • "VERBOSE"
      • "INFO"
      • "WARN"
      • "ERROR"
      • "FATAL"
    • UpdateTargets — (Array<String>) The target arns that this update will be applied to.
    • UpdateTargetsArchitecture — (String) The architecture of the Cores in the targets of an update Possible values include:
      • "armv7l"
      • "x86_64"
      • "aarch64"
    • UpdateTargetsOperatingSystem — (String) The operating system of the Cores in the targets of an update Possible values include:
      • "ubuntu"
      • "raspbian"
      • "amazon_linux"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • IotJobArn — (String) The Iot Job Arn corresponding to this update.
      • IotJobId — (String) The Iot Job Id corresponding to this update.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createSubscriptionDefinition(params = {}, callback) ⇒ AWS.Request

Creates a subscription definition. You may optionally provide the initial version of the subscription definition or use CreateSubscriptionDefinitionVersion at a later time.

Service Reference:

Examples:

Calling the createSubscriptionDefinition operation

var params = {
  AmznClientToken: 'STRING_VALUE',
  InitialVersion: {
    Subscriptions: [
      {
        Id: 'STRING_VALUE',
        Source: 'STRING_VALUE',
        Subject: 'STRING_VALUE',
        Target: 'STRING_VALUE'
      },
      /* more items */
    ]
  },
  Name: 'STRING_VALUE'
};
greengrass.createSubscriptionDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AmznClientToken — (String) The client token used to request idempotent operations.
    • InitialVersion — (map) Information on the initial version
      • Subscriptions — (Array<map>) Subscriptions in the version.
        • Id — (String) Element Id for this entry in the list.
        • Source — (String) Source of the subscription. Can be a thing arn, lambda arn or word 'cloud'
        • Subject — (String) Subject of the message.
        • Target — (String) Where the message is sent to. Can be a thing arn, lambda arn or word 'cloud'.
    • Name — (String) name of the subscription definition

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Arn — (String) Arn of the definition.
      • CreationTimestamp — (String) Timestamp of when the definition was created.
      • Id — (String) Id of the definition.
      • LastUpdatedTimestamp — (String) Last updated timestamp of the definition.
      • LatestVersion — (String) Last version of the definition.
      • LatestVersionArn — (String) Latest version arn of the definition.
      • Name — (String) Name of the definition.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createSubscriptionDefinitionVersion(params = {}, callback) ⇒ AWS.Request

Creates a version of a subscription definition which has already been defined.

Examples:

Calling the createSubscriptionDefinitionVersion operation

var params = {
  SubscriptionDefinitionId: 'STRING_VALUE', /* required */
  AmznClientToken: 'STRING_VALUE',
  Subscriptions: [
    {
      Id: 'STRING_VALUE',
      Source: 'STRING_VALUE',
      Subject: 'STRING_VALUE',
      Target: 'STRING_VALUE'
    },
    /* more items */
  ]
};
greengrass.createSubscriptionDefinitionVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AmznClientToken — (String) The client token used to request idempotent operations.
    • SubscriptionDefinitionId — (String) subscription definition Id
    • Subscriptions — (Array<map>) Subscriptions in the version.
      • Id — (String) Element Id for this entry in the list.
      • Source — (String) Source of the subscription. Can be a thing arn, lambda arn or word 'cloud'
      • Subject — (String) Subject of the message.
      • Target — (String) Where the message is sent to. Can be a thing arn, lambda arn or word 'cloud'.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Arn — (String) Arn of the version.
      • CreationTimestamp — (String) Timestamp of when the version was created.
      • Id — (String) Id of the resource container.
      • Version — (String) Unique Id of a version.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteCoreDefinition(params = {}, callback) ⇒ AWS.Request

Deletes a core definition. The core definition must not have been used in a deployment.

Service Reference:

Examples:

Calling the deleteCoreDefinition operation

var params = {
  CoreDefinitionId: 'STRING_VALUE' /* required */
};
greengrass.deleteCoreDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • CoreDefinitionId — (String) core definition Id

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteDeviceDefinition(params = {}, callback) ⇒ AWS.Request

Deletes a device definition. The device definition must not have been used in a deployment.

Service Reference:

Examples:

Calling the deleteDeviceDefinition operation

var params = {
  DeviceDefinitionId: 'STRING_VALUE' /* required */
};
greengrass.deleteDeviceDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DeviceDefinitionId — (String) device definition Id

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteFunctionDefinition(params = {}, callback) ⇒ AWS.Request

Deletes a Lambda function definition. The Lambda function definition must not have been used in a deployment.

Service Reference:

Examples:

Calling the deleteFunctionDefinition operation

var params = {
  FunctionDefinitionId: 'STRING_VALUE' /* required */
};
greengrass.deleteFunctionDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FunctionDefinitionId — (String) the unique Id of the lambda definition

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteGroup(params = {}, callback) ⇒ AWS.Request

Deletes a group. The group must not have been used in deployment.

Service Reference:

Examples:

Calling the deleteGroup operation

var params = {
  GroupId: 'STRING_VALUE' /* required */
};
greengrass.deleteGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GroupId — (String) The unique Id of the AWS Greengrass Group

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteLoggerDefinition(params = {}, callback) ⇒ AWS.Request

Deletes a logger definition. The logger definition must not have been used in a deployment.

Service Reference:

Examples:

Calling the deleteLoggerDefinition operation

var params = {
  LoggerDefinitionId: 'STRING_VALUE' /* required */
};
greengrass.deleteLoggerDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • LoggerDefinitionId — (String) logger definition Id

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteResourceDefinition(params = {}, callback) ⇒ AWS.Request

Deletes a resource definition.

Service Reference:

Examples:

Calling the deleteResourceDefinition operation

var params = {
  ResourceDefinitionId: 'STRING_VALUE' /* required */
};
greengrass.deleteResourceDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceDefinitionId — (String) Resource definition Id.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteSubscriptionDefinition(params = {}, callback) ⇒ AWS.Request

Deletes a subscription definition. The subscription definition must not have been used in a deployment.

Service Reference:

Examples:

Calling the deleteSubscriptionDefinition operation

var params = {
  SubscriptionDefinitionId: 'STRING_VALUE' /* required */
};
greengrass.deleteSubscriptionDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SubscriptionDefinitionId — (String) subscription definition Id

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

disassociateRoleFromGroup(params = {}, callback) ⇒ AWS.Request

Disassociates the role from a group.

Service Reference:

Examples:

Calling the disassociateRoleFromGroup operation

var params = {
  GroupId: 'STRING_VALUE' /* required */
};
greengrass.disassociateRoleFromGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GroupId — (String) The unique Id of the AWS Greengrass Group

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • DisassociatedAt — (String) Time when the role was disassociated from the group.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

disassociateServiceRoleFromAccount(params = {}, callback) ⇒ AWS.Request

Disassociates the service role from the account. Without a service role, deployments will not work.

Examples:

Calling the disassociateServiceRoleFromAccount operation

var params = {
};
greengrass.disassociateServiceRoleFromAccount(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • DisassociatedAt — (String) Time when the service role was disassociated from the account.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getAssociatedRole(params = {}, callback) ⇒ AWS.Request

Retrieves the role associated with a particular group.

Service Reference:

Examples:

Calling the getAssociatedRole operation

var params = {
  GroupId: 'STRING_VALUE' /* required */
};
greengrass.getAssociatedRole(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GroupId — (String) The unique Id of the AWS Greengrass Group

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • AssociatedAt — (String) Time when the role was associated for the group.
      • RoleArn — (String) Arn of the role that is associated with the group.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getConnectivityInfo(params = {}, callback) ⇒ AWS.Request

Retrieves the connectivity information for a core.

Service Reference:

Examples:

Calling the getConnectivityInfo operation

var params = {
  ThingName: 'STRING_VALUE' /* required */
};
greengrass.getConnectivityInfo(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ThingName — (String) Thing Name

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • ConnectivityInfo — (Array<map>) Connectivity info list
        • HostAddress — (String) Endpoint for the GGC. Can be an IP address or DNS.
        • Id — (String) Element Id for this entry in the list.
        • Metadata — (String) Metadata for this endpoint.
        • PortNumber — (Integer) Port of the GGC. Usually 8883.
      • Message — (String) Response Text

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getCoreDefinition(params = {}, callback) ⇒ AWS.Request

Retrieves information about a core definition version.

Service Reference:

Examples:

Calling the getCoreDefinition operation

var params = {
  CoreDefinitionId: 'STRING_VALUE' /* required */
};
greengrass.getCoreDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • CoreDefinitionId — (String) core definition Id

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Arn — (String) Arn of the definition.
      • CreationTimestamp — (String) Timestamp of when the definition was created.
      • Id — (String) Id of the definition.
      • LastUpdatedTimestamp — (String) Last updated timestamp of the definition.
      • LatestVersion — (String) Last version of the definition.
      • LatestVersionArn — (String) Latest version arn of the definition.
      • Name — (String) Name of the definition.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getCoreDefinitionVersion(params = {}, callback) ⇒ AWS.Request

Retrieves information about a core definition version.

Service Reference:

Examples:

Calling the getCoreDefinitionVersion operation

var params = {
  CoreDefinitionId: 'STRING_VALUE', /* required */
  CoreDefinitionVersionId: 'STRING_VALUE' /* required */
};
greengrass.getCoreDefinitionVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • CoreDefinitionId — (String) core definition Id
    • CoreDefinitionVersionId — (String) core definition version Id

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Arn — (String) Arn of the core definition version.
      • CreationTimestamp — (String) Timestamp of when the core definition version was created.
      • Definition — (map) Information on definition
        • Cores — (Array<map>) Cores in the definition version.
          • CertificateArn — (String) Certificate arn of the core.
          • Id — (String) Element Id for this entry in the list.
          • SyncShadow — (Boolean) If true, the local shadow value automatically syncs with the cloud's shadow state.
          • ThingArn — (String) Thing arn of the core.
      • Id — (String) Id of the core definition the version belongs to.
      • Version — (String) Version of the core definition version.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getDeploymentStatus(params = {}, callback) ⇒ AWS.Request

Returns the status of a deployment.

Service Reference:

Examples:

Calling the getDeploymentStatus operation

var params = {
  DeploymentId: 'STRING_VALUE', /* required */
  GroupId: 'STRING_VALUE' /* required */
};
greengrass.getDeploymentStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DeploymentId — (String) the deployment Id
    • GroupId — (String) The unique Id of the AWS Greengrass Group

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • DeploymentStatus — (String) Status of the deployment.
      • DeploymentType — (String) The type of the deployment. Possible values include:
        • "NewDeployment"
        • "Redeployment"
        • "ResetDeployment"
        • "ForceResetDeployment"
      • ErrorDetails — (Array<map>) The error Details
        • DetailedErrorCode — (String) Detailed Error Code
        • DetailedErrorMessage — (String) Detailed Error Message
      • ErrorMessage — (String) Error Message
      • UpdatedAt — (String) Last time the deployment status was updated.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getDeviceDefinition(params = {}, callback) ⇒ AWS.Request

Retrieves information about a device definition.

Service Reference:

Examples:

Calling the getDeviceDefinition operation

var params = {
  DeviceDefinitionId: 'STRING_VALUE' /* required */
};
greengrass.getDeviceDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DeviceDefinitionId — (String) device definition Id

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Arn — (String) Arn of the definition.
      • CreationTimestamp — (String) Timestamp of when the definition was created.
      • Id — (String) Id of the definition.
      • LastUpdatedTimestamp — (String) Last updated timestamp of the definition.
      • LatestVersion — (String) Last version of the definition.
      • LatestVersionArn — (String) Latest version arn of the definition.
      • Name — (String) Name of the definition.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getDeviceDefinitionVersion(params = {}, callback) ⇒ AWS.Request

Retrieves information about a device definition version.

Service Reference:

Examples:

Calling the getDeviceDefinitionVersion operation

var params = {
  DeviceDefinitionId: 'STRING_VALUE', /* required */
  DeviceDefinitionVersionId: 'STRING_VALUE' /* required */
};
greengrass.getDeviceDefinitionVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DeviceDefinitionId — (String) device definition Id
    • DeviceDefinitionVersionId — (String) device definition version Id

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Arn — (String) Arn of the device definition version.
      • CreationTimestamp — (String) Timestamp of when the device definition version was created.
      • Definition — (map) Device definition version
        • Devices — (Array<map>) Devices in the definition version.
          • CertificateArn — (String) Certificate arn of the device.
          • Id — (String) Element Id for this entry in the list.
          • SyncShadow — (Boolean) If true, the local shadow value automatically syncs with the cloud's shadow state.
          • ThingArn — (String) Thing arn of the device.
      • Id — (String) Id of the device definition the version belongs to.
      • Version — (String) Version of the device definition version.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getFunctionDefinition(params = {}, callback) ⇒ AWS.Request

Retrieves information about a Lambda function definition, such as its creation time and latest version.

Service Reference:

Examples:

Calling the getFunctionDefinition operation

var params = {
  FunctionDefinitionId: 'STRING_VALUE' /* required */
};
greengrass.getFunctionDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FunctionDefinitionId — (String) the unique Id of the lambda definition

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Arn — (String) Arn of the definition.
      • CreationTimestamp — (String) Timestamp of when the definition was created.
      • Id — (String) Id of the definition.
      • LastUpdatedTimestamp — (String) Last updated timestamp of the definition.
      • LatestVersion — (String) Last version of the definition.
      • LatestVersionArn — (String) Latest version arn of the definition.
      • Name — (String) Name of the definition.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getFunctionDefinitionVersion(params = {}, callback) ⇒ AWS.Request

Retrieves information about a Lambda function definition version, such as which Lambda functions are included in the version and their configurations.

Service Reference:

Examples:

Calling the getFunctionDefinitionVersion operation

var params = {
  FunctionDefinitionId: 'STRING_VALUE', /* required */
  FunctionDefinitionVersionId: 'STRING_VALUE' /* required */
};
greengrass.getFunctionDefinitionVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FunctionDefinitionId — (String) the unique Id of the lambda definition
    • FunctionDefinitionVersionId — (String) Function definition version Id

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Arn — (String) Arn of the function definition version.
      • CreationTimestamp — (String) Timestamp when the funtion definition version was created.
      • Definition — (map) Information on the definition
        • Functions — (Array<map>) Lambda functions in this function definition version.
          • FunctionArn — (String) Arn of the Lambda function.
          • FunctionConfiguration — (map) Configuration of the function
            • Environment — (map) Environment of the function configuration
              • AccessSysfs — (Boolean) Flag to allow lambda access sys filesystem.
              • ResourceAccessPolicies — (Array<map>) Policies for the function to access resources.
                • Permission — (String) The function's access permission to the resource. Possible values include:
                  • "ro"
                  • "rw"
                • ResourceId — (String) Id of the resource. A reference to the resource definiton.
              • Variables — (map<String>) Environment variables for the lambda function.
            • ExecArgs — (String) Execution Arguments
            • Executable — (String) Executable
            • MemorySize — (Integer) The memory size, in KB, you configured for the function.
            • Pinned — (Boolean) Whether the function is pinned or not. Pinned means the function is long-lived and starts when the core starts.
            • Timeout — (Integer) The function execution time at which Lambda should terminate the function. This timeout still applies to pinned lambdas for each request.
          • Id — (String) Id of the function in this version.
      • Id — (String) Id of the function definition the version belongs to.
      • Version — (String) Version of the function definition version.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getGroup(params = {}, callback) ⇒ AWS.Request

Retrieves information about a group.

Service Reference:

Examples:

Calling the getGroup operation

var params = {
  GroupId: 'STRING_VALUE' /* required */
};
greengrass.getGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GroupId — (String) The unique Id of the AWS Greengrass Group

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Arn — (String) Arn of the definition.
      • CreationTimestamp — (String) Timestamp of when the definition was created.
      • Id — (String) Id of the definition.
      • LastUpdatedTimestamp — (String) Last updated timestamp of the definition.
      • LatestVersion — (String) Last version of the definition.
      • LatestVersionArn — (String) Latest version arn of the definition.
      • Name — (String) Name of the definition.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getGroupCertificateAuthority(params = {}, callback) ⇒ AWS.Request

Retreives the CA associated with a group. Returns the public key of the CA.

Service Reference:

Examples:

Calling the getGroupCertificateAuthority operation

var params = {
  CertificateAuthorityId: 'STRING_VALUE', /* required */
  GroupId: 'STRING_VALUE' /* required */
};
greengrass.getGroupCertificateAuthority(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • CertificateAuthorityId — (String) certificate authority Id
    • GroupId — (String) The unique Id of the AWS Greengrass Group

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • GroupCertificateAuthorityArn — (String) Arn of the certificate authority for the group.
      • GroupCertificateAuthorityId — (String) Id of the certificate authority for the group.
      • PemEncodedCertificate — (String) PEM encoded certificate for the group.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getGroupCertificateConfiguration(params = {}, callback) ⇒ AWS.Request

Retrieves the current configuration for the CA used by the group.

Examples:

Calling the getGroupCertificateConfiguration operation

var params = {
  GroupId: 'STRING_VALUE' /* required */
};
greengrass.getGroupCertificateConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GroupId — (String) The unique Id of the AWS Greengrass Group

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • CertificateAuthorityExpiryInMilliseconds — (String) Amount of time when the certificate authority expires in milliseconds.
      • CertificateExpiryInMilliseconds — (String) Amount of time when the certificate expires in milliseconds.
      • GroupId — (String) Id of the group the certificate configuration belongs to.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getGroupVersion(params = {}, callback) ⇒ AWS.Request

Retrieves information about a group version.

Service Reference:

Examples:

Calling the getGroupVersion operation

var params = {
  GroupId: 'STRING_VALUE', /* required */
  GroupVersionId: 'STRING_VALUE' /* required */
};
greengrass.getGroupVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GroupId — (String) The unique Id of the AWS Greengrass Group
    • GroupVersionId — (String) Group version Id

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Arn — (String) Arn of the group version.
      • CreationTimestamp — (String) Timestamp when the group version was created.
      • Definition — (map) Information on the definition
        • CoreDefinitionVersionArn — (String) Core definition version arn for this group.
        • DeviceDefinitionVersionArn — (String) Device definition version arn for this group.
        • FunctionDefinitionVersionArn — (String) Function definition version arn for this group.
        • LoggerDefinitionVersionArn — (String) Logger definition version arn for this group.
        • ResourceDefinitionVersionArn — (String) Resource definition version arn for this group.
        • SubscriptionDefinitionVersionArn — (String) Subscription definition version arn for this group.
      • Id — (String) Id of the group version.
      • Version — (String) Unique Id for a version of the Group.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getLoggerDefinition(params = {}, callback) ⇒ AWS.Request

Retrieves information about a logger definition.

Service Reference:

Examples:

Calling the getLoggerDefinition operation

var params = {
  LoggerDefinitionId: 'STRING_VALUE' /* required */
};
greengrass.getLoggerDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • LoggerDefinitionId — (String) logger definition Id

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Arn — (String) Arn of the definition.
      • CreationTimestamp — (String) Timestamp of when the definition was created.
      • Id — (String) Id of the definition.
      • LastUpdatedTimestamp — (String) Last updated timestamp of the definition.
      • LatestVersion — (String) Last version of the definition.
      • LatestVersionArn — (String) Latest version arn of the definition.
      • Name — (String) Name of the definition.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getLoggerDefinitionVersion(params = {}, callback) ⇒ AWS.Request

Retrieves information about a logger definition version.

Service Reference:

Examples:

Calling the getLoggerDefinitionVersion operation

var params = {
  LoggerDefinitionId: 'STRING_VALUE', /* required */
  LoggerDefinitionVersionId: 'STRING_VALUE' /* required */
};
greengrass.getLoggerDefinitionVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • LoggerDefinitionId — (String) logger definition Id
    • LoggerDefinitionVersionId — (String) logger definition version Id

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Arn — (String) Arn of the logger definition version.
      • CreationTimestamp — (String) Timestamp of when the logger definition version was created.
      • Definition — (map) Information on definition
        • Loggers — (Array<map>) List of loggers.
          • Component — (String) The component that will be subject to logs Possible values include:
            • "GreengrassSystem"
            • "Lambda"
          • Id — (String) Element Id for this entry in the list.
          • Level — (String) The level of the logs Possible values include:
            • "DEBUG"
            • "INFO"
            • "WARN"
            • "ERROR"
            • "FATAL"
          • Space — (Integer) Amount of hardware space, in KB, to use if file system is used for logging purposes.
          • Type — (String) The type which will be use for log output Possible values include:
            • "FileSystem"
            • "AWSCloudWatch"
      • Id — (String) Id of the logger definition the version belongs to.
      • Version — (String) Version of the logger definition version.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getResourceDefinition(params = {}, callback) ⇒ AWS.Request

Retrieves information about a resource definition, such as its creation time and latest version.

Service Reference:

Examples:

Calling the getResourceDefinition operation

var params = {
  ResourceDefinitionId: 'STRING_VALUE' /* required */
};
greengrass.getResourceDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceDefinitionId — (String) Resource definition Id.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Arn — (String) Arn of the definition.
      • CreationTimestamp — (String) Timestamp of when the definition was created.
      • Id — (String) Id of the definition.
      • LastUpdatedTimestamp — (String) Last updated timestamp of the definition.
      • LatestVersion — (String) Last version of the definition.
      • LatestVersionArn — (String) Latest version arn of the definition.
      • Name — (String) Name of the definition.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getResourceDefinitionVersion(params = {}, callback) ⇒ AWS.Request

Retrieves information about a resource definition version, such as which resources are included in the version.

Service Reference:

Examples:

Calling the getResourceDefinitionVersion operation

var params = {
  ResourceDefinitionId: 'STRING_VALUE', /* required */
  ResourceDefinitionVersionId: 'STRING_VALUE' /* required */
};
greengrass.getResourceDefinitionVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceDefinitionId — (String) Resource definition Id.
    • ResourceDefinitionVersionId — (String) Resource definition version Id.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Arn — (String) Arn of the resource definition version.
      • CreationTimestamp — (String) Timestamp of when the resource definition version was created.
      • Definition — (map) Information on definition.
        • Resources — (Array<map>) List of resources.
          • Id — (String) Resource Id.
          • Name — (String) A descriptive resource name.
          • ResourceDataContainer — (map) A container of data for all resource types.
            • LocalDeviceResourceData — (map) Attributes that define the Local Device Resource.
              • GroupOwnerSetting — (map) Group owner related settings for local resources.
                • AutoAddGroupOwner — (Boolean) Eanble the auto added group owner.
                • GroupOwner — (String) Name of the group owner.
              • SourcePath — (String) Local source path of the resource.
            • LocalVolumeResourceData — (map) Attributes that define the Local Volume Resource.
              • DestinationPath — (String) Local destination path of the resource.
              • GroupOwnerSetting — (map) Group owner related settings for local resources.
                • AutoAddGroupOwner — (Boolean) Eanble the auto added group owner.
                • GroupOwner — (String) Name of the group owner.
              • SourcePath — (String) Local source path of the resource.
      • Id — (String) Id of the resource definition the version belongs to.
      • Version — (String) Version of the resource definition version.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getServiceRoleForAccount(params = {}, callback) ⇒ AWS.Request

Retrieves the service role that is attached to the account.

Service Reference:

Examples:

Calling the getServiceRoleForAccount operation

var params = {
};
greengrass.getServiceRoleForAccount(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • AssociatedAt — (String) Time when the service role was associated to the account.
      • RoleArn — (String) Role arn which is associated to the account.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getSubscriptionDefinition(params = {}, callback) ⇒ AWS.Request

Retrieves information about a subscription definition.

Service Reference:

Examples:

Calling the getSubscriptionDefinition operation

var params = {
  SubscriptionDefinitionId: 'STRING_VALUE' /* required */
};
greengrass.getSubscriptionDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SubscriptionDefinitionId — (String) subscription definition Id

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Arn — (String) Arn of the definition.
      • CreationTimestamp — (String) Timestamp of when the definition was created.
      • Id — (String) Id of the definition.
      • LastUpdatedTimestamp — (String) Last updated timestamp of the definition.
      • LatestVersion — (String) Last version of the definition.
      • LatestVersionArn — (String) Latest version arn of the definition.
      • Name — (String) Name of the definition.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getSubscriptionDefinitionVersion(params = {}, callback) ⇒ AWS.Request

Retrieves information about a subscription definition version.

Examples:

Calling the getSubscriptionDefinitionVersion operation

var params = {
  SubscriptionDefinitionId: 'STRING_VALUE', /* required */
  SubscriptionDefinitionVersionId: 'STRING_VALUE' /* required */
};
greengrass.getSubscriptionDefinitionVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SubscriptionDefinitionId — (String) subscription definition Id
    • SubscriptionDefinitionVersionId — (String) subscription definition version Id

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Arn — (String) Arn of the subscription definition version.
      • CreationTimestamp — (String) Timestamp of when the subscription definition version was created.
      • Definition — (map) Information on the definition
        • Subscriptions — (Array<map>) Subscriptions in the version.
          • Id — (String) Element Id for this entry in the list.
          • Source — (String) Source of the subscription. Can be a thing arn, lambda arn or word 'cloud'
          • Subject — (String) Subject of the message.
          • Target — (String) Where the message is sent to. Can be a thing arn, lambda arn or word 'cloud'.
      • Id — (String) Id of the subscription definition the version belongs to.
      • Version — (String) Version of the subscription definition version.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listCoreDefinitions(params = {}, callback) ⇒ AWS.Request

Retrieves a list of core definitions.

Service Reference:

Examples:

Calling the listCoreDefinitions operation

var params = {
  MaxResults: 'STRING_VALUE',
  NextToken: 'STRING_VALUE'
};
greengrass.listCoreDefinitions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (String) Specifies the maximum number of list results to be returned in this page
    • NextToken — (String) Specifies the pagination token used when iterating through a paginated request

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Definitions — (Array<map>) Definitions
        • Arn — (String) Arn of the definition.
        • CreationTimestamp — (String) Timestamp of when the definition was created.
        • Id — (String) Id of the definition.
        • LastUpdatedTimestamp — (String) Last updated timestamp of the definition.
        • LatestVersion — (String) Last version of the definition.
        • LatestVersionArn — (String) Latest version arn of the definition.
        • Name — (String) Name of the definition.
      • NextToken — (String) The token for the next set of results, or ''null'' if there are no additional results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listCoreDefinitionVersions(params = {}, callback) ⇒ AWS.Request

Lists versions of a core definition.

Service Reference:

Examples:

Calling the listCoreDefinitionVersions operation

var params = {
  CoreDefinitionId: 'STRING_VALUE', /* required */
  MaxResults: 'STRING_VALUE',
  NextToken: 'STRING_VALUE'
};
greengrass.listCoreDefinitionVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • CoreDefinitionId — (String) core definition Id
    • MaxResults — (String) Specifies the maximum number of list results to be returned in this page
    • NextToken — (String) Specifies the pagination token used when iterating through a paginated request

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • NextToken — (String) The token for the next set of results, or ''null'' if there are no additional results.
      • Versions — (Array<map>) Versions
        • Arn — (String) Arn of the version.
        • CreationTimestamp — (String) Timestamp of when the version was created.
        • Id — (String) Id of the resource container.
        • Version — (String) Unique Id of a version.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listDeployments(params = {}, callback) ⇒ AWS.Request

Returns a history of deployments for the group.

Service Reference:

Examples:

Calling the listDeployments operation

var params = {
  GroupId: 'STRING_VALUE', /* required */
  MaxResults: 'STRING_VALUE',
  NextToken: 'STRING_VALUE'
};
greengrass.listDeployments(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GroupId — (String) The unique Id of the AWS Greengrass Group
    • MaxResults — (String) Specifies the maximum number of list results to be returned in this page
    • NextToken — (String) Specifies the pagination token used when iterating through a paginated request

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Deployments — (Array<map>) List of deployments for the requested groups
        • CreatedAt — (String) Timestamp when the deployment was created.
        • DeploymentArn — (String) Arn of the deployment.
        • DeploymentId — (String) Id of the deployment.
        • DeploymentType — (String) The type of deployment. Possible values include:
          • "NewDeployment"
          • "Redeployment"
          • "ResetDeployment"
          • "ForceResetDeployment"
        • GroupArn — (String) Arn of the group for this deployment.
      • NextToken — (String) The token for the next set of results, or ''null'' if there are no additional results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listDeviceDefinitions(params = {}, callback) ⇒ AWS.Request

Retrieves a list of device definitions.

Service Reference:

Examples:

Calling the listDeviceDefinitions operation

var params = {
  MaxResults: 'STRING_VALUE',
  NextToken: 'STRING_VALUE'
};
greengrass.listDeviceDefinitions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (String) Specifies the maximum number of list results to be returned in this page
    • NextToken — (String) Specifies the pagination token used when iterating through a paginated request

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Definitions — (Array<map>) Definitions
        • Arn — (String) Arn of the definition.
        • CreationTimestamp — (String) Timestamp of when the definition was created.
        • Id — (String) Id of the definition.
        • LastUpdatedTimestamp — (String) Last updated timestamp of the definition.
        • LatestVersion — (String) Last version of the definition.
        • LatestVersionArn — (String) Latest version arn of the definition.
        • Name — (String) Name of the definition.
      • NextToken — (String) The token for the next set of results, or ''null'' if there are no additional results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listDeviceDefinitionVersions(params = {}, callback) ⇒ AWS.Request

Lists the versions of a device definition.

Service Reference:

Examples:

Calling the listDeviceDefinitionVersions operation

var params = {
  DeviceDefinitionId: 'STRING_VALUE', /* required */
  MaxResults: 'STRING_VALUE',
  NextToken: 'STRING_VALUE'
};
greengrass.listDeviceDefinitionVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DeviceDefinitionId — (String) device definition Id
    • MaxResults — (String) Specifies the maximum number of list results to be returned in this page
    • NextToken — (String) Specifies the pagination token used when iterating through a paginated request

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • NextToken — (String) The token for the next set of results, or ''null'' if there are no additional results.
      • Versions — (Array<map>) Versions
        • Arn — (String) Arn of the version.
        • CreationTimestamp — (String) Timestamp of when the version was created.
        • Id — (String) Id of the resource container.
        • Version — (String) Unique Id of a version.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listFunctionDefinitions(params = {}, callback) ⇒ AWS.Request

Retrieves a list of Lambda function definitions.

Service Reference:

Examples:

Calling the listFunctionDefinitions operation

var params = {
  MaxResults: 'STRING_VALUE',
  NextToken: 'STRING_VALUE'
};
greengrass.listFunctionDefinitions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (String) Specifies the maximum number of list results to be returned in this page
    • NextToken — (String) Specifies the pagination token used when iterating through a paginated request

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Definitions — (Array<map>) Definitions
        • Arn — (String) Arn of the definition.
        • CreationTimestamp — (String) Timestamp of when the definition was created.
        • Id — (String) Id of the definition.
        • LastUpdatedTimestamp — (String) Last updated timestamp of the definition.
        • LatestVersion — (String) Last version of the definition.
        • LatestVersionArn — (String) Latest version arn of the definition.
        • Name — (String) Name of the definition.
      • NextToken — (String) The token for the next set of results, or ''null'' if there are no additional results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listFunctionDefinitionVersions(params = {}, callback) ⇒ AWS.Request

Lists the versions of a Lambda function definition.

Service Reference:

Examples:

Calling the listFunctionDefinitionVersions operation

var params = {
  FunctionDefinitionId: 'STRING_VALUE', /* required */
  MaxResults: 'STRING_VALUE',
  NextToken: 'STRING_VALUE'
};
greengrass.listFunctionDefinitionVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FunctionDefinitionId — (String) the unique Id of the lambda definition
    • MaxResults — (String) Specifies the maximum number of list results to be returned in this page
    • NextToken — (String) Specifies the pagination token used when iterating through a paginated request

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • NextToken — (String) The token for the next set of results, or ''null'' if there are no additional results.
      • Versions — (Array<map>) Versions
        • Arn — (String) Arn of the version.
        • CreationTimestamp — (String) Timestamp of when the version was created.
        • Id — (String) Id of the resource container.
        • Version — (String) Unique Id of a version.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listGroupCertificateAuthorities(params = {}, callback) ⇒ AWS.Request

Retrieves the current CAs for a group.

Service Reference:

Examples:

Calling the listGroupCertificateAuthorities operation

var params = {
  GroupId: 'STRING_VALUE' /* required */
};
greengrass.listGroupCertificateAuthorities(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GroupId — (String) The unique Id of the AWS Greengrass Group

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • GroupCertificateAuthorities — (Array<map>) List of certificate authorities associated with the group.
        • GroupCertificateAuthorityArn — (String) Arn of the certificate authority for the group.
        • GroupCertificateAuthorityId — (String) Id of the certificate authority for the group.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listGroups(params = {}, callback) ⇒ AWS.Request

Retrieves a list of groups.

Service Reference:

Examples:

Calling the listGroups operation

var params = {
  MaxResults: 'STRING_VALUE',
  NextToken: 'STRING_VALUE'
};
greengrass.listGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (String) Specifies the maximum number of list results to be returned in this page
    • NextToken — (String) Specifies the pagination token used when iterating through a paginated request

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Groups — (Array<map>) Groups
        • Arn — (String) Arn of a group.
        • CreationTimestamp — (String) Timestamp of when the group was created.
        • Id — (String) Id of a group.
        • LastUpdatedTimestamp — (String) Last updated timestamp of the group.
        • LatestVersion — (String) Last version of the group.
        • LatestVersionArn — (String) Latest version arn of the group.
        • Name — (String) Name of a group.
      • NextToken — (String) The token for the next set of results, or ''null'' if there are no additional results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listGroupVersions(params = {}, callback) ⇒ AWS.Request

List the versions of a group.

Service Reference:

Examples:

Calling the listGroupVersions operation

var params = {
  GroupId: 'STRING_VALUE', /* required */
  MaxResults: 'STRING_VALUE',
  NextToken: 'STRING_VALUE'
};
greengrass.listGroupVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GroupId — (String) The unique Id of the AWS Greengrass Group
    • MaxResults — (String) Specifies the maximum number of list results to be returned in this page
    • NextToken — (String) Specifies the pagination token used when iterating through a paginated request

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • NextToken — (String) The token for the next set of results, or ''null'' if there are no additional results.
      • Versions — (Array<map>) Versions
        • Arn — (String) Arn of the version.
        • CreationTimestamp — (String) Timestamp of when the version was created.
        • Id — (String) Id of the resource container.
        • Version — (String) Unique Id of a version.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listLoggerDefinitions(params = {}, callback) ⇒ AWS.Request

Retrieves a list of logger definitions.

Service Reference:

Examples:

Calling the listLoggerDefinitions operation

var params = {
  MaxResults: 'STRING_VALUE',
  NextToken: 'STRING_VALUE'
};
greengrass.listLoggerDefinitions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (String) Specifies the maximum number of list results to be returned in this page
    • NextToken — (String) Specifies the pagination token used when iterating through a paginated request

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Definitions — (Array<map>) Definitions
        • Arn — (String) Arn of the definition.
        • CreationTimestamp — (String) Timestamp of when the definition was created.
        • Id — (String) Id of the definition.
        • LastUpdatedTimestamp — (String) Last updated timestamp of the definition.
        • LatestVersion — (String) Last version of the definition.
        • LatestVersionArn — (String) Latest version arn of the definition.
        • Name — (String) Name of the definition.
      • NextToken — (String) The token for the next set of results, or ''null'' if there are no additional results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listLoggerDefinitionVersions(params = {}, callback) ⇒ AWS.Request

Lists the versions of a logger definition.

Service Reference:

Examples:

Calling the listLoggerDefinitionVersions operation

var params = {
  LoggerDefinitionId: 'STRING_VALUE', /* required */
  MaxResults: 'STRING_VALUE',
  NextToken: 'STRING_VALUE'
};
greengrass.listLoggerDefinitionVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • LoggerDefinitionId — (String) logger definition Id
    • MaxResults — (String) Specifies the maximum number of list results to be returned in this page
    • NextToken — (String) Specifies the pagination token used when iterating through a paginated request

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • NextToken — (String) The token for the next set of results, or ''null'' if there are no additional results.
      • Versions — (Array<map>) Versions
        • Arn — (String) Arn of the version.
        • CreationTimestamp — (String) Timestamp of when the version was created.
        • Id — (String) Id of the resource container.
        • Version — (String) Unique Id of a version.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listResourceDefinitions(params = {}, callback) ⇒ AWS.Request

Retrieves a list of resource definitions.

Service Reference:

Examples:

Calling the listResourceDefinitions operation

var params = {
  MaxResults: 'STRING_VALUE',
  NextToken: 'STRING_VALUE'
};
greengrass.listResourceDefinitions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (String) Specifies the maximum number of list results to be returned in this page
    • NextToken — (String) Specifies the pagination token used when iterating through a paginated request

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Definitions — (Array<map>) Definitions
        • Arn — (String) Arn of the definition.
        • CreationTimestamp — (String) Timestamp of when the definition was created.
        • Id — (String) Id of the definition.
        • LastUpdatedTimestamp — (String) Last updated timestamp of the definition.
        • LatestVersion — (String) Last version of the definition.
        • LatestVersionArn — (String) Latest version arn of the definition.
        • Name — (String) Name of the definition.
      • NextToken — (String) The token for the next set of results, or ''null'' if there are no additional results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listResourceDefinitionVersions(params = {}, callback) ⇒ AWS.Request

Lists the versions of a resource definition.

Service Reference:

Examples:

Calling the listResourceDefinitionVersions operation

var params = {
  ResourceDefinitionId: 'STRING_VALUE', /* required */
  MaxResults: 'STRING_VALUE',
  NextToken: 'STRING_VALUE'
};
greengrass.listResourceDefinitionVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (String) Specifies the maximum number of list results to be returned in this page
    • NextToken — (String) Specifies the pagination token used when iterating through a paginated request
    • ResourceDefinitionId — (String) Resource definition Id.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • NextToken — (String) The token for the next set of results, or ''null'' if there are no additional results.
      • Versions — (Array<map>) Versions
        • Arn — (String) Arn of the version.
        • CreationTimestamp — (String) Timestamp of when the version was created.
        • Id — (String) Id of the resource container.
        • Version — (String) Unique Id of a version.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listSubscriptionDefinitions(params = {}, callback) ⇒ AWS.Request

Retrieves a list of subscription definitions.

Service Reference:

Examples:

Calling the listSubscriptionDefinitions operation

var params = {
  MaxResults: 'STRING_VALUE',
  NextToken: 'STRING_VALUE'
};
greengrass.listSubscriptionDefinitions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (String) Specifies the maximum number of list results to be returned in this page
    • NextToken — (String) Specifies the pagination token used when iterating through a paginated request

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Definitions — (Array<map>) Definitions
        • Arn — (String) Arn of the definition.
        • CreationTimestamp — (String) Timestamp of when the definition was created.
        • Id — (String) Id of the definition.
        • LastUpdatedTimestamp — (String) Last updated timestamp of the definition.
        • LatestVersion — (String) Last version of the definition.
        • LatestVersionArn — (String) Latest version arn of the definition.
        • Name — (String) Name of the definition.
      • NextToken — (String) The token for the next set of results, or ''null'' if there are no additional results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listSubscriptionDefinitionVersions(params = {}, callback) ⇒ AWS.Request

Lists the versions of a subscription definition.

Examples:

Calling the listSubscriptionDefinitionVersions operation

var params = {
  SubscriptionDefinitionId: 'STRING_VALUE', /* required */
  MaxResults: 'STRING_VALUE',
  NextToken: 'STRING_VALUE'
};
greengrass.listSubscriptionDefinitionVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (String) Specifies the maximum number of list results to be returned in this page
    • NextToken — (String) Specifies the pagination token used when iterating through a paginated request
    • SubscriptionDefinitionId — (String) subscription definition Id

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • NextToken — (String) The token for the next set of results, or ''null'' if there are no additional results.
      • Versions — (Array<map>) Versions
        • Arn — (String) Arn of the version.
        • CreationTimestamp — (String) Timestamp of when the version was created.
        • Id — (String) Id of the resource container.
        • Version — (String) Unique Id of a version.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

resetDeployments(params = {}, callback) ⇒ AWS.Request

Resets a group's deployments.

Service Reference:

Examples:

Calling the resetDeployments operation

var params = {
  GroupId: 'STRING_VALUE', /* required */
  AmznClientToken: 'STRING_VALUE',
  Force: true || false
};
greengrass.resetDeployments(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AmznClientToken — (String) The client token used to request idempotent operations.
    • Force — (Boolean) When set to true, perform a best-effort only core reset.
    • GroupId — (String) The unique Id of the AWS Greengrass Group

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • DeploymentArn — (String) The arn of the reset deployment.
      • DeploymentId — (String) The id of the reset deployment.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateConnectivityInfo(params = {}, callback) ⇒ AWS.Request

Updates the connectivity information for the core. Any devices that belong to the group which has this core will receive this information in order to find the location of the core and connect to it.

Service Reference:

Examples:

Calling the updateConnectivityInfo operation

var params = {
  ThingName: 'STRING_VALUE', /* required */
  ConnectivityInfo: [
    {
      HostAddress: 'STRING_VALUE',
      Id: 'STRING_VALUE',
      Metadata: 'STRING_VALUE',
      PortNumber: 0
    },
    /* more items */
  ]
};
greengrass.updateConnectivityInfo(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ConnectivityInfo — (Array<map>) Connectivity info list
      • HostAddress — (String) Endpoint for the GGC. Can be an IP address or DNS.
      • Id — (String) Element Id for this entry in the list.
      • Metadata — (String) Metadata for this endpoint.
      • PortNumber — (Integer) Port of the GGC. Usually 8883.
    • ThingName — (String) Thing Name

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • Message — (String) Response Text
      • Version — (String) New Version

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateCoreDefinition(params = {}, callback) ⇒ AWS.Request

Updates a core definition.

Service Reference:

Examples:

Calling the updateCoreDefinition operation

var params = {
  CoreDefinitionId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE'
};
greengrass.updateCoreDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • CoreDefinitionId — (String) core definition Id
    • Name — (String) name of the definition

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateDeviceDefinition(params = {}, callback) ⇒ AWS.Request

Updates a device definition.

Service Reference:

Examples:

Calling the updateDeviceDefinition operation

var params = {
  DeviceDefinitionId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE'
};
greengrass.updateDeviceDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DeviceDefinitionId — (String) device definition Id
    • Name — (String) name of the definition

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateFunctionDefinition(params = {}, callback) ⇒ AWS.Request

Updates a Lambda function definition.

Service Reference:

Examples:

Calling the updateFunctionDefinition operation

var params = {
  FunctionDefinitionId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE'
};
greengrass.updateFunctionDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FunctionDefinitionId — (String) the unique Id of the lambda definition
    • Name — (String) name of the definition

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateGroup(params = {}, callback) ⇒ AWS.Request

Updates a group.

Service Reference:

Examples:

Calling the updateGroup operation

var params = {
  GroupId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE'
};
greengrass.updateGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GroupId — (String) The unique Id of the AWS Greengrass Group
    • Name — (String) name of the definition

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateGroupCertificateConfiguration(params = {}, callback) ⇒ AWS.Request

Updates the Cert expiry time for a group.

Examples:

Calling the updateGroupCertificateConfiguration operation

var params = {
  GroupId: 'STRING_VALUE', /* required */
  CertificateExpiryInMilliseconds: 'STRING_VALUE'
};
greengrass.updateGroupCertificateConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • CertificateExpiryInMilliseconds — (String) Amount of time when the certificate expires in milliseconds.
    • GroupId — (String) The unique Id of the AWS Greengrass Group

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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. The data object has the following properties:

      • CertificateAuthorityExpiryInMilliseconds — (String) Amount of time when the certificate authority expires in milliseconds.
      • CertificateExpiryInMilliseconds — (String) Amount of time when the certificate expires in milliseconds.
      • GroupId — (String) Id of the group the certificate configuration belongs to.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateLoggerDefinition(params = {}, callback) ⇒ AWS.Request

Updates a logger definition.

Service Reference:

Examples:

Calling the updateLoggerDefinition operation

var params = {
  LoggerDefinitionId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE'
};
greengrass.updateLoggerDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • LoggerDefinitionId — (String) logger definition Id
    • Name — (String) name of the definition

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateResourceDefinition(params = {}, callback) ⇒ AWS.Request

Updates a resource definition.

Service Reference:

Examples:

Calling the updateResourceDefinition operation

var params = {
  ResourceDefinitionId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE'
};
greengrass.updateResourceDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String) name of the definition
    • ResourceDefinitionId — (String) Resource definition Id.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateSubscriptionDefinition(params = {}, callback) ⇒ AWS.Request

Updates a subscription definition.

Service Reference:

Examples:

Calling the updateSubscriptionDefinition operation

var params = {
  SubscriptionDefinitionId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE'
};
greengrass.updateSubscriptionDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String) name of the definition
    • SubscriptionDefinitionId — (String) subscription definition Id

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.