@aws-sdk/client-ssm 3.47.2 → 3.48.0

package/dist-types/models/models_0.d.ts

@@ -60,8 +60,7 @@ export interface Activation {
      */
     DefaultInstanceName?: string;
     /**
-     * <p>The Identity and Access Management (IAM) role to assign to the managed
-     *    node.</p>
+     * <p>The Identity and Access Management (IAM) role to assign to the managed node.</p>
      */
     IamRole?: string;
     /**
@@ -185,8 +184,8 @@ export interface InvalidResourceId extends __SmithyException, $MetadataBearer {
     $fault: "client";
 }
 /**
- * <p>The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the
- *    instance must be a registered managed node.</p>
+ * <p>The resource type isn't valid. For example, if you are attempting to tag an EC2 instance,
+ *    the instance must be a registered managed node.</p>
  */
 export interface InvalidResourceType extends __SmithyException, $MetadataBearer {
     name: "InvalidResourceType";
@@ -309,8 +308,8 @@ export interface CancelCommandRequest {
      */
     CommandId: string | undefined;
     /**
-     * <p>(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.</p>
+     * <p>(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.</p>
      */
     InstanceIds?: string[];
 }
@@ -483,9 +482,9 @@ export interface CreateActivationRequest {
      *     automatically applied to the on-premises servers or VMs.</p>
      *          </important>
      *          <p>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 <a>AddTagsToResource</a>. For information about how to remove tags from your managed nodes,
+     *    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 <a>AddTagsToResource</a>. For information about how to remove tags from your managed nodes,
      *    see <a>RemoveTagsFromResource</a>.</p>
      */
     Tags?: Tag[];
@@ -769,17 +768,20 @@ export interface CreateAssociationRequest {
     /**
      * <p>The document version you want to associate with the target(s). Can be a specific version or
      *    the default version.</p>
+     *          <important>
+     *             <p>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 <code>default</code> 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 <code>default</code>.</p>
+     *          </important>
      */
     DocumentVersion?: string;
     /**
      * <p>The managed node ID.</p>
      *          <note>
      *             <p>
-     *                <code>InstanceId</code> has been deprecated. To specify a managed node ID for an association,
-     *     use the <code>Targets</code> parameter. Requests that include the
-     *     parameter <code>InstanceID</code> with Systems Manager documents (SSM documents) that use schema version
-     *     2.0 or later will fail. In addition, if you use the parameter
-     *      <code>InstanceId</code>, you can't use the parameters <code>AssociationName</code>,
+     *                <code>InstanceId</code> has been deprecated. To specify a managed node ID for an
+     *     association, use the <code>Targets</code> parameter. Requests that
+     *     include the parameter <code>InstanceID</code> with Systems Manager documents (SSM documents) that use
+     *     schema version 2.0 or later will fail. In addition, if you use the
+     *     parameter <code>InstanceId</code>, you can't use the parameters <code>AssociationName</code>,
      *      <code>DocumentVersion</code>, <code>MaxErrors</code>, <code>MaxConcurrency</code>,
      *      <code>OutputLocation</code>, or <code>ScheduleExpression</code>. To use these parameters, you
      *     must use the <code>Targets</code> parameter.</p>
@@ -839,8 +841,8 @@ export interface CreateAssociationRequest {
      *    value is 100%, which means all targets run the association at the same time.</p>
      *          <p>If a new managed node starts and attempts to run an association while Systems Manager is running
      *     <code>MaxConcurrency</code> 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 <code>MaxConcurrency</code>.</p>
+     *    association interval, the new managed node will process its association within the limit
+     *    specified for <code>MaxConcurrency</code>.</p>
      */
     MaxConcurrency?: string;
     /**
@@ -1041,8 +1043,8 @@ export interface AssociationDescription {
      *    value is 100%, which means all targets run the association at the same time.</p>
      *          <p>If a new managed node starts and attempts to run an association while Systems Manager is running
      *     <code>MaxConcurrency</code> 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 <code>MaxConcurrency</code>.</p>
+     *    association interval, the new managed node will process its association within the limit
+     *    specified for <code>MaxConcurrency</code>.</p>
      */
     MaxConcurrency?: string;
     /**
@@ -1145,8 +1147,8 @@ export interface InvalidTarget extends __SmithyException, $MetadataBearer {
     Message?: string;
 }
 /**
- * <p>The document doesn't support the platform type of the given managed node ID(s). For example, you
- *    sent an document for a Windows managed node to a Linux node.</p>
+ * <p>The document doesn't support the platform type of the given managed node ID(s). For example,
+ *    you sent an document for a Windows managed node to a Linux node.</p>
  */
 export interface UnsupportedPlatformType extends __SmithyException, $MetadataBearer {
     name: "UnsupportedPlatformType";
@@ -1158,8 +1160,8 @@ export interface UnsupportedPlatformType extends __SmithyException, $MetadataBea
  */
 export interface CreateAssociationBatchRequestEntry {
     /**
-     * <p>The name of the SSM document that contains the configuration information for the managed node.
-     *    You can specify Command or Automation runbooks.</p>
+     * <p>The name of the SSM document that contains the configuration information for the managed
+     *    node. You can specify Command or Automation runbooks.</p>
      *          <p>You can specify Amazon Web Services-predefined documents, documents you created, or a document that is
      *    shared with you from another account.</p>
      *          <p>For SSM documents that are shared with you from other Amazon Web Services accounts, you must specify the
@@ -1181,11 +1183,11 @@ export interface CreateAssociationBatchRequestEntry {
      * <p>The managed node ID.</p>
      *          <note>
      *             <p>
-     *                <code>InstanceId</code> has been deprecated. To specify a managed node ID for an association,
-     *     use the <code>Targets</code> parameter. Requests that include the
-     *     parameter <code>InstanceID</code> with Systems Manager documents (SSM documents) that use schema version
-     *     2.0 or later will fail. In addition, if you use the parameter
-     *      <code>InstanceId</code>, you can't use the parameters <code>AssociationName</code>,
+     *                <code>InstanceId</code> has been deprecated. To specify a managed node ID for an
+     *     association, use the <code>Targets</code> parameter. Requests that
+     *     include the parameter <code>InstanceID</code> with Systems Manager documents (SSM documents) that use
+     *     schema version 2.0 or later will fail. In addition, if you use the
+     *     parameter <code>InstanceId</code>, you can't use the parameters <code>AssociationName</code>,
      *      <code>DocumentVersion</code>, <code>MaxErrors</code>, <code>MaxConcurrency</code>,
      *      <code>OutputLocation</code>, or <code>ScheduleExpression</code>. To use these parameters, you
      *     must use the <code>Targets</code> parameter.</p>
@@ -1244,8 +1246,8 @@ export interface CreateAssociationBatchRequestEntry {
      *    value is 100%, which means all targets run the association at the same time.</p>
      *          <p>If a new managed node starts and attempts to run an association while Systems Manager is running
      *     <code>MaxConcurrency</code> 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 <code>MaxConcurrency</code>.</p>
+     *    association interval, the new managed node will process its association within the limit
+     *    specified for <code>MaxConcurrency</code>.</p>
      */
     MaxConcurrency?: string;
     /**
@@ -1659,7 +1661,7 @@ export declare enum DocumentStatus {
     Updating = "Updating"
 }
 /**
- * <p>Describes a Amazon Web Services Systems Manager document (SSM document). </p>
+ * <p>Describes an Amazon Web Services Systems Manager document (SSM document). </p>
  */
 export interface DocumentDescription {
     /**
@@ -1725,7 +1727,7 @@ export interface DocumentDescription {
      */
     Parameters?: DocumentParameter[];
     /**
-     * <p>The list of OS platforms compatible with this SSM document. </p>
+     * <p>The list of operating system (OS) platforms compatible with this SSM document. </p>
      */
     PlatformTypes?: (PlatformType | string)[];
     /**
@@ -1788,6 +1790,14 @@ export interface DocumentDescription {
      * <p>The current status of the review.</p>
      */
     ReviewStatus?: ReviewStatus | string;
+    /**
+     * <p>The classification of a document to help you identify and categorize its use.</p>
+     */
+    Category?: string[];
+    /**
+     * <p>The value that identifies a document's category.</p>
+     */
+    CategoryEnum?: string[];
 }
 export declare namespace DocumentDescription {
     /**
@@ -1906,8 +1916,8 @@ export interface CreateMaintenanceWindowRequest {
     Cutoff: number | undefined;
     /**
      * <p>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.</p>
+     *    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.</p>
      *          <p>If you don't enable this option, then you must specify previously-registered targets when
      *    you register a task with the maintenance window.</p>
      */
@@ -2838,14 +2848,14 @@ export interface DeleteAssociationRequest {
      * <p>The managed node ID.</p>
      *          <note>
      *             <p>
-     *                <code>InstanceId</code> has been deprecated. To specify a managed node ID for an association,
-     *     use the <code>Targets</code> parameter. Requests that include the
-     *     parameter <code>InstanceID</code> with Systems Manager documents (SSM documents) that use schema version
-     *     2.0 or later will fail. In addition, if you use the parameter
-     *      <code>InstanceId</code>, you can't use the parameters <code>AssociationName</code>,
-     *      <code>DocumentVersion</code>, <code>MaxErrors</code>, <code>MaxConcurrency</code>,
-     *      <code>OutputLocation</code>, or <code>ScheduleExpression</code>. To use these parameters, you
-     *     must use the <code>Targets</code> parameter.</p>
+     *                <code>InstanceId</code> has been deprecated. To specify a managed node ID for an
+     *     association, use the <code>Targets</code> parameter. Requests that include the parameter
+     *      <code>InstanceID</code> with Systems Manager documents (SSM documents) that use schema version 2.0 or
+     *     later will fail. In addition, if you use the parameter <code>InstanceId</code>, you can't use
+     *     the parameters <code>AssociationName</code>, <code>DocumentVersion</code>,
+     *      <code>MaxErrors</code>, <code>MaxConcurrency</code>, <code>OutputLocation</code>, or
+     *      <code>ScheduleExpression</code>. To use these parameters, you must use the <code>Targets</code>
+     *     parameter.</p>
      *          </note>
      */
     InstanceId?: string;
@@ -3464,8 +3474,8 @@ export interface DescribeAssociationRequest {
     /**
      * <p>Specify the association version to retrieve. To view the latest version, either specify
      *     <code>$LATEST</code> for this parameter, or omit this parameter. To view a list of all
-     *    associations for a managed node, use <a>ListAssociations</a>. To get a list of versions
-     *    for a specific association, use <a>ListAssociationVersions</a>. </p>
+     *    associations for a managed node, use <a>ListAssociations</a>. To get a list of
+     *    versions for a specific association, use <a>ListAssociationVersions</a>. </p>
      */
     AssociationVersion?: string;
 }
@@ -5173,8 +5183,8 @@ export declare namespace InstanceInformationFilter {
 export interface DescribeInstanceInformationRequest {
     /**
      * <p>This is a legacy method. We recommend that you don't use this method. Instead, use the
-     *     <code>Filters</code> data type. <code>Filters</code> enables you to return node information
-     *    by filtering based on tags applied to managed nodes.</p>
+     *     <code>Filters</code> data type. <code>Filters</code> enables you to return node information by
+     *    filtering based on tags applied to managed nodes.</p>
      *          <note>
      *             <p>Attempting to use <code>InstanceInformationFilterList</code> and <code>Filters</code> leads
      *     to an exception error. </p>
@@ -5456,8 +5466,8 @@ export declare enum PatchComplianceDataState {
     NotApplicable = "NOT_APPLICABLE"
 }
 /**
- * <p>Information about the state of a patch on a particular managed node as it relates to the patch
- *    baseline used to patch the node.</p>
+ * <p>Information about the state of a patch on a particular managed node as it relates to the
+ *    patch baseline used to patch the node.</p>
  */
 export interface PatchComplianceData {
     /**
@@ -5614,8 +5624,8 @@ export interface InstancePatchState {
      */
     InstalledCount?: number;
     /**
-     * <p>The number of patches not specified in the patch baseline that are installed on the
-     *    managed node.</p>
+     * <p>The number of patches not specified in the patch baseline that are installed on the managed
+     *    node.</p>
      */
     InstalledOtherCount?: number;
     /**
@@ -5650,8 +5660,8 @@ export interface InstancePatchState {
      */
     UnreportedNotApplicableCount?: number;
     /**
-     * <p>The number of patches from the patch baseline that aren't applicable for the managed node and
-     *    therefore aren't installed on the node. This number may be truncated if the list of patch
+     * <p>The number of patches from the patch baseline that aren't applicable for the managed node
+     *    and therefore aren't installed on the node. This number may be truncated if the list of patch
      *    names is very large. The number of patches beyond this limit are reported in
      *     <code>UnreportedNotApplicableCount</code>.</p>
      */
@@ -5679,8 +5689,8 @@ export interface InstancePatchState {
      */
     Operation: PatchOperationType | string | undefined;
     /**
-     * <p>The time of the last attempt to patch the managed node with <code>NoReboot</code> specified as
-     *    the reboot option.</p>
+     * <p>The time of the last attempt to patch the managed node with <code>NoReboot</code> specified
+     *    as the reboot option.</p>
      */
     LastNoRebootInstallOperationTime?: Date;
     /**
@@ -5692,8 +5702,8 @@ export interface InstancePatchState {
      *          <ul>
      *             <li>
      *                <p>
-     *                   <code>RebootIfNeeded</code>: Patch Manager tries to reboot the managed node if it installed
-     *      any patches, or if any patches are detected with a status of
+     *                   <code>RebootIfNeeded</code>: Patch Manager tries to reboot the managed node if it
+     *      installed any patches, or if any patches are detected with a status of
      *       <code>InstalledPendingReboot</code>.</p>
      *             </li>
      *             <li>
@@ -5709,15 +5719,15 @@ export interface InstancePatchState {
     /**
      * <p>The number of managed nodes where patches that are specified as <code>Critical</code> for
      *    compliance reporting in the patch baseline aren't installed. These patches might be missing, have
-     *    failed installation, were rejected, or were installed but awaiting a required managed node reboot.
-     *    The status of these managed nodes is <code>NON_COMPLIANT</code>.</p>
+     *    failed installation, were rejected, or were installed but awaiting a required managed node
+     *    reboot. The status of these managed nodes is <code>NON_COMPLIANT</code>.</p>
      */
     CriticalNonCompliantCount?: number;
     /**
      * <p>The number of managed nodes where patches that are specified as <code>Security</code> in a
      *    patch advisory aren't installed. These patches might be missing, have failed installation, were
-     *    rejected, or were installed but awaiting a required managed node reboot. The status of these managed
-     *    nodes is <code>NON_COMPLIANT</code>.</p>
+     *    rejected, or were installed but awaiting a required managed node reboot. The status of these
+     *    managed nodes is <code>NON_COMPLIANT</code>.</p>
      */
     SecurityNonCompliantCount?: number;
     /**
@@ -6725,8 +6735,8 @@ export declare enum MaintenanceWindowTaskCutoffBehavior {
     ContinueTask = "CONTINUE_TASK"
 }
 /**
- * <p>Information about an Amazon Simple Storage Service (Amazon S3) bucket to write
- *    managed node-level logs to.</p>
+ * <p>Information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed
+ *    node-level logs to.</p>
  *          <note>
  *             <p>
  *                <code>LoggingInfo</code> has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the