AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Service Description

AWS Systems Manager is a collection of capabilities that helps you automate management tasks such as collecting system inventory, applying operating system (OS) patches, automating the creation of Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale. Systems Manager lets you remotely and securely manage the configuration of your managed instances. A managed instance is any Amazon EC2 instance or on-premises machine in your hybrid environment that has been configured for Systems Manager.

This reference is intended to be used with the AWS Systems Manager User Guide.

To get started, verify prerequisites and configure managed instances. For more information, see Setting Up AWS Systems Manager in the AWS Systems Manager User Guide.

For information about other API actions you can perform on Amazon EC2 instances, see the Amazon EC2 API Reference. For information about how to use a Query API, see Making API Requests.

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.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean)

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to 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 can assign to your documents, managed instances, maintenance windows, Parameter Store parameters, and patch baselines. 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 50 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: Document | ManagedInstance | MaintenanceWindow | Parameter | PatchBaseline | OpsItem, /* 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.

      Note: The ManagedInstance type for this API action is for on-premises managed instances. You must specify the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.
      Possible values include:
      • "Document"
      • "ManagedInstance"
      • "MaintenanceWindow"
      • "Parameter"
      • "PatchBaseline"
      • "OpsItem"
    • ResourceId — (String)

      The resource ID you want to tag.

      Use the ID of the resource. Here are some examples:

      ManagedInstance: mi-012345abcde

      MaintenanceWindow: mw-012345abcde

      PatchBaseline: pb-012345abcde

      For the Document and Parameter values, use the name of the resource.

      Note: The ManagedInstance type for this API action is only for on-premises managed instances. You must specify the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.
    • 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.

      Do not enter personally identifiable information in this field.

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

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

Stops a maintenance window execution that is already in progress and cancels any tasks in the window that have not already starting running. (Tasks already in progress will continue to completion.)

Examples:

Calling the cancelMaintenanceWindowExecution operation

var params = {
  WindowExecutionId: 'STRING_VALUE' /* required */
};
ssm.cancelMaintenanceWindowExecution(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 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. The data object has the following properties:

      • WindowExecutionId — (String)

        The ID of the maintenance window execution that has been stopped.

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 AWS Systems Manager for 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: 'NUMBER_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
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 user-defined description of the resource that you want to register with Amazon EC2.

      Do not enter personally identifiable information in this field.

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

      Do not enter personally identifiable information in this field.

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

    • Tags — (Array<map>)

      Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an activation to identify which servers or virtual machines (VMs) in your on-premises environment you intend to activate. In this case, you could specify the following key name/value pairs:

      • Key=OS,Value=Windows

      • Key=Environment,Value=Production

      When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID and code. When you specify the activation ID and code, tags assigned to the activation are automatically applied to the on-premises servers or VMs.

      You can't add tags to or delete tags from an existing activation. You can tag your on-premises servers and VMs after they connect to Systems Manager for the first time and are assigned a managed instance ID. This means they are listed in the AWS Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed instances, see AddTagsToResource. For information about how to remove tags from your managed instances, see RemoveTagsFromResource.

      • 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. 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, 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 returns the AssociationAlreadyExists exception.

Service Reference:

Examples:

Calling the createAssociation operation

var params = {
  Name: 'STRING_VALUE', /* required */
  AssociationName: 'STRING_VALUE',
  AutomationTargetParameterName: 'STRING_VALUE',
  ComplianceSeverity: CRITICAL | HIGH | MEDIUM | LOW | UNSPECIFIED,
  DocumentVersion: 'STRING_VALUE',
  InstanceId: 'STRING_VALUE',
  MaxConcurrency: 'STRING_VALUE',
  MaxErrors: '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 SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.

      You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account.

      For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format:

      arn:partition:ssm:region:account-id:document/document-name

      For example:

      arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document

      For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-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 runtime configuration of the document.

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

      • Values — (Array<String>)

        User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer.

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

    • AssociationName — (String)

      Specify a descriptive name for the association.

    • AutomationTargetParameterName — (String)

      Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.

    • MaxErrors — (String)

      The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

      Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

    • MaxConcurrency — (String)

      The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

      If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.

    • ComplianceSeverity — (String)

      The severity level to assign to the association.

      Possible values include:
      • "CRITICAL"
      • "HIGH"
      • "MEDIUM"
      • "LOW"
      • "UNSPECIFIED"

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 Systems Manager document.

        • InstanceId — (String)

          The ID of the instance.

        • AssociationVersion — (String)

          The association version.

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

        • AutomationTargetParameterName — (String)

          Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.

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

          • Values — (Array<String>)

            User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer.

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

        • AssociationName — (String)

          The association name.

        • MaxErrors — (String)

          The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

          Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

        • MaxConcurrency — (String)

          The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

          If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.

        • ComplianceSeverity — (String)

          The severity level that is assigned to the association.

          Possible values include:
          • "CRITICAL"
          • "HIGH"
          • "MEDIUM"
          • "LOW"
          • "UNSPECIFIED"

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, 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 returns the AssociationAlreadyExists exception.

Service Reference:

Examples:

Calling the createAssociationBatch operation

var params = {
  Entries: [ /* required */
    {
      Name: 'STRING_VALUE', /* required */
      AssociationName: 'STRING_VALUE',
      AutomationTargetParameterName: 'STRING_VALUE',
      ComplianceSeverity: CRITICAL | HIGH | MEDIUM | LOW | UNSPECIFIED,
      DocumentVersion: 'STRING_VALUE',
      InstanceId: 'STRING_VALUE',
      MaxConcurrency: 'STRING_VALUE',
      MaxErrors: '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 SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.

        You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account.

        For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format:

        arn:aws:ssm:region:account-id:document/document-name

        For example:

        arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document

        For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.

      • InstanceId — (String)

        The ID of the instance.

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

        A description of the parameters for a document.

      • AutomationTargetParameterName — (String)

        Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.

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

        • Values — (Array<String>)

          User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer.

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

      • AssociationName — (String)

        Specify a descriptive name for the association.

      • MaxErrors — (String)

        The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

        Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

      • MaxConcurrency — (String)

        The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

        If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.

      • ComplianceSeverity — (String)

        The severity level to assign to the association.

        Possible values include:
        • "CRITICAL"
        • "HIGH"
        • "MEDIUM"
        • "LOW"
        • "UNSPECIFIED"

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 Systems Manager document.

        • InstanceId — (String)

          The ID of the instance.

        • AssociationVersion — (String)

          The association version.

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

        • AutomationTargetParameterName — (String)

          Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.

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

          • Values — (Array<String>)

            User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer.

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

        • AssociationName — (String)

          The association name.

        • MaxErrors — (String)

          The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

          Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

        • MaxConcurrency — (String)

          The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

          If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.

        • ComplianceSeverity — (String)

          The severity level that is assigned to the association.

          Possible values include:
          • "CRITICAL"
          • "HIGH"
          • "MEDIUM"
          • "LOW"
          • "UNSPECIFIED"
      • Failed — (Array<map>)

        Information about the associations that failed.

        • Entry — (map)

          The association.

          • Namerequired — (String)

            The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.

            You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account.

            For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format:

            arn:aws:ssm:region:account-id:document/document-name

            For example:

            arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document

            For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.

          • InstanceId — (String)

            The ID of the instance.

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

            A description of the parameters for a document.

          • AutomationTargetParameterName — (String)

            Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.

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

            • Values — (Array<String>)

              User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer.

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

          • AssociationName — (String)

            Specify a descriptive name for the association.

          • MaxErrors — (String)

            The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

            Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

          • MaxConcurrency — (String)

            The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

            If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.

          • ComplianceSeverity — (String)

            The severity level to assign to the association.

            Possible values include:
            • "CRITICAL"
            • "HIGH"
            • "MEDIUM"
            • "LOW"
            • "UNSPECIFIED"
        • 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 */
  Attachments: [
    {
      Key: SourceUrl,
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  DocumentFormat: YAML | JSON,
  DocumentType: Command | Policy | Automation | Session | Package,
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  TargetType: 'STRING_VALUE',
  VersionName: 'STRING_VALUE'
};
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 or YAML string.

    • Attachments — (Array<map>)

      A list of key and value pairs that describe attachments to a version of a document.

      • Key — (String)

        The key of a key and value pair that identifies the location of an attachment to a document.

        Possible values include:
        • "SourceUrl"
      • Values — (Array<String>)

        The URL of the location of a document attachment, such as the URL of an Amazon S3 bucket.

    • Name — (String)

      A name for the Systems Manager document.

      Do not use the following to begin the names of documents you create. They are reserved by AWS for use as document prefixes:

      • aws

      • amazon

      • amzn

    • VersionName — (String)

      An optional field specifying the version of the artifact you are creating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.

    • DocumentType — (String)

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

      Possible values include:
      • "Command"
      • "Policy"
      • "Automation"
      • "Session"
      • "Package"
    • DocumentFormat — (String)

      Specify the document format for the request. The document format can be either JSON or YAML. JSON is the default format.

      Possible values include:
      • "YAML"
      • "JSON"
    • TargetType — (String)

      Specify a target type to define the kinds of resources the document can run on. For example, to run a document on EC2 instances, specify the following value: /AWS::EC2::Instance. If you specify a value of '/' the document can run on all types of resources. If you don't specify a value, the document can't run on any resources. For a list of valid resource types, see AWS Resource Types Reference in the AWS CloudFormation User Guide.

    • Tags — (Array<map>)

      Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an SSM document to identify the types of targets or the environment where it will run. In this case, you could specify the following key name/value pairs:

      • Key=OS,Value=Windows

      • Key=Environment,Value=Production

      Note: To add tags to an existing SSM document, use the AddTagsToResource action.
      • 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. 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.

        • Hash — (String)

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

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

          The hash type of the document. Valid values include Sha256 or Sha1.

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

          The name of the Systems Manager document.

        • VersionName — (String)

          The version of the artifact associated with the document.

        • Owner — (String)

          The AWS user account that created the document.

        • CreatedDate — (Date)

          The date when the document was created.

        • Status — (String)

          The status of the Systems Manager document.

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

          A message returned by AWS Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket does not exist. Verify that the URL of the S3 bucket is correct."

        • 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 Systems Manager document.

        • DocumentType — (String)

          The type of document.

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

          The schema version.

        • LatestVersion — (String)

          The latest version of the document.

        • DefaultVersion — (String)

          The default version.

        • DocumentFormat — (String)

          The document format, either JSON or YAML.

          Possible values include:
          • "YAML"
          • "JSON"
        • TargetType — (String)

          The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see AWS Resource Types Reference in the AWS CloudFormation User Guide.

        • Tags — (Array<map>)

          The tags, or metadata, that have been applied to the document.

          • Keyrequired — (String)

            The name of the tag.

          • Valuerequired — (String)

            The value of the tag.

        • AttachmentsInformation — (Array<map>)

          Details about the document attachments, including names, locations, sizes, etc.

          • Name — (String)

            The name of the attachment.

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: 'NUMBER_VALUE', /* required */
  Duration: 'NUMBER_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Schedule: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  EndDate: 'STRING_VALUE',
  ScheduleTimezone: 'STRING_VALUE',
  StartDate: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
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.

    • Description — (String)

      An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.

    • StartDate — (String)

      The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. StartDate allows you to delay activation of the maintenance window until the specified future date.

    • EndDate — (String)

      The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. EndDate allows you to set a date and time in the future when the maintenance window will no longer run.

    • Schedule — (String)

      The schedule of the maintenance window in the form of a cron or rate expression.

    • ScheduleTimezone — (String)

      The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.

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

      Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets. If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the maintenance window.

      If you don't enable this option, then you must specify previously-registered targets when you register a task with the maintenance window.

    • ClientToken — (String)

      User-provided idempotency token.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Tags — (Array<map>)

      Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in. In this case, you could specify the following key name/value pairs:

      • Key=TaskType,Value=AgentUpdate

      • Key=OS,Value=Windows

      • Key=Environment,Value=Production

      Note: To add tags to an existing maintenance window, use the AddTagsToResource action.
      • 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. 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.

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

Creates a new OpsItem. You must have permission in AWS Identity and Access Management (IAM) to create a new OpsItem. For more information, see Getting Started with OpsCenter in the AWS Systems Manager User Guide.

Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.

Service Reference:

Examples:

Calling the createOpsItem operation

var params = {
  Description: 'STRING_VALUE', /* required */
  Source: 'STRING_VALUE', /* required */
  Title: 'STRING_VALUE', /* required */
  Notifications: [
    {
      Arn: 'STRING_VALUE'
    },
    /* more items */
  ],
  OperationalData: {
    '<OpsItemDataKey>': {
      Type: SearchableString | String,
      Value: 'STRING_VALUE'
    },
    /* '<OpsItemDataKey>': ... */
  },
  Priority: 'NUMBER_VALUE',
  RelatedOpsItems: [
    {
      OpsItemId: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
ssm.createOpsItem(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)

      Information about the OpsItem.

    • OperationalData — (map<map>)

      Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.

      Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm.

      You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API action) can view and search on the specified data. Operational data that is not searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API action).

      Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view AWS CLI example commands that use these keys, see Creating OpsItems Manually in the AWS Systems Manager User Guide.

      • Value — (String)

        The value of the OperationalData key.

      • Type — (String)

        The type of key-value pair. Valid types include SearchableString and String.

        Possible values include:
        • "SearchableString"
        • "String"
    • Notifications — (Array<map>)

      The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.

      • Arn — (String)

        The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.

    • Priority — (Integer)

      The importance of this OpsItem in relation to other OpsItems in the system.

    • RelatedOpsItems — (Array<map>)

      One or more OpsItems that share something in common with the current OpsItems. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.

      • OpsItemIdrequired — (String)

        The ID of an OpsItem related to the current OpsItem.

    • Source — (String)

      The origin of the OpsItem, such as Amazon EC2 or AWS Systems Manager.

    • Title — (String)

      A short heading that describes the nature of the OpsItem and the impacted resource.

    • Tags — (Array<map>)

      Optional metadata that you assign to a resource. You can restrict access to OpsItems by using an inline IAM policy that specifies tags. For more information, see Getting Started with OpsCenter in the AWS Systems Manager User Guide.

      Tags use a key-value pair. For example:

      Key=Department,Value=Finance

      Note: To add tags to an existing OpsItem, use the AddTagsToResource action.
      • 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. The data object has the following properties:

      • OpsItemId — (String)

        The ID of the OpsItem.

Returns:

  • (AWS.Request)

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

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

Creates a patch baseline.

Note: For information about valid key and value pairs in PatchFilters for each supported operating system type, see PatchFilter.

Service Reference:

Examples:

Calling the createPatchBaseline operation

var params = {
  Name: 'STRING_VALUE', /* required */
  ApprovalRules: {
    PatchRules: [ /* required */
      {
        ApproveAfterDays: 'NUMBER_VALUE', /* required */
        PatchFilterGroup: { /* required */
          PatchFilters: [ /* required */
            {
              Key: PATCH_SET | PRODUCT | PRODUCT_FAMILY | CLASSIFICATION | MSRC_SEVERITY | PATCH_ID | SECTION | PRIORITY | SEVERITY, /* required */
              Values: [ /* required */
                'STRING_VALUE',
                /* more items */
              ]
            },
            /* more items */
          ]
        },
        ComplianceLevel: CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL | UNSPECIFIED,
        EnableNonSecurity: true || false
      },
      /* more items */
    ]
  },
  ApprovedPatches: [
    'STRING_VALUE',
    /* more items */
  ],
  ApprovedPatchesComplianceLevel: CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL | UNSPECIFIED,
  ApprovedPatchesEnableNonSecurity: true || false,
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  GlobalFilters: {
    PatchFilters: [ /* required */
      {
        Key: PATCH_SET | PRODUCT | PRODUCT_FAMILY | CLASSIFICATION | MSRC_SEVERITY | PATCH_ID | SECTION | PRIORITY | SEVERITY, /* required */
        Values: [ /* required */
          'STRING_VALUE',
          /* more items */
        ]
      },
      /* more items */
    ]
  },
  OperatingSystem: WINDOWS | AMAZON_LINUX | AMAZON_LINUX_2 | UBUNTU | REDHAT_ENTERPRISE_LINUX | SUSE | CENTOS,
  RejectedPatches: [
    'STRING_VALUE',
    /* more items */
  ],
  RejectedPatchesAction: ALLOW_AS_DEPENDENCY | BLOCK,
  Sources: [
    {
      Configuration: 'STRING_VALUE', /* required */
      Name: 'STRING_VALUE', /* required */
      Products: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* 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: {})
    • OperatingSystem — (String)

      Defines the operating system the patch baseline applies to. The Default value is WINDOWS.

      Possible values include:
      • "WINDOWS"
      • "AMAZON_LINUX"
      • "AMAZON_LINUX_2"
      • "UBUNTU"
      • "REDHAT_ENTERPRISE_LINUX"
      • "SUSE"
      • "CENTOS"
    • Name — (String)

      The name of the patch baseline.

    • GlobalFilters — (map)

      A set of global filters used to include patches in the baseline.

      • PatchFiltersrequired — (Array<map>)

        The set of patch filters that make up the group.

        • Keyrequired — (String)

          The key for the filter.

          Run the DescribePatchProperties command to view lists of valid keys for each operating system type.

          Possible values include:
          • "PATCH_SET"
          • "PRODUCT"
          • "PRODUCT_FAMILY"
          • "CLASSIFICATION"
          • "MSRC_SEVERITY"
          • "PATCH_ID"
          • "SECTION"
          • "PRIORITY"
          • "SEVERITY"
        • Valuesrequired — (Array<String>)

          The value for the filter key.

          Run the DescribePatchProperties command to view lists of valid values for each key based on operating system type.

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

              Run the DescribePatchProperties command to view lists of valid keys for each operating system type.

              Possible values include:
              • "PATCH_SET"
              • "PRODUCT"
              • "PRODUCT_FAMILY"
              • "CLASSIFICATION"
              • "MSRC_SEVERITY"
              • "PATCH_ID"
              • "SECTION"
              • "PRIORITY"
              • "SEVERITY"
            • Valuesrequired — (Array<String>)

              The value for the filter key.

              Run the DescribePatchProperties command to view lists of valid values for each key based on operating system type.

        • ComplianceLevel — (String)

          A compliance severity level for all approved patches in a patch baseline. Valid compliance severity levels include the following: Unspecified, Critical, High, Medium, Low, and Informational.

          Possible values include:
          • "CRITICAL"
          • "HIGH"
          • "MEDIUM"
          • "LOW"
          • "INFORMATIONAL"
          • "UNSPECIFIED"
        • ApproveAfterDaysrequired — (Integer)

          The number of days after the release date of each patch matched by the rule that the patch is marked as approved in the patch baseline. For example, a value of 7 means that patches are approved seven days after they are released.

        • EnableNonSecurity — (Boolean)

          For instances identified by the approval rule filters, enables a patch baseline to apply non-security updates available in the specified repository. The default value is 'false'. Applies to Linux instances only.

    • ApprovedPatches — (Array<String>)

      A list of explicitly approved patches for the baseline.

      For information about accepted formats for lists of approved patches and rejected patches, see Package Name Formats for Approved and Rejected Patch Lists in the AWS Systems Manager User Guide.

    • ApprovedPatchesComplianceLevel — (String)

      Defines the compliance level for approved patches. This means that if an approved patch is reported as missing, this is the severity of the compliance violation. The default value is UNSPECIFIED.

      Possible values include:
      • "CRITICAL"
      • "HIGH"
      • "MEDIUM"
      • "LOW"
      • "INFORMATIONAL"
      • "UNSPECIFIED"
    • ApprovedPatchesEnableNonSecurity — (Boolean)

      Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.

    • RejectedPatches — (Array<String>)

      A list of explicitly rejected patches for the baseline.

      For information about accepted formats for lists of approved patches and rejected patches, see Package Name Formats for Approved and Rejected Patch Lists in the AWS Systems Manager User Guide.

    • RejectedPatchesAction — (String)

      The action for Patch Manager to take on patches included in the RejectedPackages list.

      • ALLOW_AS_DEPENDENCY: A package in the Rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as InstalledOther. This is the default action if no option is specified.

      • BLOCK: Packages in the RejectedPatches list, and packages that include them as dependencies, are not installed under any circumstances. If a package was installed before it was added to the Rejected patches list, it is considered non-compliant with the patch baseline, and its status is reported as InstalledRejected.

      Possible values include:
      • "ALLOW_AS_DEPENDENCY"
      • "BLOCK"
    • Description — (String)

      A description of the patch baseline.

    • Sources — (Array<map>)

      Information about the patches to use to update the instances, including target operating systems and source repositories. Applies to Linux instances only.

      • Namerequired — (String)

        The name specified to identify the patch source.

      • Productsrequired — (Array<String>)

        The specific operating system versions a patch repository applies to, such as "Ubuntu16.04", "AmazonLinux2016.09", "RedhatEnterpriseLinux7.2" or "Suse12.7". For lists of supported product values, see PatchFilter.

      • Configurationrequired — (String)

        The value of the yum repo configuration. For example:

        [main]

        cachedir=/var/cache/yum/$basesearch$releasever

        keepcache=0

        debuglevel=2

    • ClientToken — (String)

      User-provided idempotency token.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Tags — (Array<map>)

      Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a patch baseline to identify the severity level of patches it specifies and the operating system family it applies to. In this case, you could specify the following key name/value pairs:

      • Key=PatchSeverity,Value=Critical

      • Key=OS,Value=Windows

      Note: To add tags to an existing patch baseline, use the AddTagsToResource action.
      • 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. 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.

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

Creates a resource data sync configuration to a single bucket in Amazon S3. This is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data to the Amazon S3 bucket. To check the status of the sync, use the ListResourceDataSync.

By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy. For more information, see Configuring Resource Data Sync for Inventory in the AWS Systems Manager User Guide.

Service Reference:

Examples:

Calling the createResourceDataSync operation

var params = {
  S3Destination: { /* required */
    BucketName: 'STRING_VALUE', /* required */
    Region: 'STRING_VALUE', /* required */
    SyncFormat: JsonSerDe, /* required */
    AWSKMSKeyARN: 'STRING_VALUE',
    Prefix: 'STRING_VALUE'
  },
  SyncName: 'STRING_VALUE' /* required */
};
ssm.createResourceDataSync(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: {})
    • SyncName — (String)

      A name for the configuration.

    • S3Destination — (map)

      Amazon S3 configuration details for the sync.

      • BucketNamerequired — (String)

        The name of the Amazon S3 bucket where the aggregated data is stored.

      • Prefix — (String)

        An Amazon S3 prefix for the bucket.

      • SyncFormatrequired — (String)

        A supported sync format. The following format is currently supported: JsonSerDe

        Possible values include:
        • "JsonSerDe"
      • Regionrequired — (String)

        The AWS Region with the Amazon S3 bucket targeted by the Resource Data Sync.

      • AWSKMSKeyARN — (String)

        The ARN of an encryption key for a destination in Amazon S3. Must belong to the same Region as the destination Amazon S3 bucket.

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.

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 */
  DocumentVersion: 'STRING_VALUE',
  VersionName: 'STRING_VALUE'
};
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.

    • DocumentVersion — (String)

      The version of the document that you want to delete. If not provided, all versions of the document are deleted.

    • VersionName — (String)

      The version name of the document that you want to delete. If not provided, all versions of the document are deleted.

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.

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

Delete a custom inventory type, or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory schema.

Service Reference:

Examples:

Calling the deleteInventory operation

var params = {
  TypeName: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  DryRun: true || false,
  SchemaDeleteOption: DisableSchema | DeleteSchema
};
ssm.deleteInventory(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 name of the custom inventory type for which you want to delete either all previously collected data, or the inventory type itself.

    • SchemaDeleteOption — (String)

      Use the SchemaDeleteOption to delete a custom inventory type (schema). If you don't choose this option, the system only deletes existing inventory data associated with the custom inventory type. Choose one of the following options:

      DisableSchema: If you choose this option, the system ignores all inventory data for the specified version, and any earlier versions. To enable this schema again, you must call the PutInventory action for a version greater than the disabled version.

      DeleteSchema: This option deletes the specified custom type from the Inventory service. You can recreate the schema later, if you want.

      Possible values include:
      • "DisableSchema"
      • "DeleteSchema"
    • DryRun — (Boolean)

      Use this option to view a summary of the deletion request without deleting any data or the data type. This option is useful when you only want to understand what will be deleted. Once you validate that the data to be deleted is what you intend to delete, you can run the same command without specifying the DryRun option.

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

      • DeletionId — (String)

        Every DeleteInventory action is assigned a unique ID. This option returns a unique ID. You can use this ID to query the status of a delete operation. This option is useful for ensuring that a delete operation has completed before you begin other actions.

      • TypeName — (String)

        The name of the inventory data type specified in the request.

      • DeletionSummary — (map)

        A summary of the delete operation. For more information about this summary, see Understanding the Delete Inventory Summary in the AWS Systems Manager User Guide.

        • TotalCount — (Integer)

          The total number of items to delete. This count does not change during the delete operation.

        • RemainingCount — (Integer)

          Remaining number of items to delete.

        • SummaryItems — (Array<map>)

          A list of counts and versions for deleted items.

          • Version — (String)

            The inventory type version.

          • Count — (Integer)

            A count of the number of deleted items.

          • RemainingCount — (Integer)

            The remaining number of items to delete.

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.

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

Deletes a Resource Data Sync configuration. After the configuration is deleted, changes to inventory data on managed instances are no longer synced with the target Amazon S3 bucket. Deleting a sync configuration does not delete data in the target Amazon S3 bucket.

Service Reference:

Examples:

Calling the deleteResourceDataSync operation

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

      The name of the configuration 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.

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 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 */
  Safe: true || false
};
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.

    • Safe — (Boolean)

      The system checks if the target is being referenced by a task. If the target is being referenced, the system returns an error and does not deregister the target 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 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

Describes details about the activation, such as the date and time the activation was created, its expiration date, the IAM role assigned to the instances in the activation, and the number of instances registered by using this activation.

Service Reference:

Examples:

Calling the describeActivations operation

var params = {
  Filters: [
    {
      FilterKey: ActivationIds | DefaultInstanceName | IamRole,
      FilterValues: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  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.

        • Tags — (Array<map>)

          Tags assigned to the activation.

          • Keyrequired — (String)

            The name of the tag.

          • Valuerequired — (String)

            The value of the tag.

      • 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 association for the specified target or instance. If you created the association by using the Targets parameter, then you must retrieve the association by using the association ID. If you created the association by specifying an instance ID and a Systems Manager document, then you retrieve the association by specifying the document name and the instance ID.

Service Reference:

Examples:

Calling the describeAssociation operation

var params = {
  AssociationId: 'STRING_VALUE',
  AssociationVersion: '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 Systems Manager document.

    • InstanceId — (String)

      The instance ID.

    • AssociationId — (String)

      The association ID for which you want information.

    • AssociationVersion — (String)

      Specify the association version to retrieve. To view the latest version, either specify $LATEST for this parameter, or omit this parameter. To view a list of all associations for an instance, use ListAssociations. To get a list of versions for a specific association, use ListAssociationVersions.

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 Systems Manager document.

        • InstanceId — (String)

          The ID of the instance.

        • AssociationVersion — (String)

          The association version.

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

        • AutomationTargetParameterName — (String)

          Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.

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

          • Values — (Array<String>)

            User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer.

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

        • AssociationName — (String)

          The association name.

        • MaxErrors — (String)

          The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

          Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

        • MaxConcurrency — (String)

          The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

          If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.

        • ComplianceSeverity — (String)

          The severity level that is assigned to the association.

          Possible values include:
          • "CRITICAL"
          • "HIGH"
          • "MEDIUM"
          • "LOW"
          • "UNSPECIFIED"

Returns:

  • (AWS.Request)

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

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

Use this API action to view all executions for a specific association ID.

Service Reference:

Examples:

Calling the describeAssociationExecutions operation

var params = {
  AssociationId: 'STRING_VALUE', /* required */
  Filters: [
    {
      Key: ExecutionId | Status | CreatedTime, /* required */
      Type: EQUAL | LESS_THAN | GREATER_THAN, /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ssm.describeAssociationExecutions(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 association ID for which you want to view execution history details.

    • Filters — (Array<map>)

      Filters for the request. You can specify the following filters and values.

      ExecutionId (EQUAL)

      Status (EQUAL)

      CreatedTime (EQUAL, GREATER_THAN, LESS_THAN)

      • Keyrequired — (String)

        The key value used in the request.

        Possible values include:
        • "ExecutionId"
        • "Status"
        • "CreatedTime"
      • Valuerequired — (String)

        The value specified for the key.

      • Typerequired — (String)

        The filter type specified in the request.

        Possible values include:
        • "EQUAL"
        • "LESS_THAN"
        • "GREATER_THAN"
    • 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:

      • AssociationExecutions — (Array<map>)

        A list of the executions for the specified association ID.

        • AssociationId — (String)

          The association ID.

        • AssociationVersion — (String)

          The association version.

        • ExecutionId — (String)

          The execution ID for the association.

        • Status — (String)

          The status of the association execution.

        • DetailedStatus — (String)

          Detailed status information about the execution.

        • CreatedTime — (Date)

          The time the execution started.

        • LastExecutionDate — (Date)

          The date of the last execution.

        • ResourceCountByStatus — (String)

          An aggregate status of the resources in the execution based on the status type.

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

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

Use this API action to view information about a specific execution of a specific association.

Examples:

Calling the describeAssociationExecutionTargets operation

var params = {
  AssociationId: 'STRING_VALUE', /* required */
  ExecutionId: 'STRING_VALUE', /* required */
  Filters: [
    {
      Key: Status | ResourceId | ResourceType, /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ssm.describeAssociationExecutionTargets(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 association ID that includes the execution for which you want to view details.

    • ExecutionId — (String)

      The execution ID for which you want to view details.

    • Filters — (Array<map>)

      Filters for the request. You can specify the following filters and values.

      Status (EQUAL)

      ResourceId (EQUAL)

      ResourceType (EQUAL)

      • Keyrequired — (String)

        The key value used in the request.

        Possible values include:
        • "Status"
        • "ResourceId"
        • "ResourceType"
      • Valuerequired — (String)

        The value specified for the 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)

      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:

      • AssociationExecutionTargets — (Array<map>)

        Information about the execution.

        • AssociationId — (String)

          The association ID.

        • AssociationVersion — (String)

          The association version.

        • ExecutionId — (String)

          The execution ID.

        • ResourceId — (String)

          The resource ID, for example, the instance ID where the association ran.

        • ResourceType — (String)

          The resource type, for example, instance.

        • Status — (String)

          The association execution status.

        • DetailedStatus — (String)

          Detailed information about the execution status.

        • LastExecutionDate — (Date)

          The date of the last execution.

        • OutputSource — (map)

          The location where the association details are saved.

          • OutputSourceId — (String)

            The ID of the output source, for example the URL of an Amazon S3 bucket.

          • OutputSourceType — (String)

            The type of source where the association execution details are stored, for example, Amazon S3.

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

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 | ExecutionId | ParentExecutionId | CurrentAction | StartTimeBefore | StartTimeAfter | AutomationType, /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  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)

        One or more keys to limit the results. Valid filter keys include the following: DocumentNamePrefix, ExecutionStatus, ExecutionId, ParentExecutionId, CurrentAction, StartTimeBefore, StartTimeAfter.

        Possible values include:
        • "DocumentNamePrefix"
        • "ExecutionStatus"
        • "ExecutionId"
        • "ParentExecutionId"
        • "CurrentAction"
        • "StartTimeBefore"
        • "StartTimeAfter"
        • "AutomationType"
      • 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"
          • "Waiting"
          • "Success"
          • "TimedOut"
          • "Cancelling"
          • "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 ran 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.

        • Mode — (String)

          The Automation execution mode.

          Possible values include:
          • "Auto"
          • "Interactive"
        • ParentAutomationExecutionId — (String)

          The ExecutionId of the parent Automation.

        • CurrentStepName — (String)

          The name of the step that is currently running.

        • CurrentAction — (String)

          The action of the step that is currently running.

        • FailureMessage — (String)

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

        • TargetParameterName — (String)

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

        • Targets — (Array<map>)

          The targets defined by the user when starting the Automation.

          • Key — (String)

            User-defined criteria for sending commands that target instances that meet the criteria.

          • Values — (Array<String>)

            User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer.

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

          The specified key-value mapping of document parameters to target resources.

        • ResolvedTargets — (map)

          A list of targets that resolved during the execution.

          • ParameterValues — (Array<String>)

            A list of parameter values sent to targets that resolved during the Automation execution.

          • Truncated — (Boolean)

            A boolean value indicating whether the resolved target list is truncated.

        • MaxConcurrency — (String)

          The MaxConcurrency value specified by the user when starting the Automation.

        • MaxErrors — (String)

          The MaxErrors value specified by the user when starting the Automation.

        • Target — (String)

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

        • AutomationType — (String)

          Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount. CrossAccount is an Automation that runs in multiple AWS Regions and accounts. For more information, see Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide.

          Possible values include:
          • "CrossAccount"
          • "Local"
      • 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.

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

Information about all active and terminated step executions in an Automation workflow.

Examples:

Calling the describeAutomationStepExecutions operation

var params = {
  AutomationExecutionId: 'STRING_VALUE', /* required */
  Filters: [
    {
      Key: StartTimeBefore | StartTimeAfter | StepExecutionStatus | StepExecutionId | StepName | Action, /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ReverseOrder: true || false
};
ssm.describeAutomationStepExecutions(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 Automation execution ID for which you want step execution descriptions.

    • Filters — (Array<map>)

      One or more filters to limit the number of step executions returned by the request.

      • Keyrequired — (String)

        One or more keys to limit the results. Valid filter keys include the following: StepName, Action, StepExecutionId, StepExecutionStatus, StartTimeBefore, StartTimeAfter.

        Possible values include:
        • "StartTimeBefore"
        • "StartTimeAfter"
        • "StepExecutionStatus"
        • "StepExecutionId"
        • "StepName"
        • "Action"
      • Valuesrequired — (Array<String>)

        The values of the filter key.

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

    • ReverseOrder — (Boolean)

      A boolean that indicates whether to list step executions in reverse order by start time. The default value is 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:

      • StepExecutions — (Array<map>)

        A list of details about the current state of all steps that make up an execution.

        • StepName — (String)

          The name of this execution step.

        • Action — (String)

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

        • TimeoutSeconds — (Integer)

          The timeout seconds of the step.

        • OnFailure — (String)

          The action to take if the step fails. The default value is Abort.

        • MaxAttempts — (Integer)

          The maximum number of tries to run the action of the step. The default value is 1.

        • 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"
          • "Waiting"
          • "Success"
          • "TimedOut"
          • "Cancelling"
          • "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.

        • StepExecutionId — (String)

          The unique ID of a step execution.

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

          A user-specified list of parameters to override when running a step.

        • IsEnd — (Boolean)

          The flag which can be used to end automation no matter whether the step succeeds or fails.

        • NextStep — (String)

          The next step after the step succeeds.

        • IsCritical — (Boolean)

          The flag which can be used to help decide whether the failure of current step leads to the Automation failure.

        • ValidNextSteps — (Array<String>)

          Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the step fails. Continue will ignore the failure of current step and allow automation to run the next step. With conditional branching, we add step:stepName to support the automation to go to another specific step.

        • Targets — (Array<map>)

          The targets for the step execution.

          • Key — (String)

            User-defined criteria for sending commands that target instances that meet the criteria.

          • Values — (Array<String>)

            User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer.

        • TargetLocation — (map)

          The combination of AWS Regions and accounts targeted by the current Automation execution.

          • Accounts — (Array<String>)

            The AWS accounts targeted by the current Automation execution.

          • Regions — (Array<String>)

            The AWS Regions targeted by the current Automation execution.

          • TargetLocationMaxConcurrency — (String)

            The maximum number of AWS accounts and AWS regions allowed to run the Automation concurrently

          • TargetLocationMaxErrors — (String)

            The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.

          • ExecutionRoleName — (String)

            The Automation execution role used by the currently running Automation.

      • 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 eligible to 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: 'NUMBER_VALUE',
  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 Systems Manager document.

Service Reference:

Examples:

Calling the describeDocument operation

var params = {
  Name: 'STRING_VALUE', /* required */
  DocumentVersion: 'STRING_VALUE',
  VersionName: '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 Systems Manager document.

    • DocumentVersion — (String)

      The document version for which you want information. Can be a specific version or the default version.

    • VersionName — (String)

      An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.

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 Systems Manager document.

        • Sha1 — (String)

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

        • Hash — (String)

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

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

          The hash type of the document. Valid values include Sha256 or Sha1.

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

          The name of the Systems Manager document.

        • VersionName — (String)

          The version of the artifact associated with the document.

        • Owner — (String)

          The AWS user account that created the document.

        • CreatedDate — (Date)

          The date when the document was created.

        • Status — (String)

          The status of the Systems Manager document.

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

          A message returned by AWS Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket does not exist. Verify that the URL of the S3 bucket is correct."

        • 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 Systems Manager document.

        • DocumentType — (String)

          The type of document.

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

          The schema version.

        • LatestVersion — (String)

          The latest version of the document.

        • DefaultVersion — (String)

          The default version.

        • DocumentFormat — (String)

          The document format, either JSON or YAML.

          Possible values include:
          • "YAML"
          • "JSON"
        • TargetType — (String)

          The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see AWS Resource Types Reference in the AWS CloudFormation User Guide.

        • Tags — (Array<map>)

          The tags, or metadata, that have been applied to the document.

          • Keyrequired — (String)

            The name of the tag.

          • Valuerequired — (String)

            The value of the tag.

        • AttachmentsInformation — (Array<map>)

          Details about the document attachments, including names, locations, sizes, etc.

          • Name — (String)

            The name of the attachment.

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: 'NUMBER_VALUE',
  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).

        • AssociationVersion — (String)

          Version information for the association 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.

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

Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Note that this API applies only to Windows patch baselines.

Examples:

Calling the describeEffectivePatchesForPatchBaseline operation

var params = {
  BaselineId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  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"
          • ComplianceLevel — (String)

            The compliance severity level for a patch.

            Possible values include:
            • "CRITICAL"
            • "HIGH"
            • "MEDIUM"
            • "LOW"
            • "INFORMATIONAL"
            • "UNSPECIFIED"
          • 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: 'NUMBER_VALUE',
  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 versions.

        • AssociationVersion — (String)

          The version of the association applied to the instance.

        • InstanceId — (String)

          The instance ID where the association was created.

        • ExecutionDate — (Date)

          The date the instance association ran.

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

        • AssociationName — (String)

          The name of the association applied to 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.

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.

Note: The IamRole field for this API action is the Amazon Identity and Access Management (IAM) role assigned to on-premises instances. This call does not return the IAM role for Amazon EC2 instances.

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: 'NUMBER_VALUE',
  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>)

      This is a legacy method. We recommend that you don't use this method. Instead, use the InstanceInformationFilter action. The InstanceInformationFilter action enables you to return instance information by using tags that are specified as a key-value mapping.

      If you do use this method, then you can't use the InstanceInformationFilter action. Using this method and the InstanceInformationFilter action causes an exception error.

      • 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. You can filter on Amazon EC2 tag. Specify tags by using a key-value mapping.

      • 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 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 SSM Agent running on your Linux instance.

        • IsLatestVersion — (Boolean)

          Indicates whether latest version of SSM Agent is running on your instance. Some older versions of Windows Server use the EC2Config service to process SSM requests. For this reason, this field does not indicate whether or not the latest version is installed on Windows managed instances.

        • 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 the on-premises Systems Manager managed instances. This call does not return the IAM role for Amazon EC2 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 run.

        • 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: 'NUMBER_VALUE',
  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, such as "INSTALLED" or "FAILED")

        InstalledTime (DateTime)

        InstalledBy (string)

        • Titlerequired — (String)

          The title of the patch.

        • KBIdrequired — (String)

          The operating system-specific 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, such as INSTALLED or FAILED.

          For descriptions of each patch state, see About Patch Compliance in the AWS Systems Manager User Guide.

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

          The date/time the patch was installed on the instance. Note that not all operating systems provide this level of information.

      • 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: 'NUMBER_VALUE',
  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.

        • InstallOverrideList — (String)

          An https URL or an Amazon S3 path-style URL to a list of patches to be installed. This patch installation list, which you maintain in an Amazon S3 bucket in YAML format and specify in the SSM document AWS-RunPatchBaseline, overrides the patches specified by the default patch baseline.

          For more information about the InstallOverrideList parameter, see About the SSM Document AWS-RunPatchBaseline in the AWS Systems Manager User Guide.

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

        • InstalledRejectedCount — (Integer)

          The number of instances with patches installed that are specified in a RejectedPatches list. Patches with a status of InstalledRejected were typically installed before they were added to a RejectedPatches list.

          Note: If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value of InstalledRejectedCount will always be 0 (zero).
        • 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.

        • UnreportedNotApplicableCount — (Integer)

          The number of patches beyond the supported limit of NotApplicableCount that are not reported by name to Systems Manager Inventory.

        • NotApplicableCount — (Integer)

          The number of patches from the patch baseline that aren't applicable for the instance and therefore aren't installed on the instance. This number may be truncated if the list of patch names is very large. The number of patches beyond this limit are reported in UnreportedNotApplicableCount.

        • 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: 'NUMBER_VALUE',
  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.

        • InstallOverrideList — (String)

          An https URL or an Amazon S3 path-style URL to a list of patches to be installed. This patch installation list, which you maintain in an Amazon S3 bucket in YAML format and specify in the SSM document AWS-RunPatchBaseline, overrides the patches specified by the default patch baseline.

          For more information about the InstallOverrideList parameter, see About the SSM Document AWS-RunPatchBaseline in the AWS Systems Manager User Guide.

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

        • InstalledRejectedCount — (Integer)

          The number of instances with patches installed that are specified in a RejectedPatches list. Patches with a status of InstalledRejected were typically installed before they were added to a RejectedPatches list.

          Note: If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value of InstalledRejectedCount will always be 0 (zero).
        • 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.

        • UnreportedNotApplicableCount — (Integer)

          The number of patches beyond the supported limit of NotApplicableCount that are not reported by name to Systems Manager Inventory.

        • NotApplicableCount — (Integer)

          The number of patches from the patch baseline that aren't applicable for the instance and therefore aren't installed on the instance. This number may be truncated if the list of patch names is very large. The number of patches beyond this limit are reported in UnreportedNotApplicableCount.

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

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

Describes a specific delete inventory operation.

Service Reference:

Examples:

Calling the describeInventoryDeletions operation

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

      Specify the delete inventory ID for which you want information. This ID was returned by the DeleteInventory action.

    • NextToken — (String)

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

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

      • InventoryDeletions — (Array<map>)

        A list of status items for deleted inventory.

        • DeletionId — (String)

          The deletion ID returned by the DeleteInventory action.

        • TypeName — (String)

          The name of the inventory data type.

        • DeletionStartTime — (Date)

          The UTC timestamp when the delete operation started.

        • LastStatus — (String)

          The status of the operation. Possible values are InProgress and Complete.

          Possible values include:
          • "InProgress"
          • "Complete"
        • LastStatusMessage — (String)

          Information about the status.

        • DeletionSummary — (map)

          Information about the delete operation. For more information about this summary, see Understanding the Delete Inventory Summary in the AWS Systems Manager User Guide.

          • TotalCount — (Integer)

            The total number of items to delete. This count does not change during the delete operation.

          • RemainingCount — (Integer)

            Remaining number of items to delete.

          • SummaryItems — (Array<map>)

            A list of counts and versions for deleted items.

            • Version — (String)

              The inventory type version.

            • Count — (Integer)

              A count of the number of deleted items.

            • RemainingCount — (Integer)

              The remaining number of items to delete.

        • LastStatusUpdateTime — (Date)

          The UTC timestamp of when the last status report.

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

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

Lists the executions of a maintenance window. This includes 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: 'NUMBER_VALUE',
  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 window executions.

        • 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 run 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: 'NUMBER_VALUE',
  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.

        • TaskType — (String)

          The task type.

          Possible values include:
          • "RUN_COMMAND"
          • "AUTOMATION"
          • "STEP_FUNCTIONS"
          • "LAMBDA"
        • Parameters — (String)

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

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

Examples:

Calling the describeMaintenanceWindowExecutionTasks operation

var params = {
  WindowExecutionId: 'STRING_VALUE', /* required */
  Filters: [
    {
      Key: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  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 task that ran.

        • TaskType — (String)

          The type of task that ran.

          Possible values include:
          • "RUN_COMMAND"
          • "AUTOMATION"
          • "STEP_FUNCTIONS"
          • "LAMBDA"
      • 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: 'NUMBER_VALUE',
  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.

        • Description — (String)

          A description of the maintenance window.

        • Enabled — (Boolean)

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

        • Schedule — (String)

          The schedule of the maintenance window in the form of a cron or rate expression.

        • ScheduleTimezone — (String)

          The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.

        • EndDate — (String)

          The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.

        • StartDate — (String)

          The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active.

        • NextExecutionTime — (String)

          The next time the maintenance window will actually run, taking into account any specified times for the maintenance window to become active or inactive.

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

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

Retrieves information about upcoming executions of a maintenance window.

Examples:

Calling the describeMaintenanceWindowSchedule operation

var params = {
  Filters: [
    {
      Key: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ResourceType: INSTANCE | RESOURCE_GROUP,
  Targets: [
    {
      Key: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  WindowId: 'STRING_VALUE'
};
ssm.describeMaintenanceWindowSchedule(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 retrieve information about.

    • Targets — (Array<map>)

      The instance ID or key/value pair to retrieve information about.

      • Key — (String)

        User-defined criteria for sending commands that target instances that meet the criteria.

      • Values — (Array<String>)

        User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer.

    • ResourceType — (String)

      The type of resource you want to retrieve information about. For example, "INSTANCE".

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

      Filters used to limit the range of results. For example, you can limit maintenance window executions to only those scheduled before or after a certain date and time.

      • Key — (String)

        The key for the filter.

      • Values — (Array<String>)

        The value for 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:

      • ScheduledWindowExecutions — (Array<map>)

        Information about maintenance window executions scheduled for the specified time range.

        • WindowId — (String)

          The ID of the maintenance window to be run.

        • Name — (String)

          The name of the maintenance window to be run.

        • ExecutionTime — (String)

          The time, in ISO-8601 Extended format, that the maintenance window is scheduled to be run.

      • NextToken — (String)

        The token for the next set of items to return. (You use this token in the next call.)

Returns:

  • (AWS.Request)

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

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

Retrieves information about the maintenance window targets or tasks that an instance is associated with.

Examples:

Calling the describeMaintenanceWindowsForTarget operation

var params = {
  ResourceType: INSTANCE | RESOURCE_GROUP, /* required */
  Targets: [ /* required */
    {
      Key: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ssm.describeMaintenanceWindowsForTarget(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: {})
    • Targets — (Array<map>)

      The instance ID or key/value pair to retrieve information about.

      • Key — (String)

        User-defined criteria for sending commands that target instances that meet the criteria.

      • Values — (Array<String>)

        User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer.

    • ResourceType — (String)

      The type of resource you want to retrieve information about. For example, "INSTANCE".

      Possible values include:
      • "INSTANCE"
      • "RESOURCE_GROUP"
    • 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 window targets and tasks an instance is associated with.

        • WindowId — (String)

          The ID of the maintenance window.

        • Name — (String)

          The name of the maintenance window.

      • NextToken — (String)

        The token for the next set of items to return. (You use this token in the next call.)

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: 'NUMBER_VALUE',
  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 ID of the maintenance window to register the target with.

        • WindowTargetId — (String)

          The ID of the target.

        • ResourceType — (String)

          The type of target that is being registered with the maintenance window.

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

          The targets, either instances or tags.

          Specify instances using the following format:

          Key=instanceids,Values=<instanceid1>,<instanceid2>

          Tags are specified using the following format:

          Key=<tag name>,Values=<tag value>.

          • Key — (String)

            User-defined criteria for sending commands that target instances that meet the criteria.

          • Values — (Array<String>)

            User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer.

        • OwnerInformation — (String)

          A user-provided value that will be included in any CloudWatch events that are raised while running tasks for these targets in this maintenance window.

        • Name — (String)

          The name for the maintenance window target.

        • Description — (String)

          A description for the target.

      • 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: 'NUMBER_VALUE',
  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 ID of the maintenance window where the task is registered.

        • WindowTaskId — (String)

          The task ID.

        • TaskArn — (String)

          The resource that the task uses during execution. For RUN_COMMAND and AUTOMATION task types, TaskArn is the Systems Manager document name or ARN. For LAMBDA tasks, it's the function name or ARN. For STEP_FUNCTIONS tasks, it's the state machine ARN.

        • Type — (String)

          The type of task. The type can be one of the following: RUN_COMMAND, AUTOMATION, LAMBDA, or STEP_FUNCTIONS.

          Possible values include:
          • "RUN_COMMAND"
          • "AUTOMATION"
          • "STEP_FUNCTIONS"
          • "LAMBDA"
        • 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.

          • Values — (Array<String>)

            User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer.

        • TaskParameters — (map<map>)

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

          Note: TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
          • 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 that have the same priority are scheduled in parallel.

        • LoggingInfo — (map)

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

          Note: LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
          • 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 ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

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

        • Name — (String)

          The task name.

        • Description — (String)

          A description of the task.

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

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

Query a set of OpsItems. You must have permission in AWS Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Getting Started with OpsCenter in the AWS Systems Manager User Guide.

Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.

Service Reference:

Examples:

Calling the describeOpsItems operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  OpsItemFilters: [
    {
      Key: Status | CreatedBy | Source | Priority | Title | OpsItemId | CreatedTime | LastModifiedTime | OperationalData | OperationalDataKey | OperationalDataValue | ResourceId | AutomationId, /* required */
      Operator: Equal | Contains | GreaterThan | LessThan, /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ]
};
ssm.describeOpsItems(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: {})
    • OpsItemFilters — (Array<map>)

      One or more filters to limit the reponse.

      • Key: CreatedTime

        Operations: GreaterThan, LessThan

      • Key: LastModifiedBy

        Operations: Contains, Equals

      • Key: LastModifiedTime

        Operations: GreaterThan, LessThan

      • Key: Priority

        Operations: Equals

      • Key: Source

        Operations: Contains, Equals

      • Key: Status

        Operations: Equals

      • Key: Title

        Operations: Contains

      • Key: OperationalData

        Operations: Equals

      • Key: OperationalDataKey

        Operations: Equals

      • Key: OperationalDataValue

        Operations: Equals, Contains

      • Key: OpsItemId

        Operations: Equals

      • Key: ResourceId

        Operations: Contains

      • Key: AutomationId

        Operations: Equals

      If you filter the response by using the OperationalData operator, specify a key-value pair by using the following JSON format: {"key":"key_name","value":"a_value"}

      • Keyrequired — (String)

        The name of the filter.

        Possible values include:
        • "Status"
        • "CreatedBy"
        • "Source"
        • "Priority"
        • "Title"
        • "OpsItemId"
        • "CreatedTime"
        • "LastModifiedTime"
        • "OperationalData"
        • "OperationalDataKey"
        • "OperationalDataValue"
        • "ResourceId"
        • "AutomationId"
      • Valuesrequired — (Array<String>)

        The filter value.

      • Operatorrequired — (String)

        The operator used by the filter call.

        Possible values include:
        • "Equal"
        • "Contains"
        • "GreaterThan"
        • "LessThan"
    • 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:

      • NextToken — (String)

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

      • OpsItemSummaries — (Array<map>)

        A list of OpsItems.

        • CreatedBy — (String)

          The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.

        • CreatedTime — (Date)

          The date and time the OpsItem was created.

        • LastModifiedBy — (String)

          The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.

        • LastModifiedTime — (Date)

          The date and time the OpsItem was last updated.

        • Priority — (Integer)

          The importance of this OpsItem in relation to other OpsItems in the system.

        • Source — (String)

          The impacted AWS resource.

        • Status — (String)

          The OpsItem status. Status can be Open, In Progress, or Resolved.

          Possible values include:
          • "Open"
          • "InProgress"
          • "Resolved"
        • OpsItemId — (String)

          The ID of the OpsItem.

        • Title — (String)

          A short heading that describes the nature of the OpsItem and the impacted resource.

        • OperationalData — (map<map>)

          Operational data is custom data that provides useful reference details about the OpsItem.

          • Value — (String)

            The value of the OperationalData key.

          • Type — (String)

            The type of key-value pair. Valid types include SearchableString and String.

            Possible values include:
            • "SearchableString"
            • "String"

Returns:

  • (AWS.Request)

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

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

Get information about a parameter.

Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.

Service Reference:

Examples:

Calling the describeParameters operation

var params = {
  Filters: [
    {
      Key: Name | Type | KeyId, /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  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_.-

        • Version — (Integer)

          The parameter version.

        • Tier — (String)

          The parameter tier.

          Possible values include:
          • "Standard"
          • "Advanced"
        • Policies — (Array<map>)

          A list of policies associated with a parameter.

          • PolicyText — (String)

            The JSON text of the policy.

          • PolicyType — (String)

            The type of policy. Parameter Store supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification.

          • PolicyStatus — (String)

            The status of the policy. Policies report the following statuses: Pending (the policy has not been enforced or applied yet), Finished (the policy was applied), Failed (the policy was not applied), or InProgress (the policy is being applied now).

      • 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: 'NUMBER_VALUE',
  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.

        • OperatingSystem — (String)

          Defines the operating system the patch baseline applies to. The Default value is WINDOWS.

          Possible values include:
          • "WINDOWS"
          • "AMAZON_LINUX"
          • "AMAZON_LINUX_2"
          • "UBUNTU"
          • "REDHAT_ENTERPRISE_LINUX"
          • "SUSE"
          • "CENTOS"
        • BaselineDescription — (String)

          The description of the patch baseline.

        • DefaultBaseline — (Boolean)

          Whether this is the default baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.

      • 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 = {
  Filters: [
    {
      Key: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  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).

    • Filters — (Array<map>)

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

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

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.

          • OperatingSystem — (String)

            Defines the operating system the patch baseline applies to. The Default value is WINDOWS.

            Possible values include:
            • "WINDOWS"
            • "AMAZON_LINUX"
            • "AMAZON_LINUX_2"
            • "UBUNTU"
            • "REDHAT_ENTERPRISE_LINUX"
            • "SUSE"
            • "CENTOS"
          • BaselineDescription — (String)

            The description of the patch baseline.

          • DefaultBaseline — (Boolean)

            Whether this is the default baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.

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

      • InstancesWithInstalledRejectedPatches — (Integer)

        The number of instances with patches installed that are specified in a RejectedPatches list. Patches with a status of INSTALLED_REJECTED were typically installed before they were added to a RejectedPatches list.

        Note: If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value of InstancesWithInstalledRejectedPatches will always be 0 (zero).
      • 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.

      • InstancesWithUnreportedNotApplicablePatches — (Integer)

        The number of instances with NotApplicable patches beyond the supported limit, which are not reported by name to Systems Manager Inventory.

Returns:

  • (AWS.Request)

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

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

Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for actions such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.

The following section lists the properties that can be used in filters for each major operating system type:

WINDOWS

Valid properties: PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, MSRC_SEVERITY

AMAZON_LINUX

Valid properties: PRODUCT, CLASSIFICATION, SEVERITY

AMAZON_LINUX_2

Valid properties: PRODUCT, CLASSIFICATION, SEVERITY

UBUNTU

Valid properties: PRODUCT, PRIORITY

REDHAT_ENTERPRISE_LINUX

Valid properties: PRODUCT, CLASSIFICATION, SEVERITY

SUSE

Valid properties: PRODUCT, CLASSIFICATION, SEVERITY

CENTOS

Valid properties: PRODUCT, CLASSIFICATION, SEVERITY

Service Reference:

Examples:

Calling the describePatchProperties operation

var params = {
  OperatingSystem: WINDOWS | AMAZON_LINUX | AMAZON_LINUX_2 | UBUNTU | REDHAT_ENTERPRISE_LINUX | SUSE | CENTOS, /* required */
  Property: PRODUCT | PRODUCT_FAMILY | CLASSIFICATION | MSRC_SEVERITY | PRIORITY | SEVERITY, /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  PatchSet: OS | APPLICATION
};
ssm.describePatchProperties(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: {})
    • OperatingSystem — (String)

      The operating system type for which to list patches.

      Possible values include:
      • "WINDOWS"
      • "AMAZON_LINUX"
      • "AMAZON_LINUX_2"
      • "UBUNTU"
      • "REDHAT_ENTERPRISE_LINUX"
      • "SUSE"
      • "CENTOS"
    • Property — (String)

      The patch property for which you want to view patch details.

      Possible values include:
      • "PRODUCT"
      • "PRODUCT_FAMILY"
      • "CLASSIFICATION"
      • "MSRC_SEVERITY"
      • "PRIORITY"
      • "SEVERITY"
    • PatchSet — (String)

      Indicates whether to list patches for the Windows operating system or for Microsoft applications. Not applicable for Linux operating systems.

      Possible values include:
      • "OS"
      • "APPLICATION"
    • 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:

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

        A list of the properties for patches matching the filter request parameters.

      • NextToken — (String)

        The token for the next set of items to return. (You use this token in the next call.)

Returns:

  • (AWS.Request)

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

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

Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.

Service Reference:

Examples:

Calling the describeSessions operation

var params = {
  State: Active | History, /* required */
  Filters: [
    {
      key: InvokedAfter | InvokedBefore | Target | Owner | Status, /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ssm.describeSessions(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: {})
    • State — (String)

      The session status to retrieve a list of sessions for. For example, "Active".

      Possible values include:
      • "Active"
      • "History"
    • 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.)

    • Filters — (Array<map>)

      One or more filters to limit the type of sessions returned by the request.

      • keyrequired — (String)

        The name of the filter.

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

        The filter value. Valid values for each filter key are as follows:

        • InvokedAfter: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started August 29, 2018, and later.

        • InvokedBefore: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started before August 29, 2018.

        • Target: Specify an instance to which session connections have been made.

        • Owner: Specify an AWS user account to see a list of sessions started by that user.

        • Status: Specify a valid session status to see a list of all sessions with that status. Status values you can specify include:

          • Connected

          • Connecting

          • Disconnected

          • Terminated

          • Terminating

          • Failed

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:

      • Sessions — (Array<map>)

        A list of sessions meeting the request parameters.

        • SessionId — (String)

          The ID of the session.

        • Target — (String)

          The instance that the Session Manager session connected to.

        • Status — (String)

          The status of the session. For example, "Connected" or "Terminated".

          Possible values include:
          • "Connected"
          • "Connecting"
          • "Disconnected"
          • "Terminated"
          • "Terminating"
          • "Failed"
        • StartDate — (Date)

          The date and time, in ISO-8601 Extended format, when the session began.

        • EndDate — (Date)

          The date and time, in ISO-8601 Extended format, when the session was terminated.

        • DocumentName — (String)

          The name of the Session Manager SSM document used to define the parameters and plugin settings for the session. For example, SSM-SessionManagerRunShell.

        • Owner — (String)

          The ID of the AWS user account that started the session.

        • Details — (String)

          Reserved for future use.

        • OutputUrl — (map)

          Reserved for future use.

          • S3OutputUrl — (String)

            Reserved for future use.

          • CloudWatchOutputUrl — (String)

            Reserved for future use.

      • NextToken — (String)

        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.

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"
          • "Waiting"
          • "Success"
          • "TimedOut"
          • "Cancelling"
          • "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 run 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.

          • TimeoutSeconds — (Integer)

            The timeout seconds of the step.

          • OnFailure — (String)

            The action to take if the step fails. The default value is Abort.

          • MaxAttempts — (Integer)

            The maximum number of tries to run the action of the step. The default value is 1.

          • 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"
            • "Waiting"
            • "Success"
            • "TimedOut"
            • "Cancelling"
            • "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.

          • StepExecutionId — (String)

            The unique ID of a step execution.

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

            A user-specified list of parameters to override when running a step.

          • IsEnd — (Boolean)

            The flag which can be used to end automation no matter whether the step succeeds or fails.

          • NextStep — (String)

            The next step after the step succeeds.

          • IsCritical — (Boolean)

            The flag which can be used to help decide whether the failure of current step leads to the Automation failure.

          • ValidNextSteps — (Array<String>)

            Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the step fails. Continue will ignore the failure of current step and allow automation to run the next step. With conditional branching, we add step:stepName to support the automation to go to another specific step.

          • Targets — (Array<map>)

            The targets for the step execution.

            • Key — (String)

              User-defined criteria for sending commands that target instances that meet the criteria.

            • Values — (Array<String>)

              User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer.

          • TargetLocation — (map)

            The combination of AWS Regions and accounts targeted by the current Automation execution.

            • Accounts — (Array<String>)

              The AWS accounts targeted by the current Automation execution.

            • Regions — (Array<String>)

              The AWS Regions targeted by the current Automation execution.

            • TargetLocationMaxConcurrency — (String)

              The maximum number of AWS accounts and AWS regions allowed to run the Automation concurrently

            • TargetLocationMaxErrors — (String)

              The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.

            • ExecutionRoleName — (String)

              The Automation execution role used by the currently running Automation.

        • StepExecutionsTruncated — (Boolean)

          A boolean value that indicates if the response contains the full list of the Automation step executions. If true, use the DescribeAutomationStepExecutions API action to get the full list of step executions.

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

        • Mode — (String)

          The automation execution mode.

          Possible values include:
          • "Auto"
          • "Interactive"
        • ParentAutomationExecutionId — (String)

          The AutomationExecutionId of the parent automation.

        • ExecutedBy — (String)

          The Amazon Resource Name (ARN) of the user who ran the automation.

        • CurrentStepName — (String)

          The name of the step that is currently running.

        • CurrentAction — (String)

          The action of the step that is currently running.

        • TargetParameterName — (String)

          The parameter name.

        • Targets — (Array<map>)

          The specified targets.

          • Key — (String)

            User-defined criteria for sending commands that target instances that meet the criteria.

          • Values — (Array<String>)

            User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer.

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

          The specified key-value mapping of document parameters to target resources.

        • ResolvedTargets — (map)

          A list of resolved targets in the rate control execution.

          • ParameterValues — (Array<String>)

            A list of parameter values sent to targets that resolved during the Automation execution.

          • Truncated — (Boolean)

            A boolean value indicating whether the resolved target list is truncated.

        • MaxConcurrency — (String)

          The MaxConcurrency value specified by the user when the execution started.

        • MaxErrors — (String)

          The MaxErrors value specified by the user when the execution started.

        • Target — (String)

          The target of the execution.

        • TargetLocations — (Array<map>)

          The combination of AWS Regions and/or AWS accounts where you want to run the Automation.

          • Accounts — (Array<String>)

            The AWS accounts targeted by the current Automation execution.

          • Regions — (Array<String>)

            The AWS Regions targeted by the current Automation execution.

          • TargetLocationMaxConcurrency — (String)

            The maximum number of AWS accounts and AWS regions allowed to run the Automation concurrently

          • TargetLocationMaxErrors — (String)

            The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.

          • ExecutionRoleName — (String)

            The Automation execution role used by the currently running Automation.

        • ProgressCounters — (map)

          An aggregate of step execution statuses displayed in the AWS Console for a multi-Region and multi-account Automation execution.

          • TotalSteps — (Integer)

            The total number of steps run in all specified AWS Regions and accounts for the current Automation execution.

          • SuccessSteps — (Integer)

            The total number of steps that successfully completed in all specified AWS Regions and accounts for the current Automation execution.

          • FailedSteps — (Integer)

            The total number of steps that failed to run in all specified AWS Regions and accounts for the current Automation execution.

          • CancelledSteps — (Integer)

            The total number of steps that the system cancelled in all specified AWS Regions and accounts for the current Automation execution.

          • TimedOutSteps — (Integer)

            The total number of steps that timed out in all specified AWS Regions and accounts for the current Automation execution.

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 run. For example, AWS-RunShellScript.

      • DocumentVersion — (String)

        The SSM document version used in the request.

      • 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 running on the instance, or it was not received by the instance.

      • ExecutionStartDateTime — (String)

        The date and time the plugin started running. 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 run, the string is empty.

      • ExecutionElapsedTime — (String)

        Duration since ExecutionStartDateTime.

      • ExecutionEndDateTime — (String)

        The date and time the plugin was finished running. 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 run, the string is empty.

      • Status — (String)

        The status of this invocation plugin. 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 Understanding Command Statuses in the AWS Systems Manager User Guide. 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 run 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 run 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 run 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 running, 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 running, 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 running, then this string is empty.

      • CloudWatchOutputConfig — (map)

        CloudWatch Logs information where Systems Manager sent the command output.

        • CloudWatchLogGroupName — (String)

          The name of the CloudWatch log group where you want to send command output. If you don't specify a group name, Systems Manager automatically creates a log group for you. The log group uses the following naming format: aws/ssm/SystemsManagerDocumentName.

        • CloudWatchOutputEnabled — (Boolean)

          Enables Systems Manager to send command output to CloudWatch Logs.

Returns:

  • (AWS.Request)

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

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

Retrieves the Session Manager connection status for an instance to determine whether it is connected and ready to receive Session Manager connections.

Service Reference:

Examples:

Calling the getConnectionStatus operation

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

      The ID of the instance.

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:

      • Target — (String)

        The ID of the instance to check connection status.

      • Status — (String)

        The status of the connection to the instance. For example, 'Connected' or 'Not Connected'.

        Possible values include:
        • "Connected"
        • "NotConnected"

Returns:

  • (AWS.Request)

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

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

Retrieves the default patch baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.

If you do not specify an operating system value, the default patch baseline for Windows is returned.

Service Reference:

Examples:

Calling the getDefaultPatchBaseline operation

var params = {
  OperatingSystem: WINDOWS | AMAZON_LINUX | AMAZON_LINUX_2 | UBUNTU | REDHAT_ENTERPRISE_LINUX | SUSE | CENTOS
};
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: {})
    • OperatingSystem — (String)

      Returns the default patch baseline for the specified operating system.

      Possible values include:
      • "WINDOWS"
      • "AMAZON_LINUX"
      • "AMAZON_LINUX_2"
      • "UBUNTU"
      • "REDHAT_ENTERPRISE_LINUX"
      • "SUSE"
      • "CENTOS"

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.

      • OperatingSystem — (String)

        The operating system for the returned patch baseline.

        Possible values include:
        • "WINDOWS"
        • "AMAZON_LINUX"
        • "AMAZON_LINUX_2"
        • "UBUNTU"
        • "REDHAT_ENTERPRISE_LINUX"
        • "SUSE"
        • "CENTOS"

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

      • Product — (String)

        Returns the specific operating system (for example Windows Server 2012 or Amazon Linux 2015.09) on the instance for the specified 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 Systems Manager document.

Service Reference:

Examples:

Calling the getDocument operation

var params = {
  Name: 'STRING_VALUE', /* required */
  DocumentFormat: YAML | JSON,
  DocumentVersion: 'STRING_VALUE',
  VersionName: '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 Systems Manager document.

    • VersionName — (String)

      An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.

    • DocumentVersion — (String)

      The document version for which you want information.

    • DocumentFormat — (String)

      Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.

      Possible values include:
      • "YAML"
      • "JSON"

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 Systems Manager document.

      • VersionName — (String)

        The version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.

      • DocumentVersion — (String)

        The document version.

      • Status — (String)

        The status of the Systems Manager document, such as Creating, Active, Updating, Failed, and Deleting.

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

        A message returned by AWS Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket does not exist. Verify that the URL of the S3 bucket is correct."

      • Content — (String)

        The contents of the Systems Manager document.

      • DocumentType — (String)

        The document type.

        Possible values include:
        • "Command"
        • "Policy"
        • "Automation"
        • "Session"
        • "Package"
      • DocumentFormat — (String)

        The document format, either JSON or YAML.

        Possible values include:
        • "YAML"
        • "JSON"
      • AttachmentsContent — (Array<map>)

        A description of the document attachments, including names, locations, sizes, etc.

        • Name — (String)

          The name of an attachment.

        • Size — (Integer)

          The size of an attachment in bytes.

        • Hash — (String)

          The cryptographic hash value of the document content.

        • HashType — (String)

          The hash algorithm used to calculate the hash value.

          Possible values include:
          • "Sha256"
        • Url — (String)

          The URL location of the attachment content.

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 = {
  Aggregators: [ /* InventoryAggregatorList */
    {
      Aggregators: /* recursive InventoryAggregatorList */,
      Expression: 'STRING_VALUE',
      Groups: [
        {
          Filters: [ /* required */
            {
              Key: 'STRING_VALUE', /* required */
              Values: [ /* required */
                'STRING_VALUE',
                /* more items */
              ],
              Type: Equal | NotEqual | BeginWith | LessThan | GreaterThan | Exists
            },
            /* more items */
          ],
          Name: 'STRING_VALUE' /* required */
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  Filters: [
    {
      Key: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      Type: Equal | NotEqual | BeginWith | LessThan | GreaterThan | Exists
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  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"
        • "Exists"
    • Aggregators — (Array<map>)

      Returns counts of inventory types based on one or more expressions. For example, if you aggregate by using an expression that uses the AWS:InstanceInformation.PlatformType type, you can see a count of how many Windows and Linux instances exist in your inventoried fleet.

      • Expression — (String)

        The inventory type and attribute name for aggregation.

      • Aggregators — (Array<map>)

        Nested aggregators to further refine aggregation for an inventory type.

      • Groups — (Array<map>)

        A user-defined set of one or more filters on which to aggregate inventory data. Groups return a count of resources that match and don't match the specified criteria.

        • Namerequired — (String)

          The name of the group.

        • Filtersrequired — (Array<map>)

          Filters define the criteria for the group. The matchingCount field displays the number of resources that match the criteria. The notMatchingCount field displays the number of resources that don't match the criteria.

          • 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"
            • "Exists"
    • 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 = {
  Aggregator: true || false,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SubType: true || false,
  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.

    • Aggregator — (Boolean)

      Returns inventory schemas that support aggregation. For example, this call returns the AWS:InstanceInformation type, because it supports aggregation based on the PlatformName, PlatformType, and PlatformVersion attributes.

    • SubType — (Boolean)

      Returns the sub-type schema for a specified 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. 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"
        • DisplayName — (String)

          The alias name of the inventory type. The alias name is used for display purposes.

      • 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 maintenance window for which you want to retrieve 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:

      • WindowId — (String)

        The ID of the created maintenance window.

      • Name — (String)

        The name of the maintenance window.

      • Description — (String)

        The description of the maintenance window.

      • StartDate — (String)

        The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. The maintenance window will not run before this specified time.

      • EndDate — (String)

        The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive. The maintenance window will not run after this specified time.

      • Schedule — (String)

        The schedule of the maintenance window in the form of a cron or rate expression.

      • ScheduleTimezone — (String)

        The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.

      • NextExecutionTime — (String)

        The next time the maintenance window will actually run, taking into account any specified times for the maintenance window to become active or inactive.

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

        Indicates whether the maintenance window 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 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 running.

      • EndTime — (Date)

        The time the maintenance window finished running.

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 run 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 task that ran.

      • ServiceRole — (String)

        The role that was assumed when running the task.

      • Type — (String)

        The type of task that was run.

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

        The parameters passed to the task when it was run.

        Note: TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

        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.

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

Retrieves information about a specific task running on a specific target.

Examples:

Calling the getMaintenanceWindowExecutionTaskInvocation operation

var params = {
  InvocationId: 'STRING_VALUE', /* required */
  TaskId: 'STRING_VALUE', /* required */
  WindowExecutionId: 'STRING_VALUE' /* required */
};
ssm.getMaintenanceWindowExecutionTaskInvocation(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 for which the task is a part.

    • TaskId — (String)

      The ID of the specific task in the maintenance window task that should be retrieved.

    • InvocationId — (String)

      The invocation ID 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:

      • WindowExecutionId — (String)

        The maintenance window execution ID.

      • TaskExecutionId — (String)

        The task execution ID.

      • InvocationId — (String)

        The invocation ID.

      • ExecutionId — (String)

        The execution ID.

      • TaskType — (String)

        Retrieves the task type for a maintenance window. Task types include the following: LAMBDA, STEP_FUNCTIONS, AUTOMATION, RUN_COMMAND.

        Possible values include:
        • "RUN_COMMAND"
        • "AUTOMATION"
        • "STEP_FUNCTIONS"
        • "LAMBDA"
      • Parameters — (String)

        The parameters used at the time that the task ran.

      • Status — (String)

        The task status for an invocation.

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

        The details explaining the status. Details are only available for certain status values.

      • StartTime — (Date)

        The time that the task started running on the target.

      • EndTime — (Date)

        The time that the task finished running on the target.

      • OwnerInformation — (String)

        User-provided value to be included in any CloudWatch events raised while running tasks for these targets in this maintenance window.

      • WindowTargetId — (String)

        The maintenance window target ID.

Returns:

  • (AWS.Request)

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

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

Lists the tasks in a maintenance window.

Service Reference:

Examples:

Calling the getMaintenanceWindowTask operation

var params = {
  WindowId: 'STRING_VALUE', /* required */
  WindowTaskId: 'STRING_VALUE' /* required */
};
ssm.getMaintenanceWindowTask(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 maintenance window ID that includes the task to retrieve.

    • WindowTaskId — (String)

      The maintenance window task ID 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:

      • WindowId — (String)

        The retrieved maintenance window ID.

      • WindowTaskId — (String)

        The retrieved maintenance window task ID.

      • Targets — (Array<map>)

        The targets where the task should run.

        • Key — (String)

          User-defined criteria for sending commands that target instances that meet the criteria.

        • Values — (Array<String>)

          User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer.

      • TaskArn — (String)

        The resource that the task used during execution. For RUN_COMMAND and AUTOMATION task types, the TaskArn is the Systems Manager Document name/ARN. For LAMBDA tasks, the value is the function name/ARN. For STEP_FUNCTIONS tasks, the value is the state machine ARN.

      • ServiceRoleArn — (String)

        The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

      • TaskType — (String)

        The type of task to run.

        Possible values include:
        • "RUN_COMMAND"
        • "AUTOMATION"
        • "STEP_FUNCTIONS"
        • "LAMBDA"
      • TaskParameters — (map<map>)

        The parameters to pass to the task when it runs.

        Note: TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
        • Values — (Array<String>)

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

      • TaskInvocationParameters — (map)

        The parameters to pass to the task when it runs.

        • RunCommand — (map)

          The parameters for a RUN_COMMAND task type.

          • Comment — (String)

            Information about the commands to run.

          • DocumentHash — (String)

            The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.

          • DocumentHashType — (String)

            SHA-256 or SHA-1. SHA-1 hashes have been deprecated.

            Possible values include:
            • "Sha256"
            • "Sha1"
          • NotificationConfig — (map)

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

            • NotificationArn — (String)

              An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon 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 Configuring Amazon SNS Notifications for AWS Systems Manager in the AWS 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"
          • OutputS3BucketName — (String)

            The name of the Amazon S3 bucket.

          • OutputS3KeyPrefix — (String)

            The Amazon S3 bucket subfolder.

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

            The parameters for the RUN_COMMAND task execution.

          • ServiceRoleArn — (String)

            The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

          • TimeoutSeconds — (Integer)

            If this time is reached and the command has not already started running, it doesn't run.

        • Automation — (map)

          The parameters for an AUTOMATION task type.

          • DocumentVersion — (String)

            The version of an Automation document to use during task execution.

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

            The parameters for the AUTOMATION task.

            For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.

            Note: LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters. TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters. For AUTOMATION task types, Systems Manager ignores any values specified for these parameters.
        • StepFunctions — (map)

          The parameters for a STEP_FUNCTIONS task type.

          • Input — (String)

            The inputs for the STEP_FUNCTIONS task.

          • Name — (String)

            The name of the STEP_FUNCTIONS task.

        • Lambda — (map)

          The parameters for a LAMBDA task type.

          • ClientContext — (String)

            Pass client-specific information to the Lambda function that you are invoking. You can then process the client information in your Lambda function as you choose through the context variable.

          • Qualifier — (String)

            (Optional) Specify a Lambda function version or alias name. If you specify a function version, the action uses the qualified function ARN to invoke a specific Lambda function. If you specify an alias name, the action uses the alias ARN to invoke the Lambda function version to which the alias points.

          • Payload — (Buffer, Typed Array, Blob, String)

            JSON to provide to your Lambda function as input.

      • Priority — (Integer)

        The priority of the task when it runs. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.

      • MaxConcurrency — (String)

        The maximum number of targets allowed to run this task in parallel.

      • MaxErrors — (String)

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

      • LoggingInfo — (map)

        The location in Amazon S3 where the task results are logged.

        Note: LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
        • 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.

      • Name — (String)

        The retrieved task name.

      • Description — (String)

        The retrieved task description.

Returns:

  • (AWS.Request)

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

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

Get information about an OpsItem by using the ID. You must have permission in AWS Identity and Access Management (IAM) to view information about an OpsItem. For more information, see Getting Started with OpsCenter in the AWS Systems Manager User Guide.

Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.

Service Reference:

Examples:

Calling the getOpsItem operation

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

      The ID of the OpsItem that you want to get.

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:

      • OpsItem — (map)

        The OpsItem.

        • CreatedBy — (String)

          The ARN of the AWS account that created the OpsItem.

        • CreatedTime — (Date)

          The date and time the OpsItem was created.

        • Description — (String)

          The OpsItem description.

        • LastModifiedBy — (String)

          The ARN of the AWS account that last updated the OpsItem.

        • LastModifiedTime — (Date)

          The date and time the OpsItem was last updated.

        • Notifications — (Array<map>)

          The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.

          • Arn — (String)

            The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.

        • Priority — (Integer)

          The importance of this OpsItem in relation to other OpsItems in the system.

        • RelatedOpsItems — (Array<map>)

          One or more OpsItems that share something in common with the current OpsItem. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.

          • OpsItemIdrequired — (String)

            The ID of an OpsItem related to the current OpsItem.

        • Status — (String)

          The OpsItem status. Status can be Open, In Progress, or Resolved. For more information, see Editing OpsItem Details in the AWS Systems Manager User Guide.

          Possible values include:
          • "Open"
          • "InProgress"
          • "Resolved"
        • OpsItemId — (String)

          The ID of the OpsItem.

        • Version — (String)

          The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.

        • Title — (String)

          A short heading that describes the nature of the OpsItem and the impacted resource.

        • Source — (String)

          The origin of the OpsItem, such as Amazon EC2 or AWS Systems Manager. The impacted resource is a subset of source.

        • OperationalData — (map<map>)

          Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.

          Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm.

          You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API action) can view and search on the specified data. Operational data that is not searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API action).

          Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view AWS CLI example commands that use these keys, see Creating OpsItems Manually in the AWS Systems Manager User Guide.

          • Value — (String)

            The value of the OperationalData key.

          • Type — (String)

            The type of key-value pair. Valid types include SearchableString and String.

            Possible values include:
            • "SearchableString"
            • "String"

Returns:

  • (AWS.Request)

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

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

View a summary of OpsItems based on specified filters and aggregators.

Service Reference:

Examples:

Calling the getOpsSummary operation

var params = {
  Aggregators: [ /* OpsAggregatorList */ /* required */
    {
      AggregatorType: 'STRING_VALUE',
      Aggregators: /* recursive OpsAggregatorList */,
      AttributeName: 'STRING_VALUE',
      Filters: [
        {
          Key: 'STRING_VALUE', /* required */
          Values: [ /* required */
            'STRING_VALUE',
            /* more items */
          ],
          Type: Equal | NotEqual | BeginWith | LessThan | GreaterThan | Exists
        },
        /* more items */
      ],
      TypeName: 'STRING_VALUE',
      Values: {
        '<OpsAggregatorValueKey>': 'STRING_VALUE',
        /* '<OpsAggregatorValueKey>': ... */
      }
    },
    /* more items */
  ],
  Filters: [
    {
      Key: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      Type: Equal | NotEqual | BeginWith | LessThan | GreaterThan | Exists
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ssm.getOpsSummary(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 scope down the returned OpsItems.

      • Keyrequired — (String)

        The name of the filter.

      • Valuesrequired — (Array<String>)

        The filter value.

      • Type — (String)

        The type of filter.

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

      Optional aggregators that return counts of OpsItems based on one or more expressions.

      • AggregatorType — (String)

        Either a Range or Count aggregator for limiting an OpsItem summary.

      • TypeName — (String)

        The data type name to use for viewing counts of OpsItems.

      • AttributeName — (String)

        The name of an OpsItem attribute on which to limit the count of OpsItems.

      • Values — (map<String>)

        The aggregator value.

      • Filters — (Array<map>)

        The aggregator filters.

        • Keyrequired — (String)

          The name of the filter.

        • Valuesrequired — (Array<String>)

          The filter value.

        • Type — (String)

          The type of filter.

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

        A nested aggregator for viewing counts of OpsItems.

    • NextToken — (String)

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

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

        The list of aggregated and filtered OpsItems.

        • Id — (String)

          The query ID.

        • Data — (map<map>)

          The data returned by the query.

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

            The detailed data content for an OpsItem summaries result item.

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

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

Get information about a parameter by using the parameter name. Don't confuse this API action with the GetParameters API action.

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.

        • Version — (Integer)

          The parameter version.

        • Selector — (String)

          Either the version number or the label used to retrieve the parameter value. Specify selectors by using one of the following formats:

          parameter_name:version

          parameter_name:label

        • SourceResult — (String)

          Applies to parameters that reference information in other AWS services. SourceResult is the raw result or response from the source.

        • LastModifiedDate — (Date)

          Date the parameter was last changed or updated and the parameter version was created.

        • ARN — (String)

          The Amazon Resource Name (ARN) of the parameter.

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: 'NUMBER_VALUE',
  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_.-

        • Version — (Integer)

          The parameter version.

        • Labels — (Array<String>)

          Labels assigned to the parameter version.

        • Tier — (String)

          The parameter tier.

          Possible values include:
          • "Standard"
          • "Advanced"
        • Policies — (Array<map>)

          Information about the policies assigned to a parameter.

          Working with Parameter Policies in the AWS Systems Manager User Guide.

          • PolicyText — (String)

            The JSON text of the policy.

          • PolicyType — (String)

            The type of policy. Parameter Store supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification.

          • PolicyStatus — (String)

            The status of the policy. Policies report the following statuses: Pending (the policy has not been enforced or applied yet), Finished (the policy was applied), Failed (the policy was not applied), or InProgress (the policy is being applied now).

      • 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. Don't confuse this API action with the GetParameter API action.

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.

        • Version — (Integer)

          The parameter version.

        • Selector — (String)

          Either the version number or the label used to retrieve the parameter value. Specify selectors by using one of the following formats:

          parameter_name:version

          parameter_name:label

        • SourceResult — (String)

          Applies to parameters that reference information in other AWS services. SourceResult is the raw result or response from the source.

        • LastModifiedDate — (Date)

          Date the parameter was last changed or updated and the parameter version was created.

        • ARN — (String)

          The Amazon Resource Name (ARN) of the parameter.

      • InvalidParameters — (Array<String>)

        A list of parameters that are not formatted correctly or do not run during an execution.

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 Working with Systems Manager Parameters in the AWS Systems Manager User Guide.

Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.

Note: This API action doesn't support filtering by tags.

Service Reference:

Examples:

Calling the getParametersByPath operation

var params = {
  Path: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  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 parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33

    • Recursive — (Boolean)

      Retrieve all parameters within a hierarchy.

      If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path /a, then the user can also access /a/b. Even if a user has explicitly been denied access in IAM for parameter /a/b, they can still call the GetParametersByPath API action recursively for /a and view /a/b.

    • ParameterFilters — (Array<map>)

      Filters to limit the request results.

      Note: You can't filter using the parameter name.
      • 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.

        • Version — (Integer)

          The parameter version.

        • Selector — (String)

          Either the version number or the label used to retrieve the parameter value. Specify selectors by using one of the following formats:

          parameter_name:version

          parameter_name:label

        • SourceResult — (String)

          Applies to parameters that reference information in other AWS services. SourceResult is the raw result or response from the source.

        • LastModifiedDate — (Date)

          Date the parameter was last changed or updated and the parameter version was created.

        • ARN — (String)

          The Amazon Resource Name (ARN) of the parameter.

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

      • OperatingSystem — (String)

        Returns the operating system specified for the patch baseline.

        Possible values include:
        • "WINDOWS"
        • "AMAZON_LINUX"
        • "AMAZON_LINUX_2"
        • "UBUNTU"
        • "REDHAT_ENTERPRISE_LINUX"
        • "SUSE"
        • "CENTOS"
      • 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.

            Run the DescribePatchProperties command to view lists of valid keys for each operating system type.

            Possible values include:
            • "PATCH_SET"
            • "PRODUCT"
            • "PRODUCT_FAMILY"
            • "CLASSIFICATION"
            • "MSRC_SEVERITY"
            • "PATCH_ID"
            • "SECTION"
            • "PRIORITY"
            • "SEVERITY"
          • Valuesrequired — (Array<String>)

            The value for the filter key.

            Run the DescribePatchProperties command to view lists of valid values for each key based on operating system type.

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

                Run the DescribePatchProperties command to view lists of valid keys for each operating system type.

                Possible values include:
                • "PATCH_SET"
                • "PRODUCT"
                • "PRODUCT_FAMILY"
                • "CLASSIFICATION"
                • "MSRC_SEVERITY"
                • "PATCH_ID"
                • "SECTION"
                • "PRIORITY"
                • "SEVERITY"
              • Valuesrequired — (Array<String>)

                The value for the filter key.

                Run the DescribePatchProperties command to view lists of valid values for each key based on operating system type.

          • ComplianceLevel — (String)

            A compliance severity level for all approved patches in a patch baseline. Valid compliance severity levels include the following: Unspecified, Critical, High, Medium, Low, and Informational.

            Possible values include:
            • "CRITICAL"
            • "HIGH"
            • "MEDIUM"
            • "LOW"
            • "INFORMATIONAL"
            • "UNSPECIFIED"
          • ApproveAfterDaysrequired — (Integer)

            The number of days after the release date of each patch matched by the rule that the patch is marked as approved in the patch baseline. For example, a value of 7 means that patches are approved seven days after they are released.

          • EnableNonSecurity — (Boolean)

            For instances identified by the approval rule filters, enables a patch baseline to apply non-security updates available in the specified repository. The default value is 'false'. Applies to Linux instances only.

      • ApprovedPatches — (Array<String>)

        A list of explicitly approved patches for the baseline.

      • ApprovedPatchesComplianceLevel — (String)

        Returns the specified compliance severity level for approved patches in the patch baseline.

        Possible values include:
        • "CRITICAL"
        • "HIGH"
        • "MEDIUM"
        • "LOW"
        • "INFORMATIONAL"
        • "UNSPECIFIED"
      • ApprovedPatchesEnableNonSecurity — (Boolean)

        Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.

      • RejectedPatches — (Array<String>)

        A list of explicitly rejected patches for the baseline.

      • RejectedPatchesAction — (String)

        The action specified to take on patches included in the RejectedPatches list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency.

        Possible values include:
        • "ALLOW_AS_DEPENDENCY"
        • "BLOCK"
      • 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.

      • Sources — (Array<map>)

        Information about the patches to use to update the instances, including target operating systems and source repositories. Applies to Linux instances only.

        • Namerequired — (String)

          The name specified to identify the patch source.

        • Productsrequired — (Array<String>)

          The specific operating system versions a patch repository applies to, such as "Ubuntu16.04", "AmazonLinux2016.09", "RedhatEnterpriseLinux7.2" or "Suse12.7". For lists of supported product values, see PatchFilter.

        • Configurationrequired — (String)

          The value of the yum repo configuration. For example:

          [main]

          cachedir=/var/cache/yum/$basesearch$releasever

          keepcache=0

          debuglevel=2

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 */
  OperatingSystem: WINDOWS | AMAZON_LINUX | AMAZON_LINUX_2 | UBUNTU | REDHAT_ENTERPRISE_LINUX | SUSE | CENTOS
};
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.

    • OperatingSystem — (String)

      Returns he operating system rule specified for patch groups using the patch baseline.

      Possible values include:
      • "WINDOWS"
      • "AMAZON_LINUX"
      • "AMAZON_LINUX_2"
      • "UBUNTU"
      • "REDHAT_ENTERPRISE_LINUX"
      • "SUSE"
      • "CENTOS"

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.

      • OperatingSystem — (String)

        The operating system rule specified for patch groups using the patch baseline.

        Possible values include:
        • "WINDOWS"
        • "AMAZON_LINUX"
        • "AMAZON_LINUX_2"
        • "UBUNTU"
        • "REDHAT_ENTERPRISE_LINUX"
        • "SUSE"
        • "CENTOS"

Returns:

  • (AWS.Request)

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

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

ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature.

Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the UpdateServiceSetting API action to change the default setting. Or use the ResetServiceSetting to change the value back to the original value defined by the AWS service team.

Query the current service setting for the account.

Service Reference:

Examples:

Calling the getServiceSetting operation

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

      The ID of the service setting to get.

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:

      • ServiceSetting — (map)

        The query result of the current service setting.

        • SettingId — (String)

          The ID of the service setting.

        • SettingValue — (String)

          The value of the service setting.

        • LastModifiedDate — (Date)

          The last time the service setting was modified.

        • LastModifiedUser — (String)

          The ARN of the last modified user. This field is populated only if the setting value was overwritten.

        • ARN — (String)

          The ARN of the service setting.

        • Status — (String)

          The status of the service setting. The value can be Default, Customized or PendingUpdate.

          • Default: The current setting uses a default value provisioned by the AWS service team.

          • Customized: The current setting use a custom value specified by the customer.

          • PendingUpdate: The current setting uses a default or custom value, but a setting change request is pending approval.

Returns:

  • (AWS.Request)

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

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

A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions.

Parameter labels have the following requirements and restrictions.

  • A version of a parameter can have a maximum of 10 labels.

  • You can't attach the same label to different versions of the same parameter. For example, if version 1 has the label Production, then you can't attach Production to version 2.

  • You can move a label from one version of a parameter to another.

  • You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter.

  • You can't delete a parameter label. If you no longer want to use a parameter label, then you must move it to a different version of a parameter.

  • A label can have a maximum of 100 characters.

  • Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_).

  • Labels can't begin with a number, "aws," or "ssm" (not case sensitive). If a label fails to meet these requirements, then the label is not associated with a parameter and the system displays it in the list of InvalidLabels.

Service Reference:

Examples:

Calling the labelParameterVersion operation

var params = {
  Labels: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Name: 'STRING_VALUE', /* required */
  ParameterVersion: 'NUMBER_VALUE'
};
ssm.labelParameterVersion(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 parameter name on which you want to attach one or more labels.

    • ParameterVersion — (Integer)

      The specific version of the parameter on which you want to attach one or more labels. If no version is specified, the system attaches the label to the latest version.)

    • Labels — (Array<String>)

      One or more labels to attach to the specified parameter 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:

      • InvalidLabels — (Array<String>)

        The label does not meet the requirements. For information about parameter label requirements, see Labeling Parameters in the AWS Systems Manager User Guide.

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 | AssociationName, /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  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"
        • "AssociationName"
      • 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 Systems Manager 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.

        • AssociationVersion — (String)

          The association version.

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

          • Values — (Array<String>)

            User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer.

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

        • AssociationName — (String)

          The association name.

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

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

Retrieves all versions of an association for a specific association ID.

Service Reference:

Examples:

Calling the listAssociationVersions operation

var params = {
  AssociationId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ssm.listAssociationVersions(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 association ID for which you want to view all versions.

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

      • AssociationVersions — (Array<map>)

        Information about all versions of the association for the specified association ID.

        • AssociationId — (String)

          The ID created by the system when the association was created.

        • AssociationVersion — (String)

          The association version.

        • CreatedDate — (Date)

          The date the association version was created.

        • Name — (String)

          The name specified when the association was created.

        • DocumentVersion — (String)

          The version of a Systems Manager document used when the association version was created.

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

          Parameters specified when the association version was created.

        • Targets — (Array<map>)

          The targets specified for the association when the association version was created.

          • Key — (String)

            User-defined criteria for sending commands that target instances that meet the criteria.

          • Values — (Array<String>)

            User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer.

        • ScheduleExpression — (String)

          The cron or rate schedule specified for the association when the association version was created.

        • OutputLocation — (map)

          The location in Amazon S3 specified for the association when the association version was created.

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

        • AssociationName — (String)

          The name specified for the association version when the association version was created.

        • MaxErrors — (String)

          The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

          Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

        • MaxConcurrency — (String)

          The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

          If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.

        • ComplianceSeverity — (String)

          The severity level that is assigned to the association.

          Possible values include:
          • "CRITICAL"
          • "HIGH"
          • "MEDIUM"
          • "LOW"
          • "UNSPECIFIED"
      • 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.

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 runs 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 | ExecutionStage | DocumentName, /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  InstanceId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  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"
        • "ExecutionStage"
        • "DocumentName"
      • valuerequired — (String)

        The filter value. Valid values for each filter key are as follows:

        • InvokedAfter: Specify a timestamp to limit your results. For example, specify 2018-07-07T00:00:00Z to see a list of command executions occurring July 7, 2018, and later.

        • InvokedBefore: Specify a timestamp to limit your results. For example, specify 2018-07-07T00:00:00Z to see a list of command executions from before July 7, 2018.

        • Status: Specify a valid command status to see a list of all command executions with that status. Status values you can specify include:

          • Pending

          • InProgress

          • Success

          • Cancelled

          • Failed

          • TimedOut

          • Cancelling

        • DocumentName: Specify name of the SSM document for which you want to see command execution results. For example, specify AWS-RunPatchBaseline to see command executions that used this SSM document to perform security patching operations on instances.

        • ExecutionStage: Specify one of the following values:

          • Executing: Returns a list of command executions that are currently still running.

          • Complete: Returns a list of command executions that have already completed.

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

        • DocumentVersion — (String)

          The SSM document version.

        • 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 Understanding Command Statuses in the AWS Systems Manager User Guide. 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 run 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 Understanding Command Statuses in the AWS Systems Manager User Guide. 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 running the plugin.

          • ResponseStartDateTime — (Date)

            The time the plugin started running.

          • ResponseFinishDateTime — (Date)

            The time the plugin stopped running. 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 an Amazon Simple Notification Service (Amazon 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 Configuring Amazon SNS Notifications for AWS Systems Manager in the AWS 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"
        • CloudWatchOutputConfig — (map)

          CloudWatch Logs information where you want Systems Manager to send the command output.

          • CloudWatchLogGroupName — (String)

            The name of the CloudWatch log group where you want to send command output. If you don't specify a group name, Systems Manager automatically creates a log group for you. The log group uses the following naming format: aws/ssm/SystemsManagerDocumentName.

          • CloudWatchOutputEnabled — (Boolean)

            Enables Systems Manager to send command output to CloudWatch Logs.

      • 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 | ExecutionStage | DocumentName, /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  InstanceId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  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"
        • "ExecutionStage"
        • "DocumentName"
      • valuerequired — (String)

        The filter value. Valid values for each filter key are as follows:

        • InvokedAfter: Specify a timestamp to limit your results. For example, specify 2018-07-07T00:00:00Z to see a list of command executions occurring July 7, 2018, and later.

        • InvokedBefore: Specify a timestamp to limit your results. For example, specify 2018-07-07T00:00:00Z to see a list of command executions from before July 7, 2018.

        • Status: Specify a valid command status to see a list of all command executions with that status. Status values you can specify include:

          • Pending

          • InProgress

          • Success

          • Cancelled

          • Failed

          • TimedOut

          • Cancelling

        • DocumentName: Specify name of the SSM document for which you want to see command execution results. For example, specify AWS-RunPatchBaseline to see command executions that used this SSM document to perform security patching operations on instances.

        • ExecutionStage: Specify one of the following values:

          • Executing: Returns a list of command executions that are currently still running.

          • Complete: Returns a list of command executions that have already completed.

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.

        • DocumentVersion — (String)

          The SSM document version.

        • 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 running, it will not run. 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 running 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.

          • Values — (Array<String>)

            User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer.

        • 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 Understanding Command Statuses in the AWS Systems Manager User Guide. 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 ran 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 running 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 run 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 Running Commands Using Systems Manager Run Command in the AWS Systems Manager User Guide.

        • 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 0. For more information about how to use MaxErrors, see Running Commands Using Systems Manager Run Command in the AWS Systems Manager User Guide.

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

        • DeliveryTimedOutCount — (Integer)

          The number of targets for which the status is Delivery 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 an Amazon Simple Notification Service (Amazon 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 Configuring Amazon SNS Notifications for AWS Systems Manager in the AWS 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"
        • CloudWatchOutputConfig — (map)

          CloudWatch Logs information where you want Systems Manager to send the command output.

          • CloudWatchLogGroupName — (String)

            The name of the CloudWatch log group where you want to send command output. If you don't specify a group name, Systems Manager automatically creates a log group for you. The log group uses the following naming format: aws/ssm/SystemsManagerDocumentName.

          • CloudWatchOutputEnabled — (Boolean)

            Enables Systems Manager to send command output to CloudWatch Logs.

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

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

For a specified resource ID, this API action returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.

Service Reference:

Examples:

Calling the listComplianceItems operation

var params = {
  Filters: [
    {
      Key: 'STRING_VALUE',
      Type: EQUAL | NOT_EQUAL | BEGIN_WITH | LESS_THAN | GREATER_THAN,
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ResourceIds: [
    'STRING_VALUE',
    /* more items */
  ],
  ResourceTypes: [
    'STRING_VALUE',
    /* more items */
  ]
};
ssm.listComplianceItems(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 compliance filters. Use a filter to return a more specific list of results.

      • Key — (String)

        The name of the filter.

      • Values — (Array<String>)

        The value for which to search.

      • Type — (String)

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

        Possible values include:
        • "EQUAL"
        • "NOT_EQUAL"
        • "BEGIN_WITH"
        • "LESS_THAN"
        • "GREATER_THAN"
    • ResourceIds — (Array<String>)

      The ID for the resources from which to get compliance information. Currently, you can only specify one resource ID.

    • ResourceTypes — (Array<String>)

      The type of resource from which to get compliance information. Currently, the only supported resource type is ManagedInstance.

    • NextToken — (String)

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

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

      • ComplianceItems — (Array<map>)

        A list of compliance information for the specified resource ID.

        • ComplianceType — (String)

          The compliance type. For example, Association (for a State Manager association), Patch, or Custom:string are all valid compliance types.

        • ResourceType — (String)

          The type of resource. ManagedInstance is currently the only supported resource type.

        • ResourceId — (String)

          An ID for the resource. For a managed instance, this is the instance ID.

        • Id — (String)

          An ID for the compliance item. For example, if the compliance item is a Windows patch, the ID could be the number of the KB article; for example: KB4010320.

        • Title — (String)

          A title for the compliance item. For example, if the compliance item is a Windows patch, the title could be the title of the KB article for the patch; for example: Security Update for Active Directory Federation Services.

        • Status — (String)

          The status of the compliance item. An item is either COMPLIANT or NON_COMPLIANT.

          Possible values include:
          • "COMPLIANT"
          • "NON_COMPLIANT"
        • Severity — (String)

          The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified.

          Possible values include:
          • "CRITICAL"
          • "HIGH"
          • "MEDIUM"
          • "LOW"
          • "INFORMATIONAL"
          • "UNSPECIFIED"
        • ExecutionSummary — (map)

          A summary for the compliance item. The summary includes an execution ID, the execution type (for example, command), and the execution time.

          • ExecutionTimerequired — (Date)

            The time the execution ran as a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'.

          • ExecutionId — (String)

            An ID created by the system when PutComplianceItems was called. For example, CommandID is a valid execution ID. You can use this ID in subsequent calls.

          • ExecutionType — (String)

            The type of execution. For example, Command is a valid execution type.

        • Details — (map<String>)

          A "Key": "Value" tag combination for the compliance item.

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

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

Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.

Service Reference:

Examples:

Calling the listComplianceSummaries operation

var params = {
  Filters: [
    {
      Key: 'STRING_VALUE',
      Type: EQUAL | NOT_EQUAL | BEGIN_WITH | LESS_THAN | GREATER_THAN,
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ssm.listComplianceSummaries(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 compliance or inventory filters. Use a filter to return a more specific list of results.

      • Key — (String)

        The name of the filter.

      • Values — (Array<String>)

        The value for which to search.

      • Type — (String)

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

        Possible values include:
        • "EQUAL"
        • "NOT_EQUAL"
        • "BEGIN_WITH"
        • "LESS_THAN"
        • "GREATER_THAN"
    • NextToken — (String)

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

    • MaxResults — (Integer)

      The maximum number of items to return for this call. Currently, you can specify null or 50. 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:

      • ComplianceSummaryItems — (Array<map>)

        A list of compliant and non-compliant summary counts based on compliance types. For example, this call returns State Manager associations, patches, or custom compliance types according to the filter criteria that you specified.

        • ComplianceType — (String)

          The type of compliance item. For example, the compliance type can be Association, Patch, or Custom:string.

        • CompliantSummary — (map)

          A list of COMPLIANT items for the specified compliance type.

          • CompliantCount — (Integer)

            The total number of resources that are compliant.

          • SeveritySummary — (map)

            A summary of the compliance severity by compliance type.

            • CriticalCount — (Integer)

              The total number of resources or compliance items that have a severity level of critical. Critical severity is determined by the organization that published the compliance items.

            • HighCount — (Integer)

              The total number of resources or compliance items that have a severity level of high. High severity is determined by the organization that published the compliance items.

            • MediumCount — (Integer)

              The total number of resources or compliance items that have a severity level of medium. Medium severity is determined by the organization that published the compliance items.

            • LowCount — (Integer)

              The total number of resources or compliance items that have a severity level of low. Low severity is determined by the organization that published the compliance items.

            • InformationalCount — (Integer)

              The total number of resources or compliance items that have a severity level of informational. Informational severity is determined by the organization that published the compliance items.

            • UnspecifiedCount — (Integer)

              The total number of resources or compliance items that have a severity level of unspecified. Unspecified severity is determined by the organization that published the compliance items.

        • NonCompliantSummary — (map)

          A list of NON_COMPLIANT items for the specified compliance type.

          • NonCompliantCount — (Integer)

            The total number of compliance items that are not compliant.

          • SeveritySummary — (map)

            A summary of the non-compliance severity by compliance type

            • CriticalCount — (Integer)

              The total number of resources or compliance items that have a severity level of critical. Critical severity is determined by the organization that published the compliance items.

            • HighCount — (Integer)

              The total number of resources or compliance items that have a severity level of high. High severity is determined by the organization that published the compliance items.

            • MediumCount — (Integer)

              The total number of resources or compliance items that have a severity level of medium. Medium severity is determined by the organization that published the compliance items.

            • LowCount — (Integer)

              The total number of resources or compliance items that have a severity level of low. Low severity is determined by the organization that published the compliance items.

            • InformationalCount — (Integer)

              The total number of resources or compliance items that have a severity level of informational. Informational severity is determined by the organization that published the compliance items.

            • UnspecifiedCount — (Integer)

              The total number of resources or compliance items that have a severity level of unspecified. Unspecified severity is determined by the organization that published the compliance items.

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

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

Describes one or more of your Systems Manager documents.

Service Reference:

Examples:

Calling the listDocuments operation

var params = {
  DocumentFilterList: [
    {
      key: Name | Owner | PlatformTypes | DocumentType, /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  Filters: [
    {
      Key: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  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.

    • Filters — (Array<map>)

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

      • Key — (String)

        The name of the filter key.

      • Values — (Array<String>)

        The value for the filter 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:

      • DocumentIdentifiers — (Array<map>)

        The names of the Systems Manager documents.

        • Name — (String)

          The name of the Systems Manager document.

        • Owner — (String)

          The AWS user account that created the document.

        • VersionName — (String)

          An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.

        • PlatformTypes — (Array<String>)

          The operating system platform.

        • DocumentVersion — (String)

          The document version.

        • DocumentType — (String)

          The document type.

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

          The schema version.

        • DocumentFormat — (String)

          The document format, either JSON or YAML.

          Possible values include:
          • "YAML"
          • "JSON"
        • TargetType — (String)

          The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see AWS Resource Types Reference in the AWS CloudFormation User Guide.

        • Tags — (Array<map>)

          The tags, or metadata, that have been applied to the document.

          • Keyrequired — (String)

            The name of the tag.

          • Valuerequired — (String)

            The value of the tag.

      • 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: 'NUMBER_VALUE',
  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.

        • VersionName — (String)

          The version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.

        • CreatedDate — (Date)

          The date the document was created.

        • IsDefaultVersion — (Boolean)

          An identifier for the default version of the document.

        • DocumentFormat — (String)

          The document format, either JSON or YAML.

          Possible values include:
          • "YAML"
          • "JSON"
        • Status — (String)

          The status of the Systems Manager document, such as Creating, Active, Failed, and Deleting.

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

          A message returned by AWS Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket does not exist. Verify that the URL of the S3 bucket is correct."

      • 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 | Exists
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  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"
        • "Exists"
    • 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.

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

Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.

Service Reference:

Examples:

Calling the listResourceComplianceSummaries operation

var params = {
  Filters: [
    {
      Key: 'STRING_VALUE',
      Type: EQUAL | NOT_EQUAL | BEGIN_WITH | LESS_THAN | GREATER_THAN,
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ssm.listResourceComplianceSummaries(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.

      • Key — (String)

        The name of the filter.

      • Values — (Array<String>)

        The value for which to search.

      • Type — (String)

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

        Possible values include:
        • "EQUAL"
        • "NOT_EQUAL"
        • "BEGIN_WITH"
        • "LESS_THAN"
        • "GREATER_THAN"
    • NextToken — (String)

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

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

      • ResourceComplianceSummaryItems — (Array<map>)

        A summary count for specified or targeted managed instances. Summary count includes information about compliant and non-compliant State Manager associations, patch status, or custom items according to the filter criteria that you specify.

        • ComplianceType — (String)

          The compliance type.

        • ResourceType — (String)

          The resource type.

        • ResourceId — (String)

          The resource ID.

        • Status — (String)

          The compliance status for the resource.

          Possible values include:
          • "COMPLIANT"
          • "NON_COMPLIANT"
        • OverallSeverity — (String)

          The highest severity item found for the resource. The resource is compliant for this item.

          Possible values include:
          • "CRITICAL"
          • "HIGH"
          • "MEDIUM"
          • "LOW"
          • "INFORMATIONAL"
          • "UNSPECIFIED"
        • ExecutionSummary — (map)

          Information about the execution.

          • ExecutionTimerequired — (Date)

            The time the execution ran as a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'.

          • ExecutionId — (String)

            An ID created by the system when PutComplianceItems was called. For example, CommandID is a valid execution ID. You can use this ID in subsequent calls.

          • ExecutionType — (String)

            The type of execution. For example, Command is a valid execution type.

        • CompliantSummary — (map)

          A list of items that are compliant for the resource.

          • CompliantCount — (Integer)

            The total number of resources that are compliant.

          • SeveritySummary — (map)

            A summary of the compliance severity by compliance type.

            • CriticalCount — (Integer)

              The total number of resources or compliance items that have a severity level of critical. Critical severity is determined by the organization that published the compliance items.

            • HighCount — (Integer)

              The total number of resources or compliance items that have a severity level of high. High severity is determined by the organization that published the compliance items.

            • MediumCount — (Integer)

              The total number of resources or compliance items that have a severity level of medium. Medium severity is determined by the organization that published the compliance items.

            • LowCount — (Integer)

              The total number of resources or compliance items that have a severity level of low. Low severity is determined by the organization that published the compliance items.

            • InformationalCount — (Integer)

              The total number of resources or compliance items that have a severity level of informational. Informational severity is determined by the organization that published the compliance items.

            • UnspecifiedCount — (Integer)

              The total number of resources or compliance items that have a severity level of unspecified. Unspecified severity is determined by the organization that published the compliance items.

        • NonCompliantSummary — (map)

          A list of items that aren't compliant for the resource.

          • NonCompliantCount — (Integer)

            The total number of compliance items that are not compliant.

          • SeveritySummary — (map)

            A summary of the non-compliance severity by compliance type

            • CriticalCount — (Integer)

              The total number of resources or compliance items that have a severity level of critical. Critical severity is determined by the organization that published the compliance items.

            • HighCount — (Integer)

              The total number of resources or compliance items that have a severity level of high. High severity is determined by the organization that published the compliance items.

            • MediumCount — (Integer)

              The total number of resources or compliance items that have a severity level of medium. Medium severity is determined by the organization that published the compliance items.

            • LowCount — (Integer)

              The total number of resources or compliance items that have a severity level of low. Low severity is determined by the organization that published the compliance items.

            • InformationalCount — (Integer)

              The total number of resources or compliance items that have a severity level of informational. Informational severity is determined by the organization that published the compliance items.

            • UnspecifiedCount — (Integer)

              The total number of resources or compliance items that have a severity level of unspecified. Unspecified severity is determined by the organization that published the compliance items.

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

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

Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed.

The number of sync configurations might be too large to return using a single call to ListResourceDataSync. You can limit the number of sync configurations returned by using the MaxResults parameter. To determine whether there are more sync configurations to list, check the value of NextToken in the output. If there are more sync configurations to list, you can request them by specifying the NextToken returned in the call to the parameter of a subsequent call.

Service Reference:

Examples:

Calling the listResourceDataSync operation

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

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

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

      • ResourceDataSyncItems — (Array<map>)

        A list of your current Resource Data Sync configurations and their statuses.

        • SyncName — (String)

          The name of the Resource Data Sync.

        • S3Destination — (map)

          Configuration information for the target Amazon S3 bucket.

          • BucketNamerequired — (String)

            The name of the Amazon S3 bucket where the aggregated data is stored.

          • Prefix — (String)

            An Amazon S3 prefix for the bucket.

          • SyncFormatrequired — (String)

            A supported sync format. The following format is currently supported: JsonSerDe

            Possible values include:
            • "JsonSerDe"
          • Regionrequired — (String)

            The AWS Region with the Amazon S3 bucket targeted by the Resource Data Sync.

          • AWSKMSKeyARN — (String)

            The ARN of an encryption key for a destination in Amazon S3. Must belong to the same Region as the destination Amazon S3 bucket.

        • LastSyncTime — (Date)

          The last time the configuration attempted to sync (UTC).

        • LastSuccessfulSyncTime — (Date)

          The last time the sync operations returned a status of SUCCESSFUL (UTC).

        • LastStatus — (String)

          The status reported by the last sync.

          Possible values include:
          • "Successful"
          • "Failed"
          • "InProgress"
        • SyncCreatedTime — (Date)

          The date and time the configuration was created (UTC).

        • LastSyncStatusMessage — (String)

          The status message details reported by the last sync.

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

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: Document | ManagedInstance | MaintenanceWindow | Parameter | PatchBaseline | OpsItem /* 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:
      • "Document"
      • "ManagedInstance"
      • "MaintenanceWindow"
      • "Parameter"
      • "PatchBaseline"
      • "OpsItem"
    • 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.

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

Registers a compliance type and other compliance details on a designated resource. This action lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request.

ComplianceType can be one of the following:

  • ExecutionId: The execution ID when the patch, association, or custom compliance item was applied.

  • ExecutionType: Specify patch, association, or Custom:string.

  • ExecutionTime. The time the patch, association, or custom compliance item was applied to the instance.

  • Id: The patch, association, or custom compliance ID.

  • Title: A title.

  • Status: The status of the compliance item. For example, approved for patches, or Failed for associations.

  • Severity: A patch severity. For example, critical.

  • DocumentName: A SSM document name. For example, AWS-RunPatchBaseline.

  • DocumentVersion: An SSM document version number. For example, 4.

  • Classification: A patch classification. For example, security updates.

  • PatchBaselineId: A patch baseline ID.

  • PatchSeverity: A patch severity. For example, Critical.

  • PatchState: A patch state. For example, InstancesWithFailedPatches.

  • PatchGroup: The name of a patch group.

  • InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'

Service Reference:

Examples:

Calling the putComplianceItems operation

var params = {
  ComplianceType: 'STRING_VALUE', /* required */
  ExecutionSummary: { /* required */
    ExecutionTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
    ExecutionId: 'STRING_VALUE',
    ExecutionType: 'STRING_VALUE'
  },
  Items: [ /* required */
    {
      Severity: CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL | UNSPECIFIED, /* required */
      Status: COMPLIANT | NON_COMPLIANT, /* required */
      Details: {
        '<AttributeName>': 'STRING_VALUE',
        /* '<AttributeName>': ... */
      },
      Id: 'STRING_VALUE',
      Title: 'STRING_VALUE'
    },
    /* more items */
  ],
  ResourceId: 'STRING_VALUE', /* required */
  ResourceType: 'STRING_VALUE', /* required */
  ItemContentHash: 'STRING_VALUE'
};
ssm.putComplianceItems(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: {})
    • ResourceId — (String)

      Specify an ID for this resource. For a managed instance, this is the instance ID.

    • ResourceType — (String)

      Specify the type of resource. ManagedInstance is currently the only supported resource type.

    • ComplianceType — (String)

      Specify the compliance type. For example, specify Association (for a State Manager association), Patch, or Custom:string.

    • ExecutionSummary — (map)

      A summary of the call execution that includes an execution ID, the type of execution (for example, Command), and the date/time of the execution using a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'.

      • ExecutionTimerequired — (Date)

        The time the execution ran as a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'.

      • ExecutionId — (String)

        An ID created by the system when PutComplianceItems was called. For example, CommandID is a valid execution ID. You can use this ID in subsequent calls.

      • ExecutionType — (String)

        The type of execution. For example, Command is a valid execution type.

    • Items — (Array<map>)

      Information about the compliance as defined by the resource type. For example, for a patch compliance type, Items includes information about the PatchSeverity, Classification, etc.

      • Id — (String)

        The compliance item ID. For example, if the compliance item is a Windows patch, the ID could be the number of the KB article.

      • Title — (String)

        The title of the compliance item. For example, if the compliance item is a Windows patch, the title could be the title of the KB article for the patch; for example: Security Update for Active Directory Federation Services.

      • Severityrequired — (String)

        The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified.

        Possible values include:
        • "CRITICAL"
        • "HIGH"
        • "MEDIUM"
        • "LOW"
        • "INFORMATIONAL"
        • "UNSPECIFIED"
      • Statusrequired — (String)

        The status of the compliance item. An item is either COMPLIANT or NON_COMPLIANT.

        Possible values include:
        • "COMPLIANT"
        • "NON_COMPLIANT"
      • Details — (map<String>)

        A "Key": "Value" tag combination for the compliance item.

    • ItemContentHash — (String)

      MD5 or SHA-256 content hash. The content hash is used to determine if existing information should be overwritten or ignored. If the content hashes match, the request to put compliance information is ignored.

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',
      Context: {
        '<AttributeName>': 'STRING_VALUE',
        /* '<AttributeName>': ... */
      }
    },
    /* 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.

      • Context — (map<String>)

        A map of associated properties for a specified inventory type. For example, with this attribute, you can specify the ExecutionId, ExecutionType, ComplianceType properties of the AWS:ComplianceItem 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. The data object has the following properties:

      • Message — (String)

        Information about the request.

Returns:

  • (AWS.Request)

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

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

Add a parameter 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,
  Policies: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  Tier: Standard | Advanced
};
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 fully qualified name of the parameter that you want to add to the system. The fully qualified name includes the complete hierarchy of the parameter path and name. For example: /Dev/DBServer/MySQL/db-string13

      Naming Constraints:

      • Parameter names are case sensitive.

      • A parameter name must be unique within an AWS Region

      • A parameter name can't be prefixed with "aws" or "ssm" (case-insensitive).

      • Parameter names can include only the following symbols and letters: a-zA-Z0-9_.-/

      • A parameter name can't include spaces.

      • Parameter hierarchies are limited to a maximum depth of fifteen levels.

      For additional information about valid values for parameter names, see Requirements and Constraints for Parameter Names in the AWS Systems Manager User Guide.

      Note: The maximum length constraint listed below includes capacity for additional system attributes that are not part of the name. The maximum length for the fully qualified parameter name is 1011 characters.
    • Description — (String)

      Information about the parameter that you want to add to the system. Optional but recommended.

      Do not enter personally identifiable information in this field.

    • Value — (String)

      The parameter value that you want to add to the system. Standard parameters have a value limit of 4 KB. Advanced parameters have a value limit of 8 KB.

    • Type — (String)

      The type of parameter that you want to add to the system.

      Items in a StringList must be separated by a comma (,). You can't use other punctuation or special character to escape items in the list. If you have a parameter value that requires a comma, then use the String data type.

      Note: SecureString is not currently supported for AWS CloudFormation templates or in the China Regions.
      Possible values include:
      • "String"
      • "StringList"
      • "SecureString"
    • KeyId — (String)

      The KMS Key ID that you want to use to encrypt a parameter. Either the default AWS Key Management Service (AWS KMS) key automatically assigned to your AWS account or a custom key. Required for parameters that use the SecureString data type.

      If you don't specify a key ID, the system uses the default key associated with your AWS account.

      • To use your default AWS KMS key, choose the SecureString data type, and do not specify the Key ID when you create the parameter. The system automatically populates Key ID with your default KMS key.

      • To use a custom KMS key, choose the SecureString data type with the Key ID parameter.

    • 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+$

    • Tags — (Array<map>)

      Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. In this case, you could specify the following key name/value pairs:

      • Key=Resource,Value=S3bucket

      • Key=OS,Value=Windows

      • Key=ParameterType,Value=LicenseKey

      Note: To add tags to an existing Systems Manager parameter, use the AddTagsToResource action.
      • Keyrequired — (String)

        The name of the tag.

      • Valuerequired — (String)

        The value of the tag.

    • Tier — (String)

      Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a value limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters per account and per Region. Standard parameters are offered at no additional cost.

      Advanced parameters have a value limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters per account and per Region. Advanced parameters incur a charge.

      If you don't specify a parameter tier when you create a new parameter, the parameter defaults to using the standard tier. You can change a standard parameter to an advanced parameter at any time. But you can't revert an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard parameter would result in data loss because the system would truncate the size of the parameter from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly, advanced parameters use a different form of encryption than standard parameters.

      If you no longer need an advanced parameter, or if you no longer want to incur charges for an advanced parameter, you must delete it and recreate it as a new standard parameter. For more information, see About Advanced Parameters in the AWS Systems Manager User Guide.

      Possible values include:
      • "Standard"
      • "Advanced"
    • Policies — (String)

      One or more policies to apply to a parameter. This action takes a JSON array. Parameter Store supports the following policy types:

      Expiration: This policy deletes the parameter after it expires. When you create the policy, you specify the expiration date. You can update the expiration date and time by updating the policy. Updating the parameter does not affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter.

      ExpirationNotification: This policy triggers an event in Amazon CloudWatch Events that notifies you about the expiration. By using this policy, you can receive notification before or after the expiration time is reached, in units of days or hours.

      NoChangeNotification: This policy triggers a CloudWatch event if a parameter has not been modified for a specified period of time. This policy type is useful when, for example, a secret needs to be changed within a period of time, but it has not been changed.

      All existing policies are preserved until you send new policies or an empty policy. For more information about parameter policies, see Working with Parameter Policies.

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:

      • Version — (Integer)

        The new version number of a parameter. If you edit a parameter value, Parameter Store automatically creates a new version and assigns this new version a unique ID. You can reference a parameter version ID in API actions or in Systems Manager documents (SSM documents). By default, if you don't specify a specific version, the system returns the latest parameter value when a parameter is called.

Returns:

  • (AWS.Request)

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

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

Defines the default patch baseline for the relevant operating system.

To reset the AWS predefined patch baseline as the default, specify the full patch baseline ARN as the baseline ID value. For example, for CentOS, specify arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed instead of pb-0574b43a65ea646ed.

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 | RESOURCE_GROUP, /* required */
  Targets: [ /* required */
    {
      Key: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  WindowId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Name: '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"
      • "RESOURCE_GROUP"
    • Targets — (Array<map>)

      The targets to register with the maintenance window. In other words, the instances to run commands on when the maintenance window runs.

      You can specify targets using instance IDs, resource group names, or tags that have been applied to instances.

      Example 1: Specify instance IDs

      Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3

      Example 2: Use tag key-pairs applied to instances

      Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2

      Example 3: Use tag-keys applied to instances

      Key=tag-key,Values=my-tag-key-1,my-tag-key-2

      Example 4: Use resource group names

      Key=resource-groups:Name,Values=resource-group-name

      Example 5: Use filters for resource group types

      Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2

      Note: For Key=resource-groups:ResourceTypeFilters, specify resource types in the following format Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC

      For more information about these examples formats, including the best use case for each one, see Examples: Register Targets with a Maintenance Window in the AWS Systems Manager User Guide.

      • Key — (String)

        User-defined criteria for sending commands that target instances that meet the criteria.

      • Values — (Array<String>)

        User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer.

    • OwnerInformation — (String)

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

    • Name — (String)

      An optional name for the target.

    • Description — (String)

      An optional description for the target.

    • 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 */
  Targets: [ /* required */
    {
      Key: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  TaskArn: 'STRING_VALUE', /* required */
  TaskType: RUN_COMMAND | AUTOMATION | STEP_FUNCTIONS | LAMBDA, /* required */
  WindowId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  LoggingInfo: {
    S3BucketName: 'STRING_VALUE', /* required */
    S3Region: 'STRING_VALUE', /* required */
    S3KeyPrefix: 'STRING_VALUE'
  },
  Name: 'STRING_VALUE',
  Priority: 'NUMBER_VALUE',
  ServiceRoleArn: 'STRING_VALUE',
  TaskInvocationParameters: {
    Automation: {
      DocumentVersion: 'STRING_VALUE',
      Parameters: {
        '<AutomationParameterKey>': [
          'STRING_VALUE',
          /* more items */
        ],
        /* '<AutomationParameterKey>': ... */
      }
    },
    Lambda: {
      ClientContext: 'STRING_VALUE',
      Payload: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
      Qualifier: 'STRING_VALUE'
    },
    RunCommand: {
      Comment: 'STRING_VALUE',
      DocumentHash: 'STRING_VALUE',
      DocumentHashType: Sha256 | Sha1,
      NotificationConfig: {
        NotificationArn: 'STRING_VALUE',
        NotificationEvents: [
          All | InProgress | Success | TimedOut | Cancelled | Failed,
          /* more items */
        ],
        NotificationType: Command | Invocation
      },
      OutputS3BucketName: 'STRING_VALUE',
      OutputS3KeyPrefix: 'STRING_VALUE',
      Parameters: {
        '<ParameterName>': [
          'STRING_VALUE',
          /* more items */
        ],
        /* '<ParameterName>': ... */
      },
      ServiceRoleArn: 'STRING_VALUE',
      TimeoutSeconds: 'NUMBER_VALUE'
    },
    StepFunctions: {
      Input: 'STRING_VALUE',
      Name: 'STRING_VALUE'
    }
  },
  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 maintenance window targets).

      Specify instances using the following format:

      Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>

      Specify maintenance window targets using the following format:

      Key=WindowTargetIds;,Values=<window-target-id-1>,<window-target-id-2>

      • Key — (String)

        User-defined criteria for sending commands that target instances that meet the criteria.

      • Values — (Array<String>)

        User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer.

    • TaskArn — (String)

      The ARN of the task to run.

    • ServiceRoleArn — (String)

      The ARN of the IAM service role for Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

      For more information, see the following topics in the in the AWS Systems Manager User Guide:

    • TaskType — (String)

      The type of task being registered.

      Possible values include:
      • "RUN_COMMAND"
      • "AUTOMATION"
      • "STEP_FUNCTIONS"
      • "LAMBDA"
    • TaskParameters — (map<map>)

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

      Note: TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
      • Values — (Array<String>)

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

    • TaskInvocationParameters — (map)

      The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.

      • RunCommand — (map)

        The parameters for a RUN_COMMAND task type.

        • Comment — (String)

          Information about the commands to run.

        • DocumentHash — (String)

          The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.

        • DocumentHashType — (String)

          SHA-256 or SHA-1. SHA-1 hashes have been deprecated.

          Possible values include:
          • "Sha256"
          • "Sha1"
        • NotificationConfig — (map)

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

          • NotificationArn — (String)

            An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon 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 Configuring Amazon SNS Notifications for AWS Systems Manager in the AWS 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"
        • OutputS3BucketName — (String)

          The name of the Amazon S3 bucket.

        • OutputS3KeyPrefix — (String)

          The Amazon S3 bucket subfolder.

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

          The parameters for the RUN_COMMAND task execution.

        • ServiceRoleArn — (String)

          The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

        • TimeoutSeconds — (Integer)

          If this time is reached and the command has not already started running, it doesn't run.

      • Automation — (map)

        The parameters for an AUTOMATION task type.

        • DocumentVersion — (String)

          The version of an Automation document to use during task execution.

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

          The parameters for the AUTOMATION task.

          For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.

          Note: LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters. TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters. For AUTOMATION task types, Systems Manager ignores any values specified for these parameters.
      • StepFunctions — (map)

        The parameters for a STEP_FUNCTIONS task type.

        • Input — (String)

          The inputs for the STEP_FUNCTIONS task.

        • Name — (String)

          The name of the STEP_FUNCTIONS task.

      • Lambda — (map)

        The parameters for a LAMBDA task type.

        • ClientContext — (String)

          Pass client-specific information to the Lambda function that you are invoking. You can then process the client information in your Lambda function as you choose through the context variable.

        • Qualifier — (String)

          (Optional) Specify a Lambda function version or alias name. If you specify a function version, the action uses the qualified function ARN to invoke a specific Lambda function. If you specify an alias name, the action uses the alias ARN to invoke the Lambda function version to which the alias points.

        • Payload — (Buffer, Typed Array, Blob, String)

          JSON to provide to your Lambda function as input.

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

      Note: LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
      • 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.

    • Name — (String)

      An optional name for the task.

    • Description — (String)

      An optional description for the task.

    • 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 tag keys from the specified resource.

Service Reference:

Examples:

Calling the removeTagsFromResource operation

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  ResourceType: Document | ManagedInstance | MaintenanceWindow | Parameter | PatchBaseline | OpsItem, /* 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 from which you want to remove a tag.

      Note: The ManagedInstance type for this API action is only for on-premises managed instances. Specify the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.
      Possible values include:
      • "Document"
      • "ManagedInstance"
      • "MaintenanceWindow"
      • "Parameter"
      • "PatchBaseline"
      • "OpsItem"
    • ResourceId — (String)

      The ID of the resource from which you want to remove tags. For example:

      ManagedInstance: mi-012345abcde

      MaintenanceWindow: mw-012345abcde

      PatchBaseline: pb-012345abcde

      For the Document and Parameter values, use the name of the resource.

      Note: The ManagedInstance type for this API action is only for on-premises managed instances. Specify the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.
    • 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.

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

ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature.

Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API action to view the current value. Use the UpdateServiceSetting API action to change the default setting.

Reset the service setting for the account to the default value as provisioned by the AWS service team.

Service Reference:

Examples:

Calling the resetServiceSetting operation

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

      The ID of the service setting to reset.

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:

      • ServiceSetting — (map)

        The current, effective service setting after calling the ResetServiceSetting API action.

        • SettingId — (String)

          The ID of the service setting.

        • SettingValue — (String)

          The value of the service setting.

        • LastModifiedDate — (Date)

          The last time the service setting was modified.

        • LastModifiedUser — (String)

          The ARN of the last modified user. This field is populated only if the setting value was overwritten.

        • ARN — (String)

          The ARN of the service setting.

        • Status — (String)

          The status of the service setting. The value can be Default, Customized or PendingUpdate.

          • Default: The current setting uses a default value provisioned by the AWS service team.

          • Customized: The current setting use a custom value specified by the customer.

          • PendingUpdate: The current setting uses a default or custom value, but a setting change request is pending approval.

Returns:

  • (AWS.Request)

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

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

Reconnects a session to an instance after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions.

Note: This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It is not intended for any other use.

Service Reference:

Examples:

Calling the resumeSession operation

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

      The ID of the disconnected session to resume.

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:

      • SessionId — (String)

        The ID of the session.

      • TokenValue — (String)

        An encrypted token value containing session and caller information. Used to authenticate the connection to the instance.

      • StreamUrl — (String)

        A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and receive output from the instance. Format: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output).

        region represents the Region identifier for an AWS Region supported by AWS Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in the AWS Systems Manager table of regions and endpoints in the AWS General Reference.

        session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.

Returns:

  • (AWS.Request)

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

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

Sends a signal to an Automation execution to change the current behavior or status of the execution.

Service Reference:

Examples:

Calling the sendAutomationSignal operation

var params = {
  AutomationExecutionId: 'STRING_VALUE', /* required */
  SignalType: Approve | Reject | StartStep | StopStep | Resume, /* required */
  Payload: {
    '<AutomationParameterKey>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<AutomationParameterKey>': ... */
  }
};
ssm.sendAutomationSignal(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 that you want to send the signal to.

    • SignalType — (String)

      The type of signal to send to an Automation execution.

      Possible values include:
      • "Approve"
      • "Reject"
      • "StartStep"
      • "StopStep"
      • "Resume"
    • Payload — (map<Array<String>>)

      The data sent with the signal. The data schema depends on the type of signal used in the request.

      For Approve and Reject signal types, the payload is an optional comment that you can send with the signal type. For example:

      Comment="Looks good"

      For StartStep and Resume signal types, you must send the name of the Automation step to start or resume as the payload. For example:

      StepName="step1"

      For the StopStep signal type, you must send the step execution ID as the payload. For example:

      StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"

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

Runs commands on one or more managed instances.

Service Reference:

Examples:

Calling the sendCommand operation

var params = {
  DocumentName: 'STRING_VALUE', /* required */
  CloudWatchOutputConfig: {
    CloudWatchLogGroupName: 'STRING_VALUE',
    CloudWatchOutputEnabled: true || false
  },
  Comment: 'STRING_VALUE',
  DocumentHash: 'STRING_VALUE',
  DocumentHashType: Sha256 | Sha1,
  DocumentVersion: 'STRING_VALUE',
  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: 'NUMBER_VALUE'
};
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 run. 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 in the AWS Systems Manager User Guide.

    • 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 in the AWS Systems Manager User Guide.

      • Key — (String)

        User-defined criteria for sending commands that target instances that meet the criteria.

      • Values — (Array<String>)

        User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer.

    • DocumentName — (String)

      Required. The name of the Systems Manager document to run. This can be a public document or a custom document.

    • DocumentVersion — (String)

      The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the AWS CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:

      --document-version "\$DEFAULT"

      --document-version "\$LATEST"

      --document-version "3"

    • 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 running, it will not run.

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

    • 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 run 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 in the AWS Systems Manager User Guide.

    • 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 0. For more information about how to use MaxErrors, see Using Error Controls in the AWS Systems Manager User Guide.

    • ServiceRoleArn — (String)

      The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.

    • NotificationConfig — (map)

      Configurations for sending notifications.

      • NotificationArn — (String)

        An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon 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 Configuring Amazon SNS Notifications for AWS Systems Manager in the AWS 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"
    • CloudWatchOutputConfig — (map)

      Enables Systems Manager to send Run Command output to Amazon CloudWatch Logs.

      • CloudWatchLogGroupName — (String)

        The name of the CloudWatch log group where you want to send command output. If you don't specify a group name, Systems Manager automatically creates a log group for you. The log group uses the following naming format: aws/ssm/SystemsManagerDocumentName.

      • CloudWatchOutputEnabled — (Boolean)

        Enables Systems Manager to send command output to CloudWatch Logs.

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.

        • DocumentVersion — (String)

          The SSM document version.

        • 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 running, it will not run. 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 running 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.

          • Values — (Array<String>)

            User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer.

        • 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 Understanding Command Statuses in the AWS Systems Manager User Guide. 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 ran 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 running 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 run 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 Running Commands Using Systems Manager Run Command in the AWS Systems Manager User Guide.

        • 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 0. For more information about how to use MaxErrors, see Running Commands Using Systems Manager Run Command in the AWS Systems Manager User Guide.

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

        • DeliveryTimedOutCount — (Integer)

          The number of targets for which the status is Delivery 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 an Amazon Simple Notification Service (Amazon 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 Configuring Amazon SNS Notifications for AWS Systems Manager in the AWS 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"
        • CloudWatchOutputConfig — (map)

          CloudWatch Logs information where you want Systems Manager to send the command output.

          • CloudWatchLogGroupName — (String)

            The name of the CloudWatch log group where you want to send command output. If you don't specify a group name, Systems Manager automatically creates a log group for you. The log group uses the following naming format: aws/ssm/SystemsManagerDocumentName.

          • CloudWatchOutputEnabled — (Boolean)

            Enables Systems Manager to send command output to CloudWatch Logs.

Returns:

  • (AWS.Request)

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

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

Use this API action to run an association immediately and only one time. This action can be helpful when troubleshooting associations.

Service Reference:

Examples:

Calling the startAssociationsOnce operation

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

      The association IDs that you want to run immediately and only one time.

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.

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

Initiates execution of an Automation document.

Service Reference:

Examples:

Calling the startAutomationExecution operation

var params = {
  DocumentName: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  DocumentVersion: 'STRING_VALUE',
  MaxConcurrency: 'STRING_VALUE',
  MaxErrors: 'STRING_VALUE',
  Mode: Auto | Interactive,
  Parameters: {
    '<AutomationParameterKey>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<AutomationParameterKey>': ... */
  },
  TargetLocations: [
    {
      Accounts: [
        'STRING_VALUE',
        /* more items */
      ],
      ExecutionRoleName: 'STRING_VALUE',
      Regions: [
        'STRING_VALUE',
        /* more items */
      ],
      TargetLocationMaxConcurrency: 'STRING_VALUE',
      TargetLocationMaxErrors: 'STRING_VALUE'
    },
    /* more items */
  ],
  TargetMaps: [
    {
      '<TargetMapKey>': [
        'STRING_VALUE',
        /* more items */
      ],
      /* '<TargetMapKey>': ... */
    },
    /* more items */
  ],
  TargetParameterName: 'STRING_VALUE',
  Targets: [
    {
      Key: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ]
};
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.

    • ClientToken — (String)

      User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

    • Mode — (String)

      The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.

      Possible values include:
      • "Auto"
      • "Interactive"
    • TargetParameterName — (String)

      The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.

    • Targets — (Array<map>)

      A key-value mapping to target resources. Required if you specify TargetParameterName.

      • Key — (String)

        User-defined criteria for sending commands that target instances that meet the criteria.

      • Values — (Array<String>)

        User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer.

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

      A key-value mapping of document parameters to target resources. Both Targets and TargetMaps cannot be specified together.

    • MaxConcurrency — (String)

      The maximum number of targets allowed to run this task in parallel. You can specify a number, such as 10, or a percentage, such as 10%. The default value is 10.

    • MaxErrors — (String)

      The number of errors that are allowed before the system stops running the automation on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops running the automation when the fourth error is received. If you specify 0, then the system stops running the automation on additional targets after the first error result is returned. If you run an automation on 50 resources and set max-errors to 10%, then the system stops running the automation on additional targets when the sixth error is received.

      Executions that are already running an automation when max-errors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set max-concurrency to 1 so the executions proceed one at a time.

    • TargetLocations — (Array<map>)

      A location is a combination of AWS Regions and/or AWS accounts where you want to run the Automation. Use this action to start an Automation in multiple Regions and multiple accounts. For more information, see Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide.

      • Accounts — (Array<String>)

        The AWS accounts targeted by the current Automation execution.

      • Regions — (Array<String>)

        The AWS Regions targeted by the current Automation execution.

      • TargetLocationMaxConcurrency — (String)

        The maximum number of AWS accounts and AWS regions allowed to run the Automation concurrently

      • TargetLocationMaxErrors — (String)

        The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.

      • ExecutionRoleName — (String)

        The Automation execution role used by the currently running 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:

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

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

Initiates a connection to a target (for example, an instance) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs.

Note: AWS CLI usage: start-session is an interactive command that requires the Session Manager plugin to be installed on the client machine making the call. For information, see Install the Session Manager Plugin for the AWS CLI in the AWS Systems Manager User Guide.

Service Reference:

Examples:

Calling the startSession operation

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

      The instance to connect to for the session.

    • DocumentName — (String)

      The name of the SSM document to define the parameters and plugin settings for the session. For example, SSM-SessionManagerRunShell. If no document name is provided, a shell to the instance is launched by default.

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

      Reserved for future use.

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:

      • SessionId — (String)

        The ID of the session.

      • TokenValue — (String)

        An encrypted token value containing session and caller information. Used to authenticate the connection to the instance.

      • StreamUrl — (String)

        A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and receive output from the instance. Format: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)

        region represents the Region identifier for an AWS Region supported by AWS Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in the AWS Systems Manager table of regions and endpoints in the AWS General Reference.

        session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.

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

Service Reference:

Examples:

Calling the stopAutomationExecution operation

var params = {
  AutomationExecutionId: 'STRING_VALUE', /* required */
  Type: Complete | Cancel
};
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.

    • Type — (String)

      The stop request type. Valid types include the following: Cancel and Complete. The default type is Cancel.

      Possible values include:
      • "Complete"
      • "Cancel"

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.

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

Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the instance. A terminated session cannot be resumed.

Service Reference:

Examples:

Calling the terminateSession operation

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

      The ID of the session to terminate.

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:

      • SessionId — (String)

        The ID of the session that has been terminated.

Returns:

  • (AWS.Request)

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

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

Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon S3 output.

When you update an association, the association immediately runs against the specified targets.

Service Reference:

Examples:

Calling the updateAssociation operation

var params = {
  AssociationId: 'STRING_VALUE', /* required */
  AssociationName: 'STRING_VALUE',
  AssociationVersion: 'STRING_VALUE',
  AutomationTargetParameterName: 'STRING_VALUE',
  ComplianceSeverity: CRITICAL | HIGH | MEDIUM | LOW | UNSPECIFIED,
  DocumentVersion: 'STRING_VALUE',
  MaxConcurrency: 'STRING_VALUE',
  MaxErrors: '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 SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.

      You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account.

      For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format:

      arn:aws:ssm:region:account-id:document/document-name

      For example:

      arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document

      For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.

    • Targets — (Array<map>)

      The targets of the association.

      • Key — (String)

        User-defined criteria for sending commands that target instances that meet the criteria.

      • Values — (Array<String>)

        User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer.

    • AssociationName — (String)

      The name of the association that you want to update.

    • AssociationVersion — (String)

      This parameter is provided for concurrency control purposes. You must specify the latest association version in the service. If you want to ensure that this request succeeds, either specify $LATEST, or omit this parameter.

    • AutomationTargetParameterName — (String)

      Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.

    • MaxErrors — (String)

      The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

      Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

    • MaxConcurrency — (String)

      The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

      If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.

    • ComplianceSeverity — (String)

      The severity level to assign to the association.

      Possible values include:
      • "CRITICAL"
      • "HIGH"
      • "MEDIUM"
      • "LOW"
      • "UNSPECIFIED"

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 Systems Manager document.

        • InstanceId — (String)

          The ID of the instance.

        • AssociationVersion — (String)

          The association version.

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

        • AutomationTargetParameterName — (String)

          Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.

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

          • Values — (Array<String>)

            User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer.

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

        • AssociationName — (String)

          The association name.

        • MaxErrors — (String)

          The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

          Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

        • MaxConcurrency — (String)

          The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

          If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.

        • ComplianceSeverity — (String)

          The severity level that is assigned to the association.

          Possible values include:
          • "CRITICAL"
          • "HIGH"
          • "MEDIUM"
          • "LOW"
          • "UNSPECIFIED"

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 Systems Manager 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 Systems Manager document.

        • InstanceId — (String)

          The ID of the instance.

        • AssociationVersion — (String)

          The association version.

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

        • AutomationTargetParameterName — (String)

          Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.

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

          • Values — (Array<String>)

            User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer.

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

        • AssociationName — (String)

          The association name.

        • MaxErrors — (String)

          The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

          Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

        • MaxConcurrency — (String)

          The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

          If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.

        • ComplianceSeverity — (String)

          The severity level that is assigned to the association.

          Possible values include:
          • "CRITICAL"
          • "HIGH"
          • "MEDIUM"
          • "LOW"
          • "UNSPECIFIED"

Returns:

  • (AWS.Request)

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

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

Updates one or more values for an SSM document.

Service Reference:

Examples:

Calling the updateDocument operation

var params = {
  Content: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Attachments: [
    {
      Key: SourceUrl,
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  DocumentFormat: YAML | JSON,
  DocumentVersion: 'STRING_VALUE',
  TargetType: 'STRING_VALUE',
  VersionName: '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)

      A valid JSON or YAML string.

    • Attachments — (Array<map>)

      A list of key and value pairs that describe attachments to a version of a document.

      • Key — (String)

        The key of a key and value pair that identifies the location of an attachment to a document.

        Possible values include:
        • "SourceUrl"
      • Values — (Array<String>)

        The URL of the location of a document attachment, such as the URL of an Amazon S3 bucket.

    • Name — (String)

      The name of the document that you want to update.

    • VersionName — (String)

      An optional field specifying the version of the artifact you are updating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.

    • DocumentVersion — (String)

      The version of the document that you want to update.

    • DocumentFormat — (String)

      Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.

      Possible values include:
      • "YAML"
      • "JSON"
    • TargetType — (String)

      Specify a new target type for 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. 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.

        • Hash — (String)

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

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

          The hash type of the document. Valid values include Sha256 or Sha1.

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

          The name of the Systems Manager document.

        • VersionName — (String)

          The version of the artifact associated with the document.

        • Owner — (String)

          The AWS user account that created the document.

        • CreatedDate — (Date)

          The date when the document was created.

        • Status — (String)

          The status of the Systems Manager document.

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

          A message returned by AWS Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket does not exist. Verify that the URL of the S3 bucket is correct."

        • 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 Systems Manager document.

        • DocumentType — (String)

          The type of document.

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

          The schema version.

        • LatestVersion — (String)

          The latest version of the document.

        • DefaultVersion — (String)

          The default version.

        • DocumentFormat — (String)

          The document format, either JSON or YAML.

          Possible values include:
          • "YAML"
          • "JSON"
        • TargetType — (String)

          The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see AWS Resource Types Reference in the AWS CloudFormation User Guide.

        • Tags — (Array<map>)

          The tags, or metadata, that have been applied to the document.

          • Keyrequired — (String)

            The name of the tag.

          • Valuerequired — (String)

            The value of the tag.

        • AttachmentsInformation — (Array<map>)

          Details about the document attachments, including names, locations, sizes, etc.

          • Name — (String)

            The name of the attachment.

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.

        • DefaultVersionName — (String)

          The default version of the artifact associated with 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: 'NUMBER_VALUE',
  Description: 'STRING_VALUE',
  Duration: 'NUMBER_VALUE',
  Enabled: true || false,
  EndDate: 'STRING_VALUE',
  Name: 'STRING_VALUE',
  Replace: true || false,
  Schedule: 'STRING_VALUE',
  ScheduleTimezone: 'STRING_VALUE',
  StartDate: '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.

    • Description — (String)

      An optional description for the update request.

    • StartDate — (String)

      The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.

    • EndDate — (String)

      The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. EndDate allows you to set a date and time in the future when the maintenance window will no longer run.

    • Schedule — (String)

      The schedule of the maintenance window in the form of a cron or rate expression.

    • ScheduleTimezone — (String)

      The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.

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

    • Replace — (Boolean)

      If True, then all fields that are required by the CreateMaintenanceWindow action are also required for this API request. Optional fields that are not specified are set to null.

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.

      • Description — (String)

        An optional description of the update.

      • StartDate — (String)

        The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. The maintenance window will not run before this specified time.

      • EndDate — (String)

        The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive. The maintenance window will not run after this specified time.

      • Schedule — (String)

        The schedule of the maintenance window in the form of a cron or rate expression.

      • ScheduleTimezone — (String)

        The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.

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

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

Modifies the target of an existing maintenance window. You can change the following:

  • Name

  • Description

  • Owner

  • IDs for an ID target

  • Tags for a Tag target

  • From any supported tag type to another. The three supported tag types are ID target, Tag target, and resource group. For more information, see Target.

Note: If a parameter is null, then the corresponding field is not modified.

Service Reference:

Examples:

Calling the updateMaintenanceWindowTarget operation

var params = {
  WindowId: 'STRING_VALUE', /* required */
  WindowTargetId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Name: 'STRING_VALUE',
  OwnerInformation: 'STRING_VALUE',
  Replace: true || false,
  Targets: [
    {
      Key: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ]
};
ssm.updateMaintenanceWindowTarget(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 maintenance window ID with which to modify the target.

    • WindowTargetId — (String)

      The target ID to modify.

    • Targets — (Array<map>)

      The targets to add or replace.

      • Key — (String)

        User-defined criteria for sending commands that target instances that meet the criteria.

      • Values — (Array<String>)

        User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer.

    • OwnerInformation — (String)

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

    • Name — (String)

      A name for the update.

    • Description — (String)

      An optional description for the update.

    • Replace — (Boolean)

      If True, then all fields that are required by the RegisterTargetWithMaintenanceWindow action are also required for this API request. Optional fields that are not specified are set to null.

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 maintenance window ID specified in the update request.

      • WindowTargetId — (String)

        The target ID specified in the update request.

      • Targets — (Array<map>)

        The updated targets.

        • Key — (String)

          User-defined criteria for sending commands that target instances that meet the criteria.

        • Values — (Array<String>)

          User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer.

      • OwnerInformation — (String)

        The updated owner.

      • Name — (String)

        The updated name.

      • Description — (String)

        The updated description.

Returns:

  • (AWS.Request)

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

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

Modifies a task assigned to a maintenance window. You can't change the task type, but you can change the following values:

  • TaskARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript.

  • ServiceRoleArn

  • TaskInvocationParameters

  • Priority

  • MaxConcurrency

  • MaxErrors

If a parameter is null, then the corresponding field is not modified. Also, if you set Replace to true, then all fields required by the RegisterTaskWithMaintenanceWindow action are required for this request. Optional fields that aren't specified are set to null.

Service Reference:

Examples:

Calling the updateMaintenanceWindowTask operation

var params = {
  WindowId: 'STRING_VALUE', /* required */
  WindowTaskId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  LoggingInfo: {
    S3BucketName: 'STRING_VALUE', /* required */
    S3Region: 'STRING_VALUE', /* required */
    S3KeyPrefix: 'STRING_VALUE'
  },
  MaxConcurrency: 'STRING_VALUE',
  MaxErrors: 'STRING_VALUE',
  Name: 'STRING_VALUE',
  Priority: 'NUMBER_VALUE',
  Replace: true || false,
  ServiceRoleArn: 'STRING_VALUE',
  Targets: [
    {
      Key: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  TaskArn: 'STRING_VALUE',
  TaskInvocationParameters: {
    Automation: {
      DocumentVersion: 'STRING_VALUE',
      Parameters: {
        '<AutomationParameterKey>': [
          'STRING_VALUE',
          /* more items */
        ],
        /* '<AutomationParameterKey>': ... */
      }
    },
    Lambda: {
      ClientContext: 'STRING_VALUE',
      Payload: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
      Qualifier: 'STRING_VALUE'
    },
    RunCommand: {
      Comment: 'STRING_VALUE',
      DocumentHash: 'STRING_VALUE',
      DocumentHashType: Sha256 | Sha1,
      NotificationConfig: {
        NotificationArn: 'STRING_VALUE',
        NotificationEvents: [
          All | InProgress | Success | TimedOut | Cancelled | Failed,
          /* more items */
        ],
        NotificationType: Command | Invocation
      },
      OutputS3BucketName: 'STRING_VALUE',
      OutputS3KeyPrefix: 'STRING_VALUE',
      Parameters: {
        '<ParameterName>': [
          'STRING_VALUE',
          /* more items */
        ],
        /* '<ParameterName>': ... */
      },
      ServiceRoleArn: 'STRING_VALUE',
      TimeoutSeconds: 'NUMBER_VALUE'
    },
    StepFunctions: {
      Input: 'STRING_VALUE',
      Name: 'STRING_VALUE'
    }
  },
  TaskParameters: {
    '<MaintenanceWindowTaskParameterName>': {
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* '<MaintenanceWindowTaskParameterName>': ... */
  }
};
ssm.updateMaintenanceWindowTask(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 maintenance window ID that contains the task to modify.

    • WindowTaskId — (String)

      The task ID to modify.

    • Targets — (Array<map>)

      The targets (either instances or tags) to modify. Instances are specified using Key=instanceids,Values=instanceID_1,instanceID_2. 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.

      • Values — (Array<String>)

        User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer.

    • TaskArn — (String)

      The task ARN to modify.

    • ServiceRoleArn — (String)

      The ARN of the IAM service role for Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

      For more information, see the following topics in the in the AWS Systems Manager User Guide:

    • TaskParameters — (map<map>)

      The parameters to modify.

      Note: TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

      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.

    • TaskInvocationParameters — (map)

      The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.

      • RunCommand — (map)

        The parameters for a RUN_COMMAND task type.

        • Comment — (String)

          Information about the commands to run.

        • DocumentHash — (String)

          The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.

        • DocumentHashType — (String)

          SHA-256 or SHA-1. SHA-1 hashes have been deprecated.

          Possible values include:
          • "Sha256"
          • "Sha1"
        • NotificationConfig — (map)

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

          • NotificationArn — (String)

            An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon 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 Configuring Amazon SNS Notifications for AWS Systems Manager in the AWS 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"
        • OutputS3BucketName — (String)

          The name of the Amazon S3 bucket.

        • OutputS3KeyPrefix — (String)

          The Amazon S3 bucket subfolder.

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

          The parameters for the RUN_COMMAND task execution.

        • ServiceRoleArn — (String)

          The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

        • TimeoutSeconds — (Integer)

          If this time is reached and the command has not already started running, it doesn't run.

      • Automation — (map)

        The parameters for an AUTOMATION task type.

        • DocumentVersion — (String)

          The version of an Automation document to use during task execution.

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

          The parameters for the AUTOMATION task.

          For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.

          Note: LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters. TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters. For AUTOMATION task types, Systems Manager ignores any values specified for these parameters.
      • StepFunctions — (map)

        The parameters for a STEP_FUNCTIONS task type.

        • Input — (String)

          The inputs for the STEP_FUNCTIONS task.

        • Name — (String)

          The name of the STEP_FUNCTIONS task.

      • Lambda — (map)

        The parameters for a LAMBDA task type.

        • ClientContext — (String)

          Pass client-specific information to the Lambda function that you are invoking. You can then process the client information in your Lambda function as you choose through the context variable.

        • Qualifier — (String)

          (Optional) Specify a Lambda function version or alias name. If you specify a function version, the action uses the qualified function ARN to invoke a specific Lambda function. If you specify an alias name, the action uses the alias ARN to invoke the Lambda function version to which the alias points.

        • Payload — (Buffer, Typed Array, Blob, String)

          JSON to provide to your Lambda function as input.

    • Priority — (Integer)

      The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.

    • MaxConcurrency — (String)

      The new MaxConcurrency value you want to specify. MaxConcurrency is the number of targets that are allowed to run this task in parallel.

    • MaxErrors — (String)

      The new MaxErrors value to specify. MaxErrors is the maximum number of errors that are allowed before the task stops being scheduled.

    • LoggingInfo — (map)

      The new logging location in Amazon S3 to specify.

      Note: LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
      • 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.

    • Name — (String)

      The new task name to specify.

    • Description — (String)

      The new task description to specify.

    • Replace — (Boolean)

      If True, then all fields that are required by the RegisterTaskWithMaintenanceWndow action are also required for this API request. Optional fields that are not specified are set to null.

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 that was updated.

      • WindowTaskId — (String)

        The task ID of the maintenance window that was updated.

      • Targets — (Array<map>)

        The updated target values.

        • Key — (String)

          User-defined criteria for sending commands that target instances that meet the criteria.

        • Values — (Array<String>)

          User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer.

      • TaskArn — (String)

        The updated task ARN value.

      • ServiceRoleArn — (String)

        The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

      • TaskParameters — (map<map>)

        The updated parameter values.

        Note: TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
        • Values — (Array<String>)

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

      • TaskInvocationParameters — (map)

        The updated parameter values.

        • RunCommand — (map)

          The parameters for a RUN_COMMAND task type.

          • Comment — (String)

            Information about the commands to run.

          • DocumentHash — (String)

            The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.

          • DocumentHashType — (String)

            SHA-256 or SHA-1. SHA-1 hashes have been deprecated.

            Possible values include:
            • "Sha256"
            • "Sha1"
          • NotificationConfig — (map)

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

            • NotificationArn — (String)

              An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon 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 Configuring Amazon SNS Notifications for AWS Systems Manager in the AWS 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"
          • OutputS3BucketName — (String)

            The name of the Amazon S3 bucket.

          • OutputS3KeyPrefix — (String)

            The Amazon S3 bucket subfolder.

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

            The parameters for the RUN_COMMAND task execution.

          • ServiceRoleArn — (String)

            The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

          • TimeoutSeconds — (Integer)

            If this time is reached and the command has not already started running, it doesn't run.

        • Automation — (map)

          The parameters for an AUTOMATION task type.

          • DocumentVersion — (String)

            The version of an Automation document to use during task execution.

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

            The parameters for the AUTOMATION task.

            For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.

            Note: LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters. TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters. For AUTOMATION task types, Systems Manager ignores any values specified for these parameters.
        • StepFunctions — (map)

          The parameters for a STEP_FUNCTIONS task type.

          • Input — (String)

            The inputs for the STEP_FUNCTIONS task.

          • Name — (String)

            The name of the STEP_FUNCTIONS task.