@aws-sdk/client-ssm 3.556.0 → 3.563.0

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

@@ -1,6 +1,205 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
-import { AlarmConfiguration, AlarmStateInformation, AssociationComplianceSeverity, AssociationOverview, AssociationSyncCompliance, AutomationExecutionStatus, AutomationSubtype, DocumentFormat, DocumentHashType, DocumentPermissionType, DocumentRequires, DocumentStatus, DocumentType, ExecutionMode, InstanceAssociationOutputLocation, MaintenanceWindowExecutionStatus, MaintenanceWindowResourceType, MaintenanceWindowTaskType, MetadataValue, OperatingSystem, OpsItemDataValue, OpsItemNotification, PatchAction, PatchComplianceLevel, PatchFilterGroup, PatchOrchestratorFilter, PatchRuleGroup, PatchSource, PlatformType, RelatedOpsItem, ResolvedTargets, ResourceDataSyncAwsOrganizationsSource, ResourceDataSyncS3Destination, ResourceTypeForTagging, ReviewStatus, Runbook, StepExecution, Tag, Target, TargetLocation } from "./models_0";
+import { AlarmConfiguration, AlarmStateInformation, AssociationComplianceSeverity, AssociationOverview, AssociationSyncCompliance, AutomationExecutionStatus, AutomationSubtype, DocumentFormat, DocumentHashType, DocumentPermissionType, DocumentRequires, DocumentStatus, DocumentType, ExecutionMode, InstanceAssociationOutputLocation, MaintenanceWindowExecutionStatus, MaintenanceWindowFilter, MaintenanceWindowResourceType, MaintenanceWindowTaskType, MetadataValue, OperatingSystem, OpsItemDataValue, OpsItemNotification, PatchAction, PatchComplianceLevel, PatchFilterGroup, PatchOrchestratorFilter, PatchRuleGroup, PatchSource, PlatformType, RelatedOpsItem, ResolvedTargets, ResourceDataSyncAwsOrganizationsSource, ResourceDataSyncS3Destination, ResourceTypeForTagging, ReviewStatus, Runbook, ScheduledWindowExecution, StepExecution, Tag, Target, TargetLocation } from "./models_0";
 import { SSMServiceException as __BaseException } from "./SSMServiceException";
