Class: AWS.SSM

var params = {
  AssociationType: 'STRING_VALUE', /* required */
  OpsItemId: 'STRING_VALUE', /* required */
  ResourceType: 'STRING_VALUE', /* required */
  ResourceUri: 'STRING_VALUE' /* required */
};
ssm.associateOpsItemRelatedItem(params, 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 to which you want to associate a resource as a related item.

  • AssociationType — (String)

    The type of association that you want to create between an OpsItem and a resource. OpsCenter supports IsParentOf and RelatesTo association types.

  • ResourceType — (String)

    The type of resource that you want to associate with an OpsItem. OpsCenter supports the following types:

    AWS::SSMIncidents::IncidentRecord: an Incident Manager incident.

    AWS::SSM::Document: a Systems Manager (SSM) document.

  • ResourceUri — (String)

    The Amazon Resource Name (ARN) of the Amazon Web Services resource that you want to associate with the OpsItem.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to 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:

    • AssociationId — (String)

      The association ID.

Returns:

• (AWS.Request) —

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

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 managed node IDs on which you want to cancel the command. If not provided, the command is canceled on every node 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.

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.

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',
  RegistrationMetadata: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  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 Systems Manager.

    Don't enter personally identifiable information in this field.

  • DefaultInstanceName — (String)

    The name of the registered, managed node as it will appear in the Amazon Web Services Systems Manager console or when you use the Amazon Web Services command line tools to list Systems Manager resources.

    Don't enter personally identifiable information in this field.

  • IamRole — (String)

    The name of the Identity and Access Management (IAM) role that you want to assign to the managed node. This IAM role must provide AssumeRole permissions for the Amazon Web Services Systems Manager service principal ssm.amazonaws.com. For more information, see Create an IAM service role for a hybrid and multicloud environment in the Amazon Web Services Systems Manager User Guide.

    Note: You can't specify an IAM service-linked role for this parameter. You must create a unique role.
  • RegistrationLimit — (Integer)

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

  • ExpirationDate — (Date)

    The date by which this activation request should expire, in timestamp format, such as "2021-07-07T00:00:00". You can specify a date up to 30 days in advance. If you don't provide an expiration date, the activation code expires in 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-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, edge devices, and VMs after they connect to Systems Manager for the first time and are assigned a managed node ID. This means they are listed in the Amazon Web Services Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed nodes, see AddTagsToResource. For information about how to remove tags from your managed nodes, see RemoveTagsFromResource.

    • Key — required — (String)

      The name of the tag.

    • Value — required — (String)

      The value of the tag.

  • RegistrationMetadata — (Array<map>)

    Reserved for internal use.

    • Key — required — (String)

      Reserved for internal use.

    • Value — required — (String)

      Reserved for internal 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:

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

var params = {
  Name: 'STRING_VALUE', /* required */
  AlarmConfiguration: {
    Alarms: [ /* required */
      {
        Name: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    IgnorePollAlarmFailure: true || false
  },
  ApplyOnlyAtCronInterval: true || false,
  AssociationName: 'STRING_VALUE',
  AutomationTargetParameterName: 'STRING_VALUE',
  CalendarNames: [
    'STRING_VALUE',
    /* more items */
  ],
  ComplianceSeverity: CRITICAL | HIGH | MEDIUM | LOW | UNSPECIFIED,
  DocumentVersion: 'STRING_VALUE',
  Duration: 'NUMBER_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',
  ScheduleOffset: 'NUMBER_VALUE',
  SyncCompliance: AUTO | MANUAL,
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  TargetLocations: [
    {
      Accounts: [
        'STRING_VALUE',
        /* more items */
      ],
      ExecutionRoleName: 'STRING_VALUE',
      Regions: [
        'STRING_VALUE',
        /* more items */
      ],
      TargetLocationAlarmConfiguration: {
        Alarms: [ /* required */
          {
            Name: 'STRING_VALUE' /* required */
          },
          /* more items */
        ],
        IgnorePollAlarmFailure: true || false
      },
      TargetLocationMaxConcurrency: 'STRING_VALUE',
      TargetLocationMaxErrors: 'STRING_VALUE'
    },
    /* more items */
  ],
  TargetMaps: [
    {
      '<TargetMapKey>': [
        'STRING_VALUE',
        /* more items */
      ],
      /* '<TargetMapKey>': ... */
    },
    /* more items */
  ],
  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 Command document or Automation runbook that contains the configuration information for the managed node.

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

    For Systems Manager documents (SSM documents) that are shared with you from other Amazon Web Services 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 Amazon Web Services-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 targets. Can be a specific version or the default version.

    State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the default version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to default.

  • InstanceId — (String)

    The managed node ID.

    Note: InstanceId has been deprecated. To specify a managed node ID for an association, use the Targets parameter. Requests that include the parameter InstanceID with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId, you can't use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.
  • Parameters — (map<Array<String>>)

    The parameters for the runtime configuration of the document.

  • Targets — (Array<map>)

    The targets for the association. You can target managed nodes by using tags, Amazon Web Services resource groups, all managed nodes in an Amazon Web Services account, or individual managed node IDs. You can target all managed nodes in an Amazon Web Services account by specifying the InstanceIds key with a value of *. For more information about choosing targets for an association, see About targets and rate controls in State Manager associations in the Amazon Web Services Systems Manager User Guide.

    • Key — (String)

      User-defined criteria for sending commands that target managed nodes 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 EC2 tags of ServerRole,WebServer.

      Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.

  • ScheduleExpression — (String)

    A cron expression when the association will be applied to the targets.

  • OutputLocation — (map)

    An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.

    • S3Location — (map)

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

      • OutputS3Region — (String)

        The Amazon Web Services Region of the S3 bucket.

      • OutputS3BucketName — (String)

        The name of the S3 bucket.

      • OutputS3KeyPrefix — (String)

        The S3 bucket subfolder.

  • AssociationName — (String)

    Specify a descriptive name for the association.

  • AutomationTargetParameterName — (String)

    Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.

  • 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 managed nodes 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 managed node 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 managed node 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"
  • SyncCompliance — (String)

    The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.

    In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager. It is managed by your direct call to the PutComplianceItems API operation.

    By default, all associations use AUTO mode.

    Possible values include:
    • "AUTO"
    • "MANUAL"
  • ApplyOnlyAtCronInterval — (Boolean)

    By default, when you create a new association, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions.

  • CalendarNames — (Array<String>)

    The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.

  • TargetLocations — (Array<map>)

    A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts.

    • Accounts — (Array<String>)

      The Amazon Web Services accounts targeted by the current Automation execution.

    • Regions — (Array<String>)

      The Amazon Web Services Regions targeted by the current Automation execution.

    • TargetLocationMaxConcurrency — (String)

      The maximum number of Amazon Web Services Regions and Amazon Web Services accounts 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. If not specified, the default value is AWS-SystemsManager-AutomationExecutionRole.

    • TargetLocationAlarmConfiguration — (map)

      The details for the CloudWatch alarm you want to apply to an automation or command.

      • IgnorePollAlarmFailure — (Boolean)

        When this value is true, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is false.

      • Alarms — required — (Array<map>)

        The name of the CloudWatch alarm specified in the configuration.

        • Name — required — (String)

          The name of your CloudWatch alarm.

  • ScheduleOffset — (Integer)

    Number of days to wait after the scheduled day to run an association. For example, if you specified a cron schedule of cron(0 0 ? * THU#2 *), you could specify an offset of 3 to run the association each Sunday after the second Thursday of the month. For more information about cron schedules for associations, see Reference: Cron and rate expressions for Systems Manager in the Amazon Web Services Systems Manager User Guide.

    Note: To use offsets, you must specify the ApplyOnlyAtCronInterval parameter. This option tells the system not to run an association immediately after you create it.
  • Duration — (Integer)

    The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot.

    The Duration parameter applies only when both these conditions are true:

    • The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution.

    • The command specifies the ApplyOnlyAtCronInterval parameter, which means that the association doesn't run immediately after it is created, but only according to the specified schedule.

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

    A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

  • Tags — (Array<map>)

    Adds or overwrites one or more tags for a State Manager association. Tags are metadata that you can assign to your Amazon Web Services resources. 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.

    • Key — required — (String)

      The name of the tag.

    • Value — required — (String)

      The value of the tag.

  • AlarmConfiguration — (map)

    The details for the CloudWatch alarm you want to apply to an automation or command.

    • IgnorePollAlarmFailure — (Boolean)

      When this value is true, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is false.

    • Alarms — required — (Array<map>)

      The name of the CloudWatch alarm specified in the configuration.

      • Name — required — (String)

        The name of your CloudWatch alarm.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AssociationDescription — (map)

      Information about the association.

      • Name — (String)

        The name of the SSM document.

      • InstanceId — (String)

        The managed node ID.

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

        • Date — required — (Date)

          The date when the status changed.

        • Name — required — (String)

          The status.

          Possible values include:
          • "Pending"
          • "Success"
          • "Failed"
        • Message — required — (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 managed nodes, and one of them was successful, this would return the count of managed nodes by status.

      • DocumentVersion — (String)

        The document version.

      • AutomationTargetParameterName — (String)

        Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.

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

        A description of the parameters for a document.

      • AssociationId — (String)

        The association ID.

      • Targets — (Array<map>)

        The managed nodes targeted by the request.

        • Key — (String)

          User-defined criteria for sending commands that target managed nodes 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 EC2 tags of ServerRole,WebServer.

          Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.

      • ScheduleExpression — (String)

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

      • OutputLocation — (map)

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

        • S3Location — (map)

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

          • OutputS3Region — (String)

            The Amazon Web Services Region of the S3 bucket.

          • OutputS3BucketName — (String)

            The name of the S3 bucket.

          • OutputS3KeyPrefix — (String)

            The 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 managed nodes 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 managed node 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 managed node 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"
      • SyncCompliance — (String)

        The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.

        In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

        By default, all associations use AUTO mode.

        Possible values include:
        • "AUTO"
        • "MANUAL"
      • ApplyOnlyAtCronInterval — (Boolean)

        By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions.

      • CalendarNames — (Array<String>)

        The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.

      • TargetLocations — (Array<map>)

        The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.

        • Accounts — (Array<String>)

          The Amazon Web Services accounts targeted by the current Automation execution.

        • Regions — (Array<String>)

          The Amazon Web Services Regions targeted by the current Automation execution.

        • TargetLocationMaxConcurrency — (String)

          The maximum number of Amazon Web Services Regions and Amazon Web Services accounts 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. If not specified, the default value is AWS-SystemsManager-AutomationExecutionRole.

        • TargetLocationAlarmConfiguration — (map)

          The details for the CloudWatch alarm you want to apply to an automation or command.

          • IgnorePollAlarmFailure — (Boolean)

            When this value is true, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is false.

          • Alarms — required — (Array<map>)

            The name of the CloudWatch alarm specified in the configuration.

            • Name — required — (String)

              The name of your CloudWatch alarm.

      • ScheduleOffset — (Integer)

        Number of days to wait after the scheduled day to run an association.

      • Duration — (Integer)

        The number of hours that an association can run on specified targets. After the resulting cutoff time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets.

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

        A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

      • AlarmConfiguration — (map)

        The details for the CloudWatch alarm you want to apply to an automation or command.

        • IgnorePollAlarmFailure — (Boolean)

          When this value is true, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is false.

        • Alarms — required — (Array<map>)

          The name of the CloudWatch alarm specified in the configuration.

          • Name — required — (String)

            The name of your CloudWatch alarm.

      • TriggeredAlarms — (Array<map>)

        The CloudWatch alarm that was invoked during the association.

        • Name — required — (String)

          The name of your CloudWatch alarm.

        • State — required — (String)

          The state of your CloudWatch alarm.

          Possible values include:
          • "UNKNOWN"
          • "ALARM"

Returns:

• (AWS.Request) —

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

var params = {
  Entries: [ /* required */
    {
      Name: 'STRING_VALUE', /* required */
      AlarmConfiguration: {
        Alarms: [ /* required */
          {
            Name: 'STRING_VALUE' /* required */
          },
          /* more items */
        ],
        IgnorePollAlarmFailure: true || false
      },
      ApplyOnlyAtCronInterval: true || false,
      AssociationName: 'STRING_VALUE',
      AutomationTargetParameterName: 'STRING_VALUE',
      CalendarNames: [
        'STRING_VALUE',
        /* more items */
      ],
      ComplianceSeverity: CRITICAL | HIGH | MEDIUM | LOW | UNSPECIFIED,
      DocumentVersion: 'STRING_VALUE',
      Duration: 'NUMBER_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',
      ScheduleOffset: 'NUMBER_VALUE',
      SyncCompliance: AUTO | MANUAL,
      TargetLocations: [
        {
          Accounts: [
            'STRING_VALUE',
            /* more items */
          ],
          ExecutionRoleName: 'STRING_VALUE',
          Regions: [
            'STRING_VALUE',
            /* more items */
          ],
          TargetLocationAlarmConfiguration: {
            Alarms: [ /* required */
              {
                Name: 'STRING_VALUE' /* required */
              },
              /* more items */
            ],
            IgnorePollAlarmFailure: true || false
          },
          TargetLocationMaxConcurrency: 'STRING_VALUE',
          TargetLocationMaxErrors: 'STRING_VALUE'
        },
        /* more items */
      ],
      TargetMaps: [
        {
          '<TargetMapKey>': [
            'STRING_VALUE',
            /* more items */
          ],
          /* '<TargetMapKey>': ... */
        },
        /* more items */
      ],
      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.

    • Name — required — (String)

      The name of the SSM document that contains the configuration information for the managed node. You can specify Command or Automation runbooks.

      You can specify Amazon Web Services-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 Amazon Web Services 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 Amazon Web Services-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 managed node ID.

      Note: InstanceId has been deprecated. To specify a managed node ID for an association, use the Targets parameter. Requests that include the parameter InstanceID with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId, you can't use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.
    • 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 runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.

    • DocumentVersion — (String)

      The document version.

    • Targets — (Array<map>)

      The managed nodes targeted by the request.

      • Key — (String)

        User-defined criteria for sending commands that target managed nodes 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 EC2 tags of ServerRole,WebServer.

        Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.

    • ScheduleExpression — (String)

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

    • OutputLocation — (map)

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

      • S3Location — (map)

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

        • OutputS3Region — (String)

          The Amazon Web Services Region of the S3 bucket.

        • OutputS3BucketName — (String)

          The name of the S3 bucket.

        • OutputS3KeyPrefix — (String)

          The 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 managed nodes 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 managed node 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 managed node 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"
    • SyncCompliance — (String)

      The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.

      In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

      By default, all associations use AUTO mode.

      Possible values include:
      • "AUTO"
      • "MANUAL"
    • ApplyOnlyAtCronInterval — (Boolean)

      By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions.

    • CalendarNames — (Array<String>)

      The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that Change Calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.

    • TargetLocations — (Array<map>)

      Use this action to create an association in multiple Regions and multiple accounts.

      • Accounts — (Array<String>)

        The Amazon Web Services accounts targeted by the current Automation execution.

      • Regions — (Array<String>)

        The Amazon Web Services Regions targeted by the current Automation execution.

      • TargetLocationMaxConcurrency — (String)

        The maximum number of Amazon Web Services Regions and Amazon Web Services accounts 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. If not specified, the default value is AWS-SystemsManager-AutomationExecutionRole.

      • TargetLocationAlarmConfiguration — (map)

        The details for the CloudWatch alarm you want to apply to an automation or command.

        • IgnorePollAlarmFailure — (Boolean)

          When this value is true, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is false.

        • Alarms — required — (Array<map>)

          The name of the CloudWatch alarm specified in the configuration.

          • Name — required — (String)

            The name of your CloudWatch alarm.

    • ScheduleOffset — (Integer)

      Number of days to wait after the scheduled day to run an association.

    • Duration — (Integer)

      The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot.

      The Duration parameter applies only when both these conditions are true:

      • The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution.

      • The command specifies the ApplyOnlyAtCronInterval parameter, which means that the association doesn't run immediately after it is created, but only according to the specified schedule.

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

      A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

    • AlarmConfiguration — (map)

      The details for the CloudWatch alarm you want to apply to an automation or command.

      • IgnorePollAlarmFailure — (Boolean)

        When this value is true, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is false.

      • Alarms — required — (Array<map>)

        The name of the CloudWatch alarm specified in the configuration.

        • Name — required — (String)

          The name of your CloudWatch alarm.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Successful — (Array<map>)

      Information about the associations that succeeded.

      • Name — (String)

        The name of the SSM document.

      • InstanceId — (String)

        The managed node ID.

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

        • Date — required — (Date)

          The date when the status changed.

        • Name — required — (String)

          The status.

          Possible values include:
          • "Pending"
          • "Success"
          • "Failed"
        • Message — required — (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 managed nodes, and one of them was successful, this would return the count of managed nodes by status.

      • DocumentVersion — (String)

        The document version.

      • AutomationTargetParameterName — (String)

        Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.

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

        A description of the parameters for a document.

      • AssociationId — (String)

        The association ID.

      • Targets — (Array<map>)

        The managed nodes targeted by the request.

        • Key — (String)

          User-defined criteria for sending commands that target managed nodes 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 EC2 tags of ServerRole,WebServer.

          Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.

      • ScheduleExpression — (String)

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

      • OutputLocation — (map)

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

        • S3Location — (map)

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

          • OutputS3Region — (String)

            The Amazon Web Services Region of the S3 bucket.

          • OutputS3BucketName — (String)

            The name of the S3 bucket.

          • OutputS3KeyPrefix — (String)

            The 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 managed nodes 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 managed node 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 managed node 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"
      • SyncCompliance — (String)

        The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.

        In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

        By default, all associations use AUTO mode.

        Possible values include:
        • "AUTO"
        • "MANUAL"
      • ApplyOnlyAtCronInterval — (Boolean)

        By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions.

      • CalendarNames — (Array<String>)

        The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.

      • TargetLocations — (Array<map>)

        The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.

        • Accounts — (Array<String>)

          The Amazon Web Services accounts targeted by the current Automation execution.

        • Regions — (Array<String>)

          The Amazon Web Services Regions targeted by the current Automation execution.

        • TargetLocationMaxConcurrency — (String)

          The maximum number of Amazon Web Services Regions and Amazon Web Services accounts 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. If not specified, the default value is AWS-SystemsManager-AutomationExecutionRole.

        • TargetLocationAlarmConfiguration — (map)

          The details for the CloudWatch alarm you want to apply to an automation or command.

          • IgnorePollAlarmFailure — (Boolean)

            When this value is true, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is false.

          • Alarms — required — (Array<map>)

            The name of the CloudWatch alarm specified in the configuration.

            • Name — required — (String)

              The name of your CloudWatch alarm.

      • ScheduleOffset — (Integer)

        Number of days to wait after the scheduled day to run an association.

      • Duration — (Integer)

        The number of hours that an association can run on specified targets. After the resulting cutoff time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets.

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

        A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

      • AlarmConfiguration — (map)

        The details for the CloudWatch alarm you want to apply to an automation or command.

        • IgnorePollAlarmFailure — (Boolean)

          When this value is true, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is false.

        • Alarms — required — (Array<map>)

          The name of the CloudWatch alarm specified in the configuration.

          • Name — required — (String)

            The name of your CloudWatch alarm.

      • TriggeredAlarms — (Array<map>)

        The CloudWatch alarm that was invoked during the association.

        • Name — required — (String)

          The name of your CloudWatch alarm.

        • State — required — (String)

          The state of your CloudWatch alarm.

          Possible values include:
          • "UNKNOWN"
          • "ALARM"
    • Failed — (Array<map>)

      Information about the associations that failed.

      • Entry — (map)

        The association.

        • Name — required — (String)

          The name of the SSM document that contains the configuration information for the managed node. You can specify Command or Automation runbooks.

          You can specify Amazon Web Services-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 Amazon Web Services 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 Amazon Web Services-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 managed node ID.

          Note: InstanceId has been deprecated. To specify a managed node ID for an association, use the Targets parameter. Requests that include the parameter InstanceID with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId, you can't use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.
        • 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 runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.

        • DocumentVersion — (String)

          The document version.

        • Targets — (Array<map>)

          The managed nodes targeted by the request.

          • Key — (String)

            User-defined criteria for sending commands that target managed nodes 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 EC2 tags of ServerRole,WebServer.

            Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.

        • ScheduleExpression — (String)

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

        • OutputLocation — (map)

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

          • S3Location — (map)

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

            • OutputS3Region — (String)

              The Amazon Web Services Region of the S3 bucket.

            • OutputS3BucketName — (String)

              The name of the S3 bucket.

            • OutputS3KeyPrefix — (String)

              The 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 managed nodes 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 managed node 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 managed node 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"
        • SyncCompliance — (String)

          The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.

          In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

          By default, all associations use AUTO mode.

          Possible values include:
          • "AUTO"
          • "MANUAL"
        • ApplyOnlyAtCronInterval — (Boolean)

          By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions.

        • CalendarNames — (Array<String>)

          The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that Change Calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.

        • TargetLocations — (Array<map>)

          Use this action to create an association in multiple Regions and multiple accounts.

          • Accounts — (Array<String>)

            The Amazon Web Services accounts targeted by the current Automation execution.

          • Regions — (Array<String>)

            The Amazon Web Services Regions targeted by the current Automation execution.

          • TargetLocationMaxConcurrency — (String)

            The maximum number of Amazon Web Services Regions and Amazon Web Services accounts 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. If not specified, the default value is AWS-SystemsManager-AutomationExecutionRole.

          • TargetLocationAlarmConfiguration — (map)

            The details for the CloudWatch alarm you want to apply to an automation or command.

            • IgnorePollAlarmFailure — (Boolean)

              When this value is true, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is false.

            • Alarms — required — (Array<map>)

              The name of the CloudWatch alarm specified in the configuration.

              • Name — required — (String)

                The name of your CloudWatch alarm.

        • ScheduleOffset — (Integer)

          Number of days to wait after the scheduled day to run an association.

        • Duration — (Integer)

          The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot.

          The Duration parameter applies only when both these conditions are true:

          • The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution.

          • The command specifies the ApplyOnlyAtCronInterval parameter, which means that the association doesn't run immediately after it is created, but only according to the specified schedule.

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

          A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

        • AlarmConfiguration — (map)

          The details for the CloudWatch alarm you want to apply to an automation or command.

          • IgnorePollAlarmFailure — (Boolean)

            When this value is true, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is false.

          • Alarms — required — (Array<map>)

            The name of the CloudWatch alarm specified in the configuration.

            • Name — required — (String)

              The name of your CloudWatch alarm.

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

var params = {
  Content: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Attachments: [
    {
      Key: SourceUrl | S3FileUrl | AttachmentReference,
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  DisplayName: 'STRING_VALUE',
  DocumentFormat: YAML | JSON | TEXT,
  DocumentType: Command | Policy | Automation | Session | Package | ApplicationConfiguration | ApplicationConfigurationSchema | DeploymentStrategy | ChangeCalendar | Automation.ChangeTemplate | ProblemAnalysis | ProblemAnalysisTemplate | CloudFormation | ConformancePackTemplate | QuickSetup,
  Requires: [
    {
      Name: 'STRING_VALUE', /* required */
      RequireType: 'STRING_VALUE',
      Version: 'STRING_VALUE',
      VersionName: 'STRING_VALUE'
    },
    /* more items */
  ],
  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)

    The content for the new SSM document in JSON or YAML format. The content of the document must not exceed 64KB. This quota also includes the content specified for input parameters at runtime. We recommend storing the contents for your new document in an external JSON or YAML file and referencing the file in a command.

    For examples, see the following topics in the Amazon Web Services Systems Manager User Guide.

    • Create an SSM document (console)

    • Create an SSM document (command line)

    • Create an SSM document (API)

  • Requires — (Array<map>)

    A list of SSM documents required by a document. This parameter is used exclusively by AppConfig. When a user creates an AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes. In this case, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document for validation purposes. For more information, see What is AppConfig? in the AppConfig User Guide.

    • Name — required — (String)

      The name of the required SSM document. The name can be an Amazon Resource Name (ARN).

    • Version — (String)

      The document version required by the current document.

    • RequireType — (String)

      The document type of the required SSM document.

    • VersionName — (String)

      An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.

  • Attachments — (Array<map>)

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

    • Key — (String)

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

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

      The value of a key-value pair that identifies the location of an attachment to a document. The format for Value depends on the type of key you specify.

      • For the key SourceUrl, the value is an S3 bucket location. For example:

        "Values": [ "s3://doc-example-bucket/my-folder" ]

      • For the key S3FileUrl, the value is a file in an S3 bucket. For example:

        "Values": [ "s3://doc-example-bucket/my-folder/my-file.py" ]

      • For the key AttachmentReference, the value is constructed from the name of another SSM document in your account, a version number of that document, and a file attached to that document version that you want to reuse. For example:

        "Values": [ "MyOtherDocument/3/my-other-file.py" ]

        However, if the SSM document is shared with you from another account, the full SSM document ARN must be specified instead of the document name only. For example:

        "Values": [ "arn:aws:ssm:us-east-2:111122223333:document/OtherAccountDocument/3/their-file.py" ]

    • Name — (String)

      The name of the document attachment file.

  • Name — (String)

    A name for the SSM document.

    You can't use the following strings as document name prefixes. These are reserved by Amazon Web Services for use as document name prefixes:

    • aws

    • amazon

    • amzn

    • AWSEC2

    • AWSConfigRemediation

    • AWSSupport

  • DisplayName — (String)

    An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. You can update this value at a later time using the UpdateDocument operation.

  • VersionName — (String)

    An optional field specifying the version of the artifact you are creating with the document. For example, Release12.1. This value is unique across all versions of a document, and can't be changed.

  • DocumentType — (String)

    The type of document to create.

    Note: The DeploymentStrategy document type is an internal-use-only document type reserved for AppConfig.
    Possible values include:
    • "Command"
    • "Policy"
    • "Automation"
    • "Session"
    • "Package"
    • "ApplicationConfiguration"
    • "ApplicationConfigurationSchema"
    • "DeploymentStrategy"
    • "ChangeCalendar"
    • "Automation.ChangeTemplate"
    • "ProblemAnalysis"
    • "ProblemAnalysisTemplate"
    • "CloudFormation"
    • "ConformancePackTemplate"
    • "QuickSetup"
  • DocumentFormat — (String)

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

    Possible values include:
    • "YAML"
    • "JSON"
    • "TEXT"
  • 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 Amazon Web Services resource and property types reference in the 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-value pairs:

    • Key=OS,Value=Windows

    • Key=Environment,Value=Production

    Note: To add tags to an existing SSM document, use the AddTagsToResource operation.
    • Key — required — (String)

      The name of the tag.

    • Value — required — (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 SSM 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 SSM document.

      • DisplayName — (String)

        The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.

      • VersionName — (String)

        The version of the artifact associated with the document.

      • Owner — (String)

        The Amazon Web Services user that created the document.

      • CreatedDate — (Date)

        The date when the document was created.

      • Status — (String)

        The status of the SSM document.

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

        A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket doesn't 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 operating system (OS) platforms compatible with this SSM document.

      • DocumentType — (String)

        The type of document.

        Possible values include:
        • "Command"
        • "Policy"
        • "Automation"
        • "Session"
        • "Package"
        • "ApplicationConfiguration"
        • "ApplicationConfigurationSchema"
        • "DeploymentStrategy"
        • "ChangeCalendar"
        • "Automation.ChangeTemplate"
        • "ProblemAnalysis"
        • "ProblemAnalysisTemplate"
        • "CloudFormation"
        • "ConformancePackTemplate"
        • "QuickSetup"
      • 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"
        • "TEXT"
      • 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 Amazon Web Services resource and property types reference in the CloudFormation User Guide.

      • Tags — (Array<map>)

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

        • Key — required — (String)

          The name of the tag.

        • Value — required — (String)

          The value of the tag.

      • AttachmentsInformation — (Array<map>)

        Details about the document attachments, including names, locations, sizes, and so on.

        • Name — (String)

          The name of the attachment.

      • Requires — (Array<map>)

        A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

        • Name — required — (String)

          The name of the required SSM document. The name can be an Amazon Resource Name (ARN).

        • Version — (String)

          The document version required by the current document.

        • RequireType — (String)

          The document type of the required SSM document.

        • VersionName — (String)

          An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.

      • Author — (String)

        The user in your organization who created the document.

      • ReviewInformation — (Array<map>)

        Details about the review of a document.

        • ReviewedTime — (Date)

          The time that the reviewer took action on the document review request.

        • Status — (String)

          The current status of the document review request.

          Possible values include:
          • "APPROVED"
          • "NOT_REVIEWED"
          • "PENDING"
          • "REJECTED"
        • Reviewer — (String)

          The reviewer assigned to take action on the document review request.

      • ApprovedVersion — (String)

        The version of the document currently approved for use in the organization.

      • PendingReviewVersion — (String)

        The version of the document that is currently under review.

      • ReviewStatus — (String)

        The current status of the review.

        Possible values include:
        • "APPROVED"
        • "NOT_REVIEWED"
        • "PENDING"
        • "REJECTED"
      • Category — (Array<String>)

        The classification of a document to help you identify and categorize its use.

      • CategoryEnum — (Array<String>)

        The value that identifies a document's category.

Returns:

• (AWS.Request) —

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

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',
  ScheduleOffset: 'NUMBER_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.

    Note: When using a rate schedule, if you provide a start date that occurs in the past, the current date and time are used as the start 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", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.

  • ScheduleOffset — (Integer)

    The number of days to wait after the date and time specified by a cron expression before running the maintenance window.

    For example, the following cron expression schedules a maintenance window to run on the third Tuesday of every month at 11:30 PM.

    cron(30 23 ? * TUE#3 *)

    If the schedule offset is 2, the maintenance window won't run until two days later.

  • Duration — (Integer)

    The duration of the maintenance window in hours.

  • Cutoff — (Integer)

    The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.

  • AllowUnassociatedTargets — (Boolean)

    Enables a maintenance window task to run on managed nodes, even if you haven't registered those nodes as targets. If enabled, then you must specify the unregistered managed nodes (by node 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-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 operation.
    • Key — required — (String)

      The name of the tag.

    • Value — required — (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.

var params = {
  Description: 'STRING_VALUE', /* required */
  Source: 'STRING_VALUE', /* required */
  Title: 'STRING_VALUE', /* required */
  AccountId: 'STRING_VALUE',
  ActualEndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  ActualStartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  Category: 'STRING_VALUE',
  Notifications: [
    {
      Arn: 'STRING_VALUE'
    },
    /* more items */
  ],
  OperationalData: {
    '<OpsItemDataKey>': {
      Type: SearchableString | String,
      Value: 'STRING_VALUE'
    },
    /* '<OpsItemDataKey>': ... */
  },
  OpsItemType: 'STRING_VALUE',
  PlannedEndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  PlannedStartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  Priority: 'NUMBER_VALUE',
  RelatedOpsItems: [
    {
      OpsItemId: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  Severity: 'STRING_VALUE',
  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)

    User-defined text that contains information about the OpsItem, in Markdown format.

    Note: Provide enough information so that users viewing this OpsItem for the first time understand the issue.
  • OpsItemType — (String)

    The type of OpsItem to create. Systems Manager supports the following types of OpsItems:

    • /aws/issue

      This type of OpsItem is used for default OpsItems created by OpsCenter.

    • /aws/changerequest

      This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.

    • /aws/insight

      This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.

  • 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 operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API operation).

    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 Amazon Web Services CLI example commands that use these keys, see Create OpsItems manually in the Amazon Web Services 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 Amazon Simple Notification Service (Amazon 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.

    • OpsItemId — required — (String)

      The ID of an OpsItem related to the current OpsItem.

  • Source — (String)

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

    Note: The source name can't contain the following strings: aws, amazon, and amzn.
  • 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.

    Tags use a key-value pair. For example:

    Key=Department,Value=Finance

    To add tags to a new OpsItem, a user must have IAM permissions for both the ssm:CreateOpsItems operation and the ssm:AddTagsToResource operation. To add tags to an existing OpsItem, use the AddTagsToResource operation.

    • Key — required — (String)

      The name of the tag.

    • Value — required — (String)

      The value of the tag.

  • Category — (String)

    Specify a category to assign to an OpsItem.

  • Severity — (String)

    Specify a severity to assign to an OpsItem.

  • ActualStartTime — (Date)

    The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest.

  • ActualEndTime — (Date)

    The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.

  • PlannedStartTime — (Date)

    The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.

  • PlannedEndTime — (Date)

    The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.

  • AccountId — (String)

    The target Amazon Web Services account where you want to create an OpsItem. To make this call, your account must be configured to work with OpsItems across accounts. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to 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.

    • OpsItemArn — (String)

      The OpsItem Amazon Resource Name (ARN).

Returns:

• (AWS.Request) —

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

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  Metadata: {
    '<MetadataKey>': {
      Value: 'STRING_VALUE'
    },
    /* '<MetadataKey>': ... */
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
ssm.createOpsMetadata(params, 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)

    A resource ID for a new Application Manager application.

  • Metadata — (map<map>)

    Metadata for a new Application Manager application.

    • Value — (String)

      Metadata value to assign to an Application Manager application.

  • Tags — (Array<map>)

    Optional metadata that you assign to a resource. You can specify a maximum of five tags for an OpsMetadata object. 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 OpsMetadata object to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs:

    • Key=Environment,Value=Production

    • Key=Region,Value=us-east-2

    • Key — required — (String)

      The name of the tag.

    • Value — required — (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:

    • OpsMetadataArn — (String)

      The Amazon Resource Name (ARN) of the OpsMetadata Object or blob created by the call.

Returns:

• (AWS.Request) —

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

var params = {
  Name: 'STRING_VALUE', /* required */
  ApprovalRules: {
    PatchRules: [ /* required */
      {
        PatchFilterGroup: { /* required */
          PatchFilters: [ /* required */
            {
              Key: ARCH | ADVISORY_ID | BUGZILLA_ID | PATCH_SET | PRODUCT | PRODUCT_FAMILY | CLASSIFICATION | CVE_ID | EPOCH | MSRC_SEVERITY | NAME | PATCH_ID | SECTION | PRIORITY | REPOSITORY | RELEASE | SEVERITY | SECURITY | VERSION, /* required */
              Values: [ /* required */
                'STRING_VALUE',
                /* more items */
              ]
            },
            /* more items */
          ]
        },
        ApproveAfterDays: 'NUMBER_VALUE',
        ApproveUntilDate: 'STRING_VALUE',
        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: ARCH | ADVISORY_ID | BUGZILLA_ID | PATCH_SET | PRODUCT | PRODUCT_FAMILY | CLASSIFICATION | CVE_ID | EPOCH | MSRC_SEVERITY | NAME | PATCH_ID | SECTION | PRIORITY | REPOSITORY | RELEASE | SEVERITY | SECURITY | VERSION, /* required */
        Values: [ /* required */
          'STRING_VALUE',
          /* more items */
        ]
      },
      /* more items */
    ]
  },
  OperatingSystem: WINDOWS | AMAZON_LINUX | AMAZON_LINUX_2 | AMAZON_LINUX_2022 | UBUNTU | REDHAT_ENTERPRISE_LINUX | SUSE | CENTOS | ORACLE_LINUX | DEBIAN | MACOS | RASPBIAN | ROCKY_LINUX | ALMA_LINUX | AMAZON_LINUX_2023,
  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"
    • "AMAZON_LINUX_2022"
    • "UBUNTU"
    • "REDHAT_ENTERPRISE_LINUX"
    • "SUSE"
    • "CENTOS"
    • "ORACLE_LINUX"
    • "DEBIAN"
    • "MACOS"
    • "RASPBIAN"
    • "ROCKY_LINUX"
    • "ALMA_LINUX"
    • "AMAZON_LINUX_2023"
  • Name — (String)

    The name of the patch baseline.

  • GlobalFilters — (map)

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

    • PatchFilters — required — (Array<map>)

      The set of patch filters that make up the group.

      • Key — required — (String)

        The key for the filter.

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

        Possible values include:
        • "ARCH"
        • "ADVISORY_ID"
        • "BUGZILLA_ID"
        • "PATCH_SET"
        • "PRODUCT"
        • "PRODUCT_FAMILY"
        • "CLASSIFICATION"
        • "CVE_ID"
        • "EPOCH"
        • "MSRC_SEVERITY"
        • "NAME"
        • "PATCH_ID"
        • "SECTION"
        • "PRIORITY"
        • "REPOSITORY"
        • "RELEASE"
        • "SEVERITY"
        • "SECURITY"
        • "VERSION"
      • Values — required — (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.

    • PatchRules — required — (Array<map>)

      The rules that make up the rule group.

      • PatchFilterGroup — required — (map)

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

        • PatchFilters — required — (Array<map>)

          The set of patch filters that make up the group.

          • Key — required — (String)

            The key for the filter.

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

            Possible values include:
            • "ARCH"
            • "ADVISORY_ID"
            • "BUGZILLA_ID"
            • "PATCH_SET"
            • "PRODUCT"
            • "PRODUCT_FAMILY"
            • "CLASSIFICATION"
            • "CVE_ID"
            • "EPOCH"
            • "MSRC_SEVERITY"
            • "NAME"
            • "PATCH_ID"
            • "SECTION"
            • "PRIORITY"
            • "REPOSITORY"
            • "RELEASE"
            • "SEVERITY"
            • "SECURITY"
            • "VERSION"
          • Values — required — (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.

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

        Note: This parameter is marked as not required, but your request must include a value for either ApproveAfterDays or ApproveUntilDate.

        Not supported for Debian Server or Ubuntu Server.

      • ApproveUntilDate — (String)

        The cutoff date for auto approval of released patches. Any patches released on or before this date are installed automatically.

        Enter dates in the format YYYY-MM-DD. For example, 2021-12-31.

        Note: This parameter is marked as not required, but your request must include a value for either ApproveUntilDate or ApproveAfterDays.

        Not supported for Debian Server or Ubuntu Server.

      • EnableNonSecurity — (Boolean)

        For managed nodes 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 managed nodes 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 About package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.

  • ApprovedPatchesComplianceLevel — (String)

    Defines the compliance level for approved patches. When an approved patch is reported as missing, this value describes 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 managed nodes. The default value is false. Applies to Linux managed nodes 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 About package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.

  • RejectedPatchesAction — (String)

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

    ALLOW_AS_DEPENDENCY

    Linux and macOS: 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 INSTALLED_OTHER. This is the default action if no option is specified.

    Windows Server: Windows Server doesn't support the concept of package dependencies. If a package in the rejected patches list and already installed on the node, its status is reported as INSTALLED_OTHER. Any package not already installed on the node is skipped. This is the default action if no option is specified.

    BLOCK

    All OSs: Packages in the rejected patches list, and packages that include them as dependencies, aren't installed by Patch Manager under any circumstances. If a package was installed before it was added to the rejected patches list, or is installed outside of Patch Manager afterward, it's considered noncompliant with the patch baseline and its status is reported as INSTALLED_REJECTED.

    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 managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.

    • Name — required — (String)

      The name specified to identify the patch source.

    • Products — required — (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.

    • Configuration — required — (String)

      The value of the yum repo configuration. For example:

      [main]

      name=MyCustomRepository

      baseurl=https://my-custom-repository

      enabled=1

      Note: For information about other options available for your yum repository configuration, see dnf.conf(5).
  • 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-value pairs:

    • Key=PatchSeverity,Value=Critical

    • Key=OS,Value=Windows

    Note: To add tags to an existing patch baseline, use the AddTagsToResource operation.
    • Key — required — (String)

      The name of the tag.

    • Value — required — (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.

var params = {
  SyncName: 'STRING_VALUE', /* required */
  S3Destination: {
    BucketName: 'STRING_VALUE', /* required */
    Region: 'STRING_VALUE', /* required */
    SyncFormat: JsonSerDe, /* required */
    AWSKMSKeyARN: 'STRING_VALUE',
    DestinationDataSharing: {
      DestinationDataSharingType: 'STRING_VALUE'
    },
    Prefix: 'STRING_VALUE'
  },
  SyncSource: {
    SourceRegions: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    SourceType: 'STRING_VALUE', /* required */
    AwsOrganizationsSource: {
      OrganizationSourceType: 'STRING_VALUE', /* required */
      OrganizationalUnits: [
        {
          OrganizationalUnitId: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    EnableAllOpsDataSources: true || false,
    IncludeFutureRegions: true || false
  },
  SyncType: 'STRING_VALUE'
};
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. This parameter is required if the SyncType value is SyncToDestination.

    • BucketName — required — (String)

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

    • Prefix — (String)

      An Amazon S3 prefix for the bucket.

    • SyncFormat — required — (String)

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

      Possible values include:
      • "JsonSerDe"
    • Region — required — (String)

      The Amazon Web Services Region with the 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 S3 bucket.

    • DestinationDataSharing — (map)

      Enables destination data sharing. By default, this field is null.

      • DestinationDataSharingType — (String)

        The sharing data type. Only Organization is supported.

  • SyncType — (String)

    Specify SyncToDestination to create a resource data sync that synchronizes data to an S3 bucket for Inventory. If you specify SyncToDestination, you must provide a value for S3Destination. Specify SyncFromSource to synchronize data from a single account and multiple Regions, or multiple Amazon Web Services accounts and Amazon Web Services Regions, as listed in Organizations for Explorer. If you specify SyncFromSource, you must provide a value for SyncSource. The default value is SyncToDestination.

  • SyncSource — (map)

    Specify information about the data sources to synchronize. This parameter is required if the SyncType value is SyncFromSource.

    • SourceType — required — (String)

      The type of data source for the resource data sync. SourceType is either AwsOrganizations (if an organization is present in Organizations) or SingleAccountMultiRegions.

    • AwsOrganizationsSource — (map)

      Information about the AwsOrganizationsSource resource data sync source. A sync source of this type can synchronize data from Organizations.

      • OrganizationSourceType — required — (String)

        If an Amazon Web Services organization is present, this is either OrganizationalUnits or EntireOrganization. For OrganizationalUnits, the data is aggregated from a set of organization units. For EntireOrganization, the data is aggregated from the entire Amazon Web Services organization.

      • OrganizationalUnits — (Array<map>)

        The Organizations organization units included in the sync.

        • OrganizationalUnitId — (String)

          The Organizations unit ID data source for the sync.

    • SourceRegions — required — (Array<String>)

      The SyncSource Amazon Web Services Regions included in the resource data sync.

    • IncludeFutureRegions — (Boolean)

      Whether to automatically synchronize and aggregate data from new Amazon Web Services Regions when those Regions come online.

    • EnableAllOpsDataSources — (Boolean)

      When you create a resource data sync, if you choose one of the Organizations options, then Systems Manager automatically enables all OpsData sources in the selected Amazon Web Services Regions for all Amazon Web Services accounts in your organization (or in the selected organization units). For more information, see Setting up Systems Manager Explorer to display data from multiple accounts and Regions in the Amazon Web Services Systems Manager User Guide.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to 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.

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.

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 SSM document.

  • InstanceId — (String)

    The managed node ID.

    Note: InstanceId has been deprecated. To specify a managed node ID for an association, use the Targets parameter. Requests that include the parameter InstanceID with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId, you can't use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.
  • 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.

var params = {
  Name: 'STRING_VALUE', /* required */
  DocumentVersion: 'STRING_VALUE',
  Force: true || false,
  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.

  • Force — (Boolean)

    Some SSM document types require that you specify a Force flag before you can delete the document. For example, you must specify a Force flag to delete a document of type ApplicationConfigurationSchema. You can restrict access to the Force flag in an Identity and Access Management (IAM) policy.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to 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.

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 operation 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 operation 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 operations.

    • 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 Amazon Web Services Systems Manager User Guide.

      • TotalCount — (Integer)

        The total number of items to delete. This count doesn't 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.

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.

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

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

Parameters:

• params (Object) (defaults to: {}) —
  • OpsMetadataArn — (String)

    The Amazon Resource Name (ARN) of an OpsMetadata Object 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.

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.

    Note: You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to 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.

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. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.

    Note: You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to 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 aren't valid.

Returns:

• (AWS.Request) —

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

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.

var params = {
  SyncName: 'STRING_VALUE', /* required */
  SyncType: 'STRING_VALUE'
};
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.

  • SyncType — (String)

    Specify the type of resource data sync 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.

var params = {
  PolicyHash: 'STRING_VALUE', /* required */
  PolicyId: 'STRING_VALUE', /* required */
  ResourceArn: 'STRING_VALUE' /* required */
};
ssm.deleteResourcePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceArn — (String)

    Amazon Resource Name (ARN) of the resource to which the policies are attached.

  • PolicyId — (String)

    The policy ID.

  • PolicyHash — (String)

    ID of the current policy version. The hash helps to prevent multiple calls from attempting to overwrite a policy.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to 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.

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

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.

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 doesn't 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.

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.

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 Amazon Web Services 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 node when it is created.

      • IamRole — (String)

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

      • RegistrationLimit — (Integer)

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

      • RegistrationsCount — (Integer)

        The number of managed nodes already registered with this activation.

      • ExpirationDate — (Date)

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

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

        • Key — required — (String)

          The name of the tag.

        • Value — required — (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.

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 SSM document.

  • InstanceId — (String)

    The managed node 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 a managed node, 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 SSM document.

      • InstanceId — (String)

        The managed node ID.

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

        • Date — required — (Date)

          The date when the status changed.

        • Name — required — (String)

          The status.

          Possible values include:
          • "Pending"
          • "Success"
          • "Failed"
        • Message — required — (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 managed nodes, and one of them was successful, this would return the count of managed nodes by status.

      • DocumentVersion — (String)

        The document version.

      • AutomationTargetParameterName — (String)

        Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.

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

        A description of the parameters for a document.

      • AssociationId — (String)

        The association ID.

      • Targets — (Array<map>)

        The managed nodes targeted by the request.

        • Key — (String)

          User-defined criteria for sending commands that target managed nodes 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 EC2 tags of ServerRole,WebServer.

          Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.

      • ScheduleExpression — (String)

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

      • OutputLocation — (map)

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

        • S3Location — (map)

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

          • OutputS3Region — (String)

            The Amazon Web Services Region of the S3 bucket.

          • OutputS3BucketName — (String)

            The name of the S3 bucket.

          • OutputS3KeyPrefix — (String)

            The 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 managed nodes 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 managed node 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 managed node 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"
      • SyncCompliance — (String)

        The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.

        In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

        By default, all associations use AUTO mode.

        Possible values include:
        • "AUTO"
        • "MANUAL"
      • ApplyOnlyAtCronInterval — (Boolean)

        By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions.

      • CalendarNames — (Array<String>)

        The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.

      • TargetLocations — (Array<map>)

        The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.

        • Accounts — (Array<String>)

          The Amazon Web Services accounts targeted by the current Automation execution.

        • Regions — (Array<String>)

          The Amazon Web Services Regions targeted by the current Automation execution.

        • TargetLocationMaxConcurrency — (String)

          The maximum number of Amazon Web Services Regions and Amazon Web Services accounts 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. If not specified, the default value is AWS-SystemsManager-AutomationExecutionRole.

        • TargetLocationAlarmConfiguration — (map)

          The details for the CloudWatch alarm you want to apply to an automation or command.

          • IgnorePollAlarmFailure — (Boolean)

            When this value is true, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is false.

          • Alarms — required — (Array<map>)

            The name of the CloudWatch alarm specified in the configuration.

            • Name — required — (String)

              The name of your CloudWatch alarm.

      • ScheduleOffset — (Integer)

        Number of days to wait after the scheduled day to run an association.

      • Duration — (Integer)

        The number of hours that an association can run on specified targets. After the resulting cutoff time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets.

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

        A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

      • AlarmConfiguration — (map)

        The details for the CloudWatch alarm you want to apply to an automation or command.

        • IgnorePollAlarmFailure — (Boolean)

          When this value is true, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is false.

        • Alarms — required — (Array<map>)

          The name of the CloudWatch alarm specified in the configuration.

          • Name — required — (String)

            The name of your CloudWatch alarm.

      • TriggeredAlarms — (Array<map>)

        The CloudWatch alarm that was invoked during the association.

        • Name — required — (String)

          The name of your CloudWatch alarm.

        • State — required — (String)

          The state of your CloudWatch alarm.

          Possible values include:
          • "UNKNOWN"
          • "ALARM"