Class: AWS.SSM

Inherits:
AWS.Service show all
Identifier:
ssm
API Version:
2014-11-06
Defined in:
(unknown)

Overview

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

Sending a Request Using SSM

var ssm = new AWS.SSM();
ssm.deregisterTargetFromMaintenanceWindow(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 SSM object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var ssm = new AWS.SSM({apiVersion: '2014-11-06'});

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

AWS.config.apiVersions = {
  ssm: '2014-11-06',
  // other service API versions
};

var ssm = new AWS.SSM();

Version:

  • 2014-11-06

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.SSM(options = {}) ⇒ Object

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

Examples:

Constructing a SSM object

var ssm = new AWS.SSM({apiVersion: '2014-11-06'});

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.SSM.region for more information.

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.SSM.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

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

Adds or overwrites one or more tags for the specified resource. Tags are metadata that you assign to your managed instances, Maintenance Windows, or Parameter Store parameters. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example: Key=Owner and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and Value=Production, Pre-Production, or Test.

Each resource can have a maximum of 10 tags.

We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to Amazon EC2 and are interpreted strictly as a string of characters.

For more information about tags, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.

Service Reference:

Examples:

Calling the addTagsToResource operation

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  ResourceType: ManagedInstance | MaintenanceWindow | Parameter, /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
ssm.addTagsToResource(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: {})
    • ResourceType — (String)

      Specifies the type of resource you are tagging.

      Possible values include:
      • "ManagedInstance"
      • "MaintenanceWindow"
      • "Parameter"
    • ResourceId — (String)

      The resource ID you want to tag.

    • Tags — (Array<map>)

      One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

      • Keyrequired — (String)

        The name of the tag.

      • Valuerequired — (String)

        The value of the tag.

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.

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

Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.

Service Reference:

Examples:

Calling the cancelCommand operation

var params = {
  CommandId: 'STRING_VALUE', /* required */
  InstanceIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
ssm.cancelCommand(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: {})
    • CommandId — (String)

      The ID of the command you want to cancel.

    • InstanceIds — (Array<String>)

      (Optional) A list of instance IDs on which you want to cancel the command. If not provided, the command is canceled on every instance on which it was requested.

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.

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

Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using Run Command. An on-premises server or virtual machine that has been registered with EC2 is called a managed instance. For more information about activations, see Setting Up Systems Manager in Hybrid Environments.

Service Reference:

Examples:

Calling the createActivation operation

var params = {
  IamRole: 'STRING_VALUE', /* required */
  DefaultInstanceName: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  ExpirationDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  RegistrationLimit: 0
};
ssm.createActivation(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: {})
    • Description — (String)

      A userdefined description of the resource that you want to register with Amazon EC2.

    • DefaultInstanceName — (String)

      The name of the registered, managed instance as it will appear in the Amazon EC2 console or when you use the AWS command line tools to list EC2 resources.

    • IamRole — (String)

      The Amazon Identity and Access Management (IAM) role that you want to assign to the managed instance.

    • RegistrationLimit — (Integer)

      Specify the maximum number of managed instances you want to register. The default value is 1 instance.

    • ExpirationDate — (Date)

      The date by which this activation request should expire. The default value is 24 hours.

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:

      • ActivationId — (String)

        The ID number generated by the system when it processed the activation. The activation ID functions like a user name.

      • ActivationCode — (String)

        The code the system generates when it processes the activation. The activation code functions like a password to validate the activation ID.

Returns:

  • (AWS.Request)

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

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

Associates the specified Systems Manager document with the specified instances or targets.

When you associate a document with one or more instances using instance IDs or tags, the SSM Agent running on the instance processes the document and configures the instance as specified.

If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception.

Service Reference:

Examples:

Calling the createAssociation operation

var params = {
  Name: 'STRING_VALUE', /* required */
  DocumentVersion: 'STRING_VALUE',
  InstanceId: 'STRING_VALUE',
  OutputLocation: {
    S3Location: {
      OutputS3BucketName: 'STRING_VALUE',
      OutputS3KeyPrefix: 'STRING_VALUE',
      OutputS3Region: 'STRING_VALUE'
    }
  },
  Parameters: {
    '<ParameterName>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<ParameterName>': ... */
  },
  ScheduleExpression: 'STRING_VALUE',
  Targets: [
    {
      Key: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ]
};
ssm.createAssociation(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)

      The name of the Systems Manager document.

    • DocumentVersion — (String)

      The document version you want to associate with the target(s). Can be a specific version or the default version.

    • InstanceId — (String)

      The instance ID.

    • Parameters — (map<Array<String>>)

      The parameters for the documents runtime configuration.

    • Targets — (Array<map>)

      The targets (either instances or tags) for the association.

      • Key — (String)

        User-defined criteria for sending commands that target instances that meet the criteria. Key can be tag:<Amazon EC2 tag> or InstanceIds. For more information about how to send commands that target instances using Key,Value parameters, see Executing a Command Using Systems Manager Run Command.

      • Values — (Array<String>)

        User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to execute a command on instances that include Amazon EC2 tags of ServerRole,WebServer. For more information about how to send commands that target instances using Key,Value parameters, see Executing a Command Using Systems Manager Run Command.

    • ScheduleExpression — (String)

      A cron expression when the association will be applied to the target(s).

    • OutputLocation — (map)

      An Amazon S3 bucket where you want to store the output details of the request.

      • S3Location — (map)

        An Amazon S3 bucket where you want to store the results of this request.

        • OutputS3Region — (String)

          (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.

        • OutputS3BucketName — (String)

          The name of the Amazon S3 bucket.

        • OutputS3KeyPrefix — (String)

          The Amazon S3 bucket subfolder.

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:

      • AssociationDescription — (map)

        Information about the association.

        • Name — (String)

          The name of the SSM document.

        • InstanceId — (String)

          The ID of the instance.

        • Date — (Date)

          The date when the association was made.

        • LastUpdateAssociationDate — (Date)

          The date when the association was last updated.

        • Status — (map)

          The association status.

          • Daterequired — (Date)

            The date when the status changed.

          • Namerequired — (String)

            The status.

            Possible values include:
            • "Pending"
            • "Success"
            • "Failed"
          • Messagerequired — (String)

            The reason for the status.

          • AdditionalInfo — (String)

            A user-defined string.

        • Overview — (map)

          Information about the association.

          • Status — (String)

            The status of the association. Status can be: Pending, Success, or Failed.

          • DetailedStatus — (String)

            A detailed status of the association.

          • AssociationStatusAggregatedCount — (map<Integer>)

            Returns the number of targets for the association status. For example, if you created an association with two instances, and one of them was successful, this would return the count of instances by status.

        • DocumentVersion — (String)

          The document version.

        • Parameters — (map<Array<String>>)

          A description of the parameters for a document.

        • AssociationId — (String)

          The association ID.

        • Targets — (Array<map>)

          The instances targeted by the request.

          • Key — (String)

            User-defined criteria for sending commands that target instances that meet the criteria. Key can be tag:<Amazon EC2 tag> or InstanceIds. For more information about how to send commands that target instances using Key,Value parameters, see Executing a Command Using Systems Manager Run Command.

          • Values — (Array<String>)

            User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to execute a command on instances that include Amazon EC2 tags of ServerRole,WebServer. For more information about how to send commands that target instances using Key,Value parameters, see Executing a Command Using Systems Manager Run Command.

        • ScheduleExpression — (String)

          A cron expression that specifies a schedule when the association runs.

        • OutputLocation — (map)

          An Amazon S3 bucket where you want to store the output details of the request.

          • S3Location — (map)

            An Amazon S3 bucket where you want to store the results of this request.

            • OutputS3Region — (String)

              (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.

            • OutputS3BucketName — (String)

              The name of the Amazon S3 bucket.

            • OutputS3KeyPrefix — (String)

              The Amazon S3 bucket subfolder.

        • LastExecutionDate — (Date)

          The date on which the association was last run.

        • LastSuccessfulExecutionDate — (Date)

          The last date on which the association was successfully run.

Returns:

  • (AWS.Request)

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

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

Associates the specified Systems Manager document with the specified instances or targets.

When you associate a document with one or more instances using instance IDs or tags, the SSM Agent running on the instance processes the document and configures the instance as specified.

If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception.

Service Reference:

Examples:

Calling the createAssociationBatch operation

var params = {
  Entries: [ /* required */
    {
      Name: 'STRING_VALUE', /* required */
      DocumentVersion: 'STRING_VALUE',
      InstanceId: 'STRING_VALUE',
      OutputLocation: {
        S3Location: {
          OutputS3BucketName: 'STRING_VALUE',
          OutputS3KeyPrefix: 'STRING_VALUE',
          OutputS3Region: 'STRING_VALUE'
        }
      },
      Parameters: {
        '<ParameterName>': [
          'STRING_VALUE',
          /* more items */
        ],
        /* '<ParameterName>': ... */
      },
      ScheduleExpression: 'STRING_VALUE',
      Targets: [
        {
          Key: 'STRING_VALUE',
          Values: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
ssm.createAssociationBatch(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: {})
    • Entries — (Array<map>)

      One or more associations.

      • Namerequired — (String)

        The name of the configuration document.

      • InstanceId — (String)

        The ID of the instance.

      • Parameters — (map<Array<String>>)

        A description of the parameters for a document.

      • DocumentVersion — (String)

        The document version.

      • Targets — (Array<map>)

        The instances targeted by the request.

        • Key — (String)

          User-defined criteria for sending commands that target instances that meet the criteria. Key can be tag:<Amazon EC2 tag> or InstanceIds. For more information about how to send commands that target instances using Key,Value parameters, see Executing a Command Using Systems Manager Run Command.

        • Values — (Array<String>)

          User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to execute a command on instances that include Amazon EC2 tags of ServerRole,WebServer. For more information about how to send commands that target instances using Key,Value parameters, see Executing a Command Using Systems Manager Run Command.

      • ScheduleExpression — (String)

        A cron expression that specifies a schedule when the association runs.

      • OutputLocation — (map)

        An Amazon S3 bucket where you want to store the results of this request.

        • S3Location — (map)

          An Amazon S3 bucket where you want to store the results of this request.

          • OutputS3Region — (String)

            (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.

          • OutputS3BucketName — (String)

            The name of the Amazon S3 bucket.

          • OutputS3KeyPrefix — (String)

            The Amazon S3 bucket subfolder.

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:

      • Successful — (Array<map>)

        Information about the associations that succeeded.

        • Name — (String)

          The name of the SSM document.

        • InstanceId — (String)

          The ID of the instance.

        • Date — (Date)

          The date when the association was made.

        • LastUpdateAssociationDate — (Date)

          The date when the association was last updated.

        • Status — (map)

          The association status.

          • Daterequired — (Date)

            The date when the status changed.

          • Namerequired — (String)

            The status.

            Possible values include:
            • "Pending"
            • "Success"
            • "Failed"
          • Messagerequired — (String)

            The reason for the status.

          • AdditionalInfo — (String)

            A user-defined string.

        • Overview — (map)

          Information about the association.

          • Status — (String)

            The status of the association. Status can be: Pending, Success, or Failed.

          • DetailedStatus — (String)

            A detailed status of the association.

          • AssociationStatusAggregatedCount — (map<Integer>)

            Returns the number of targets for the association status. For example, if you created an association with two instances, and one of them was successful, this would return the count of instances by status.

        • DocumentVersion — (String)

          The document version.

        • Parameters — (map<Array<String>>)

          A description of the parameters for a document.

        • AssociationId — (String)

          The association ID.

        • Targets — (Array<map>)

          The instances targeted by the request.

          • Key — (String)

            User-defined criteria for sending commands that target instances that meet the criteria. Key can be tag:<Amazon EC2 tag> or InstanceIds. For more information about how to send commands that target instances using Key,Value parameters, see Executing a Command Using Systems Manager Run Command.

          • Values — (Array<String>)

            User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to execute a command on instances that include Amazon EC2 tags of ServerRole,WebServer. For more information about how to send commands that target instances using Key,Value parameters, see Executing a Command Using Systems Manager Run Command.

        • ScheduleExpression — (String)

          A cron expression that specifies a schedule when the association runs.

        • OutputLocation — (map)

          An Amazon S3 bucket where you want to store the output details of the request.

          • S3Location — (map)

            An Amazon S3 bucket where you want to store the results of this request.

            • OutputS3Region — (String)

              (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.

            • OutputS3BucketName — (String)

              The name of the Amazon S3 bucket.

            • OutputS3KeyPrefix — (String)

              The Amazon S3 bucket subfolder.

        • LastExecutionDate — (Date)

          The date on which the association was last run.

        • LastSuccessfulExecutionDate — (Date)

          The last date on which the association was successfully run.

      • Failed — (Array<map>)

        Information about the associations that failed.

        • Entry — (map)

          The association.

          • Namerequired — (String)

            The name of the configuration document.

          • InstanceId — (String)

            The ID of the instance.

          • Parameters — (map<Array<String>>)

            A description of the parameters for a document.

          • DocumentVersion — (String)

            The document version.

          • Targets — (Array<map>)

            The instances targeted by the request.

            • Key — (String)

              User-defined criteria for sending commands that target instances that meet the criteria. Key can be tag:<Amazon EC2 tag> or InstanceIds. For more information about how to send commands that target instances using Key,Value parameters, see Executing a Command Using Systems Manager Run Command.

            • Values — (Array<String>)

              User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to execute a command on instances that include Amazon EC2 tags of ServerRole,WebServer. For more information about how to send commands that target instances using Key,Value parameters, see Executing a Command Using Systems Manager Run Command.

          • ScheduleExpression — (String)

            A cron expression that specifies a schedule when the association runs.

          • OutputLocation — (map)

            An Amazon S3 bucket where you want to store the results of this request.

            • S3Location — (map)

              An Amazon S3 bucket where you want to store the results of this request.

              • OutputS3Region — (String)

                (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.

              • OutputS3BucketName — (String)

                The name of the Amazon S3 bucket.

              • OutputS3KeyPrefix — (String)

                The Amazon S3 bucket subfolder.

        • Message — (String)

          A description of the failure.

        • Fault — (String)

          The source of the failure.

          Possible values include:
          • "Client"
          • "Server"
          • "Unknown"

Returns:

  • (AWS.Request)

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

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

Creates a Systems Manager document.

After you create a document, you can use CreateAssociation to associate it with one or more running instances.

Service Reference:

Examples:

Calling the createDocument operation

var params = {
  Content: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  DocumentType: Command | Policy | Automation
};
ssm.createDocument(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: {})
    • Content — (String)

      A valid JSON string.

    • Name — (String)

      A name for the Systems Manager document.

    • DocumentType — (String)

      The type of document to create. Valid document types include: Policy, Automation, and Command.

      Possible values include:
      • "Command"
      • "Policy"
      • "Automation"

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:

      • DocumentDescription — (map)

        Information about the Systems Manager document.

        • Sha1 — (String)

          The SHA1 hash of the document, which you can use for verification purposes.

        • Hash — (String)

          The Sha256 or Sha1 hash created by the system when the document was created.

          Note: Sha1 hashes have been deprecated.
        • HashType — (String)

          Sha256 or Sha1.

          Note: Sha1 hashes have been deprecated.
          Possible values include:
          • "Sha256"
          • "Sha1"
        • Name — (String)

          The name of the SSM document.

        • Owner — (String)

          The AWS user account of the person who created the document.

        • CreatedDate — (Date)

          The date when the document was created.

        • Status — (String)

          The status of the SSM document.

          Possible values include:
          • "Creating"
          • "Active"
          • "Updating"
          • "Deleting"
        • DocumentVersion — (String)

          The document version.

        • Description — (String)

          A description of the document.

        • Parameters — (Array<map>)

          A description of the parameters for a document.

          • Name — (String)

            The name of the parameter.

          • Type — (String)

            The type of parameter. The type can be either String or StringList.

            Possible values include:
            • "String"
            • "StringList"
          • Description — (String)

            A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.

          • DefaultValue — (String)

            If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.

        • PlatformTypes — (Array<String>)

          The list of OS platforms compatible with this SSM document.

        • DocumentType — (String)

          The type of document.

          Possible values include:
          • "Command"
          • "Policy"
          • "Automation"
        • SchemaVersion — (String)

          The schema version.

        • LatestVersion — (String)

          The latest version of the document.

        • DefaultVersion — (String)

          The default version.

Returns:

  • (AWS.Request)

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

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

Creates a new Maintenance Window.

Service Reference:

Examples:

Calling the createMaintenanceWindow operation

var params = {
  AllowUnassociatedTargets: true || false, /* required */
  Cutoff: 0, /* required */
  Duration: 0, /* required */
  Name: 'STRING_VALUE', /* required */
  Schedule: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE'
};
ssm.createMaintenanceWindow(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)

      The name of the Maintenance Window.

    • Schedule — (String)

      The schedule of the Maintenance Window in the form of a cron or rate expression.

    • Duration — (Integer)

      The duration of the Maintenance Window in hours.

    • Cutoff — (Integer)

      The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.

    • AllowUnassociatedTargets — (Boolean)

      Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets.

    • ClientToken — (String)

      User-provided idempotency token.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • WindowId — (String)

        The ID of the created Maintenance Window.

Returns:

  • (AWS.Request)

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

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

Creates a patch baseline.

Service Reference:

Examples:

Calling the createPatchBaseline operation

var params = {
  Name: 'STRING_VALUE', /* required */
  ApprovalRules: {
    PatchRules: [ /* required */
      {
        ApproveAfterDays: 0, /* required */
        PatchFilterGroup: { /* required */
          PatchFilters: [ /* required */
            {
              Key: PRODUCT | CLASSIFICATION | MSRC_SEVERITY | PATCH_ID, /* required */
              Values: [ /* required */
                'STRING_VALUE',
                /* more items */
              ]
            },
            /* more items */
          ]
        }
      },
      /* more items */
    ]
  },
  ApprovedPatches: [
    'STRING_VALUE',
    /* more items */
  ],
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  GlobalFilters: {
    PatchFilters: [ /* required */
      {
        Key: PRODUCT | CLASSIFICATION | MSRC_SEVERITY | PATCH_ID, /* required */
        Values: [ /* required */
          'STRING_VALUE',
          /* more items */
        ]
      },
      /* more items */
    ]
  },
  RejectedPatches: [
    'STRING_VALUE',
    /* more items */
  ]
};
ssm.createPatchBaseline(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)

      The name of the patch baseline.

    • GlobalFilters — (map)

      A set of global filters used to exclude patches from the baseline.

      • PatchFiltersrequired — (Array<map>)

        The set of patch filters that make up the group.

        • Keyrequired — (String)

          The key for the filter (PRODUCT, CLASSIFICATION, MSRC_SEVERITY, PATCH_ID)

          Possible values include:
          • "PRODUCT"
          • "CLASSIFICATION"
          • "MSRC_SEVERITY"
          • "PATCH_ID"
        • Valuesrequired — (Array<String>)

          The value for the filter key.

    • ApprovalRules — (map)

      A set of rules used to include patches in the baseline.

      • PatchRulesrequired — (Array<map>)

        The rules that make up the rule group.

        • PatchFilterGrouprequired — (map)

          The patch filter group that defines the criteria for the rule.

          • PatchFiltersrequired — (Array<map>)

            The set of patch filters that make up the group.

            • Keyrequired — (String)

              The key for the filter (PRODUCT, CLASSIFICATION, MSRC_SEVERITY, PATCH_ID)

              Possible values include:
              • "PRODUCT"
              • "CLASSIFICATION"
              • "MSRC_SEVERITY"
              • "PATCH_ID"
            • Valuesrequired — (Array<String>)

              The value for the filter key.

        • ApproveAfterDaysrequired — (Integer)

          The number of days after the release date of each patch matched by the rule the patch is marked as approved in the patch baseline.

    • ApprovedPatches — (Array<String>)

      A list of explicitly approved patches for the baseline.

    • RejectedPatches — (Array<String>)

      A list of explicitly rejected patches for the baseline.

    • Description — (String)

      A description of the patch baseline.

    • ClientToken — (String)

      User-provided idempotency token.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • BaselineId — (String)

        The ID of the created patch baseline.

Returns:

  • (AWS.Request)

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

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

Deletes an activation. You are not required to delete an activation. If you delete an activation, you can no longer use it to register additional managed instances. Deleting an activation does not de-register managed instances. You must manually de-register managed instances.

Service Reference:

Examples:

Calling the deleteActivation operation

var params = {
  ActivationId: 'STRING_VALUE' /* required */
};
ssm.deleteActivation(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: {})
    • ActivationId — (String)

      The ID of the activation that you want to delete.

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.

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

Disassociates the specified Systems Manager document from the specified instance.

When you disassociate a document from an instance, it does not change the configuration of the instance. To change the configuration state of an instance after you disassociate a document, you must create a new document with the desired configuration and associate it with the instance.

Service Reference:

Examples:

Calling the deleteAssociation operation

var params = {
  AssociationId: 'STRING_VALUE',
  InstanceId: 'STRING_VALUE',
  Name: 'STRING_VALUE'
};
ssm.deleteAssociation(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)

      The name of the Systems Manager document.

    • InstanceId — (String)

      The ID of the instance.

    • AssociationId — (String)

      The association ID that you want to delete.

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.

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

Deletes the Systems Manager document and all instance associations to the document.

Before you delete the document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.

Service Reference:

Examples:

Calling the deleteDocument operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
ssm.deleteDocument(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)

      The name of the document.

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.

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

Deletes a Maintenance Window.

Service Reference:

Examples:

Calling the deleteMaintenanceWindow operation

var params = {
  WindowId: 'STRING_VALUE' /* required */
};
ssm.deleteMaintenanceWindow(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: {})
    • WindowId — (String)

      The ID of the Maintenance Window to delete.

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:

      • WindowId — (String)

        The ID of the deleted Maintenance Window.

Returns:

  • (AWS.Request)

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

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

Delete a parameter from the system.

Service Reference:

Examples:

Calling the deleteParameter operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
ssm.deleteParameter(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)

      The name of the parameter to delete.

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.

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

Delete a list of parameters.

Service Reference:

Examples:

Calling the deleteParameters operation

var params = {
  Names: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
ssm.deleteParameters(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: {})
    • Names — (Array<String>)

      The names of the parameters to delete.

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:

      • DeletedParameters — (Array<String>)

        The names of the deleted parameters.

      • InvalidParameters — (Array<String>)

        The names of parameters that weren't deleted because the parameters are not valid.

Returns:

  • (AWS.Request)

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

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

Deletes a patch baseline.

Service Reference:

Examples:

Calling the deletePatchBaseline operation

var params = {
  BaselineId: 'STRING_VALUE' /* required */
};
ssm.deletePatchBaseline(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: {})
    • BaselineId — (String)

      The ID of the patch baseline to delete.

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:

      • BaselineId — (String)

        The ID of the deleted patch baseline.

Returns:

  • (AWS.Request)

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

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

Removes the server or virtual machine from the list of registered servers. You can reregister the instance again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling the SSM Agent first.

Service Reference:

Examples:

Calling the deregisterManagedInstance operation

var params = {
  InstanceId: 'STRING_VALUE' /* required */
};
ssm.deregisterManagedInstance(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: {})
    • InstanceId — (String)

      The ID assigned to the managed instance when you registered it using the activation process.

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.

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

Removes a patch group from a patch baseline.

Examples:

Calling the deregisterPatchBaselineForPatchGroup operation

var params = {
  BaselineId: 'STRING_VALUE', /* required */
  PatchGroup: 'STRING_VALUE' /* required */
};
ssm.deregisterPatchBaselineForPatchGroup(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: {})
    • BaselineId — (String)

      The ID of the patch baseline to deregister the patch group from.

    • PatchGroup — (String)

      The name of the patch group that should be deregistered from the patch baseline.

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:

      • BaselineId — (String)

        The ID of the patch baseline the patch group was deregistered from.

      • PatchGroup — (String)

        The name of the patch group deregistered from the patch baseline.

Returns:

  • (AWS.Request)

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

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

Removes a target from a Maintenance Window.

Examples:

Calling the deregisterTargetFromMaintenanceWindow operation

var params = {
  WindowId: 'STRING_VALUE', /* required */
  WindowTargetId: 'STRING_VALUE' /* required */
};
ssm.deregisterTargetFromMaintenanceWindow(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: {})
    • WindowId — (String)

      The ID of the Maintenance Window the target should be removed from.

    • WindowTargetId — (String)

      The ID of the target definition to remove.

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:

      • WindowId — (String)

        The ID of the Maintenance Window the target was removed from.

      • WindowTargetId — (String)

        The ID of the removed target definition.

Returns:

  • (AWS.Request)

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

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

Removes a task from a Maintenance Window.

Examples:

Calling the deregisterTaskFromMaintenanceWindow operation

var params = {
  WindowId: 'STRING_VALUE', /* required */
  WindowTaskId: 'STRING_VALUE' /* required */
};
ssm.deregisterTaskFromMaintenanceWindow(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: {})
    • WindowId — (String)

      The ID of the Maintenance Window the task should be removed from.

    • WindowTaskId — (String)

      The ID of the task to remove from the Maintenance Window.

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:

      • WindowId — (String)

        The ID of the Maintenance Window the task was removed from.

      • WindowTaskId — (String)

        The ID of the task removed from the Maintenance Window.

Returns:

  • (AWS.Request)

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

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

Details about the activation, including: the date and time the activation was created, the expiration date, the IAM role assigned to the instances in the activation, and the number of instances activated by this registration.

Service Reference:

Examples:

Calling the describeActivations operation

var params = {
  Filters: [
    {
      FilterKey: ActivationIds | DefaultInstanceName | IamRole,
      FilterValues: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
ssm.describeActivations(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: {})
    • Filters — (Array<map>)

      A filter to view information about your activations.

      • FilterKey — (String)

        The name of the filter.

        Possible values include:
        • "ActivationIds"
        • "DefaultInstanceName"
        • "IamRole"
      • FilterValues — (Array<String>)

        The filter values.

    • MaxResults — (Integer)

      The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    • NextToken — (String)

      A token to start the list. Use this token to get the next set of results.

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:

      • ActivationList — (Array<map>)

        A list of activations for your AWS account.

        • ActivationId — (String)

          The ID created by Systems Manager when you submitted the activation.

        • Description — (String)

          A user defined description of the activation.

        • DefaultInstanceName — (String)

          A name for the managed instance when it is created.

        • IamRole — (String)

          The Amazon Identity and Access Management (IAM) role to assign to the managed instance.

        • RegistrationLimit — (Integer)

          The maximum number of managed instances that can be registered using this activation.

        • RegistrationsCount — (Integer)

          The number of managed instances already registered with this activation.

        • ExpirationDate — (Date)

          The date when this activation can no longer be used to register managed instances.

        • Expired — (Boolean)

          Whether or not the activation is expired.

        • CreatedDate — (Date)

          The date the activation was created.

      • NextToken — (String)

        The token for the next set of items to return. Use this token to get the next set of results.

Returns:

  • (AWS.Request)

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

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

Describes the associations for the specified Systems Manager document or instance.

Service Reference:

Examples:

Calling the describeAssociation operation

var params = {
  AssociationId: 'STRING_VALUE',
  InstanceId: 'STRING_VALUE',
  Name: 'STRING_VALUE'
};
ssm.describeAssociation(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)

      The name of the SSM document.

    • InstanceId — (String)

      The instance ID.

    • AssociationId — (String)

      The association ID for which you want information.

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:

      • AssociationDescription — (map)

        Information about the association.

        • Name — (String)

          The name of the SSM document.

        • InstanceId — (String)

          The ID of the instance.

        • Date — (Date)

          The date when the association was made.

        • LastUpdateAssociationDate — (Date)

          The date when the association was last updated.

        • Status — (map)

          The association status.

          • Daterequired — (Date)

            The date when the status changed.

          • Namerequired — (String)

            The status.

            Possible values include:
            • "Pending"
            • "Success"
            • "Failed"
          • Messagerequired — (String)

            The reason for the status.

          • AdditionalInfo — (String)

            A user-defined string.

        • Overview — (map)

          Information about the association.

          • Status — (String)

            The status of the association. Status can be: Pending, Success, or Failed.

          • DetailedStatus — (String)

            A detailed status of the association.

          • AssociationStatusAggregatedCount — (map<Integer>)

            Returns the number of targets for the association status. For example, if you created an association with two instances, and one of them was successful, this would return the count of instances by status.

        • DocumentVersion — (String)

          The document version.

        • Parameters — (map<Array<String>>)

          A description of the parameters for a document.

        • AssociationId — (String)

          The association ID.

        • Targets — (Array<map>)

          The instances targeted by the request.

          • Key — (String)

            User-defined criteria for sending commands that target instances that meet the criteria. Key can be tag:<Amazon EC2 tag> or InstanceIds. For more information about how to send commands that target instances using Key,Value parameters, see Executing a Command Using Systems Manager Run Command.

          • Values — (Array<String>)

            User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to execute a command on instances that include Amazon EC2 tags of ServerRole,WebServer. For more information about how to send commands that target instances using Key,Value parameters, see Executing a Command Using Systems Manager Run Command.

        • ScheduleExpression — (String)

          A cron expression that specifies a schedule when the association runs.

        • OutputLocation — (map)

          An Amazon S3 bucket where you want to store the output details of the request.

          • S3Location — (map)

            An Amazon S3 bucket where you want to store the results of this request.

            • OutputS3Region — (String)

              (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.

            • OutputS3BucketName — (String)

              The name of the Amazon S3 bucket.

            • OutputS3KeyPrefix — (String)

              The Amazon S3 bucket subfolder.

        • LastExecutionDate — (Date)

          The date on which the association was last run.

        • LastSuccessfulExecutionDate — (Date)

          The last date on which the association was successfully run.

Returns:

  • (AWS.Request)

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

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

Provides details about all active and terminated Automation executions.

Service Reference:

Examples:

Calling the describeAutomationExecutions operation

var params = {
  Filters: [
    {
      Key: DocumentNamePrefix | ExecutionStatus, /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
ssm.describeAutomationExecutions(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: {})
    • Filters — (Array<map>)

      Filters used to limit the scope of executions that are requested.

      • Keyrequired — (String)

        The aspect of the Automation execution information that should be limited.

        Possible values include:
        • "DocumentNamePrefix"
        • "ExecutionStatus"
      • Valuesrequired — (Array<String>)

        The values used to limit the execution information associated with the filter's key.

    • MaxResults — (Integer)

      The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    • NextToken — (String)

      The token for the next set of items to return. (You received this token from a previous call.)

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:

      • AutomationExecutionMetadataList — (Array<map>)

        The list of details about each automation execution which has occurred which matches the filter specification, if any.

        • AutomationExecutionId — (String)

          The execution ID.

        • DocumentName — (String)

          The name of the Automation document used during execution.

        • DocumentVersion — (String)

          The document version used during the execution.

        • AutomationExecutionStatus — (String)

          The status of the execution. Valid values include: Running, Succeeded, Failed, Timed out, or Cancelled.

          Possible values include:
          • "Pending"
          • "InProgress"
          • "Success"
          • "TimedOut"
          • "Cancelled"
          • "Failed"
        • ExecutionStartTime — (Date)

          The time the execution started.>

        • ExecutionEndTime — (Date)

          The time the execution finished. This is not populated if the execution is still in progress.

        • ExecutedBy — (String)

          The IAM role ARN of the user who executed the Automation.

        • LogFile — (String)

          An Amazon S3 bucket where execution information is stored.

        • Outputs — (map<Array<String>>)

          The list of execution outputs as defined in the Automation document.

      • NextToken — (String)

        The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Returns:

  • (AWS.Request)

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

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

Lists all patches that could possibly be included in a patch baseline.

Service Reference:

Examples:

Calling the describeAvailablePatches operation

var params = {
  Filters: [
    {
      Key: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
ssm.describeAvailablePatches(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: {})
    • Filters — (Array<map>)

      Filters used to scope down the returned patches.

      • Key — (String)

        The key for the filter.

      • Values — (Array<String>)

        The value for the filter.

    • MaxResults — (Integer)

      The maximum number of patches to return (per page).

    • NextToken — (String)

      The token for the next set of items to return. (You received this token from a previous call.)

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:

      • Patches — (Array<map>)

        An array of patches. Each entry in the array is a patch structure.

        • Id — (String)

          The ID of the patch (this is different than the Microsoft Knowledge Base ID).

        • ReleaseDate — (Date)

          The date the patch was released.

        • Title — (String)

          The title of the patch.

        • Description — (String)

          The description of the patch.

        • ContentUrl — (String)

          The URL where more information can be obtained about the patch.

        • Vendor — (String)

          The name of the vendor providing the patch.

        • ProductFamily — (String)

          The product family the patch is applicable for (for example, Windows).

        • Product — (String)

          The specific product the patch is applicable for (for example, WindowsServer2016).

        • Classification — (String)

          The classification of the patch (for example, SecurityUpdates, Updates, CriticalUpdates).

        • MsrcSeverity — (String)

          The severity of the patch (for example Critical, Important, Moderate).

        • KbNumber — (String)

          The Microsoft Knowledge Base ID of the patch.

        • MsrcNumber — (String)

          The ID of the MSRC bulletin the patch is related to.

        • Language — (String)

          The language of the patch if it's language-specific.

      • NextToken — (String)

        The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Returns:

  • (AWS.Request)

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

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

Describes the specified SSM document.

Service Reference:

Examples:

Calling the describeDocument operation

var params = {
  Name: 'STRING_VALUE', /* required */
  DocumentVersion: 'STRING_VALUE'
};
ssm.describeDocument(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)

      The name of the SSM document.

    • DocumentVersion — (String)

      The document version for which you want information. Can be a specific version or the default 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:

      • Document — (map)

        Information about the SSM document.

        • Sha1 — (String)

          The SHA1 hash of the document, which you can use for verification purposes.

        • Hash — (String)

          The Sha256 or Sha1 hash created by the system when the document was created.

          Note: Sha1 hashes have been deprecated.
        • HashType — (String)

          Sha256 or Sha1.

          Note: Sha1 hashes have been deprecated.
          Possible values include:
          • "Sha256"
          • "Sha1"
        • Name — (String)

          The name of the SSM document.

        • Owner — (String)

          The AWS user account of the person who created the document.

        • CreatedDate — (Date)

          The date when the document was created.

        • Status — (String)

          The status of the SSM document.

          Possible values include:
          • "Creating"
          • "Active"
          • "Updating"
          • "Deleting"
        • DocumentVersion — (String)

          The document version.

        • Description — (String)

          A description of the document.

        • Parameters — (Array<map>)

          A description of the parameters for a document.

          • Name — (String)

            The name of the parameter.

          • Type — (String)

            The type of parameter. The type can be either String or StringList.

            Possible values include:
            • "String"
            • "StringList"
          • Description — (String)

            A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.

          • DefaultValue — (String)

            If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.

        • PlatformTypes — (Array<String>)

          The list of OS platforms compatible with this SSM document.

        • DocumentType — (String)

          The type of document.

          Possible values include:
          • "Command"
          • "Policy"
          • "Automation"
        • SchemaVersion — (String)

          The schema version.

        • LatestVersion — (String)

          The latest version of the document.

        • DefaultVersion — (String)

          The default version.

Returns:

  • (AWS.Request)

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

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

Describes the permissions for a Systems Manager document. If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's AWS account ID) or publicly (All).

Service Reference:

Examples:

Calling the describeDocumentPermission operation

var params = {
  Name: 'STRING_VALUE', /* required */
  PermissionType: Share /* required */
};
ssm.describeDocumentPermission(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)

      The name of the document for which you are the owner.

    • PermissionType — (String)

      The permission type for the document. The permission type can be Share.

      Possible values include:
      • "Share"

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:

      • AccountIds — (Array<String>)

        The account IDs that have permission to use this document. The ID can be either an AWS account or All.

Returns:

  • (AWS.Request)

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

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

All associations for the instance(s).

Examples:

Calling the describeEffectiveInstanceAssociations operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
ssm.describeEffectiveInstanceAssociations(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: {})
    • InstanceId — (String)

      The instance ID for which you want to view all associations.

    • MaxResults — (Integer)

      The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    • NextToken — (String)

      The token for the next set of items to return. (You received this token from a previous call.)

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:

      • Associations — (Array<map>)

        The associations for the requested instance.

        • AssociationId — (String)

          The association ID.

        • InstanceId — (String)

          The instance ID.

        • Content — (String)

          The content of the association document for the instance(s).

      • NextToken — (String)

        The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Returns:

  • (AWS.Request)

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

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

Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline.

Examples:

Calling the describeEffectivePatchesForPatchBaseline operation

var params = {
  BaselineId: 'STRING_VALUE', /* required */
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
ssm.describeEffectivePatchesForPatchBaseline(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: {})
    • BaselineId — (String)

      The ID of the patch baseline to retrieve the effective patches for.

    • MaxResults — (Integer)

      The maximum number of patches to return (per page).

    • NextToken — (String)

      The token for the next set of items to return. (You received this token from a previous call.)

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:

      • EffectivePatches — (Array<map>)

        An array of patches and patch status.

        • Patch — (map)

          Provides metadata for a patch, including information such as the KB ID, severity, classification and a URL for where more information can be obtained about the patch.

          • Id — (String)

            The ID of the patch (this is different than the Microsoft Knowledge Base ID).

          • ReleaseDate — (Date)

            The date the patch was released.

          • Title — (String)

            The title of the patch.

          • Description — (String)

            The description of the patch.

          • ContentUrl — (String)

            The URL where more information can be obtained about the patch.

          • Vendor — (String)

            The name of the vendor providing the patch.

          • ProductFamily — (String)

            The product family the patch is applicable for (for example, Windows).

          • Product — (String)

            The specific product the patch is applicable for (for example, WindowsServer2016).

          • Classification — (String)

            The classification of the patch (for example, SecurityUpdates, Updates, CriticalUpdates).

          • MsrcSeverity — (String)

            The severity of the patch (for example Critical, Important, Moderate).

          • KbNumber — (String)

            The Microsoft Knowledge Base ID of the patch.

          • MsrcNumber — (String)

            The ID of the MSRC bulletin the patch is related to.

          • Language — (String)

            The language of the patch if it's language-specific.

        • PatchStatus — (map)

          The status of the patch in a patch baseline. This includes information about whether the patch is currently approved, due to be approved by a rule, explicitly approved, or explicitly rejected and the date the patch was or will be approved.

          • DeploymentStatus — (String)

            The approval status of a patch (APPROVED, PENDING_APPROVAL, EXPLICIT_APPROVED, EXPLICIT_REJECTED).

            Possible values include:
            • "APPROVED"
            • "PENDING_APPROVAL"
            • "EXPLICIT_APPROVED"
            • "EXPLICIT_REJECTED"
          • ApprovalDate — (Date)

            The date the patch was approved (or will be approved if the status is PENDING_APPROVAL).

      • NextToken — (String)

        The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Returns:

  • (AWS.Request)

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

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

The status of the associations for the instance(s).

Examples:

Calling the describeInstanceAssociationsStatus operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
ssm.describeInstanceAssociationsStatus(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: {})
    • InstanceId — (String)

      The instance IDs for which you want association status information.

    • MaxResults — (Integer)

      The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    • NextToken — (String)

      The token for the next set of items to return. (You received this token from a previous call.)

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:

      • InstanceAssociationStatusInfos — (Array<map>)

        Status information about the association.

        • AssociationId — (String)

          The association ID.

        • Name — (String)

          The name of the association.

        • DocumentVersion — (String)

          The association document verions.

        • InstanceId — (String)

          The instance ID where the association was created.

        • ExecutionDate — (Date)

          The date the instance association executed.

        • Status — (String)

          Status information about the instance association.

        • DetailedStatus — (String)

          Detailed status information about the instance association.

        • ExecutionSummary — (String)

          Summary information about association execution.

        • ErrorCode — (String)

          An error code returned by the request to create the association.

        • OutputUrl — (map)

          A URL for an Amazon S3 bucket where you want to store the results of this request.

          • S3OutputUrl — (map)

            The URL of Amazon S3 bucket where you want to store the results of this request.

            • OutputUrl — (String)

              A URL for an Amazon S3 bucket where you want to store the results of this request.

      • NextToken — (String)

        The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Returns:

  • (AWS.Request)

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

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

Describes one or more of your instances. You can use this to get information about instances like the operating system platform, the SSM Agent version (Linux), status etc. If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error.

Service Reference:

Examples:

Calling the describeInstanceInformation operation

var params = {
  Filters: [
    {
      Key: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  InstanceInformationFilterList: [
    {
      key: InstanceIds | AgentVersion | PingStatus | PlatformTypes | ActivationIds | IamRole | ResourceType | AssociationStatus, /* required */
      valueSet: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
ssm.describeInstanceInformation(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: {})
    • InstanceInformationFilterList — (Array<map>)

      One or more filters. Use a filter to return a more specific list of instances.

      • keyrequired — (String)

        The name of the filter.

        Possible values include:
        • "InstanceIds"
        • "AgentVersion"
        • "PingStatus"
        • "PlatformTypes"
        • "ActivationIds"
        • "IamRole"
        • "ResourceType"
        • "AssociationStatus"
      • valueSetrequired — (Array<String>)

        The filter values.

    • Filters — (Array<map>)

      One or more filters. Use a filter to return a more specific list of instances.

      • Keyrequired — (String)

        The filter key name to describe your instances. For example:

        "InstanceIds"|"AgentVersion"|"PingStatus"|"PlatformTypes"|"ActivationIds"|"IamRole"|"ResourceType"|"AssociationStatus"|"Tag Key"

      • Valuesrequired — (Array<String>)

        The filter values.

    • MaxResults — (Integer)

      The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    • NextToken — (String)

      The token for the next set of items to return. (You received this token from a previous call.)

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:

      • InstanceInformationList — (Array<map>)

        The instance information list.

        • InstanceId — (String)

          The instance ID.

        • PingStatus — (String)

          Connection status of the SSM Agent.

          Possible values include:
          • "Online"
          • "ConnectionLost"
          • "Inactive"
        • LastPingDateTime — (Date)

          The date and time when agent last pinged Systems Manager service.

        • AgentVersion — (String)

          The version of the SSM Agent running on your Linux instance.

        • IsLatestVersion — (Boolean)

          Indicates whether latest version of the SSM Agent is running on your instance.

        • PlatformType — (String)

          The operating system platform type.

          Possible values include:
          • "Windows"
          • "Linux"
        • PlatformName — (String)

          The name of the operating system platform running on your instance.

        • PlatformVersion — (String)

          The version of the OS platform running on your instance.

        • ActivationId — (String)

          The activation ID created by Systems Manager when the server or VM was registered.

        • IamRole — (String)

          The Amazon Identity and Access Management (IAM) role assigned to EC2 instances or managed instances.

        • RegistrationDate — (Date)

          The date the server or VM was registered with AWS as a managed instance.

        • ResourceType — (String)

          The type of instance. Instances are either EC2 instances or managed instances.

          Possible values include:
          • "ManagedInstance"
          • "Document"
          • "EC2Instance"
        • Name — (String)

          The name of the managed instance.

        • IPAddress — (String)

          The IP address of the managed instance.

        • ComputerName — (String)

          The fully qualified host name of the managed instance.

        • AssociationStatus — (String)

          The status of the association.

        • LastAssociationExecutionDate — (Date)

          The date the association was last executed.

        • LastSuccessfulAssociationExecutionDate — (Date)

          The last date the association was successfully run.

        • AssociationOverview — (map)

          Information about the association.

          • DetailedStatus — (String)

            Detailed status information about the aggregated associations.

          • InstanceAssociationStatusAggregatedCount — (map<Integer>)

            The number of associations for the instance(s).

      • NextToken — (String)

        The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Returns:

  • (AWS.Request)

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

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

Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.

Service Reference:

Examples:

Calling the describeInstancePatches operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  Filters: [
    {
      Key: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
ssm.describeInstancePatches(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: {})
    • InstanceId — (String)

      The ID of the instance whose patch state information should be retrieved.

    • Filters — (Array<map>)

      Each entry in the array is a structure containing:

      Key (string, between 1 and 128 characters)

      Values (array of strings, each string between 1 and 256 characters)

      • Key — (String)

        The key for the filter.

      • Values — (Array<String>)

        The value for the filter.

    • NextToken — (String)

      The token for the next set of items to return. (You received this token from a previous call.)

    • MaxResults — (Integer)

      The maximum number of patches to return (per page).

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:

      • Patches — (Array<map>)

        Each entry in the array is a structure containing:

        Title (string)

        KBId (string)

        Classification (string)

        Severity (string)

        State (string: "INSTALLED", "INSTALLED OTHER", "MISSING", "NOT APPLICABLE", "FAILED")

        InstalledTime (DateTime)

        InstalledBy (string)

        • Titlerequired — (String)

          The title of the patch.

        • KBIdrequired — (String)

          The Microsoft Knowledge Base ID of the patch.

        • Classificationrequired — (String)

          The classification of the patch (for example, SecurityUpdates, Updates, CriticalUpdates).

        • Severityrequired — (String)

          The severity of the patch (for example, Critical, Important, Moderate).

        • Staterequired — (String)

          The state of the patch on the instance (INSTALLED, INSTALLED_OTHER, MISSING, NOT_APPLICABLE or FAILED).

          Possible values include:
          • "INSTALLED"
          • "INSTALLED_OTHER"
          • "MISSING"
          • "NOT_APPLICABLE"
          • "FAILED"
        • InstalledTimerequired — (Date)

          The date/time the patch was installed on the instance.

      • NextToken — (String)

        The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Returns:

  • (AWS.Request)

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

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

Retrieves the high-level patch state of one or more instances.

Service Reference:

Examples:

Calling the describeInstancePatchStates operation

var params = {
  InstanceIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
ssm.describeInstancePatchStates(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: {})
    • InstanceIds — (Array<String>)

      The ID of the instance whose patch state information should be retrieved.

    • NextToken — (String)

      The token for the next set of items to return. (You received this token from a previous call.)

    • MaxResults — (Integer)

      The maximum number of instances to return (per page).

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:

      • InstancePatchStates — (Array<map>)

        The high-level patch state for the requested instances.

        • InstanceIdrequired — (String)

          The ID of the managed instance the high-level patch compliance information was collected for.

        • PatchGrouprequired — (String)

          The name of the patch group the managed instance belongs to.

        • BaselineIdrequired — (String)

          The ID of the patch baseline used to patch the instance.

        • SnapshotId — (String)

          The ID of the patch baseline snapshot used during the patching operation when this compliance data was collected.

        • OwnerInformation — (String)

          Placeholder information, this field will always be empty in the current release of the service.

        • InstalledCount — (Integer)

          The number of patches from the patch baseline that are installed on the instance.

        • InstalledOtherCount — (Integer)

          The number of patches not specified in the patch baseline that are installed on the instance.

        • MissingCount — (Integer)

          The number of patches from the patch baseline that are applicable for the instance but aren't currently installed.

        • FailedCount — (Integer)

          The number of patches from the patch baseline that were attempted to be installed during the last patching operation, but failed to install.

        • NotApplicableCount — (Integer)

          The number of patches from the patch baseline that aren't applicable for the instance and hence aren't installed on the instance.

        • OperationStartTimerequired — (Date)

          The time the most recent patching operation was started on the instance.

        • OperationEndTimerequired — (Date)

          The time the most recent patching operation completed on the instance.

        • Operationrequired — (String)

          The type of patching operation that was performed: SCAN (assess patch compliance state) or INSTALL (install missing patches).

          Possible values include:
          • "Scan"
          • "Install"
      • NextToken — (String)

        The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Returns:

  • (AWS.Request)

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

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

Retrieves the high-level patch state for the instances in the specified patch group.

Examples:

Calling the describeInstancePatchStatesForPatchGroup operation

var params = {
  PatchGroup: 'STRING_VALUE', /* required */
  Filters: [
    {
      Key: 'STRING_VALUE', /* required */
      Type: Equal | NotEqual | LessThan | GreaterThan, /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
ssm.describeInstancePatchStatesForPatchGroup(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: {})
    • PatchGroup — (String)

      The name of the patch group for which the patch state information should be retrieved.

    • Filters — (Array<map>)

      Each entry in the array is a structure containing:

      Key (string between 1 and 200 characters)

      Values (array containing a single string)

      Type (string "Equal", "NotEqual", "LessThan", "GreaterThan")

      • Keyrequired — (String)

        The key for the filter. Supported values are FailedCount, InstalledCount, InstalledOtherCount, MissingCount and NotApplicableCount.

      • Valuesrequired — (Array<String>)

        The value for the filter, must be an integer greater than or equal to 0.

      • Typerequired — (String)

        The type of comparison that should be performed for the value: Equal, NotEqual, LessThan or GreaterThan.

        Possible values include:
        • "Equal"
        • "NotEqual"
        • "LessThan"
        • "GreaterThan"
    • NextToken — (String)

      The token for the next set of items to return. (You received this token from a previous call.)

    • MaxResults — (Integer)

      The maximum number of patches to return (per page).

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:

      • InstancePatchStates — (Array<map>)

        The high-level patch state for the requested instances.

        • InstanceIdrequired — (String)

          The ID of the managed instance the high-level patch compliance information was collected for.

        • PatchGrouprequired — (String)

          The name of the patch group the managed instance belongs to.

        • BaselineIdrequired — (String)

          The ID of the patch baseline used to patch the instance.

        • SnapshotId — (String)

          The ID of the patch baseline snapshot used during the patching operation when this compliance data was collected.

        • OwnerInformation — (String)

          Placeholder information, this field will always be empty in the current release of the service.

        • InstalledCount — (Integer)

          The number of patches from the patch baseline that are installed on the instance.

        • InstalledOtherCount — (Integer)

          The number of patches not specified in the patch baseline that are installed on the instance.

        • MissingCount — (Integer)

          The number of patches from the patch baseline that are applicable for the instance but aren't currently installed.

        • FailedCount — (Integer)

          The number of patches from the patch baseline that were attempted to be installed during the last patching operation, but failed to install.

        • NotApplicableCount — (Integer)

          The number of patches from the patch baseline that aren't applicable for the instance and hence aren't installed on the instance.

        • OperationStartTimerequired — (Date)

          The time the most recent patching operation was started on the instance.

        • OperationEndTimerequired — (Date)

          The time the most recent patching operation completed on the instance.

        • Operationrequired — (String)

          The type of patching operation that was performed: SCAN (assess patch compliance state) or INSTALL (install missing patches).

          Possible values include:
          • "Scan"
          • "Install"
      • NextToken — (String)

        The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Returns:

  • (AWS.Request)

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

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

Lists the executions of a Maintenance Window (meaning, information about when the Maintenance Window was scheduled to be active and information about tasks registered and run with the Maintenance Window).

Examples:

Calling the describeMaintenanceWindowExecutions operation

var params = {
  WindowId: 'STRING_VALUE', /* required */
  Filters: [
    {
      Key: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
ssm.describeMaintenanceWindowExecutions(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: {})
    • WindowId — (String)

      The ID of the Maintenance Window whose executions should be retrieved.

    • Filters — (Array<map>)

      Each entry in the array is a structure containing:

      Key (string, between 1 and 128 characters)

      Values (array of strings, each string is between 1 and 256 characters)

      The supported Keys are ExecutedBefore and ExecutedAfter with the value being a date/time string such as 2016-11-04T05:00:00Z.

      • Key — (String)

        The name of the filter.

      • Values — (Array<String>)

        The filter values.

    • MaxResults — (Integer)

      The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    • NextToken — (String)

      The token for the next set of items to return. (You received this token from a previous call.)

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:

      • WindowExecutions — (Array<map>)

        Information about the Maintenance Windows execution.

        • WindowId — (String)

          The ID of the Maintenance Window.

        • WindowExecutionId — (String)

          The ID of the Maintenance Window execution.

        • Status — (String)

          The status of the execution.

          Possible values include:
          • "PENDING"
          • "IN_PROGRESS"
          • "SUCCESS"
          • "FAILED"
          • "TIMED_OUT"
          • "CANCELLING"
          • "CANCELLED"
          • "SKIPPED_OVERLAPPING"
        • StatusDetails — (String)

          The details explaining the Status. Only available for certain status values.

        • StartTime — (Date)

          The time the execution started.

        • EndTime — (Date)

          The time the execution finished.

      • NextToken — (String)

        The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Returns:

  • (AWS.Request)

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

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

Retrieves the individual task executions (one per target) for a particular task executed as part of a Maintenance Window execution.

Examples:

Calling the describeMaintenanceWindowExecutionTaskInvocations operation

var params = {
  TaskId: 'STRING_VALUE', /* required */
  WindowExecutionId: 'STRING_VALUE', /* required */
  Filters: [
    {
      Key: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
ssm.describeMaintenanceWindowExecutionTaskInvocations(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: {})
    • WindowExecutionId — (String)

      The ID of the Maintenance Window execution the task is part of.

    • TaskId — (String)

      The ID of the specific task in the Maintenance Window task that should be retrieved.

    • Filters — (Array<map>)

      Optional filters used to scope down the returned task invocations. The supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED.

      • Key — (String)

        The name of the filter.

      • Values — (Array<String>)

        The filter values.

    • MaxResults — (Integer)

      The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    • NextToken — (String)

      The token for the next set of items to return. (You received this token from a previous call.)

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:

      • WindowExecutionTaskInvocationIdentities — (Array<map>)

        Information about the task invocation results per invocation.

        • WindowExecutionId — (String)

          The ID of the Maintenance Window execution that ran the task.

        • TaskExecutionId — (String)

          The ID of the specific task execution in the Maintenance Window execution.

        • InvocationId — (String)

          The ID of the task invocation.

        • ExecutionId — (String)

          The ID of the action performed in the service that actually handled the task invocation. If the task type is RUN_COMMAND, this value is the command ID.

        • Parameters — (String)

          The parameters that were provided for the invocation when it was executed.

        • Status — (String)

          The status of the task invocation.

          Possible values include:
          • "PENDING"
          • "IN_PROGRESS"
          • "SUCCESS"
          • "FAILED"
          • "TIMED_OUT"
          • "CANCELLING"
          • "CANCELLED"
          • "SKIPPED_OVERLAPPING"
        • StatusDetails — (String)

          The details explaining the status of the task invocation. Only available for certain Status values.

        • StartTime — (Date)

          The time the invocation started.

        • EndTime — (Date)

          The time the invocation finished.

        • OwnerInformation — (String)

          User-provided value that was specified when the target was registered with the Maintenance Window. This was also included in any CloudWatch events raised during the task invocation.

        • WindowTargetId — (String)

          The ID of the target definition in this Maintenance Window the invocation was performed for.

      • NextToken — (String)

        The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Returns:

  • (AWS.Request)

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

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

For a given Maintenance Window execution, lists the tasks that were executed.

Examples:

Calling the describeMaintenanceWindowExecutionTasks operation

var params = {
  WindowExecutionId: 'STRING_VALUE', /* required */
  Filters: [
    {
      Key: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
ssm.describeMaintenanceWindowExecutionTasks(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: {})
    • WindowExecutionId — (String)

      The ID of the Maintenance Window execution whose task executions should be retrieved.

    • Filters — (Array<map>)

      Optional filters used to scope down the returned tasks. The supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED.

      • Key — (String)

        The name of the filter.

      • Values — (Array<String>)

        The filter values.

    • MaxResults — (Integer)

      The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    • NextToken — (String)

      The token for the next set of items to return. (You received this token from a previous call.)

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:

      • WindowExecutionTaskIdentities — (Array<map>)

        Information about the task executions.

        • WindowExecutionId — (String)

          The ID of the Maintenance Window execution that ran the task.

        • TaskExecutionId — (String)

          The ID of the specific task execution in the Maintenance Window execution.

        • Status — (String)

          The status of the task execution.

          Possible values include:
          • "PENDING"
          • "IN_PROGRESS"
          • "SUCCESS"
          • "FAILED"
          • "TIMED_OUT"
          • "CANCELLING"
          • "CANCELLED"
          • "SKIPPED_OVERLAPPING"
        • StatusDetails — (String)

          The details explaining the status of the task execution. Only available for certain status values.

        • StartTime — (Date)

          The time the task execution started.

        • EndTime — (Date)

          The time the task execution finished.

        • TaskArn — (String)

          The ARN of the executed task.

        • TaskType — (String)

          The type of executed task.

          Possible values include:
          • "RUN_COMMAND"
      • NextToken — (String)

        The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Returns:

  • (AWS.Request)

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

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

Retrieves the Maintenance Windows in an AWS account.

Service Reference:

Examples:

Calling the describeMaintenanceWindows operation

var params = {
  Filters: [
    {
      Key: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
ssm.describeMaintenanceWindows(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: {})
    • Filters — (Array<map>)

      Optional filters used to narrow down the scope of the returned Maintenance Windows. Supported filter keys are Name and Enabled.

      • Key — (String)

        The name of the filter.

      • Values — (Array<String>)

        The filter values.

    • MaxResults — (Integer)

      The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    • NextToken — (String)

      The token for the next set of items to return. (You received this token from a previous call.)

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:

      • WindowIdentities — (Array<map>)

        Information about the Maintenance Windows.

        • WindowId — (String)

          The ID of the Maintenance Window.

        • Name — (String)

          The name of the Maintenance Window.

        • Enabled — (Boolean)

          Whether the Maintenance Window is enabled.

        • Duration — (Integer)

          The duration of the Maintenance Window in hours.

        • Cutoff — (Integer)

          The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.

      • NextToken — (String)

        The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Returns:

  • (AWS.Request)

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

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

Lists the targets registered with the Maintenance Window.

Examples:

Calling the describeMaintenanceWindowTargets operation

var params = {
  WindowId: 'STRING_VALUE', /* required */
  Filters: [
    {
      Key: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
ssm.describeMaintenanceWindowTargets(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: {})
    • WindowId — (String)

      The ID of the Maintenance Window whose targets should be retrieved.

    • Filters — (Array<map>)

      Optional filters that can be used to narrow down the scope of the returned window targets. The supported filter keys are Type, WindowTargetId and OwnerInformation.

      • Key — (String)

        The name of the filter.

      • Values — (Array<String>)

        The filter values.

    • MaxResults — (Integer)

      The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    • NextToken — (String)

      The token for the next set of items to return. (You received this token from a previous call.)

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:

      • Targets — (Array<map>)

        Information about the targets in the Maintenance Window.

        • WindowId — (String)

          The Maintenance Window ID where the target is registered.

        • WindowTargetId — (String)

          The ID of the target.

        • ResourceType — (String)

          The type of target.

          Possible values include:
          • "INSTANCE"
        • Targets — (Array<map>)

          The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.

          • Key — (String)

            User-defined criteria for sending commands that target instances that meet the criteria. Key can be tag:<Amazon EC2 tag> or InstanceIds. For more information about how to send commands that target instances using Key,Value parameters, see Executing a Command Using Systems Manager Run Command.

          • Values — (Array<String>)

            User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to execute a command on instances that include Amazon EC2 tags of ServerRole,WebServer. For more information about how to send commands that target instances using Key,Value parameters, see Executing a Command Using Systems Manager Run Command.

        • OwnerInformation — (String)

          User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this Maintenance Window.

      • NextToken — (String)

        The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Returns:

  • (AWS.Request)

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

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

Lists the tasks in a Maintenance Window.

Service Reference:

Examples:

Calling the describeMaintenanceWindowTasks operation

var params = {
  WindowId: 'STRING_VALUE', /* required */
  Filters: [
    {
      Key: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
ssm.describeMaintenanceWindowTasks(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: {})
    • WindowId — (String)

      The ID of the Maintenance Window whose tasks should be retrieved.

    • Filters — (Array<map>)

      Optional filters used to narrow down the scope of the returned tasks. The supported filter keys are WindowTaskId, TaskArn, Priority, and TaskType.

      • Key — (String)

        The name of the filter.

      • Values — (Array<String>)

        The filter values.

    • MaxResults — (Integer)

      The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    • NextToken — (String)

      The token for the next set of items to return. (You received this token from a previous call.)

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:

      • Tasks — (Array<map>)

        Information about the tasks in the Maintenance Window.

        • WindowId — (String)

          The Maintenance Window ID where the task is registered.

        • WindowTaskId — (String)

          The task ID.

        • TaskArn — (String)

          The ARN of the task to execute.

        • Type — (String)

          The type of task.

          Possible values include:
          • "RUN_COMMAND"
        • Targets — (Array<map>)

          The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.

          • Key — (String)

            User-defined criteria for sending commands that target instances that meet the criteria. Key can be tag:<Amazon EC2 tag> or InstanceIds. For more information about how to send commands that target instances using Key,Value parameters, see Executing a Command Using Systems Manager Run Command.

          • Values — (Array<String>)

            User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to execute a command on instances that include Amazon EC2 tags of ServerRole,WebServer. For more information about how to send commands that target instances using Key,Value parameters, see Executing a Command Using Systems Manager Run Command.

        • TaskParameters — (map<map>)

          The parameters that should be passed to the task when it is executed.

          • Values — (Array<String>)

            This field contains an array of 0 or more strings, each 1 to 255 characters in length.

        • Priority — (Integer)

          The priority of the task in the Maintenance Window, the lower the number the higher the priority. Tasks in a Maintenance Window are scheduled in priority order with tasks that have the same priority scheduled in parallel.

        • LoggingInfo — (map)

          Information about an Amazon S3 bucket to write task-level logs to.

          • S3BucketNamerequired — (String)

            The name of an Amazon S3 bucket where execution logs are stored .

          • S3KeyPrefix — (String)

            (Optional) The Amazon S3 bucket subfolder.

          • S3Regionrequired — (String)

            The region where the Amazon S3 bucket is located.

        • ServiceRoleArn — (String)

          The role that should be assumed when executing the task

        • MaxConcurrency — (String)

          The maximum number of targets this task can be run for in parallel.

        • MaxErrors — (String)

          The maximum number of errors allowed before this task stops being scheduled.

      • NextToken — (String)

        The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Returns:

  • (AWS.Request)

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

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

Get information about a parameter.

Service Reference:

Examples:

Calling the describeParameters operation

var params = {
  Filters: [
    {
      Key: Name | Type | KeyId, /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 0,
  NextToken: 'STRING_VALUE',
  ParameterFilters: [
    {
      Key: 'STRING_VALUE', /* required */
      Option: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ]
};
ssm.describeParameters(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: {})
    • Filters — (Array<map>)

      One or more filters. Use a filter to return a more specific list of results.

      • Keyrequired — (String)

        The name of the filter.

        Possible values include:
        • "Name"
        • "Type"
        • "KeyId"
      • Valuesrequired — (Array<String>)

        The filter values.

    • ParameterFilters — (Array<map>)

      Filters to limit the request results.

      • Keyrequired — (String)

        The name of the filter.

      • Option — (String)

        Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.

      • Values — (Array<String>)

        The value you want to search for.

    • MaxResults — (Integer)

      The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    • NextToken — (String)

      The token for the next set of items to return. (You received this token from a previous call.)

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:

      • Parameters — (Array<map>)

        Parameters returned by the request.

        • Name — (String)

          The parameter name.

        • Type — (String)

          The type of parameter. Valid parameter types include the following: String, String list, Secure string.

          Possible values include:
          • "String"
          • "StringList"
          • "SecureString"
        • KeyId — (String)

          The ID of the query key used for this parameter.

        • LastModifiedDate — (Date)

          Date the parameter was last changed or updated.

        • LastModifiedUser — (String)

          Amazon Resource Name (ARN) of the AWS user who last changed the parameter.

        • Description — (String)

          Description of the parameter actions.

        • AllowedPattern — (String)

          A parameter name can include only the following letters and symbols.

          a-zA-Z0-9_.-

      • NextToken — (String)

        The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Returns:

  • (AWS.Request)

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

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

Lists the patch baselines in your AWS account.

Service Reference:

Examples:

Calling the describePatchBaselines operation

var params = {
  Filters: [
    {
      Key: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
ssm.describePatchBaselines(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: {})
    • Filters — (Array<map>)

      Each element in the array is a structure containing:

      Key: (string, "NAME_PREFIX" or "OWNER")

      Value: (array of strings, exactly 1 entry, between 1 and 255 characters)

      • Key — (String)

        The key for the filter.

      • Values — (Array<String>)

        The value for the filter.

    • MaxResults — (Integer)

      The maximum number of patch baselines to return (per page).

    • NextToken — (String)

      The token for the next set of items to return. (You received this token from a previous call.)

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:

      • BaselineIdentities — (Array<map>)

        An array of PatchBaselineIdentity elements.

        • BaselineId — (String)

          The ID of the patch baseline.

        • BaselineName — (String)

          The name of the patch baseline.

        • BaselineDescription — (String)

          The description of the patch baseline.

        • DefaultBaseline — (Boolean)

          Whether this is the default baseline.

      • NextToken — (String)

        The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Returns:

  • (AWS.Request)

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

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

Lists all patch groups that have been registered with patch baselines.

Service Reference:

Examples:

Calling the describePatchGroups operation

var params = {
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
ssm.describePatchGroups(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 — (Integer)

      The maximum number of patch groups to return (per page).

    • NextToken — (String)

      The token for the next set of items to return. (You received this token from a previous call.)

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:

      • Mappings — (Array<map>)

        Each entry in the array contains:

        PatchGroup: string (between 1 and 256 characters, Regex: ^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$)

        PatchBaselineIdentity: A PatchBaselineIdentity element.

        • PatchGroup — (String)

          The name of the patch group registered with the patch baseline.

        • BaselineIdentity — (map)

          The patch baseline the patch group is registered with.

          • BaselineId — (String)

            The ID of the patch baseline.

          • BaselineName — (String)

            The name of the patch baseline.

          • BaselineDescription — (String)

            The description of the patch baseline.

          • DefaultBaseline — (Boolean)

            Whether this is the default baseline.

      • NextToken — (String)

        The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Returns:

  • (AWS.Request)

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

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

Returns high-level aggregated patch compliance state for a patch group.

Service Reference:

Examples:

Calling the describePatchGroupState operation

var params = {
  PatchGroup: 'STRING_VALUE' /* required */
};
ssm.describePatchGroupState(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: {})
    • PatchGroup — (String)

      The name of the patch group whose patch snapshot should be retrieved.

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:

      • Instances — (Integer)

        The number of instances in the patch group.

      • InstancesWithInstalledPatches — (Integer)

        The number of instances with installed patches.

      • InstancesWithInstalledOtherPatches — (Integer)

        The number of instances with patches installed that aren't defined in the patch baseline.

      • InstancesWithMissingPatches — (Integer)

        The number of instances with missing patches from the patch baseline.

      • InstancesWithFailedPatches — (Integer)

        The number of instances with patches from the patch baseline that failed to install.

      • InstancesWithNotApplicablePatches — (Integer)

        The number of instances with patches that aren't applicable.

Returns:

  • (AWS.Request)

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

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

Get detailed information about a particular Automation execution.

Service Reference:

Examples:

Calling the getAutomationExecution operation

var params = {
  AutomationExecutionId: 'STRING_VALUE' /* required */
};
ssm.getAutomationExecution(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: {})
    • AutomationExecutionId — (String)

      The unique identifier for an existing automation execution to examine. The execution ID is returned by StartAutomationExecution when the execution of an Automation document is initiated.

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:

      • AutomationExecution — (map)

        Detailed information about the current state of an automation execution.

        • AutomationExecutionId — (String)

          The execution ID.

        • DocumentName — (String)

          The name of the Automation document used during the execution.

        • DocumentVersion — (String)

          The version of the document to use during execution.

        • ExecutionStartTime — (Date)

          The time the execution started.

        • ExecutionEndTime — (Date)

          The time the execution finished.

        • AutomationExecutionStatus — (String)

          The execution status of the Automation.

          Possible values include:
          • "Pending"
          • "InProgress"
          • "Success"
          • "TimedOut"
          • "Cancelled"
          • "Failed"
        • StepExecutions — (Array<map>)

          A list of details about the current state of all steps that comprise an execution. An Automation document contains a list of steps that are executed in order.

          • StepName — (String)

            The name of this execution step.

          • Action — (String)

            The action this step performs. The action determines the behavior of the step.

          • ExecutionStartTime — (Date)

            If a step has begun execution, this contains the time the step started. If the step is in Pending status, this field is not populated.

          • ExecutionEndTime — (Date)

            If a step has finished execution, this contains the time the execution ended. If the step has not yet concluded, this field is not populated.

          • StepStatus — (String)

            The execution status for this step. Valid values include: Pending, InProgress, Success, Cancelled, Failed, and TimedOut.

            Possible values include:
            • "Pending"
            • "InProgress"
            • "Success"
            • "TimedOut"
            • "Cancelled"
            • "Failed"
          • ResponseCode — (String)

            The response code returned by the execution of the step.

          • Inputs — (map<String>)

            Fully-resolved values passed into the step before execution.

          • Outputs — (map<Array<String>>)

            Returned values from the execution of the step.

          • Response — (String)

            A message associated with the response code for an execution.

          • FailureMessage — (String)

            If a step failed, this message explains why the execution failed.

          • FailureDetails — (map)

            Information about the Automation failure.

            • FailureStage — (String)

              The stage of the Automation execution when the failure occurred. The stages include the following: InputValidation, PreVerification, Invocation, PostVerification.

            • FailureType — (String)

              The type of Automation failure. Failure types include the following: Action, Permission, Throttling, Verification, Internal.

            • Details — (map<Array<String>>)

              Detailed information about the Automation step failure.

        • Parameters — (map<Array<String>>)

          The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.

        • Outputs — (map<Array<String>>)

          The list of execution outputs as defined in the automation document.

        • FailureMessage — (String)

          A message describing why an execution has failed, if the status is set to Failed.

Returns:

  • (AWS.Request)

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

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

Returns detailed information about command execution for an invocation or plugin.

Service Reference:

Examples:

Calling the getCommandInvocation operation

var params = {
  CommandId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  PluginName: 'STRING_VALUE'
};
ssm.getCommandInvocation(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: {})
    • CommandId — (String)

      (Required) The parent command ID of the invocation plugin.

    • InstanceId — (String)

      (Required) The ID of the managed instance targeted by the command. A managed instance can be an Amazon EC2 instance or an instance in your hybrid environment that is configured for Systems Manager.

    • PluginName — (String)

      (Optional) The name of the plugin for which you want detailed results. If the document contains only one plugin, the name can be omitted and the details will be returned.

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:

      • CommandId — (String)

        The parent command ID of the invocation plugin.

      • InstanceId — (String)

        The ID of the managed instance targeted by the command. A managed instance can be an Amazon EC2 instance or an instance in your hybrid environment that is configured for Systems Manager.

      • Comment — (String)

        The comment text for the command.

      • DocumentName — (String)

        The name of the document that was executed. For example, AWS-RunShellScript.

      • PluginName — (String)

        The name of the plugin for which you want detailed results. For example, aws:RunShellScript is a plugin.

      • ResponseCode — (Integer)

        The error level response code for the plugin script. If the response code is -1, then the command has not started executing on the instance, or it was not received by the instance.

      • ExecutionStartDateTime — (String)

        The date and time the plugin started executing. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample AWS CLI command uses the InvokedBefore filter.

        aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z

        If the plugin has not started to execute, the string is empty.

      • ExecutionElapsedTime — (String)

        Duration since ExecutionStartDateTime.

      • ExecutionEndDateTime — (String)

        The date and time the plugin was finished executing. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample AWS CLI command uses the InvokedAfter filter.

        aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z

        If the plugin has not started to execute, the string is empty.

      • Status — (String)

        The status of the parent command for this invocation. This status can be different than StatusDetails.

        Possible values include:
        • "Pending"
        • "InProgress"
        • "Delayed"
        • "Success"
        • "Cancelled"
        • "TimedOut"
        • "Failed"
        • "Cancelling"
      • StatusDetails — (String)

        A detailed status of the command execution for an invocation. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Run Command Status. StatusDetails can be one of the following values:

        • Pending: The command has not been sent to the instance.

        • In Progress: The command has been sent to the instance but has not reached a terminal state.

        • Delayed: The system attempted to send the command to the target, but the target was not available. The instance might not be available because of network issues, the instance was stopped, etc. The system will try to deliver the command again.

        • Success: The command or plugin was executed successfully. This is a terminal state.

        • Delivery Timed Out: The command was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

        • Execution Timed Out: The command started to execute on the instance, but the execution was not complete before the timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.

        • Failed: The command wasn't executed successfully on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.

        • Canceled: The command was terminated before it was completed. This is a terminal state.

        • Undeliverable: The command can't be delivered to the instance. The instance might not exist or might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

        • Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.

      • StandardOutputContent — (String)

        The first 24,000 characters written by the plugin to stdout. If the command has not finished executing, if ExecutionStatus is neither Succeeded nor Failed, then this string is empty.

      • StandardOutputUrl — (String)

        The URL for the complete text written by the plugin to stdout in Amazon S3. If an Amazon S3 bucket was not specified, then this string is empty.

      • StandardErrorContent — (String)

        The first 8,000 characters written by the plugin to stderr. If the command has not finished executing, then this string is empty.

      • StandardErrorUrl — (String)

        The URL for the complete text written by the plugin to stderr. If the command has not finished executing, then this string is empty.

Returns:

  • (AWS.Request)

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

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

Retrieves the default patch baseline.

Service Reference:

Examples:

Calling the getDefaultPatchBaseline operation

var params = {
};
ssm.getDefaultPatchBaseline(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:

      • BaselineId — (String)

        The ID of the default patch baseline.

Returns:

  • (AWS.Request)

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

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

Retrieves the current snapshot for the patch baseline the instance uses. This API is primarily used by the AWS-ApplyPatchBaseline Systems Manager document.

Examples:

Calling the getDeployablePatchSnapshotForInstance operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  SnapshotId: 'STRING_VALUE' /* required */
};
ssm.getDeployablePatchSnapshotForInstance(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: {})
    • InstanceId — (String)

      The ID of the instance for which the appropriate patch snapshot should be retrieved.

    • SnapshotId — (String)

      The user-defined snapshot 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:

      • InstanceId — (String)

        The ID of the instance.

      • SnapshotId — (String)

        The user-defined snapshot ID.

      • SnapshotDownloadUrl — (String)

        A pre-signed Amazon S3 URL that can be used to download the patch snapshot.

Returns:

  • (AWS.Request)

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

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

Gets the contents of the specified SSM document.

Service Reference:

Examples:

Calling the getDocument operation

var params = {
  Name: 'STRING_VALUE', /* required */
  DocumentVersion: 'STRING_VALUE'
};
ssm.getDocument(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)

      The name of the SSM document.

    • DocumentVersion — (String)

      The document version for which you want information.

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:

      • Name — (String)

        The name of the SSM document.

      • DocumentVersion — (String)

        The document version.

      • Content — (String)

        The contents of the SSM document.

      • DocumentType — (String)

        The document type.

        Possible values include:
        • "Command"
        • "Policy"
        • "Automation"

Returns:

  • (AWS.Request)

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

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

Query inventory information.

Service Reference:

Examples:

Calling the getInventory operation

var params = {
  Filters: [
    {
      Key: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      Type: Equal | NotEqual | BeginWith | LessThan | GreaterThan
    },
    /* more items */
  ],
  MaxResults: 0,
  NextToken: 'STRING_VALUE',
  ResultAttributes: [
    {
      TypeName: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
ssm.getInventory(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: {})
    • Filters — (Array<map>)

      One or more filters. Use a filter to return a more specific list of results.

      • Keyrequired — (String)

        The name of the filter key.

      • Valuesrequired — (Array<String>)

        Inventory filter values. Example: inventory filter where instance IDs are specified as values Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g, i-1a2b3c4d5e6,Type=Equal

      • Type — (String)

        The type of filter. Valid values include the following: "Equal"|"NotEqual"|"BeginWith"|"LessThan"|"GreaterThan"

        Possible values include:
        • "Equal"
        • "NotEqual"
        • "BeginWith"
        • "LessThan"
        • "GreaterThan"
    • ResultAttributes — (Array<map>)

      The list of inventory item types to return.

      • TypeNamerequired — (String)

        Name of the inventory item type. Valid value: AWS:InstanceInformation. Default Value: AWS:InstanceInformation.

    • NextToken — (String)

      The token for the next set of items to return. (You received this token from a previous call.)

    • MaxResults — (Integer)

      The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

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:

      • Entities — (Array<map>)

        Collection of inventory entities such as a collection of instance inventory.

        • Id — (String)

          ID of the inventory result entity. For example, for managed instance inventory the result will be the managed instance ID. For EC2 instance inventory, the result will be the instance ID.

        • Data — (map<map>)

          The data section in the inventory result entity json.

          • TypeNamerequired — (String)

            The name of the inventory result item type.

          • SchemaVersionrequired — (String)

            The schema version for the inventory result item/

          • CaptureTime — (String)

            The time inventory item data was captured.

          • ContentHash — (String)

            MD5 hash of the inventory item type contents. The content hash is used to determine whether to update inventory information. The PutInventory API does not update the inventory item type contents if the MD5 hash has not changed since last update.

          • Contentrequired — (Array<map<String>>)

            Contains all the inventory data of the item type. Results include attribute names and values.

      • NextToken — (String)

        The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Returns:

  • (AWS.Request)

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

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

Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.

Service Reference:

Examples:

Calling the getInventorySchema operation

var params = {
  MaxResults: 0,
  NextToken: 'STRING_VALUE',
  TypeName: 'STRING_VALUE'
};
ssm.getInventorySchema(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: {})
    • TypeName — (String)

      The type of inventory item to return.

    • NextToken — (String)

      The token for the next set of items to return. (You received this token from a previous call.)

    • MaxResults — (Integer)

      The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

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:

      • Schemas — (Array<map>)

        Inventory schemas returned by the request.

        • TypeNamerequired — (String)

          The name of the inventory type. Default inventory item type names start with AWS. Custom inventory type names will start with Custom. Default inventory item types include the following: AWS:AWSComponent, AWS:Application, AWS:InstanceInformation, AWS:Network, and AWS:WindowsUpdate.

        • Version — (String)

          The schema version for the inventory item.

        • Attributesrequired — (Array<map>)

          The schema attributes for inventory. This contains data type and attribute name.

          • Namerequired — (String)

            Name of the inventory item attribute.

          • DataTyperequired — (String)

            The data type of the inventory item attribute.

            Possible values include:
            • "string"
            • "number"
      • NextToken — (String)

        The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Returns:

  • (AWS.Request)

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

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

Retrieves a Maintenance Window.

Service Reference:

Examples:

Calling the getMaintenanceWindow operation

var params = {
  WindowId: 'STRING_VALUE' /* required */
};
ssm.getMaintenanceWindow(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: {})
    • WindowId — (String)

      The ID of the desired Maintenance Window.

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:

      • WindowId — (String)

        The ID of the created Maintenance Window.

      • Name — (String)

        The name of the Maintenance Window.

      • Schedule — (String)

        The schedule of the Maintenance Window in the form of a cron or rate expression.

      • Duration — (Integer)

        The duration of the Maintenance Window in hours.

      • Cutoff — (Integer)

        The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.

      • AllowUnassociatedTargets — (Boolean)

        Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets.

      • Enabled — (Boolean)

        Whether the Maintenance Windows is enabled.

      • CreatedDate — (Date)

        The date the Maintenance Window was created.

      • ModifiedDate — (Date)

        The date the Maintenance Window was last modified.

Returns:

  • (AWS.Request)

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

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

Retrieves details about a specific task executed as part of a Maintenance Window execution.

Service Reference:

Examples:

Calling the getMaintenanceWindowExecution operation

var params = {
  WindowExecutionId: 'STRING_VALUE' /* required */
};
ssm.getMaintenanceWindowExecution(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: {})
    • WindowExecutionId — (String)

      The ID of the Maintenance Window execution that includes the task.

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:

      • WindowExecutionId — (String)

        The ID of the Maintenance Window execution.

      • TaskIds — (Array<String>)

        The ID of the task executions from the Maintenance Window execution.

      • Status — (String)

        The status of the Maintenance Window execution.

        Possible values include:
        • "PENDING"
        • "IN_PROGRESS"
        • "SUCCESS"
        • "FAILED"
        • "TIMED_OUT"
        • "CANCELLING"
        • "CANCELLED"
        • "SKIPPED_OVERLAPPING"
      • StatusDetails — (String)

        The details explaining the Status. Only available for certain status values.

      • StartTime — (Date)

        The time the Maintenance Window started executing.

      • EndTime — (Date)

        The time the Maintenance Window finished executing.

Returns:

  • (AWS.Request)

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

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

Retrieves the details about a specific task executed as part of a Maintenance Window execution.

Examples:

Calling the getMaintenanceWindowExecutionTask operation

var params = {
  TaskId: 'STRING_VALUE', /* required */
  WindowExecutionId: 'STRING_VALUE' /* required */
};
ssm.getMaintenanceWindowExecutionTask(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: {})
    • WindowExecutionId — (String)

      The ID of the Maintenance Window execution that includes the task.

    • TaskId — (String)

      The ID of the specific task execution in the Maintenance Window task that should be retrieved.

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:

      • WindowExecutionId — (String)

        The ID of the Maintenance Window execution that includes the task.

      • TaskExecutionId — (String)

        The ID of the specific task execution in the Maintenance Window task that was retrieved.

      • TaskArn — (String)

        The ARN of the executed task.

      • ServiceRole — (String)

        The role that was assumed when executing the task.

      • Type — (String)

        The type of task executed.

        Possible values include:
        • "RUN_COMMAND"
      • TaskParameters — (Array<map<map>>)

        The parameters passed to the task when it was executed. The map has the following format:

        Key: string, between 1 and 255 characters

        Value: an array of strings, each string is between 1 and 255 characters

        • Values — (Array<String>)

          This field contains an array of 0 or more strings, each 1 to 255 characters in length.

      • Priority — (Integer)

        The priority of the task.

      • MaxConcurrency — (String)

        The defined maximum number of task executions that could be run in parallel.

      • MaxErrors — (String)

        The defined maximum number of task execution errors allowed before scheduling of the task execution would have been stopped.

      • Status — (String)

        The status of the task.

        Possible values include:
        • "PENDING"
        • "IN_PROGRESS"
        • "SUCCESS"
        • "FAILED"
        • "TIMED_OUT"
        • "CANCELLING"
        • "CANCELLED"
        • "SKIPPED_OVERLAPPING"
      • StatusDetails — (String)

        The details explaining the Status. Only available for certain status values.

      • StartTime — (Date)

        The time the task execution started.

      • EndTime — (Date)

        The time the task execution completed.

Returns:

  • (AWS.Request)

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

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

Get information about a parameter by using the parameter name.

Service Reference:

Examples:

Calling the getParameter operation

var params = {
  Name: 'STRING_VALUE', /* required */
  WithDecryption: true || false
};
ssm.getParameter(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)

      The name of the parameter you want to query.

    • WithDecryption — (Boolean)

      Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.

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:

      • Parameter — (map)

        Information about a parameter.

        • Name — (String)

          The name of the parameter.

        • Type — (String)

          The type of parameter. Valid values include the following: String, String list, Secure string.

          Possible values include:
          • "String"
          • "StringList"
          • "SecureString"
        • Value — (String)

          The parameter value.

Returns:

  • (AWS.Request)

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

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

Query a list of all parameters used by the AWS account.

Service Reference:

Examples:

Calling the getParameterHistory operation

var params = {
  Name: 'STRING_VALUE', /* required */
  MaxResults: 0,
  NextToken: 'STRING_VALUE',
  WithDecryption: true || false
};
ssm.getParameterHistory(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)

      The name of a parameter you want to query.

    • WithDecryption — (Boolean)

      Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.

    • MaxResults — (Integer)

      The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    • NextToken — (String)

      The token for the next set of items to return. (You received this token from a previous call.)

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:

      • Parameters — (Array<map>)

        A list of parameters returned by the request.

        • Name — (String)

          The name of the parameter.

        • Type — (String)

          The type of parameter used.

          Possible values include:
          • "String"
          • "StringList"
          • "SecureString"
        • KeyId — (String)

          The ID of the query key used for this parameter.

        • LastModifiedDate — (Date)

          Date the parameter was last changed or updated.

        • LastModifiedUser — (String)

          Amazon Resource Name (ARN) of the AWS user who last changed the parameter.

        • Description — (String)

          Information about the parameter.

        • Value — (String)

          The parameter value.

        • AllowedPattern — (String)

          Parameter names can include the following letters and symbols.

          a-zA-Z0-9_.-

      • NextToken — (String)

        The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Returns:

  • (AWS.Request)

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

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

Get details of a parameter.

Service Reference:

Examples:

Calling the getParameters operation

var params = {
  Names: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  WithDecryption: true || false
};
ssm.getParameters(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: {})
    • Names — (Array<String>)

      Names of the parameters for which you want to query information.

    • WithDecryption — (Boolean)

      Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.

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:

      • Parameters — (Array<map>)

        A list of details for a parameter.

        • Name — (String)

          The name of the parameter.

        • Type — (String)

          The type of parameter. Valid values include the following: String, String list, Secure string.

          Possible values include:
          • "String"
          • "StringList"
          • "SecureString"
        • Value — (String)

          The parameter value.

      • InvalidParameters — (Array<String>)

        A list of parameters that are not formatted correctly or do not run when executed.

Returns:

  • (AWS.Request)

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

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

Retrieve parameters in a specific hierarchy. For more information, see Using Parameter Hierarchies.

Service Reference:

Examples:

Calling the getParametersByPath operation

var params = {
  Path: 'STRING_VALUE', /* required */
  MaxResults: 0,
  NextToken: 'STRING_VALUE',
  ParameterFilters: [
    {
      Key: 'STRING_VALUE', /* required */
      Option: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Recursive: true || false,
  WithDecryption: true || false
};
ssm.getParametersByPath(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: {})
    • Path — (String)

      The hierarchy for the parameter. Hierarchies start with a forward slash (/) and end with the parameter name. A hierarchy can have a maximum of five levels. Examples: /Environment/Test/DBString003

      /Finance/Prod/IAD/OS/WinServ2016/license15

    • Recursive — (Boolean)

      Retrieve all parameters within a hierarchy.

    • ParameterFilters — (Array<map>)

      Filters to limit the request results.

      • Keyrequired — (String)

        The name of the filter.

      • Option — (String)

        Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.

      • Values — (Array<String>)

        The value you want to search for.

    • WithDecryption — (Boolean)

      Retrieve all parameters in a hierarchy with their value decrypted.

    • MaxResults — (Integer)

      The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    • NextToken — (String)

      A token to start the list. Use this token to get the next set of results.

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:

      • Parameters — (Array<map>)

        A list of parameters found in the specified hierarchy.

        • Name — (String)

          The name of the parameter.

        • Type — (String)

          The type of parameter. Valid values include the following: String, String list, Secure string.

          Possible values include:
          • "String"
          • "StringList"
          • "SecureString"
        • Value — (String)

          The parameter value.

      • NextToken — (String)

        The token for the next set of items to return. Use this token to get the next set of results.

Returns:

  • (AWS.Request)

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

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

Retrieves information about a patch baseline.

Service Reference:

Examples:

Calling the getPatchBaseline operation

var params = {
  BaselineId: 'STRING_VALUE' /* required */
};
ssm.getPatchBaseline(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: {})
    • BaselineId — (String)

      The ID of the patch baseline to retrieve.

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:

      • BaselineId — (String)

        The ID of the retrieved patch baseline.

      • Name — (String)

        The name of the patch baseline.

      • GlobalFilters — (map)

        A set of global filters used to exclude patches from the baseline.

        • PatchFiltersrequired — (Array<map>)

          The set of patch filters that make up the group.

          • Keyrequired — (String)

            The key for the filter (PRODUCT, CLASSIFICATION, MSRC_SEVERITY, PATCH_ID)

            Possible values include:
            • "PRODUCT"
            • "CLASSIFICATION"
            • "MSRC_SEVERITY"
            • "PATCH_ID"
          • Valuesrequired — (Array<String>)

            The value for the filter key.

      • ApprovalRules — (map)

        A set of rules used to include patches in the baseline.

        • PatchRulesrequired — (Array<map>)

          The rules that make up the rule group.

          • PatchFilterGrouprequired — (map)

            The patch filter group that defines the criteria for the rule.

            • PatchFiltersrequired — (Array<map>)

              The set of patch filters that make up the group.

              • Keyrequired — (String)

                The key for the filter (PRODUCT, CLASSIFICATION, MSRC_SEVERITY, PATCH_ID)

                Possible values include:
                • "PRODUCT"
                • "CLASSIFICATION"
                • "MSRC_SEVERITY"
                • "PATCH_ID"
              • Valuesrequired — (Array<String>)

                The value for the filter key.

          • ApproveAfterDaysrequired — (Integer)

            The number of days after the release date of each patch matched by the rule the patch is marked as approved in the patch baseline.

      • ApprovedPatches — (Array<String>)

        A list of explicitly approved patches for the baseline.

      • RejectedPatches — (Array<String>)

        A list of explicitly rejected patches for the baseline.

      • PatchGroups — (Array<String>)

        Patch groups included in the patch baseline.

      • CreatedDate — (Date)

        The date the patch baseline was created.

      • ModifiedDate — (Date)

        The date the patch baseline was last modified.

      • Description — (String)

        A description of the patch baseline.

Returns:

  • (AWS.Request)

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

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

Retrieves the patch baseline that should be used for the specified patch group.

Service Reference:

Examples:

Calling the getPatchBaselineForPatchGroup operation

var params = {
  PatchGroup: 'STRING_VALUE' /* required */
};
ssm.getPatchBaselineForPatchGroup(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: {})
    • PatchGroup — (String)

      The name of the patch group whose patch baseline should be retrieved.

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:

      • BaselineId — (String)

        The ID of the patch baseline that should be used for the patch group.

      • PatchGroup — (String)

        The name of the patch group.

Returns:

  • (AWS.Request)

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

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

Lists the associations for the specified Systems Manager document or instance.

Service Reference:

Examples:

Calling the listAssociations operation

var params = {
  AssociationFilterList: [
    {
      key: InstanceId | Name | AssociationId | AssociationStatusName | LastExecutedBefore | LastExecutedAfter, /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
ssm.listAssociations(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: {})
    • AssociationFilterList — (Array<map>)

      One or more filters. Use a filter to return a more specific list of results.

      • keyrequired — (String)

        The name of the filter.

        Possible values include:
        • "InstanceId"
        • "Name"
        • "AssociationId"
        • "AssociationStatusName"
        • "LastExecutedBefore"
        • "LastExecutedAfter"
      • valuerequired — (String)

        The filter value.

    • MaxResults — (Integer)

      The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    • NextToken — (String)

      The token for the next set of items to return. (You received this token from a previous call.)

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:

      • Associations — (Array<map>)

        The associations.

        • Name — (String)

          The name of the SSM document.

        • InstanceId — (String)

          The ID of the instance.

        • AssociationId — (String)

          The ID created by the system when you create an association. An association is a binding between a document and a set of targets with a schedule.

        • DocumentVersion — (String)

          The version of the document used in the association.

        • Targets — (Array<map>)

          The instances targeted by the request to create an association.

          • Key — (String)

            User-defined criteria for sending commands that target instances that meet the criteria. Key can be tag:<Amazon EC2 tag> or InstanceIds. For more information about how to send commands that target instances using Key,Value parameters, see Executing a Command Using Systems Manager Run Command.

          • Values — (Array<String>)

            User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to execute a command on instances that include Amazon EC2 tags of ServerRole,WebServer. For more information about how to send commands that target instances using Key,Value parameters, see Executing a Command Using Systems Manager Run Command.

        • LastExecutionDate — (Date)

          The date on which the association was last run.

        • Overview — (map)

          Information about the association.

          • Status — (String)

            The status of the association. Status can be: Pending, Success, or Failed.

          • DetailedStatus — (String)

            A detailed status of the association.

          • AssociationStatusAggregatedCount — (map<Integer>)

            Returns the number of targets for the association status. For example, if you created an association with two instances, and one of them was successful, this would return the count of instances by status.

        • ScheduleExpression — (String)

          A cron expression that specifies a schedule when the association runs.

      • NextToken — (String)

        The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Returns:

  • (AWS.Request)

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

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

An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user executes SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.

Service Reference:

Examples:

Calling the listCommandInvocations operation

var params = {
  CommandId: 'STRING_VALUE',
  Details: true || false,
  Filters: [
    {
      key: InvokedAfter | InvokedBefore | Status, /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  InstanceId: 'STRING_VALUE',
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
ssm.listCommandInvocations(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: {})
    • CommandId — (String)

      (Optional) The invocations for a specific command ID.

    • InstanceId — (String)

      (Optional) The command execution details for a specific instance ID.

    • MaxResults — (Integer)

      (Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    • NextToken — (String)

      (Optional) The token for the next set of items to return. (You received this token from a previous call.)

    • Filters — (Array<map>)

      (Optional) One or more filters. Use a filter to return a more specific list of results.

      • keyrequired — (String)

        The name of the filter.

        Possible values include:
        • "InvokedAfter"
        • "InvokedBefore"
        • "Status"
      • valuerequired — (String)

        The filter value.

    • Details — (Boolean)

      (Optional) If set this returns the response of the command executions and any command output. By default this is set to False.

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:

      • CommandInvocations — (Array<map>)

        (Optional) A list of all invocations.

        • CommandId — (String)

          The command against which this invocation was requested.

        • InstanceId — (String)

          The instance ID in which this invocation was requested.

        • InstanceName — (String)

          The name of the invocation target. For Amazon EC2 instances this is the value for the aws:Name tag. For on-premises instances, this is the name of the instance.

        • Comment — (String)

          User-specified information about the command, such as a brief description of what the command should do.

        • DocumentName — (String)

          The document name that was requested for execution.

        • RequestedDateTime — (Date)

          The time and date the request was sent to this instance.

        • Status — (String)

          Whether or not the invocation succeeded, failed, or is pending.

          Possible values include:
          • "Pending"
          • "InProgress"
          • "Delayed"
          • "Success"
          • "Cancelled"
          • "TimedOut"
          • "Failed"
          • "Cancelling"
        • StatusDetails — (String)

          A detailed status of the command execution for each invocation (each instance targeted by the command). StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Run Command Status. StatusDetails can be one of the following values:

          • Pending: The command has not been sent to the instance.

          • In Progress: The command has been sent to the instance but has not reached a terminal state.

          • Success: The execution of the command or plugin was successfully completed. This is a terminal state.

          • Delivery Timed Out: The command was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

          • Execution Timed Out: Command execution started on the instance, but the execution was not complete before the execution timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.

          • Failed: The command was not successful on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.

          • Canceled: The command was terminated before it was completed. This is a terminal state.

          • Undeliverable: The command can't be delivered to the instance. The instance might not exist or might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

          • Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.

        • TraceOutput — (String)

          Gets the trace output sent by the agent.

        • StandardOutputUrl — (String)

          The URL to the plugin's StdOut file in Amazon S3, if the Amazon S3 bucket was defined for the parent command. For an invocation, StandardOutputUrl is populated if there is just one plugin defined for the command, and the Amazon S3 bucket was defined for the command.

        • StandardErrorUrl — (String)

          The URL to the plugin's StdErr file in Amazon S3, if the Amazon S3 bucket was defined for the parent command. For an invocation, StandardErrorUrl is populated if there is just one plugin defined for the command, and the Amazon S3 bucket was defined for the command.

        • CommandPlugins — (Array<map>)
          • Name — (String)

            The name of the plugin. Must be one of the following: aws:updateAgent, aws:domainjoin, aws:applications, aws:runPowerShellScript, aws:psmodule, aws:cloudWatch, aws:runShellScript, or aws:updateSSMAgent.

          • Status — (String)

            The status of this plugin. You can execute a document with multiple plugins.

            Possible values include:
            • "Pending"
            • "InProgress"
            • "Success"
            • "TimedOut"
            • "Cancelled"
            • "Failed"
          • StatusDetails — (String)

            A detailed status of the plugin execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Run Command Status. StatusDetails can be one of the following values:

            • Pending: The command has not been sent to the instance.

            • In Progress: The command has been sent to the instance but has not reached a terminal state.

            • Success: The execution of the command or plugin was successfully completed. This is a terminal state.

            • Delivery Timed Out: The command was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

            • Execution Timed Out: Command execution started on the instance, but the execution was not complete before the execution timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.

            • Failed: The command was not successful on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.

            • Canceled: The command was terminated before it was completed. This is a terminal state.

            • Undeliverable: The command can't be delivered to the instance. The instance might not exist, or it might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit, and they don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

            • Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.

          • ResponseCode — (Integer)

            A numeric response code generated after executing the plugin.

          • ResponseStartDateTime — (Date)

            The time the plugin started executing.

          • ResponseFinishDateTime — (Date)

            The time the plugin stopped executing. Could stop prematurely if, for example, a cancel command was sent.

          • Output — (String)

            Output of the plugin execution.

          • StandardOutputUrl — (String)

            The URL for the complete text written by the plugin to stdout in Amazon S3. If the Amazon S3 bucket for the command was not specified, then this string is empty.

          • StandardErrorUrl — (String)

            The URL for the complete text written by the plugin to stderr. If execution is not yet complete, then this string is empty.

          • OutputS3Region — (String)

            (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.

          • OutputS3BucketName — (String)

            The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command. For example, in the following response:

            test_folder/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-1234567876543/awsrunShellScript

            test_folder is the name of the Amazon S3 bucket;

            ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;

            i-1234567876543 is the instance ID;

            awsrunShellScript is the name of the plugin.

          • OutputS3KeyPrefix — (String)

            The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command. For example, in the following response:

            test_folder/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-1234567876543/awsrunShellScript

            test_folder is the name of the Amazon S3 bucket;

            ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;

            i-1234567876543 is the instance ID;

            awsrunShellScript is the name of the plugin.

        • ServiceRole — (String)

          The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes on a per instance basis.

        • NotificationConfig — (map)

          Configurations for sending notifications about command status changes on a per instance basis.

          • NotificationArn — (String)

            An Amazon Resource Name (ARN) for a Simple Notification Service (SNS) topic. Run Command pushes notifications about command status changes to this topic.

          • NotificationEvents — (Array<String>)

            The different events for which you can receive notifications. These events include the following: All (events), InProgress, Success, TimedOut, Cancelled, Failed. To learn more about these events, see Setting Up Events and Notifications in the Amazon EC2 Systems Manager User Guide.

          • NotificationType — (String)

            Command: Receive notification when the status of a command changes. Invocation: For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes.

            Possible values include:
            • "Command"
            • "Invocation"
      • NextToken — (String)

        (Optional) The token for the next set of items to return. (You received this token from a previous call.)

Returns:

  • (AWS.Request)

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

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

Lists the commands requested by users of the AWS account.

Service Reference:

Examples:

Calling the listCommands operation

var params = {
  CommandId: 'STRING_VALUE',
  Filters: [
    {
      key: InvokedAfter | InvokedBefore | Status, /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  InstanceId: 'STRING_VALUE',
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
ssm.listCommands(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: {})
    • CommandId — (String)

      (Optional) If provided, lists only the specified command.

    • InstanceId — (String)

      (Optional) Lists commands issued against this instance ID.

    • MaxResults — (Integer)

      (Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    • NextToken — (String)

      (Optional) The token for the next set of items to return. (You received this token from a previous call.)

    • Filters — (Array<map>)

      (Optional) One or more filters. Use a filter to return a more specific list of results.

      • keyrequired — (String)

        The name of the filter.

        Possible values include:
        • "InvokedAfter"
        • "InvokedBefore"
        • "Status"
      • valuerequired — (String)

        The filter value.

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:

      • Commands — (Array<map>)

        (Optional) The list of commands requested by the user.

        • CommandId — (String)

          A unique identifier for this command.

        • DocumentName — (String)

          The name of the document requested for execution.

        • Comment — (String)

          User-specified information about the command, such as a brief description of what the command should do.

        • ExpiresAfter — (Date)

          If this time is reached and the command has not already started executing, it will not execute. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.

        • Parameters — (map<Array<String>>)

          The parameter values to be inserted in the document when executing the command.

        • InstanceIds — (Array<String>)

          The instance IDs against which this command was requested.

        • Targets — (Array<map>)

          An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call.

          • Key — (String)

            User-defined criteria for sending commands that target instances that meet the criteria. Key can be tag:<Amazon EC2 tag> or InstanceIds. For more information about how to send commands that target instances using Key,Value parameters, see Executing a Command Using Systems Manager Run Command.

          • Values — (Array<String>)

            User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to execute a command on instances that include Amazon EC2 tags of ServerRole,WebServer. For more information about how to send commands that target instances using Key,Value parameters, see Executing a Command Using Systems Manager Run Command.

        • RequestedDateTime — (Date)

          The date and time the command was requested.

        • Status — (String)

          The status of the command.

          Possible values include:
          • "Pending"
          • "InProgress"
          • "Success"
          • "Cancelled"
          • "Failed"
          • "TimedOut"
          • "Cancelling"
        • StatusDetails — (String)

          A detailed status of the command execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Run Command Status. StatusDetails can be one of the following values:

          • Pending: The command has not been sent to any instances.

          • In Progress: The command has been sent to at least one instance but has not reached a final state on all instances.

          • Success: The command successfully executed on all invocations. This is a terminal state.

          • Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.

          • Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.

          • Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.

          • Incomplete: The command was attempted on all instances and one or more invocations does not have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.

          • Canceled: The command was terminated before it was completed. This is a terminal state.

          • Rate Exceeded: The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before executing it on any instance. This is a terminal state.

        • OutputS3Region — (String)

          (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.

        • OutputS3BucketName — (String)

          The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.

        • OutputS3KeyPrefix — (String)

          The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.

        • MaxConcurrency — (String)

          The maximum number of instances that are allowed to execute the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Executing a Command Using Systems Manager Run Command.

        • MaxErrors — (String)

          The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 50. For more information about how to use MaxErrors, see Executing a Command Using Systems Manager Run Command.

        • TargetCount — (Integer)

          The number of targets for the command.

        • CompletedCount — (Integer)

          The number of targets for which the command invocation reached a terminal state. Terminal states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Canceled, Terminated, or Undeliverable.

        • ErrorCount — (Integer)

          The number of targets for which the status is Failed or Execution Timed Out.

        • ServiceRole — (String)

          The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes.

        • NotificationConfig — (map)

          Configurations for sending notifications about command status changes.

          • NotificationArn — (String)

            An Amazon Resource Name (ARN) for a Simple Notification Service (SNS) topic. Run Command pushes notifications about command status changes to this topic.

          • NotificationEvents — (Array<String>)

            The different events for which you can receive notifications. These events include the following: All (events), InProgress, Success, TimedOut, Cancelled, Failed. To learn more about these events, see Setting Up Events and Notifications in the Amazon EC2 Systems Manager User Guide.

          • NotificationType — (String)

            Command: Receive notification when the status of a command changes. Invocation: For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes.

            Possible values include:
            • "Command"
            • "Invocation"
      • NextToken — (String)

        (Optional) The token for the next set of items to return. (You received this token from a previous call.)

Returns:

  • (AWS.Request)

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

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

Describes one or more of your SSM documents.

Service Reference:

Examples:

Calling the listDocuments operation

var params = {
  DocumentFilterList: [
    {
      key: Name | Owner | PlatformTypes | DocumentType, /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
ssm.listDocuments(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: {})
    • DocumentFilterList — (Array<map>)

      One or more filters. Use a filter to return a more specific list of results.

      • keyrequired — (String)

        The name of the filter.

        Possible values include:
        • "Name"
        • "Owner"
        • "PlatformTypes"
        • "DocumentType"
      • valuerequired — (String)

        The value of the filter.

    • MaxResults — (Integer)

      The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    • NextToken — (String)

      The token for the next set of items to return. (You received this token from a previous call.)

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:

      • DocumentIdentifiers — (Array<map>)

        The names of the SSM documents.

        • Name — (String)

          The name of the SSM document.

        • Owner — (String)

          The AWS user account of the person who created the document.

        • PlatformTypes — (Array<String>)

          The operating system platform.

        • DocumentVersion — (String)

          The document version.

        • DocumentType — (String)

          The document type.

          Possible values include:
          • "Command"
          • "Policy"
          • "Automation"
        • SchemaVersion — (String)

          The schema version.

      • NextToken — (String)

        The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Returns:

  • (AWS.Request)

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

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

List all versions for a document.

Service Reference:

Examples:

Calling the listDocumentVersions operation

var params = {
  Name: 'STRING_VALUE', /* required */
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
ssm.listDocumentVersions(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)

      The name of the document about which you want version information.

    • MaxResults — (Integer)

      The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    • NextToken — (String)

      The token for the next set of items to return. (You received this token from a previous call.)

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:

      • DocumentVersions — (Array<map>)

        The document versions.

        • Name — (String)

          The document name.

        • DocumentVersion — (String)

          The document version.

        • CreatedDate — (Date)

          The date the document was created.

        • IsDefaultVersion — (Boolean)

          An identifier for the default version of the document.

      • NextToken — (String)

        The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Returns:

  • (AWS.Request)

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

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

A list of inventory items returned by the request.

Service Reference:

Examples:

Calling the listInventoryEntries operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  TypeName: 'STRING_VALUE', /* required */
  Filters: [
    {
      Key: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      Type: Equal | NotEqual | BeginWith | LessThan | GreaterThan
    },
    /* more items */
  ],
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
ssm.listInventoryEntries(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: {})
    • InstanceId — (String)

      The instance ID for which you want inventory information.

    • TypeName — (String)

      The type of inventory item for which you want information.

    • Filters — (Array<map>)

      One or more filters. Use a filter to return a more specific list of results.

      • Keyrequired — (String)

        The name of the filter key.

      • Valuesrequired — (Array<String>)

        Inventory filter values. Example: inventory filter where instance IDs are specified as values Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g, i-1a2b3c4d5e6,Type=Equal

      • Type — (String)

        The type of filter. Valid values include the following: "Equal"|"NotEqual"|"BeginWith"|"LessThan"|"GreaterThan"

        Possible values include:
        • "Equal"
        • "NotEqual"
        • "BeginWith"
        • "LessThan"
        • "GreaterThan"
    • NextToken — (String)

      The token for the next set of items to return. (You received this token from a previous call.)

    • MaxResults — (Integer)

      The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

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:

      • TypeName — (String)

        The type of inventory item returned by the request.

      • InstanceId — (String)

        The instance ID targeted by the request to query inventory information.

      • SchemaVersion — (String)

        The inventory schema version used by the instance(s).

      • CaptureTime — (String)

        The time that inventory information was collected for the instance(s).

      • Entries — (Array<map<String>>)

        A list of inventory items on the instance(s).

      • NextToken — (String)

        The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Returns:

  • (AWS.Request)

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

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

Returns a list of the tags assigned to the specified resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  ResourceType: ManagedInstance | MaintenanceWindow | Parameter /* required */
};
ssm.listTagsForResource(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: {})
    • ResourceType — (String)

      Returns a list of tags for a specific resource type.

      Possible values include:
      • "ManagedInstance"
      • "MaintenanceWindow"
      • "Parameter"
    • ResourceId — (String)

      The resource ID for which you want to see a list of tags.

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:

      • TagList — (Array<map>)

        A list of tags.

        • Keyrequired — (String)

          The name of the tag.

        • Valuerequired — (String)

          The value of the tag.

Returns:

  • (AWS.Request)

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

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

Shares a Systems Manager document publicly or privately. If you share a document privately, you must specify the AWS user account IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.

Service Reference:

Examples:

Calling the modifyDocumentPermission operation

var params = {
  Name: 'STRING_VALUE', /* required */
  PermissionType: Share, /* required */
  AccountIdsToAdd: [
    'STRING_VALUE',
    /* more items */
  ],
  AccountIdsToRemove: [
    'STRING_VALUE',
    /* more items */
  ]
};
ssm.modifyDocumentPermission(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)

      The name of the document that you want to share.

    • PermissionType — (String)

      The permission type for the document. The permission type can be Share.

      Possible values include:
      • "Share"
    • AccountIdsToAdd — (Array<String>)

      The AWS user accounts that should have access to the document. The account IDs can either be a group of account IDs or All.

    • AccountIdsToRemove — (Array<String>)

      The AWS user accounts that should no longer have access to the document. The AWS user account can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an account ID to add and the same ID to remove, the system removes access to the document.

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.

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

Bulk update custom inventory items on one more instance. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.

Service Reference:

Examples:

Calling the putInventory operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  Items: [ /* required */
    {
      CaptureTime: 'STRING_VALUE', /* required */
      SchemaVersion: 'STRING_VALUE', /* required */
      TypeName: 'STRING_VALUE', /* required */
      Content: [
        {
          '<AttributeName>': 'STRING_VALUE',
          /* '<AttributeName>': ... */
        },
        /* more items */
      ],
      ContentHash: 'STRING_VALUE'
    },
    /* more items */
  ]
};
ssm.putInventory(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: {})
    • InstanceId — (String)

      One or more instance IDs where you want to add or update inventory items.

    • Items — (Array<map>)

      The inventory items that you want to add or update on instances.

      • TypeNamerequired — (String)

        The name of the inventory type. Default inventory item type names start with AWS. Custom inventory type names will start with Custom. Default inventory item types include the following: AWS:AWSComponent, AWS:Application, AWS:InstanceInformation, AWS:Network, and AWS:WindowsUpdate.

      • SchemaVersionrequired — (String)

        The schema version for the inventory item.

      • CaptureTimerequired — (String)

        The time the inventory information was collected.

      • ContentHash — (String)

        MD5 hash of the inventory item type contents. The content hash is used to determine whether to update inventory information. The PutInventory API does not update the inventory item type contents if the MD5 hash has not changed since last update.

      • Content — (Array<map<String>>)

        The inventory data of the inventory type.

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.

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

Add one or more parameters to the system.

Service Reference:

Examples:

Calling the putParameter operation

var params = {
  Name: 'STRING_VALUE', /* required */
  Type: String | StringList | SecureString, /* required */
  Value: 'STRING_VALUE', /* required */
  AllowedPattern: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  KeyId: 'STRING_VALUE',
  Overwrite: true || false
};
ssm.putParameter(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)

      The name of the parameter that you want to add to the system.

    • Description — (String)

      Information about the parameter that you want to add to the system

    • Value — (String)

      The parameter value that you want to add to the system.

    • Type — (String)

      The type of parameter that you want to add to the system.

      Possible values include:
      • "String"
      • "StringList"
      • "SecureString"
    • KeyId — (String)

      The KMS Key ID that you want to use to encrypt a parameter when you choose the SecureString data type. If you don't specify a key ID, the system uses the default key associated with your AWS account.

    • Overwrite — (Boolean)

      Overwrite an existing parameter. If not specified, will default to "false".

    • AllowedPattern — (String)

      A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$

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.

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

Defines the default patch baseline.

Service Reference:

Examples:

Calling the registerDefaultPatchBaseline operation

var params = {
  BaselineId: 'STRING_VALUE' /* required */
};
ssm.registerDefaultPatchBaseline(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: {})
    • BaselineId — (String)

      The ID of the patch baseline that should be the default patch baseline.

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:

      • BaselineId — (String)

        The ID of the default patch baseline.

Returns:

  • (AWS.Request)

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

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

Registers a patch baseline for a patch group.

Examples:

Calling the registerPatchBaselineForPatchGroup operation

var params = {
  BaselineId: 'STRING_VALUE', /* required */
  PatchGroup: 'STRING_VALUE' /* required */
};
ssm.registerPatchBaselineForPatchGroup(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: {})
    • BaselineId — (String)

      The ID of the patch baseline to register the patch group with.

    • PatchGroup — (String)

      The name of the patch group that should be registered with the patch baseline.

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:

      • BaselineId — (String)

        The ID of the patch baseline the patch group was registered with.

      • PatchGroup — (String)

        The name of the patch group registered with the patch baseline.

Returns:

  • (AWS.Request)

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

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

Registers a target with a Maintenance Window.

Examples:

Calling the registerTargetWithMaintenanceWindow operation

var params = {
  ResourceType: INSTANCE, /* required */
  Targets: [ /* required */
    {
      Key: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  WindowId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  OwnerInformation: 'STRING_VALUE'
};
ssm.registerTargetWithMaintenanceWindow(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: {})
    • WindowId — (String)

      The ID of the Maintenance Window the target should be registered with.

    • ResourceType — (String)

      The type of target being registered with the Maintenance Window.

      Possible values include:
      • "INSTANCE"
    • Targets — (Array<map>)

      The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.

      • Key — (String)

        User-defined criteria for sending commands that target instances that meet the criteria. Key can be tag:<Amazon EC2 tag> or InstanceIds. For more information about how to send commands that target instances using Key,Value parameters, see Executing a Command Using Systems Manager Run Command.

      • Values — (Array<String>)

        User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to execute a command on instances that include Amazon EC2 tags of ServerRole,WebServer. For more information about how to send commands that target instances using Key,Value parameters, see Executing a Command Using Systems Manager Run Command.

    • OwnerInformation — (String)

      User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this Maintenance Window.

    • ClientToken — (String)

      User-provided idempotency token.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • WindowTargetId — (String)

        The ID of the target definition in this Maintenance Window.

Returns:

  • (AWS.Request)

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

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

Adds a new task to a Maintenance Window.

Examples:

Calling the registerTaskWithMaintenanceWindow operation

var params = {
  MaxConcurrency: 'STRING_VALUE', /* required */
  MaxErrors: 'STRING_VALUE', /* required */
  ServiceRoleArn: 'STRING_VALUE', /* required */
  Targets: [ /* required */
    {
      Key: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  TaskArn: 'STRING_VALUE', /* required */
  TaskType: RUN_COMMAND, /* required */
  WindowId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  LoggingInfo: {
    S3BucketName: 'STRING_VALUE', /* required */
    S3Region: 'STRING_VALUE', /* required */
    S3KeyPrefix: 'STRING_VALUE'
  },
  Priority: 0,
  TaskParameters: {
    '<MaintenanceWindowTaskParameterName>': {
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* '<MaintenanceWindowTaskParameterName>': ... */
  }
};
ssm.registerTaskWithMaintenanceWindow(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: {})
    • WindowId — (String)

      The id of the Maintenance Window the task should be added to.

    • Targets — (Array<map>)

      The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.

      • Key — (String)

        User-defined criteria for sending commands that target instances that meet the criteria. Key can be tag:<Amazon EC2 tag> or InstanceIds. For more information about how to send commands that target instances using Key,Value parameters, see Executing a Command Using Systems Manager Run Command.

      • Values — (Array<String>)

        User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to execute a command on instances that include Amazon EC2 tags of ServerRole,WebServer. For more information about how to send commands that target instances using Key,Value parameters, see Executing a Command Using Systems Manager Run Command.

    • TaskArn — (String)

      The ARN of the task to execute

    • ServiceRoleArn — (String)

      The role that should be assumed when executing the task.

    • TaskType — (String)

      The type of task being registered.

      Possible values include:
      • "RUN_COMMAND"
    • TaskParameters — (map<map>)

      The parameters that should be passed to the task when it is executed.

      • Values — (Array<String>)

        This field contains an array of 0 or more strings, each 1 to 255 characters in length.

    • Priority — (Integer)

      The priority of the task in the Maintenance Window, the lower the number the higher the priority. Tasks in a Maintenance Window are scheduled in priority order with tasks that have the same priority scheduled in parallel.

    • MaxConcurrency — (String)

      The maximum number of targets this task can be run for in parallel.

    • MaxErrors — (String)

      The maximum number of errors allowed before this task stops being scheduled.

    • LoggingInfo — (map)

      A structure containing information about an Amazon S3 bucket to write instance-level logs to.

      • S3BucketNamerequired — (String)

        The name of an Amazon S3 bucket where execution logs are stored .

      • S3KeyPrefix — (String)

        (Optional) The Amazon S3 bucket subfolder.

      • S3Regionrequired — (String)

        The region where the Amazon S3 bucket is located.

    • ClientToken — (String)

      User-provided idempotency token.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • WindowTaskId — (String)

        The id of the task in the Maintenance Window.

Returns:

  • (AWS.Request)

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

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

Removes all tags from the specified resource.

Service Reference:

Examples:

Calling the removeTagsFromResource operation

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  ResourceType: ManagedInstance | MaintenanceWindow | Parameter, /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
ssm.removeTagsFromResource(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: {})
    • ResourceType — (String)

      The type of resource of which you want to remove a tag.

      Possible values include:
      • "ManagedInstance"
      • "MaintenanceWindow"
      • "Parameter"
    • ResourceId — (String)

      The resource ID for which you want to remove tags.

    • TagKeys — (Array<String>)

      Tag keys that you want to remove from the specified 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.

Returns:

  • (AWS.Request)

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

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

Executes commands on one or more managed instances.

Service Reference:

Examples:

Calling the sendCommand operation

var params = {
  DocumentName: 'STRING_VALUE', /* required */
  Comment: 'STRING_VALUE',
  DocumentHash: 'STRING_VALUE',
  DocumentHashType: Sha256 | Sha1,
  InstanceIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxConcurrency: 'STRING_VALUE',
  MaxErrors: 'STRING_VALUE',
  NotificationConfig: {
    NotificationArn: 'STRING_VALUE',
    NotificationEvents: [
      All | InProgress | Success | TimedOut | Cancelled | Failed,
      /* more items */
    ],
    NotificationType: Command | Invocation
  },
  OutputS3BucketName: 'STRING_VALUE',
  OutputS3KeyPrefix: 'STRING_VALUE',
  OutputS3Region: 'STRING_VALUE',
  Parameters: {
    '<ParameterName>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<ParameterName>': ... */
  },
  ServiceRoleArn: 'STRING_VALUE',
  Targets: [
    {
      Key: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  TimeoutSeconds: 0
};
ssm.sendCommand(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: {})
    • InstanceIds — (Array<String>)

      The instance IDs where the command should execute. You can specify a maximum of 50 IDs. If you prefer not to list individual instance IDs, you can instead send commands to a fleet of instances using the Targets parameter, which accepts EC2 tags. For more information about how to use Targets, see Sending Commands to a Fleet.

    • Targets — (Array<map>)

      (Optional) An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call. For more information about how to use Targets, see Sending Commands to a Fleet.

      • Key — (String)

        User-defined criteria for sending commands that target instances that meet the criteria. Key can be tag:<Amazon EC2 tag> or InstanceIds. For more information about how to send commands that target instances using Key,Value parameters, see Executing a Command Using Systems Manager Run Command.

      • Values — (Array<String>)

        User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to execute a command on instances that include Amazon EC2 tags of ServerRole,WebServer. For more information about how to send commands that target instances using Key,Value parameters, see Executing a Command Using Systems Manager Run Command.

    • DocumentName — (String)

      Required. The name of the Systems Manager document to execute. This can be a public document or a custom document.

    • DocumentHash — (String)

      The Sha256 or Sha1 hash created by the system when the document was created.

      Note: Sha1 hashes have been deprecated.
    • DocumentHashType — (String)

      Sha256 or Sha1.

      Note: Sha1 hashes have been deprecated.
      Possible values include:
      • "Sha256"
      • "Sha1"
    • TimeoutSeconds — (Integer)

      If this time is reached and the command has not already started executing, it will not execute.

    • Comment — (String)

      User-specified information about the command, such as a brief description of what the command should do.

    • Parameters — (map<Array<String>>)

      The required and optional parameters specified in the document being executed.

    • OutputS3Region — (String)

      (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.

    • OutputS3BucketName — (String)

      The name of the S3 bucket where command execution responses should be stored.

    • OutputS3KeyPrefix — (String)

      The directory structure within the S3 bucket where the responses should be stored.

    • MaxConcurrency — (String)

      (Optional) The maximum number of instances that are allowed to execute the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using Concurrency Controls.

    • MaxErrors — (String)

      The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 50. For more information about how to use MaxErrors, see Using Error Controls.

    • ServiceRoleArn — (String)

      The IAM role that Systems Manager uses to send notifications.

    • NotificationConfig — (map)

      Configurations for sending notifications.

      • NotificationArn — (String)

        An Amazon Resource Name (ARN) for a Simple Notification Service (SNS) topic. Run Command pushes notifications about command status changes to this topic.

      • NotificationEvents — (Array<String>)

        The different events for which you can receive notifications. These events include the following: All (events), InProgress, Success, TimedOut, Cancelled, Failed. To learn more about these events, see Setting Up Events and Notifications in the Amazon EC2 Systems Manager User Guide.

      • NotificationType — (String)

        Command: Receive notification when the status of a command changes. Invocation: For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes.

        Possible values include:
        • "Command"
        • "Invocation"

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:

      • Command — (map)

        The request as it was received by Systems Manager. Also provides the command ID which can be used future references to this request.

        • CommandId — (String)

          A unique identifier for this command.

        • DocumentName — (String)

          The name of the document requested for execution.

        • Comment — (String)

          User-specified information about the command, such as a brief description of what the command should do.

        • ExpiresAfter — (Date)

          If this time is reached and the command has not already started executing, it will not execute. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.

        • Parameters — (map<Array<String>>)

          The parameter values to be inserted in the document when executing the command.

        • InstanceIds — (Array<String>)

          The instance IDs against which this command was requested.

        • Targets — (Array<map>)

          An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call.

          • Key — (String)

            User-defined criteria for sending commands that target instances that meet the criteria. Key can be tag:<Amazon EC2 tag> or InstanceIds. For more information about how to send commands that target instances using Key,Value parameters, see Executing a Command Using Systems Manager Run Command.

          • Values — (Array<String>)

            User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to execute a command on instances that include Amazon EC2 tags of ServerRole,WebServer. For more information about how to send commands that target instances using Key,Value parameters, see Executing a Command Using Systems Manager Run Command.

        • RequestedDateTime — (Date)

          The date and time the command was requested.

        • Status — (String)

          The status of the command.

          Possible values include:
          • "Pending"
          • "InProgress"
          • "Success"
          • "Cancelled"
          • "Failed"
          • "TimedOut"
          • "Cancelling"
        • StatusDetails — (String)

          A detailed status of the command execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Run Command Status. StatusDetails can be one of the following values:

          • Pending: The command has not been sent to any instances.

          • In Progress: The command has been sent to at least one instance but has not reached a final state on all instances.

          • Success: The command successfully executed on all invocations. This is a terminal state.

          • Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.

          • Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.

          • Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.

          • Incomplete: The command was attempted on all instances and one or more invocations does not have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.

          • Canceled: The command was terminated before it was completed. This is a terminal state.

          • Rate Exceeded: The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before executing it on any instance. This is a terminal state.

        • OutputS3Region — (String)

          (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.

        • OutputS3BucketName — (String)

          The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.

        • OutputS3KeyPrefix — (String)

          The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.

        • MaxConcurrency — (String)

          The maximum number of instances that are allowed to execute the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Executing a Command Using Systems Manager Run Command.

        • MaxErrors — (String)

          The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 50. For more information about how to use MaxErrors, see Executing a Command Using Systems Manager Run Command.

        • TargetCount — (Integer)

          The number of targets for the command.

        • CompletedCount — (Integer)

          The number of targets for which the command invocation reached a terminal state. Terminal states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Canceled, Terminated, or Undeliverable.

        • ErrorCount — (Integer)

          The number of targets for which the status is Failed or Execution Timed Out.

        • ServiceRole — (String)

          The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes.

        • NotificationConfig — (map)

          Configurations for sending notifications about command status changes.

          • NotificationArn — (String)

            An Amazon Resource Name (ARN) for a Simple Notification Service (SNS) topic. Run Command pushes notifications about command status changes to this topic.

          • NotificationEvents — (Array<String>)

            The different events for which you can receive notifications. These events include the following: All (events), InProgress, Success, TimedOut, Cancelled, Failed. To learn more about these events, see Setting Up Events and Notifications in the Amazon EC2 Systems Manager User Guide.

          • NotificationType — (String)

            Command: Receive notification when the status of a command changes. Invocation: For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes.

            Possible values include:
            • "Command"
            • "Invocation"

Returns:

  • (AWS.Request)

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

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

Initiates execution of an Automation document.

Service Reference:

Examples:

Calling the startAutomationExecution operation

var params = {
  DocumentName: 'STRING_VALUE', /* required */
  DocumentVersion: 'STRING_VALUE',
  Parameters: {
    '<AutomationParameterKey>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<AutomationParameterKey>': ... */
  }
};
ssm.startAutomationExecution(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: {})
    • DocumentName — (String)

      The name of the Automation document to use for this execution.

    • DocumentVersion — (String)

      The version of the Automation document to use for this execution.

    • Parameters — (map<Array<String>>)

      A key-value map of execution parameters, which match the declared parameters in the Automation document.

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:

      • AutomationExecutionId — (String)

        The unique ID of a newly scheduled automation execution.

Returns:

  • (AWS.Request)

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

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

Stop an Automation that is currently executing.

Service Reference:

Examples:

Calling the stopAutomationExecution operation

var params = {
  AutomationExecutionId: 'STRING_VALUE' /* required */
};
ssm.stopAutomationExecution(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: {})
    • AutomationExecutionId — (String)

      The execution ID of the Automation to stop.

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.

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

Updates an association. You can only update the document version, schedule, parameters, and Amazon S3 output of an association.

Service Reference:

Examples:

Calling the updateAssociation operation

var params = {
  AssociationId: 'STRING_VALUE', /* required */
  DocumentVersion: 'STRING_VALUE',
  Name: 'STRING_VALUE',
  OutputLocation: {
    S3Location: {
      OutputS3BucketName: 'STRING_VALUE',
      OutputS3KeyPrefix: 'STRING_VALUE',
      OutputS3Region: 'STRING_VALUE'
    }
  },
  Parameters: {
    '<ParameterName>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<ParameterName>': ... */
  },
  ScheduleExpression: 'STRING_VALUE',
  Targets: [
    {
      Key: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ]
};
ssm.updateAssociation(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: {})
    • AssociationId — (String)

      The ID of the association you want to update.

    • Parameters — (map<Array<String>>)

      The parameters you want to update for the association. If you create a parameter using Parameter Store, you can reference the parameter using {{ssm:parameter-name}}

    • DocumentVersion — (String)

      The document version you want update for the association.

    • ScheduleExpression — (String)

      The cron expression used to schedule the association that you want to update.

    • OutputLocation — (map)

      An Amazon S3 bucket where you want to store the results of this request.

      • S3Location — (map)

        An Amazon S3 bucket where you want to store the results of this request.

        • OutputS3Region — (String)

          (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.

        • OutputS3BucketName — (String)

          The name of the Amazon S3 bucket.

        • OutputS3KeyPrefix — (String)

          The Amazon S3 bucket subfolder.

    • Name — (String)

      The name of the association document.

    • Targets — (Array<map>)

      The targets of the association.

      • Key — (String)

        User-defined criteria for sending commands that target instances that meet the criteria. Key can be tag:<Amazon EC2 tag> or InstanceIds. For more information about how to send commands that target instances using Key,Value parameters, see Executing a Command Using Systems Manager Run Command.

      • Values — (Array<String>)

        User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to execute a command on instances that include Amazon EC2 tags of ServerRole,WebServer. For more information about how to send commands that target instances using Key,Value parameters, see Executing a Command Using Systems Manager Run Command.

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:

      • AssociationDescription — (map)

        The description of the association that was updated.

        • Name — (String)

          The name of the SSM document.

        • InstanceId — (String)

          The ID of the instance.

        • Date — (Date)

          The date when the association was made.

        • LastUpdateAssociationDate — (Date)

          The date when the association was last updated.

        • Status — (map)

          The association status.

          • Daterequired — (Date)

            The date when the status changed.

          • Namerequired — (String)

            The status.

            Possible values include:
            • "Pending"
            • "Success"
            • "Failed"
          • Messagerequired — (String)

            The reason for the status.

          • AdditionalInfo — (String)

            A user-defined string.

        • Overview — (map)

          Information about the association.

          • Status — (String)

            The status of the association. Status can be: Pending, Success, or Failed.

          • DetailedStatus — (String)

            A detailed status of the association.

          • AssociationStatusAggregatedCount — (map<Integer>)

            Returns the number of targets for the association status. For example, if you created an association with two instances, and one of them was successful, this would return the count of instances by status.

        • DocumentVersion — (String)

          The document version.

        • Parameters — (map<Array<String>>)

          A description of the parameters for a document.

        • AssociationId — (String)

          The association ID.

        • Targets — (Array<map>)

          The instances targeted by the request.

          • Key — (String)

            User-defined criteria for sending commands that target instances that meet the criteria. Key can be tag:<Amazon EC2 tag> or InstanceIds. For more information about how to send commands that target instances using Key,Value parameters, see Executing a Command Using Systems Manager Run Command.

          • Values — (Array<String>)

            User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to execute a command on instances that include Amazon EC2 tags of ServerRole,WebServer. For more information about how to send commands that target instances using Key,Value parameters, see Executing a Command Using Systems Manager Run Command.

        • ScheduleExpression — (String)

          A cron expression that specifies a schedule when the association runs.

        • OutputLocation — (map)

          An Amazon S3 bucket where you want to store the output details of the request.

          • S3Location — (map)

            An Amazon S3 bucket where you want to store the results of this request.

            • OutputS3Region — (String)

              (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.

            • OutputS3BucketName — (String)

              The name of the Amazon S3 bucket.

            • OutputS3KeyPrefix — (String)

              The Amazon S3 bucket subfolder.

        • LastExecutionDate — (Date)

          The date on which the association was last run.

        • LastSuccessfulExecutionDate — (Date)

          The last date on which the association was successfully run.

Returns:

  • (AWS.Request)

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

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

Updates the status of the Systems Manager document associated with the specified instance.

Service Reference:

Examples:

Calling the updateAssociationStatus operation

var params = {
  AssociationStatus: { /* required */
    Date: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
    Message: 'STRING_VALUE', /* required */
    Name: Pending | Success | Failed, /* required */
    AdditionalInfo: 'STRING_VALUE'
  },
  InstanceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
ssm.updateAssociationStatus(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)

      The name of the SSM document.

    • InstanceId — (String)

      The ID of the instance.

    • AssociationStatus — (map)

      The association status.

      • Daterequired — (Date)

        The date when the status changed.

      • Namerequired — (String)

        The status.

        Possible values include:
        • "Pending"
        • "Success"
        • "Failed"
      • Messagerequired — (String)

        The reason for the status.

      • AdditionalInfo — (String)

        A user-defined string.

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:

      • AssociationDescription — (map)

        Information about the association.

        • Name — (String)

          The name of the SSM document.

        • InstanceId — (String)

          The ID of the instance.

        • Date — (Date)

          The date when the association was made.

        • LastUpdateAssociationDate — (Date)

          The date when the association was last updated.

        • Status — (map)

          The association status.

          • Daterequired — (Date)

            The date when the status changed.

          • Namerequired — (String)

            The status.

            Possible values include:
            • "Pending"
            • "Success"
            • "Failed"
          • Messagerequired — (String)

            The reason for the status.

          • AdditionalInfo — (String)

            A user-defined string.

        • Overview — (map)

          Information about the association.

          • Status — (String)

            The status of the association. Status can be: Pending, Success, or Failed.

          • DetailedStatus — (String)

            A detailed status of the association.

          • AssociationStatusAggregatedCount — (map<Integer>)

            Returns the number of targets for the association status. For example, if you created an association with two instances, and one of them was successful, this would return the count of instances by status.

        • DocumentVersion — (String)

          The document version.

        • Parameters — (map<Array<String>>)

          A description of the parameters for a document.

        • AssociationId — (String)

          The association ID.

        • Targets — (Array<map>)

          The instances targeted by the request.

          • Key — (String)

            User-defined criteria for sending commands that target instances that meet the criteria. Key can be tag:<Amazon EC2 tag> or InstanceIds. For more information about how to send commands that target instances using Key,Value parameters, see Executing a Command Using Systems Manager Run Command.

          • Values — (Array<String>)

            User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to execute a command on instances that include Amazon EC2 tags of ServerRole,WebServer. For more information about how to send commands that target instances using Key,Value parameters, see Executing a Command Using Systems Manager Run Command.

        • ScheduleExpression — (String)

          A cron expression that specifies a schedule when the association runs.

        • OutputLocation — (map)

          An Amazon S3 bucket where you want to store the output details of the request.

          • S3Location — (map)

            An Amazon S3 bucket where you want to store the results of this request.

            • OutputS3Region — (String)

              (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.

            • OutputS3BucketName — (String)

              The name of the Amazon S3 bucket.

            • OutputS3KeyPrefix — (String)

              The Amazon S3 bucket subfolder.

        • LastExecutionDate — (Date)

          The date on which the association was last run.

        • LastSuccessfulExecutionDate — (Date)

          The last date on which the association was successfully run.

Returns:

  • (AWS.Request)

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

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

The document you want to update.

Service Reference:

Examples:

Calling the updateDocument operation

var params = {
  Content: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  DocumentVersion: 'STRING_VALUE'
};
ssm.updateDocument(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: {})
    • Content — (String)

      The content in a document that you want to update.

    • Name — (String)

      The name of the document that you want to update.

    • DocumentVersion — (String)

      The version of the document that you want to update.

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:

      • DocumentDescription — (map)

        A description of the document that was updated.

        • Sha1 — (String)

          The SHA1 hash of the document, which you can use for verification purposes.

        • Hash — (String)

          The Sha256 or Sha1 hash created by the system when the document was created.

          Note: Sha1 hashes have been deprecated.
        • HashType — (String)

          Sha256 or Sha1.

          Note: Sha1 hashes have been deprecated.
          Possible values include:
          • "Sha256"
          • "Sha1"
        • Name — (String)

          The name of the SSM document.

        • Owner — (String)

          The AWS user account of the person who created the document.

        • CreatedDate — (Date)

          The date when the document was created.

        • Status — (String)

          The status of the SSM document.

          Possible values include:
          • "Creating"
          • "Active"
          • "Updating"
          • "Deleting"
        • DocumentVersion — (String)

          The document version.

        • Description — (String)

          A description of the document.

        • Parameters — (Array<map>)

          A description of the parameters for a document.

          • Name — (String)

            The name of the parameter.

          • Type — (String)

            The type of parameter. The type can be either String or StringList.

            Possible values include:
            • "String"
            • "StringList"
          • Description — (String)

            A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.

          • DefaultValue — (String)

            If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.

        • PlatformTypes — (Array<String>)

          The list of OS platforms compatible with this SSM document.

        • DocumentType — (String)

          The type of document.

          Possible values include:
          • "Command"
          • "Policy"
          • "Automation"
        • SchemaVersion — (String)

          The schema version.

        • LatestVersion — (String)

          The latest version of the document.

        • DefaultVersion — (String)

          The default version.

Returns:

  • (AWS.Request)

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

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

Set the default version of a document.

Service Reference:

Examples:

Calling the updateDocumentDefaultVersion operation

var params = {
  DocumentVersion: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
ssm.updateDocumentDefaultVersion(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)

      The name of a custom document that you want to set as the default version.

    • DocumentVersion — (String)

      The version of a custom document that you want to set as the default 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:

      • Description — (map)

        The description of a custom document that you want to set as the default version.

        • Name — (String)

          The name of the document.

        • DefaultVersion — (String)

          The default version of the document.

Returns:

  • (AWS.Request)

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

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

Updates an existing Maintenance Window. Only specified parameters are modified.

Service Reference:

Examples:

Calling the updateMaintenanceWindow operation

var params = {
  WindowId: 'STRING_VALUE', /* required */
  AllowUnassociatedTargets: true || false,
  Cutoff: 0,
  Duration: 0,
  Enabled: true || false,
  Name: 'STRING_VALUE',
  Schedule: 'STRING_VALUE'
};
ssm.updateMaintenanceWindow(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: {})
    • WindowId — (String)

      The ID of the Maintenance Window to update.

    • Name — (String)

      The name of the Maintenance Window.

    • Schedule — (String)

      The schedule of the Maintenance Window in the form of a cron or rate expression.

    • Duration — (Integer)

      The duration of the Maintenance Window in hours.

    • Cutoff — (Integer)

      The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.

    • AllowUnassociatedTargets — (Boolean)

      Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets.

    • Enabled — (Boolean)

      Whether the Maintenance Window is enabled.

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:

      • WindowId — (String)

        The ID of the created Maintenance Window.

      • Name — (String)

        The name of the Maintenance Window.

      • Schedule — (String)

        The schedule of the Maintenance Window in the form of a cron or rate expression.

      • Duration — (Integer)

        The duration of the Maintenance Window in hours.

      • Cutoff — (Integer)

        The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.

      • AllowUnassociatedTargets — (Boolean)

        Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets.

      • Enabled — (Boolean)

        Whether the Maintenance Window is enabled.

Returns:

  • (AWS.Request)

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

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

Assigns or changes an Amazon Identity and Access Management (IAM) role to the managed instance.

Service Reference:

Examples:

Calling the updateManagedInstanceRole operation

var params = {
  IamRole: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
ssm.updateManagedInstanceRole(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: {})
    • InstanceId — (String)

      The ID of the managed instance where you want to update the role.

    • IamRole — (String)

      The IAM role you want to assign or change.

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.

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

Modifies an existing patch baseline. Fields not specified in the request are left unchanged.

Service Reference:

Examples:

Calling the updatePatchBaseline operation

var params = {
  BaselineId: 'STRING_VALUE', /* required */
  ApprovalRules: {
    PatchRules: [ /* required */
      {
        ApproveAfterDays: 0, /* required */
        PatchFilterGroup: { /* required */
          PatchFilters: [ /* required */
            {
              Key: PRODUCT | CLASSIFICATION | MSRC_SEVERITY | PATCH_ID, /* required */
              Values: [ /* required */
                'STRING_VALUE',
                /* more items */
              ]
            },
            /* more items */
          ]
        }
      },
      /* more items */
    ]
  },
  ApprovedPatches: [
    'STRING_VALUE',
    /* more items */
  ],
  Description: 'STRING_VALUE',
  GlobalFilters: {
    PatchFilters: [ /* required */
      {
        Key: PRODUCT | CLASSIFICATION | MSRC_SEVERITY | PATCH_ID, /* required */
        Values: [ /* required */
          'STRING_VALUE',
          /* more items */
        ]
      },
      /* more items */
    ]
  },
  Name: 'STRING_VALUE',
  RejectedPatches: [
    'STRING_VALUE',
    /* more items */
  ]
};
ssm.updatePatchBaseline(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: {})
    • BaselineId — (String)

      The ID of the patch baseline to update.

    • Name — (String)

      The name of the patch baseline.

    • GlobalFilters — (map)

      A set of global filters used to exclude patches from the baseline.

      • PatchFiltersrequired — (Array<map>)

        The set of patch filters that make up the group.

        • Keyrequired — (String)

          The key for the filter (PRODUCT, CLASSIFICATION, MSRC_SEVERITY, PATCH_ID)

          Possible values include:
          • "PRODUCT"
          • "CLASSIFICATION"
          • "MSRC_SEVERITY"
          • "PATCH_ID"
        • Valuesrequired — (Array<String>)

          The value for the filter key.

    • ApprovalRules — (map)

      A set of rules used to include patches in the baseline.

      • PatchRulesrequired — (Array<map>)

        The rules that make up the rule group.

        • PatchFilterGrouprequired — (map)

          The patch filter group that defines the criteria for the rule.

          • PatchFiltersrequired — (Array<map>)

            The set of patch filters that make up the group.

            • Keyrequired — (String)

              The key for the filter (PRODUCT, CLASSIFICATION, MSRC_SEVERITY, PATCH_ID)

              Possible values include:
              • "PRODUCT"
              • "CLASSIFICATION"
              • "MSRC_SEVERITY"
              • "PATCH_ID"
            • Valuesrequired — (Array<String>)

              The value for the filter key.

        • ApproveAfterDaysrequired — (Integer)

          The number of days after the release date of each patch matched by the rule the patch is marked as approved in the patch baseline.

    • ApprovedPatches — (Array<String>)

      A list of explicitly approved patches for the baseline.

    • RejectedPatches — (Array<String>)

      A list of explicitly rejected patches for the baseline.

    • Description — (String)

      A description of the patch baseline.

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:

      • BaselineId — (String)

        The ID of the deleted patch baseline.

      • Name — (String)

        The name of the patch baseline.

      • GlobalFilters — (map)

        A set of global filters used to exclude patches from the baseline.

        • PatchFiltersrequired — (Array<map>)

          The set of patch filters that make up the group.

          • Keyrequired — (String)

            The key for the filter (PRODUCT, CLASSIFICATION, MSRC_SEVERITY, PATCH_ID)

            Possible values include:
            • "PRODUCT"
            • "CLASSIFICATION"
            • "MSRC_SEVERITY"
            • "PATCH_ID"
          • Valuesrequired — (Array<String>)

            The value for the filter key.

      • ApprovalRules — (map)

        A set of rules used to include patches in the baseline.

        • PatchRulesrequired — (Array<map>)

          The rules that make up the rule group.

          • PatchFilterGrouprequired — (map)

            The patch filter group that defines the criteria for the rule.

            • PatchFiltersrequired — (Array<map>)

              The set of patch filters that make up the group.

              • Keyrequired — (String)

                The key for the filter (PRODUCT, CLASSIFICATION, MSRC_SEVERITY, PATCH_ID)

                Possible values include:
                • "PRODUCT"
                • "CLASSIFICATION"
                • "MSRC_SEVERITY"
                • "PATCH_ID"
              • Valuesrequired — (Array<String>)

                The value for the filter key.

          • ApproveAfterDaysrequired — (Integer)

            The number of days after the release date of each patch matched by the rule the patch is marked as approved in the patch baseline.

      • ApprovedPatches — (Array<String>)

        A list of explicitly approved patches for the baseline.

      • RejectedPatches — (Array<String>)

        A list of explicitly rejected patches for the baseline.

      • CreatedDate — (Date)

        The date when the patch baseline was created.

      • ModifiedDate — (Date)

        The date when the patch baseline was last modified.

      • Description — (String)

        A description of the Patch Baseline.

Returns:

  • (AWS.Request)

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