+/**
+ * @public
+ */
+export interface DescribeMaintenanceWindowScheduleResult {
+    /**
+     * <p>Information about maintenance window executions scheduled for the specified time
+     *    range.</p>
+     * @public
+     */
+    ScheduledWindowExecutions?: ScheduledWindowExecution[];
+    /**
+     * <p>The token for the next set of items to return. (You use this token in the next call.)</p>
+     * @public
+     */
+    NextToken?: string;
+}
+/**
+ * @public
+ */
+export interface DescribeMaintenanceWindowsForTargetRequest {
+    /**
+     * <p>The managed node ID or key-value pair to retrieve information about.</p>
+     * @public
+     */
+    Targets: Target[] | undefined;
+    /**
+     * <p>The type of resource you want to retrieve information about. For example,
+     *     <code>INSTANCE</code>.</p>
+     * @public
+     */
+    ResourceType: MaintenanceWindowResourceType | undefined;
+    /**
+     * <p>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.</p>
+     * @public
+     */
+    MaxResults?: number;
+    /**
+     * <p>The token for the next set of items to return. (You received this token from a previous
+     *    call.)</p>
+     * @public
+     */
+    NextToken?: string;
+}
+/**
+ * <p>The maintenance window to which the specified target belongs.</p>
+ * @public
+ */
+export interface MaintenanceWindowIdentityForTarget {
+    /**
+     * <p>The ID of the maintenance window.</p>
+     * @public
+     */
+    WindowId?: string;
+    /**
+     * <p>The name of the maintenance window.</p>
+     * @public
+     */
+    Name?: string;
+}
+/**
+ * @public
+ */
+export interface DescribeMaintenanceWindowsForTargetResult {
+    /**
+     * <p>Information about the maintenance window targets and tasks a managed node is associated
+     *    with.</p>
+     * @public
+     */
+    WindowIdentities?: MaintenanceWindowIdentityForTarget[];
+    /**
+     * <p>The token for the next set of items to return. (You use this token in the next call.)</p>
+     * @public
+     */
+    NextToken?: string;
+}
+/**
+ * @public
+ */
+export interface DescribeMaintenanceWindowTargetsRequest {
+    /**
+     * <p>The ID of the maintenance window whose targets should be retrieved.</p>
+     * @public
+     */
+    WindowId: string | undefined;
+    /**
+     * <p>Optional filters that can be used to narrow down the scope of the returned window targets.
+     *    The supported filter keys are <code>Type</code>, <code>WindowTargetId</code>, and
+     *     <code>OwnerInformation</code>.</p>
+     * @public
+     */
+    Filters?: MaintenanceWindowFilter[];
+    /**
+     * <p>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.</p>
+     * @public
+     */
+    MaxResults?: number;
+    /**
+     * <p>The token for the next set of items to return. (You received this token from a previous
+     *    call.)</p>
+     * @public
+     */
+    NextToken?: string;
+}
+/**
+ * <p>The target registered with the maintenance window.</p>
+ * @public
+ */
+export interface MaintenanceWindowTarget {
+    /**
+     * <p>The ID of the maintenance window to register the target with.</p>
+     * @public
+     */
+    WindowId?: string;
+    /**
+     * <p>The ID of the target.</p>
+     * @public
+     */
+    WindowTargetId?: string;
+    /**
+     * <p>The type of target that is being registered with the maintenance window.</p>
+     * @public
+     */
+    ResourceType?: MaintenanceWindowResourceType;
+    /**
+     * <p>The targets, either managed nodes or tags.</p>
+     *          <p>Specify managed nodes using the following format:</p>
+     *          <p>
+     *             <code>Key=instanceids,Values=<instanceid1>,<instanceid2></code>
+     *          </p>
+     *          <p>Tags are specified using the following format:</p>
+     *          <p>
+     *             <code>Key=<tag name>,Values=<tag value></code>.</p>
+     * @public
+     */
+    Targets?: Target[];
+    /**
+     * <p>A user-provided value that will be included in any Amazon CloudWatch Events events that are
+     *    raised while running tasks for these targets in this maintenance window.</p>
+     * @public
+     */
+    OwnerInformation?: string;
+    /**
+     * <p>The name for the maintenance window target.</p>
+     * @public
+     */
+    Name?: string;
+    /**
+     * <p>A description for the target.</p>
+     * @public
+     */
+    Description?: string;
+}
+/**
+ * @public
+ */
+export interface DescribeMaintenanceWindowTargetsResult {
+    /**
+     * <p>Information about the targets in the maintenance window.</p>
+     * @public
+     */
+    Targets?: MaintenanceWindowTarget[];
+    /**
+     * <p>The token to use when requesting the next set of items. If there are no additional items to
+     *    return, the string is empty.</p>
+     * @public
+     */
+    NextToken?: string;
+}
+/**
+ * @public
+ */
+export interface DescribeMaintenanceWindowTasksRequest {
+    /**
+     * <p>The ID of the maintenance window whose tasks should be retrieved.</p>
+     * @public
+     */
+    WindowId: string | undefined;
+    /**
+     * <p>Optional filters used to narrow down the scope of the returned tasks. The supported filter
+     *    keys are <code>WindowTaskId</code>, <code>TaskArn</code>, <code>Priority</code>, and
+     *     <code>TaskType</code>.</p>
+     * @public
+     */
+    Filters?: MaintenanceWindowFilter[];
+    /**
+     * <p>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.</p>
+     * @public
+     */
+    MaxResults?: number;
+    /**
+     * <p>The token for the next set of items to return. (You received this token from a previous
+     *    call.)</p>
+     * @public
+     */
+    NextToken?: string;
+}
 /**
  * @public
  * @enum
@@ -3981,7 +4180,11 @@ export interface GetParametersRequest {
      *    parameters shared with you from another account, you must use the full ARNs.</p>
      *          <p>To query by parameter label, use <code>"Name": "name:label"</code>. To query by parameter
      *    version, use <code>"Name": "name:version"</code>.</p>
-     *          <p>For more information about shared parameters, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-shared-parameters.html">Working with
+     *          <note>
+     *             <p>The results for <code>GetParameters</code> requests are listed in alphabetical order in
+     *     query responses.</p>
+     *          </note>
+     *          <p>For information about shared parameters, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-shared-parameters.html">Working with
      *     shared parameters</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
      * @public
      */
@@ -8403,12 +8606,16 @@ export interface RegisterTaskWithMaintenanceWindowRequest {
      */
     TaskArn: string | undefined;
     /**
-     * <p>The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a
-     *   maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's
-     *   service-linked role.  If no service-linked role for Systems Manager exists in your account, it is created when you run
-     *   <code>RegisterTaskWithMaintenanceWindow</code>.</p>
-     *          <p>For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/using-service-linked-roles.html#slr-permissions">Using
-     *     service-linked roles for Systems Manager</a> in the in the <i>Amazon Web Services Systems Manager User Guide</i>:</p>
+     * <p>The Amazon Resource Name (ARN) of the IAM service role for
+     *                 Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a
+     *                 service role ARN, Systems Manager uses a service-linked role in your account. If no
+     *                 appropriate service-linked role for Systems Manager exists in your account, it is created when
+     *                 you run <code>RegisterTaskWithMaintenanceWindow</code>.</p>
+     *          <p>However, for an improved security posture, we strongly recommend creating a custom
+     *                 policy and custom service role for running your maintenance window tasks. The policy
+     *                 can be crafted to provide only the permissions needed for your particular
+     *                 maintenance window tasks. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html">Setting up maintenance windows</a> in the in the
+     *                     <i>Amazon Web Services Systems Manager User Guide</i>.</p>
      * @public
      */
     ServiceRoleArn?: string;
@@ -9184,235 +9391,13 @@ export interface StartAutomationExecutionResult {
     AutomationExecutionId?: string;
 }
 /**
- * <p>Indicates that the Change Manager change template used in the change request was rejected or is
- *    still in a pending state.</p>
- * @public
- */
-export declare class AutomationDefinitionNotApprovedException extends __BaseException {
-    readonly name: "AutomationDefinitionNotApprovedException";
-    readonly $fault: "client";
-    Message?: string;
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<AutomationDefinitionNotApprovedException, __BaseException>);
-}
-/**
- * @public
- */
-export interface StartChangeRequestExecutionRequest {
-    /**
-     * <p>The date and time specified in the change request to run the Automation runbooks.</p>
-     *          <note>
-     *             <p>The Automation runbooks specified for the runbook workflow can't run until all required
-     *     approvals for the change request have been received.</p>
-     *          </note>
-     * @public
-     */
-    ScheduledTime?: Date;
-    /**
-     * <p>The name of the change template document to run during the runbook workflow.</p>
-     * @public
-     */
-    DocumentName: string | undefined;
-    /**
-     * <p>The version of the change template document to run during the runbook workflow.</p>
-     * @public
-     */
-    DocumentVersion?: string;
-    /**
-     * <p>A key-value map of parameters that match the declared parameters in the change template
-     *    document.</p>
-     * @public
-     */
-    Parameters?: Record<string, string[]>;
-    /**
-     * <p>The name of the change request associated with the runbook workflow to be run.</p>
-     * @public
-     */
-    ChangeRequestName?: string;
-    /**
-     * <p>The user-provided idempotency token. The token must be unique, is case insensitive, enforces
-     *    the UUID format, and can't be reused.</p>
-     * @public
-     */
-    ClientToken?: string;
-    /**
-     * <p>Indicates whether the change request can be approved automatically without the need for
-     *    manual approvals.</p>
-     *          <p>If <code>AutoApprovable</code> is enabled in a change template, then setting
-     *     <code>AutoApprove</code> to <code>true</code> in <code>StartChangeRequestExecution</code>
-     *    creates a change request that bypasses approver review.</p>
-     *          <note>
-     *             <p>Change Calendar restrictions are not bypassed in this scenario. If the state of an
-     *     associated calendar is <code>CLOSED</code>, change freeze approvers must still grant permission
-     *     for this change request to run. If they don't, the change won't be processed until the calendar
-     *     state is again <code>OPEN</code>. </p>
-     *          </note>
-     * @public
-     */
-    AutoApprove?: boolean;
-    /**
-     * <p>Information about the Automation runbooks that are run during the runbook workflow.</p>
-     *          <note>
-     *             <p>The Automation runbooks specified for the runbook workflow can't run until all required
-     *     approvals for the change request have been received.</p>
-     *          </note>
-     * @public
-     */
-    Runbooks: Runbook[] | undefined;
-    /**
-     * <p>Optional metadata that you assign to a resource. You can specify a maximum of five tags for
-     *    a change request. 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 change request to identify
-     *    an environment or target Amazon Web Services Region. In this case, you could specify the following key-value
-     *    pairs:</p>
-     *          <ul>
-     *             <li>
-     *                <p>
-     *                   <code>Key=Environment,Value=Production</code>
-     *                </p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>Key=Region,Value=us-east-2</code>
-     *                </p>
-     *             </li>
-     *          </ul>
-     * @public
-     */
-    Tags?: Tag[];
-    /**
-     * <p>The time that the requester expects the runbook workflow related to the change request to
-     *    complete. The time is an estimate only that the requester provides for reviewers.</p>
-     * @public
-     */
-    ScheduledEndTime?: Date;
-    /**
-     * <p>User-provided details about the change. If no details are provided, content specified in the
-     *     <b>Template information</b> section of the associated change template
-     *    is added.</p>
-     * @public
-     */
-    ChangeDetails?: string;
-}
-/**
- * @public
- */
-export interface StartChangeRequestExecutionResult {
-    /**
-     * <p>The unique ID of a runbook workflow operation. (A runbook workflow is a type of Automation
-     *    operation.) </p>
-     * @public
-     */
-    AutomationExecutionId?: string;
-}
-/**
- * @public
- */
-export interface StartSessionRequest {
-    /**
-     * <p>The managed node to connect to for the session.</p>
-     * @public
-     */
-    Target: string | undefined;
-    /**
-     * <p>The name of the SSM document you want to use to define the type of session, input
-     *    parameters, or preferences for the session. For example, <code>SSM-SessionManagerRunShell</code>.
-     *    You can call the <a>GetDocument</a> API to verify the document exists before
-     *    attempting to start a session. If no document name is provided, a shell to the managed node is
-     *    launched by default. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-sessions-start.html">Start a
-     *     session</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
-     * @public
-     */
-    DocumentName?: string;
-    /**
-     * <p>The reason for connecting to the instance. This value is included in the details for the
-     *     Amazon CloudWatch Events event created when you start the session.</p>
-     * @public
-     */
-    Reason?: string;
-    /**
-     * <p>The values you want to specify for the parameters defined in the Session
-     *    document.</p>
-     * @public
-     */
-    Parameters?: Record<string, string[]>;
-}
-/**
- * @public
- */
-export interface StartSessionResponse {
-    /**
-     * <p>The ID of the session.</p>
-     * @public
-     */
-    SessionId?: string;
-    /**
-     * <p>An encrypted token value containing session and caller information. This token is used to
-     *    authenticate the connection to the managed node, and is valid only long enough to ensure the
-     *    connection is successful. Never share your session's token.</p>
-     * @public
-     */
-    TokenValue?: string;
-    /**
-     * <p>A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and
-     *    receive output from the node. Format: <code>wss://ssmmessages.<b>region</b>.amazonaws.com/v1/data-channel/<b>session-id</b>?stream=(input|output)</code>
-     *          </p>
-     *          <p>
-     *             <b>region</b> represents the Region identifier for an
-     * 						Amazon Web Services Region supported by Amazon Web Services Systems Manager, such as <code>us-east-2</code> for the US East (Ohio) Region.
-     * 						For a list of supported <b>region</b> values, see the <b>Region</b> column in <a href="https://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region">Systems Manager service endpoints</a> in the
-     *         <i>Amazon Web Services General Reference</i>.</p>
-     *          <p>
-     *             <b>session-id</b> represents the ID of a Session Manager session, such as
-     *     <code>1a2b3c4dEXAMPLE</code>.</p>
-     * @public
-     */
-    StreamUrl?: string;
-}
-/**
- * <p>The specified target managed node for the session isn't fully configured for use with Session Manager.
- *    For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-getting-started.html">Getting started with
- *     Session Manager</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. This error is also returned if you
- *    attempt to start a session on a managed node that is located in a different account or
- *    Region</p>
- * @public
- */
-export declare class TargetNotConnected extends __BaseException {
-    readonly name: "TargetNotConnected";
-    readonly $fault: "client";
-    Message?: string;
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<TargetNotConnected, __BaseException>);
-}
-/**
- * <p>The specified update status operation isn't valid.</p>
- * @public
- */
-export declare class InvalidAutomationStatusUpdateException extends __BaseException {
-    readonly name: "InvalidAutomationStatusUpdateException";
-    readonly $fault: "client";
-    Message?: string;
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<InvalidAutomationStatusUpdateException, __BaseException>);
-}
-/**
- * @public
- * @enum
+ * @internal
  */
-export declare const StopType: {
-    readonly CANCEL: "Cancel";
-    readonly COMPLETE: "Complete";
-};
+export declare const MaintenanceWindowTargetFilterSensitiveLog: (obj: MaintenanceWindowTarget) => any;
 /**
- * @public
+ * @internal
  */
-export type StopType = (typeof StopType)[keyof typeof StopType];
+export declare const DescribeMaintenanceWindowTargetsResultFilterSensitiveLog: (obj: DescribeMaintenanceWindowTargetsResult) => any;
 /**
  * @internal
  */