@aws-sdk/client-ssm 3.693.0 → 3.698.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +39 -7
- package/dist-cjs/index.js +834 -437
- package/dist-es/SSM.js +8 -0
- package/dist-es/commands/GetExecutionPreviewCommand.js +22 -0
- package/dist-es/commands/ListNodesCommand.js +23 -0
- package/dist-es/commands/ListNodesSummaryCommand.js +22 -0
- package/dist-es/commands/SendCommandCommand.js +1 -1
- package/dist-es/commands/StartExecutionPreviewCommand.js +22 -0
- package/dist-es/commands/index.js +4 -0
- package/dist-es/models/models_1.js +99 -144
- package/dist-es/models/models_2.js +167 -1
- package/dist-es/pagination/ListNodesPaginator.js +4 -0
- package/dist-es/pagination/ListNodesSummaryPaginator.js +4 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_json1_1.js +159 -3
- package/dist-types/SSM.d.ts +29 -0
- package/dist-types/SSMClient.d.ts +6 -2
- package/dist-types/commands/CreateResourceDataSyncCommand.d.ts +1 -1
- package/dist-types/commands/DeleteActivationCommand.d.ts +1 -1
- package/dist-types/commands/DescribeActivationsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeInstancePatchStatesForPatchGroupCommand.d.ts +1 -1
- package/dist-types/commands/DescribeInstancePatchesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeInstancePropertiesCommand.d.ts +1 -1
- package/dist-types/commands/GetExecutionPreviewCommand.d.ts +98 -0
- package/dist-types/commands/GetInventoryCommand.d.ts +3 -4
- package/dist-types/commands/GetOpsSummaryCommand.d.ts +3 -4
- package/dist-types/commands/ListComplianceItemsCommand.d.ts +1 -1
- package/dist-types/commands/ListComplianceSummariesCommand.d.ts +1 -1
- package/dist-types/commands/ListInventoryEntriesCommand.d.ts +1 -1
- package/dist-types/commands/ListNodesCommand.d.ts +123 -0
- package/dist-types/commands/ListNodesSummaryCommand.d.ts +123 -0
- package/dist-types/commands/ListResourceComplianceSummariesCommand.d.ts +1 -1
- package/dist-types/commands/ResetServiceSettingCommand.d.ts +2 -1
- package/dist-types/commands/ResumeSessionCommand.d.ts +1 -1
- package/dist-types/commands/SendAutomationSignalCommand.d.ts +1 -1
- package/dist-types/commands/SendCommandCommand.d.ts +1 -1
- package/dist-types/commands/StartAssociationsOnceCommand.d.ts +1 -1
- package/dist-types/commands/StartAutomationExecutionCommand.d.ts +1 -1
- package/dist-types/commands/StartExecutionPreviewCommand.d.ts +141 -0
- package/dist-types/commands/index.d.ts +4 -0
- package/dist-types/models/models_0.d.ts +9 -4
- package/dist-types/models/models_1.d.ts +955 -989
- package/dist-types/models/models_2.d.ts +770 -5
- package/dist-types/pagination/ListNodesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListNodesSummaryPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_json1_1.d.ts +36 -0
- package/dist-types/ts3.4/SSM.d.ts +69 -0
- package/dist-types/ts3.4/SSMClient.d.ts +24 -0
- package/dist-types/ts3.4/commands/GetExecutionPreviewCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListNodesCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListNodesSummaryCommand.d.ts +48 -0
- package/dist-types/ts3.4/commands/ResetServiceSettingCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/ResumeSessionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SendAutomationSignalCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SendCommandCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartAssociationsOnceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartAutomationExecutionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartExecutionPreviewCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +4 -0
- package/dist-types/ts3.4/models/models_1.d.ts +176 -170
- package/dist-types/ts3.4/models/models_2.d.ts +236 -0
- package/dist-types/ts3.4/pagination/ListNodesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListNodesSummaryPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +48 -0
- package/package.json +36 -36
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
|
-
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";
|
|
2
|
+
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, ResourceType, ResourceTypeForTagging, ReviewStatus, Runbook, ScheduledWindowExecution, StepExecution, Tag, Target, TargetLocation } from "./models_0";
|
|
3
3
|
import { SSMServiceException as __BaseException } from "./SSMServiceException";
|
|
4
4
|
/**
|
|
5
5
|
* @public
|
|
@@ -889,7 +889,7 @@ export interface ParameterMetadata {
|
|
|
889
889
|
*/
|
|
890
890
|
Name?: string | undefined;
|
|
891
891
|
/**
|
|
892
|
-
* <p>The (ARN) of the
|
|
892
|
+
* <p>The Amazon Resource Name (ARN) of the parameter.</p>
|
|
893
893
|
* @public
|
|
894
894
|
*/
|
|
895
895
|
ARN?: string | undefined;
|
|
@@ -2532,6 +2532,167 @@ export interface GetDocumentResult {
|
|
|
2532
2532
|
*/
|
|
2533
2533
|
ReviewStatus?: ReviewStatus | undefined;
|
|
2534
2534
|
}
|
|
2535
|
+
/**
|
|
2536
|
+
* @public
|
|
2537
|
+
*/
|
|
2538
|
+
export interface GetExecutionPreviewRequest {
|
|
2539
|
+
/**
|
|
2540
|
+
* <p>The ID of the existing execution preview.</p>
|
|
2541
|
+
* @public
|
|
2542
|
+
*/
|
|
2543
|
+
ExecutionPreviewId: string | undefined;
|
|
2544
|
+
}
|
|
2545
|
+
/**
|
|
2546
|
+
* @public
|
|
2547
|
+
* @enum
|
|
2548
|
+
*/
|
|
2549
|
+
export declare const ImpactType: {
|
|
2550
|
+
readonly MUTATING: "Mutating";
|
|
2551
|
+
readonly NON_MUTATING: "NonMutating";
|
|
2552
|
+
readonly UNDETERMINED: "Undetermined";
|
|
2553
|
+
};
|
|
2554
|
+
/**
|
|
2555
|
+
* @public
|
|
2556
|
+
*/
|
|
2557
|
+
export type ImpactType = (typeof ImpactType)[keyof typeof ImpactType];
|
|
2558
|
+
/**
|
|
2559
|
+
* <p>Information about the resources that would be included in the actual runbook execution, if
|
|
2560
|
+
* it were to be run.</p>
|
|
2561
|
+
* @public
|
|
2562
|
+
*/
|
|
2563
|
+
export interface TargetPreview {
|
|
2564
|
+
/**
|
|
2565
|
+
* <p>The number of resources of a certain type included in an execution preview.</p>
|
|
2566
|
+
* @public
|
|
2567
|
+
*/
|
|
2568
|
+
Count?: number | undefined;
|
|
2569
|
+
/**
|
|
2570
|
+
* <p>A type of resource that was included in the execution preview.</p>
|
|
2571
|
+
* @public
|
|
2572
|
+
*/
|
|
2573
|
+
TargetType?: string | undefined;
|
|
2574
|
+
}
|
|
2575
|
+
/**
|
|
2576
|
+
* <p>Information about the results of the execution preview.</p>
|
|
2577
|
+
* @public
|
|
2578
|
+
*/
|
|
2579
|
+
export interface AutomationExecutionPreview {
|
|
2580
|
+
/**
|
|
2581
|
+
* <p>Information about the type of impact a runbook step would have on a resource.</p>
|
|
2582
|
+
* <ul>
|
|
2583
|
+
* <li>
|
|
2584
|
+
* <p>
|
|
2585
|
+
* <code>Mutating</code>: The runbook step would make changes to the targets through actions
|
|
2586
|
+
* that create, modify, or delete resources.</p>
|
|
2587
|
+
* </li>
|
|
2588
|
+
* <li>
|
|
2589
|
+
* <p>
|
|
2590
|
+
* <code>Non_Mutating</code>: The runbook step would retrieve data about resources but not
|
|
2591
|
+
* make changes to them. This category generally includes <code>Describe*</code>,
|
|
2592
|
+
* <code>List*</code>, <code>Get*</code>, and similar read-only API actions.</p>
|
|
2593
|
+
* </li>
|
|
2594
|
+
* <li>
|
|
2595
|
+
* <p>
|
|
2596
|
+
* <code>Undetermined</code>: An undetermined step invokes executions performed by another
|
|
2597
|
+
* orchestration service like Lambda, Step Functions, or Amazon Web Services Systems Manager Run Command. An undetermined step might also call a third-party API. Systems Manager Automation doesn't know the outcome of the orchestration processes or
|
|
2598
|
+
* third-party API executions, so the results of the steps are undetermined.</p>
|
|
2599
|
+
* </li>
|
|
2600
|
+
* </ul>
|
|
2601
|
+
* @public
|
|
2602
|
+
*/
|
|
2603
|
+
StepPreviews?: Partial<Record<ImpactType, number>> | undefined;
|
|
2604
|
+
/**
|
|
2605
|
+
* <p>Information about the Amazon Web Services Regions targeted by the execution preview.</p>
|
|
2606
|
+
* @public
|
|
2607
|
+
*/
|
|
2608
|
+
Regions?: string[] | undefined;
|
|
2609
|
+
/**
|
|
2610
|
+
* <p>Information that provides a preview of what the impact of running the specified Automation
|
|
2611
|
+
* runbook would be.</p>
|
|
2612
|
+
* @public
|
|
2613
|
+
*/
|
|
2614
|
+
TargetPreviews?: TargetPreview[] | undefined;
|
|
2615
|
+
/**
|
|
2616
|
+
* <p>Information about the Amazon Web Services accounts that were included in the execution
|
|
2617
|
+
* preview.</p>
|
|
2618
|
+
* @public
|
|
2619
|
+
*/
|
|
2620
|
+
TotalAccounts?: number | undefined;
|
|
2621
|
+
}
|
|
2622
|
+
/**
|
|
2623
|
+
* <p>Information about the changes that would be made if an execution were run.</p>
|
|
2624
|
+
* @public
|
|
2625
|
+
*/
|
|
2626
|
+
export type ExecutionPreview = ExecutionPreview.AutomationMember | ExecutionPreview.$UnknownMember;
|
|
2627
|
+
/**
|
|
2628
|
+
* @public
|
|
2629
|
+
*/
|
|
2630
|
+
export declare namespace ExecutionPreview {
|
|
2631
|
+
/**
|
|
2632
|
+
* <p>Information about the changes that would be made if an Automation workflow were run.</p>
|
|
2633
|
+
* @public
|
|
2634
|
+
*/
|
|
2635
|
+
interface AutomationMember {
|
|
2636
|
+
Automation: AutomationExecutionPreview;
|
|
2637
|
+
$unknown?: never;
|
|
2638
|
+
}
|
|
2639
|
+
/**
|
|
2640
|
+
* @public
|
|
2641
|
+
*/
|
|
2642
|
+
interface $UnknownMember {
|
|
2643
|
+
Automation?: never;
|
|
2644
|
+
$unknown: [string, any];
|
|
2645
|
+
}
|
|
2646
|
+
interface Visitor<T> {
|
|
2647
|
+
Automation: (value: AutomationExecutionPreview) => T;
|
|
2648
|
+
_: (name: string, value: any) => T;
|
|
2649
|
+
}
|
|
2650
|
+
const visit: <T>(value: ExecutionPreview, visitor: Visitor<T>) => T;
|
|
2651
|
+
}
|
|
2652
|
+
/**
|
|
2653
|
+
* @public
|
|
2654
|
+
* @enum
|
|
2655
|
+
*/
|
|
2656
|
+
export declare const ExecutionPreviewStatus: {
|
|
2657
|
+
readonly FAILED: "Failed";
|
|
2658
|
+
readonly IN_PROGRESS: "InProgress";
|
|
2659
|
+
readonly PENDING: "Pending";
|
|
2660
|
+
readonly SUCCESS: "Success";
|
|
2661
|
+
};
|
|
2662
|
+
/**
|
|
2663
|
+
* @public
|
|
2664
|
+
*/
|
|
2665
|
+
export type ExecutionPreviewStatus = (typeof ExecutionPreviewStatus)[keyof typeof ExecutionPreviewStatus];
|
|
2666
|
+
/**
|
|
2667
|
+
* @public
|
|
2668
|
+
*/
|
|
2669
|
+
export interface GetExecutionPreviewResponse {
|
|
2670
|
+
/**
|
|
2671
|
+
* <p>The generated ID for the existing execution preview.</p>
|
|
2672
|
+
* @public
|
|
2673
|
+
*/
|
|
2674
|
+
ExecutionPreviewId?: string | undefined;
|
|
2675
|
+
/**
|
|
2676
|
+
* <p>A UTC timestamp indicating when the execution preview operation ended.</p>
|
|
2677
|
+
* @public
|
|
2678
|
+
*/
|
|
2679
|
+
EndedAt?: Date | undefined;
|
|
2680
|
+
/**
|
|
2681
|
+
* <p>The current status of the execution preview operation.</p>
|
|
2682
|
+
* @public
|
|
2683
|
+
*/
|
|
2684
|
+
Status?: ExecutionPreviewStatus | undefined;
|
|
2685
|
+
/**
|
|
2686
|
+
* <p>Supplemental information about the current status of the execution preview.</p>
|
|
2687
|
+
* @public
|
|
2688
|
+
*/
|
|
2689
|
+
StatusMessage?: string | undefined;
|
|
2690
|
+
/**
|
|
2691
|
+
* <p>Information about the changes that would be made if an execution were run.</p>
|
|
2692
|
+
* @public
|
|
2693
|
+
*/
|
|
2694
|
+
ExecutionPreview?: ExecutionPreview | undefined;
|
|
2695
|
+
}
|
|
2535
2696
|
/**
|
|
2536
2697
|
* @public
|
|
2537
2698
|
* @enum
|
|
@@ -2674,9 +2835,8 @@ export interface GetInventoryResult {
|
|
|
2674
2835
|
NextToken?: string | undefined;
|
|
2675
2836
|
}
|
|
2676
2837
|
/**
|
|
2677
|
-
* <p>The specified aggregator isn't valid for
|
|
2678
|
-
*
|
|
2679
|
-
* <code>AWS:InstanceInformation</code>.</p>
|
|
2838
|
+
* <p>The specified aggregator isn't valid for the group type. Verify that the aggregator you
|
|
2839
|
+
* provided is supported.</p>
|
|
2680
2840
|
* @public
|
|
2681
2841
|
*/
|
|
2682
2842
|
export declare class InvalidAggregatorException extends __BaseException {
|
|
@@ -4528,7 +4688,7 @@ export interface GetServiceSettingRequest {
|
|
|
4528
4688
|
* <ul>
|
|
4529
4689
|
* <li>
|
|
4530
4690
|
* <p>
|
|
4531
|
-
* <code>/ssm/
|
|
4691
|
+
* <code>/ssm/appmanager/appmanager-enabled</code>
|
|
4532
4692
|
* </p>
|
|
4533
4693
|
* </li>
|
|
4534
4694
|
* <li>
|
|
@@ -4542,6 +4702,9 @@ export interface GetServiceSettingRequest {
|
|
|
4542
4702
|
* </p>
|
|
4543
4703
|
* </li>
|
|
4544
4704
|
* <li>
|
|
4705
|
+
* <p>/ssm/automation/enable-adaptive-concurrency</p>
|
|
4706
|
+
* </li>
|
|
4707
|
+
* <li>
|
|
4545
4708
|
* <p>
|
|
4546
4709
|
* <code>/ssm/documents/console/public-sharing-permission</code>
|
|
4547
4710
|
* </p>
|
|
@@ -4553,6 +4716,11 @@ export interface GetServiceSettingRequest {
|
|
|
4553
4716
|
* </li>
|
|
4554
4717
|
* <li>
|
|
4555
4718
|
* <p>
|
|
4719
|
+
* <code>/ssm/managed-instance/default-ec2-instance-management-role</code>
|
|
4720
|
+
* </p>
|
|
4721
|
+
* </li>
|
|
4722
|
+
* <li>
|
|
4723
|
+
* <p>
|
|
4556
4724
|
* <code>/ssm/opsinsights/opscenter</code>
|
|
4557
4725
|
* </p>
|
|
4558
4726
|
* </li>
|
|
@@ -6899,450 +7067,781 @@ export interface ListInventoryEntriesResult {
|
|
|
6899
7067
|
* @public
|
|
6900
7068
|
* @enum
|
|
6901
7069
|
*/
|
|
6902
|
-
export declare const
|
|
6903
|
-
readonly
|
|
7070
|
+
export declare const NodeFilterKey: {
|
|
7071
|
+
readonly ACCOUNT_ID: "AccountId";
|
|
7072
|
+
readonly AGENT_TYPE: "AgentType";
|
|
7073
|
+
readonly AGENT_VERSION: "AgentVersion";
|
|
7074
|
+
readonly COMPUTER_NAME: "ComputerName";
|
|
7075
|
+
readonly INSTANCE_ID: "InstanceId";
|
|
7076
|
+
readonly INSTANCE_STATUS: "InstanceStatus";
|
|
7077
|
+
readonly IP_ADDRESS: "IpAddress";
|
|
7078
|
+
readonly MANAGED_STATUS: "ManagedStatus";
|
|
7079
|
+
readonly ORGANIZATIONAL_UNIT_ID: "OrganizationalUnitId";
|
|
7080
|
+
readonly ORGANIZATIONAL_UNIT_PATH: "OrganizationalUnitPath";
|
|
7081
|
+
readonly PLATFORM_NAME: "PlatformName";
|
|
7082
|
+
readonly PLATFORM_TYPE: "PlatformType";
|
|
7083
|
+
readonly PLATFORM_VERSION: "PlatformVersion";
|
|
7084
|
+
readonly REGION: "Region";
|
|
7085
|
+
readonly RESOURCE_TYPE: "ResourceType";
|
|
6904
7086
|
};
|
|
6905
7087
|
/**
|
|
6906
7088
|
* @public
|
|
6907
7089
|
*/
|
|
6908
|
-
export type
|
|
7090
|
+
export type NodeFilterKey = (typeof NodeFilterKey)[keyof typeof NodeFilterKey];
|
|
6909
7091
|
/**
|
|
6910
7092
|
* @public
|
|
6911
7093
|
* @enum
|
|
6912
7094
|
*/
|
|
6913
|
-
export declare const
|
|
7095
|
+
export declare const NodeFilterOperatorType: {
|
|
7096
|
+
readonly BEGIN_WITH: "BeginWith";
|
|
6914
7097
|
readonly EQUAL: "Equal";
|
|
7098
|
+
readonly NOT_EQUAL: "NotEqual";
|
|
6915
7099
|
};
|
|
6916
7100
|
/**
|
|
6917
7101
|
* @public
|
|
6918
7102
|
*/
|
|
6919
|
-
export type
|
|
7103
|
+
export type NodeFilterOperatorType = (typeof NodeFilterOperatorType)[keyof typeof NodeFilterOperatorType];
|
|
6920
7104
|
/**
|
|
6921
|
-
* <p>
|
|
6922
|
-
* by using tags. You specify tags by using a key-value pair mapping. </p>
|
|
7105
|
+
* <p>The filters for the operation.</p>
|
|
6923
7106
|
* @public
|
|
6924
7107
|
*/
|
|
6925
|
-
export interface
|
|
7108
|
+
export interface NodeFilter {
|
|
6926
7109
|
/**
|
|
6927
|
-
* <p>The name of the filter
|
|
6928
|
-
* <code>OpsItemId</code>.</p>
|
|
7110
|
+
* <p>The name of the filter.</p>
|
|
6929
7111
|
* @public
|
|
6930
7112
|
*/
|
|
6931
|
-
Key:
|
|
7113
|
+
Key: NodeFilterKey | undefined;
|
|
6932
7114
|
/**
|
|
6933
|
-
* <p>
|
|
7115
|
+
* <p>A filter value supported by the specified key. For example, for the key
|
|
7116
|
+
* <code>PlatformType</code>, supported values include <code>Linux</code> and
|
|
7117
|
+
* <code>Windows</code>.</p>
|
|
6934
7118
|
* @public
|
|
6935
7119
|
*/
|
|
6936
7120
|
Values: string[] | undefined;
|
|
6937
7121
|
/**
|
|
6938
|
-
* <p>The
|
|
6939
|
-
* <code>Equal</code>.</p>
|
|
7122
|
+
* <p>The type of filter operator.</p>
|
|
6940
7123
|
* @public
|
|
6941
7124
|
*/
|
|
6942
|
-
|
|
7125
|
+
Type?: NodeFilterOperatorType | undefined;
|
|
6943
7126
|
}
|
|
6944
7127
|
/**
|
|
6945
7128
|
* @public
|
|
6946
7129
|
*/
|
|
6947
|
-
export interface
|
|
7130
|
+
export interface ListNodesRequest {
|
|
6948
7131
|
/**
|
|
6949
|
-
* <p>
|
|
7132
|
+
* <p>The name of the resource data sync to retrieve information about. Required for
|
|
7133
|
+
* cross-account/cross-Region configurations. Optional for single account/single-Region
|
|
7134
|
+
* configurations.</p>
|
|
6950
7135
|
* @public
|
|
6951
7136
|
*/
|
|
6952
|
-
|
|
7137
|
+
SyncName?: string | undefined;
|
|
6953
7138
|
/**
|
|
6954
|
-
* <p>
|
|
6955
|
-
* can specify in a subsequent call to get the next set of results. </p>
|
|
7139
|
+
* <p>One or more filters. Use a filter to return a more specific list of managed nodes.</p>
|
|
6956
7140
|
* @public
|
|
6957
7141
|
*/
|
|
6958
|
-
|
|
7142
|
+
Filters?: NodeFilter[] | undefined;
|
|
6959
7143
|
/**
|
|
6960
|
-
* <p>
|
|
7144
|
+
* <p>The token for the next set of items to return. (You received this token from a previous
|
|
7145
|
+
* call.)</p>
|
|
6961
7146
|
* @public
|
|
6962
7147
|
*/
|
|
6963
7148
|
NextToken?: string | undefined;
|
|
6964
|
-
}
|
|
6965
|
-
/**
|
|
6966
|
-
* <p>Information about the user or resource that created an OpsItem event.</p>
|
|
6967
|
-
* @public
|
|
6968
|
-
*/
|
|
6969
|
-
export interface OpsItemIdentity {
|
|
6970
7149
|
/**
|
|
6971
|
-
* <p>The
|
|
6972
|
-
*
|
|
7150
|
+
* <p>The maximum number of items to return for this call. The call also returns a token that you
|
|
7151
|
+
* can specify in a subsequent call to get the next set of results.</p>
|
|
6973
7152
|
* @public
|
|
6974
7153
|
*/
|
|
6975
|
-
|
|
7154
|
+
MaxResults?: number | undefined;
|
|
6976
7155
|
}
|
|
6977
7156
|
/**
|
|
6978
|
-
* <p>Summary information about an OpsItem event or that associated an OpsItem with a related
|
|
6979
|
-
* item.</p>
|
|
6980
7157
|
* @public
|
|
7158
|
+
* @enum
|
|
6981
7159
|
*/
|
|
6982
|
-
export
|
|
7160
|
+
export declare const ManagedStatus: {
|
|
7161
|
+
readonly ALL: "All";
|
|
7162
|
+
readonly MANAGED: "Managed";
|
|
7163
|
+
readonly UNMANAGED: "Unmanaged";
|
|
7164
|
+
};
|
|
7165
|
+
/**
|
|
7166
|
+
* @public
|
|
7167
|
+
*/
|
|
7168
|
+
export type ManagedStatus = (typeof ManagedStatus)[keyof typeof ManagedStatus];
|
|
7169
|
+
/**
|
|
7170
|
+
* <p>Details about a specific managed node.</p>
|
|
7171
|
+
* @public
|
|
7172
|
+
*/
|
|
7173
|
+
export interface InstanceInfo {
|
|
6983
7174
|
/**
|
|
6984
|
-
* <p>The
|
|
7175
|
+
* <p>The type of agent installed on the node.</p>
|
|
6985
7176
|
* @public
|
|
6986
7177
|
*/
|
|
6987
|
-
|
|
7178
|
+
AgentType?: string | undefined;
|
|
6988
7179
|
/**
|
|
6989
|
-
* <p>The
|
|
7180
|
+
* <p>The version number of the agent installed on the node.</p>
|
|
6990
7181
|
* @public
|
|
6991
7182
|
*/
|
|
6992
|
-
|
|
7183
|
+
AgentVersion?: string | undefined;
|
|
6993
7184
|
/**
|
|
6994
|
-
* <p>The
|
|
7185
|
+
* <p>The fully qualified host name of the managed node.</p>
|
|
6995
7186
|
* @public
|
|
6996
7187
|
*/
|
|
6997
|
-
|
|
7188
|
+
ComputerName?: string | undefined;
|
|
6998
7189
|
/**
|
|
6999
|
-
* <p>The
|
|
7190
|
+
* <p>The current status of the managed node.</p>
|
|
7000
7191
|
* @public
|
|
7001
7192
|
*/
|
|
7002
|
-
|
|
7193
|
+
InstanceStatus?: string | undefined;
|
|
7003
7194
|
/**
|
|
7004
|
-
* <p>
|
|
7195
|
+
* <p>The IP address of the managed node.</p>
|
|
7005
7196
|
* @public
|
|
7006
7197
|
*/
|
|
7007
|
-
|
|
7198
|
+
IpAddress?: string | undefined;
|
|
7008
7199
|
/**
|
|
7009
|
-
* <p>
|
|
7200
|
+
* <p>Indicates whether the node is managed by Systems Manager.</p>
|
|
7010
7201
|
* @public
|
|
7011
7202
|
*/
|
|
7012
|
-
|
|
7203
|
+
ManagedStatus?: ManagedStatus | undefined;
|
|
7013
7204
|
/**
|
|
7014
|
-
* <p>The
|
|
7205
|
+
* <p>The operating system platform type of the managed node.</p>
|
|
7015
7206
|
* @public
|
|
7016
7207
|
*/
|
|
7017
|
-
|
|
7018
|
-
}
|
|
7019
|
-
/**
|
|
7020
|
-
* @public
|
|
7021
|
-
*/
|
|
7022
|
-
export interface ListOpsItemEventsResponse {
|
|
7208
|
+
PlatformType?: PlatformType | undefined;
|
|
7023
7209
|
/**
|
|
7024
|
-
* <p>The
|
|
7025
|
-
* results. </p>
|
|
7210
|
+
* <p>The name of the operating system platform running on your managed node.</p>
|
|
7026
7211
|
* @public
|
|
7027
7212
|
*/
|
|
7028
|
-
|
|
7213
|
+
PlatformName?: string | undefined;
|
|
7029
7214
|
/**
|
|
7030
|
-
* <p>
|
|
7215
|
+
* <p>The version of the OS platform running on your managed node. </p>
|
|
7031
7216
|
* @public
|
|
7032
7217
|
*/
|
|
7033
|
-
|
|
7218
|
+
PlatformVersion?: string | undefined;
|
|
7219
|
+
/**
|
|
7220
|
+
* <p>The type of instance, either an EC2 instance or another supported machine type in a hybrid
|
|
7221
|
+
* fleet.</p>
|
|
7222
|
+
* @public
|
|
7223
|
+
*/
|
|
7224
|
+
ResourceType?: ResourceType | undefined;
|
|
7034
7225
|
}
|
|
7035
7226
|
/**
|
|
7036
|
-
*
|
|
7037
|
-
* @enum
|
|
7038
|
-
*/
|
|
7039
|
-
export declare const OpsItemRelatedItemsFilterKey: {
|
|
7040
|
-
readonly ASSOCIATION_ID: "AssociationId";
|
|
7041
|
-
readonly RESOURCE_TYPE: "ResourceType";
|
|
7042
|
-
readonly RESOURCE_URI: "ResourceUri";
|
|
7043
|
-
};
|
|
7044
|
-
/**
|
|
7045
|
-
* @public
|
|
7046
|
-
*/
|
|
7047
|
-
export type OpsItemRelatedItemsFilterKey = (typeof OpsItemRelatedItemsFilterKey)[keyof typeof OpsItemRelatedItemsFilterKey];
|
|
7048
|
-
/**
|
|
7049
|
-
* @public
|
|
7050
|
-
* @enum
|
|
7051
|
-
*/
|
|
7052
|
-
export declare const OpsItemRelatedItemsFilterOperator: {
|
|
7053
|
-
readonly EQUAL: "Equal";
|
|
7054
|
-
};
|
|
7055
|
-
/**
|
|
7227
|
+
* <p>Information about a managed node's type.</p>
|
|
7056
7228
|
* @public
|
|
7057
7229
|
*/
|
|
7058
|
-
export type
|
|
7230
|
+
export type NodeType = NodeType.InstanceMember | NodeType.$UnknownMember;
|
|
7059
7231
|
/**
|
|
7060
|
-
* <p>Describes a filter for a specific list of related-item resources. </p>
|
|
7061
7232
|
* @public
|
|
7062
7233
|
*/
|
|
7063
|
-
export
|
|
7064
|
-
/**
|
|
7065
|
-
* <p>The name of the filter key. Supported values include <code>ResourceUri</code>,
|
|
7066
|
-
* <code>ResourceType</code>, or <code>AssociationId</code>.</p>
|
|
7067
|
-
* @public
|
|
7068
|
-
*/
|
|
7069
|
-
Key: OpsItemRelatedItemsFilterKey | undefined;
|
|
7234
|
+
export declare namespace NodeType {
|
|
7070
7235
|
/**
|
|
7071
|
-
* <p>
|
|
7236
|
+
* <p>Information about a specific managed node.</p>
|
|
7072
7237
|
* @public
|
|
7073
7238
|
*/
|
|
7074
|
-
|
|
7239
|
+
interface InstanceMember {
|
|
7240
|
+
Instance: InstanceInfo;
|
|
7241
|
+
$unknown?: never;
|
|
7242
|
+
}
|
|
7075
7243
|
/**
|
|
7076
|
-
* <p>The operator used by the filter call. The only supported operator is
|
|
7077
|
-
* <code>EQUAL</code>.</p>
|
|
7078
7244
|
* @public
|
|
7079
7245
|
*/
|
|
7080
|
-
|
|
7246
|
+
interface $UnknownMember {
|
|
7247
|
+
Instance?: never;
|
|
7248
|
+
$unknown: [string, any];
|
|
7249
|
+
}
|
|
7250
|
+
interface Visitor<T> {
|
|
7251
|
+
Instance: (value: InstanceInfo) => T;
|
|
7252
|
+
_: (name: string, value: any) => T;
|
|
7253
|
+
}
|
|
7254
|
+
const visit: <T>(value: NodeType, visitor: Visitor<T>) => T;
|
|
7081
7255
|
}
|
|
7082
7256
|
/**
|
|
7257
|
+
* <p>Information about ownership of a managed node.</p>
|
|
7083
7258
|
* @public
|
|
7084
7259
|
*/
|
|
7085
|
-
export interface
|
|
7086
|
-
/**
|
|
7087
|
-
* <p>The ID of the OpsItem for which you want to list all related-item resources.</p>
|
|
7088
|
-
* @public
|
|
7089
|
-
*/
|
|
7090
|
-
OpsItemId?: string | undefined;
|
|
7260
|
+
export interface NodeOwnerInfo {
|
|
7091
7261
|
/**
|
|
7092
|
-
* <p>
|
|
7262
|
+
* <p>The ID of the Amazon Web Services account that owns the managed node.</p>
|
|
7093
7263
|
* @public
|
|
7094
7264
|
*/
|
|
7095
|
-
|
|
7265
|
+
AccountId?: string | undefined;
|
|
7096
7266
|
/**
|
|
7097
|
-
* <p>The
|
|
7098
|
-
* can specify in a subsequent call to get the next set of results.</p>
|
|
7267
|
+
* <p>The ID of the organization unit (OU) that the account is part of.</p>
|
|
7099
7268
|
* @public
|
|
7100
7269
|
*/
|
|
7101
|
-
|
|
7270
|
+
OrganizationalUnitId?: string | undefined;
|
|
7102
7271
|
/**
|
|
7103
|
-
* <p>The
|
|
7104
|
-
*
|
|
7272
|
+
* <p>The path for the organizational unit (OU) that owns the managed node. The path for the OU is
|
|
7273
|
+
* built using the IDs of the organization, root, and all OUs in the path down to and including the
|
|
7274
|
+
* OU. For example:</p>
|
|
7275
|
+
* <p>
|
|
7276
|
+
* <code>o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-ghi0-awsccccc/ou-jkl0-awsddddd/</code>
|
|
7277
|
+
* </p>
|
|
7105
7278
|
* @public
|
|
7106
7279
|
*/
|
|
7107
|
-
|
|
7280
|
+
OrganizationalUnitPath?: string | undefined;
|
|
7108
7281
|
}
|
|
7109
7282
|
/**
|
|
7110
|
-
* <p>
|
|
7283
|
+
* <p>Details about an individual managed node.</p>
|
|
7111
7284
|
* @public
|
|
7112
7285
|
*/
|
|
7113
|
-
export interface
|
|
7286
|
+
export interface Node {
|
|
7114
7287
|
/**
|
|
7115
|
-
* <p>The
|
|
7288
|
+
* <p>The UTC timestamp for when the managed node data was last captured.</p>
|
|
7116
7289
|
* @public
|
|
7117
7290
|
*/
|
|
7118
|
-
|
|
7291
|
+
CaptureTime?: Date | undefined;
|
|
7119
7292
|
/**
|
|
7120
|
-
* <p>The
|
|
7293
|
+
* <p>The ID of the managed node.</p>
|
|
7121
7294
|
* @public
|
|
7122
7295
|
*/
|
|
7123
|
-
|
|
7296
|
+
Id?: string | undefined;
|
|
7124
7297
|
/**
|
|
7125
|
-
* <p>
|
|
7298
|
+
* <p>Information about the ownership of the managed node.</p>
|
|
7126
7299
|
* @public
|
|
7127
7300
|
*/
|
|
7128
|
-
|
|
7301
|
+
Owner?: NodeOwnerInfo | undefined;
|
|
7129
7302
|
/**
|
|
7130
|
-
* <p>The
|
|
7303
|
+
* <p>The Amazon Web Services Region that a managed node was created in or assigned to.</p>
|
|
7131
7304
|
* @public
|
|
7132
7305
|
*/
|
|
7133
|
-
|
|
7306
|
+
Region?: string | undefined;
|
|
7134
7307
|
/**
|
|
7135
|
-
* <p>
|
|
7308
|
+
* <p>Information about the type of node.</p>
|
|
7136
7309
|
* @public
|
|
7137
7310
|
*/
|
|
7138
|
-
|
|
7311
|
+
NodeType?: NodeType | undefined;
|
|
7312
|
+
}
|
|
7313
|
+
/**
|
|
7314
|
+
* @public
|
|
7315
|
+
*/
|
|
7316
|
+
export interface ListNodesResult {
|
|
7139
7317
|
/**
|
|
7140
|
-
* <p>
|
|
7318
|
+
* <p>A list of managed nodes that match the specified filter criteria.</p>
|
|
7141
7319
|
* @public
|
|
7142
7320
|
*/
|
|
7143
|
-
|
|
7144
|
-
/**
|
|
7145
|
-
* <p>The time the related-item association was created.</p>
|
|
7146
|
-
* @public
|
|
7147
|
-
*/
|
|
7148
|
-
CreatedTime?: Date | undefined;
|
|
7321
|
+
Nodes?: Node[] | undefined;
|
|
7149
7322
|
/**
|
|
7150
|
-
* <p>
|
|
7323
|
+
* <p>The token to use when requesting the next set of items. If there are no additional items to
|
|
7324
|
+
* return, the string is empty.</p>
|
|
7151
7325
|
* @public
|
|
7152
7326
|
*/
|
|
7153
|
-
|
|
7327
|
+
NextToken?: string | undefined;
|
|
7328
|
+
}
|
|
7329
|
+
/**
|
|
7330
|
+
* <p>This operation is not supported for the current account. You must first enable the Systems Manager integrated experience in your account.</p>
|
|
7331
|
+
* @public
|
|
7332
|
+
*/
|
|
7333
|
+
export declare class UnsupportedOperationException extends __BaseException {
|
|
7334
|
+
readonly name: "UnsupportedOperationException";
|
|
7335
|
+
readonly $fault: "client";
|
|
7336
|
+
Message?: string | undefined;
|
|
7154
7337
|
/**
|
|
7155
|
-
*
|
|
7156
|
-
* @public
|
|
7338
|
+
* @internal
|
|
7157
7339
|
*/
|
|
7158
|
-
|
|
7340
|
+
constructor(opts: __ExceptionOptionType<UnsupportedOperationException, __BaseException>);
|
|
7159
7341
|
}
|
|
7160
7342
|
/**
|
|
7161
7343
|
* @public
|
|
7344
|
+
* @enum
|
|
7162
7345
|
*/
|
|
7163
|
-
export
|
|
7346
|
+
export declare const NodeAggregatorType: {
|
|
7347
|
+
readonly COUNT: "Count";
|
|
7348
|
+
};
|
|
7349
|
+
/**
|
|
7350
|
+
* @public
|
|
7351
|
+
*/
|
|
7352
|
+
export type NodeAggregatorType = (typeof NodeAggregatorType)[keyof typeof NodeAggregatorType];
|
|
7353
|
+
/**
|
|
7354
|
+
* @public
|
|
7355
|
+
* @enum
|
|
7356
|
+
*/
|
|
7357
|
+
export declare const NodeAttributeName: {
|
|
7358
|
+
readonly AGENT_VERSION: "AgentVersion";
|
|
7359
|
+
readonly PLATFORM_NAME: "PlatformName";
|
|
7360
|
+
readonly PLATFORM_TYPE: "PlatformType";
|
|
7361
|
+
readonly PLATFORM_VERSION: "PlatformVersion";
|
|
7362
|
+
readonly REGION: "Region";
|
|
7363
|
+
readonly RESOURCE_TYPE: "ResourceType";
|
|
7364
|
+
};
|
|
7365
|
+
/**
|
|
7366
|
+
* @public
|
|
7367
|
+
*/
|
|
7368
|
+
export type NodeAttributeName = (typeof NodeAttributeName)[keyof typeof NodeAttributeName];
|
|
7369
|
+
/**
|
|
7370
|
+
* @public
|
|
7371
|
+
* @enum
|
|
7372
|
+
*/
|
|
7373
|
+
export declare const NodeTypeName: {
|
|
7374
|
+
readonly INSTANCE: "Instance";
|
|
7375
|
+
};
|
|
7376
|
+
/**
|
|
7377
|
+
* @public
|
|
7378
|
+
*/
|
|
7379
|
+
export type NodeTypeName = (typeof NodeTypeName)[keyof typeof NodeTypeName];
|
|
7380
|
+
/**
|
|
7381
|
+
* @public
|
|
7382
|
+
*/
|
|
7383
|
+
export interface ListNodesSummaryResult {
|
|
7164
7384
|
/**
|
|
7165
|
-
* <p>
|
|
7166
|
-
*
|
|
7385
|
+
* <p>A collection of objects reporting information about your managed nodes, such as the count of
|
|
7386
|
+
* nodes by operating system.</p>
|
|
7167
7387
|
* @public
|
|
7168
7388
|
*/
|
|
7169
|
-
|
|
7389
|
+
Summary?: Record<string, string>[] | undefined;
|
|
7170
7390
|
/**
|
|
7171
|
-
* <p>
|
|
7391
|
+
* <p>The token to use when requesting the next set of items. If there are no additional items to
|
|
7392
|
+
* return, the string is empty.</p>
|
|
7172
7393
|
* @public
|
|
7173
7394
|
*/
|
|
7174
|
-
|
|
7395
|
+
NextToken?: string | undefined;
|
|
7175
7396
|
}
|
|
7176
7397
|
/**
|
|
7177
|
-
* <p>A filter to limit the number of OpsMetadata objects displayed.</p>
|
|
7178
7398
|
* @public
|
|
7399
|
+
* @enum
|
|
7179
7400
|
*/
|
|
7180
|
-
export
|
|
7401
|
+
export declare const OpsItemEventFilterKey: {
|
|
7402
|
+
readonly OPSITEM_ID: "OpsItemId";
|
|
7403
|
+
};
|
|
7404
|
+
/**
|
|
7405
|
+
* @public
|
|
7406
|
+
*/
|
|
7407
|
+
export type OpsItemEventFilterKey = (typeof OpsItemEventFilterKey)[keyof typeof OpsItemEventFilterKey];
|
|
7408
|
+
/**
|
|
7409
|
+
* @public
|
|
7410
|
+
* @enum
|
|
7411
|
+
*/
|
|
7412
|
+
export declare const OpsItemEventFilterOperator: {
|
|
7413
|
+
readonly EQUAL: "Equal";
|
|
7414
|
+
};
|
|
7415
|
+
/**
|
|
7416
|
+
* @public
|
|
7417
|
+
*/
|
|
7418
|
+
export type OpsItemEventFilterOperator = (typeof OpsItemEventFilterOperator)[keyof typeof OpsItemEventFilterOperator];
|
|
7419
|
+
/**
|
|
7420
|
+
* <p>Describes a filter for a specific list of OpsItem events. You can filter event information
|
|
7421
|
+
* by using tags. You specify tags by using a key-value pair mapping. </p>
|
|
7422
|
+
* @public
|
|
7423
|
+
*/
|
|
7424
|
+
export interface OpsItemEventFilter {
|
|
7181
7425
|
/**
|
|
7182
|
-
* <p>
|
|
7426
|
+
* <p>The name of the filter key. Currently, the only supported value is
|
|
7427
|
+
* <code>OpsItemId</code>.</p>
|
|
7183
7428
|
* @public
|
|
7184
7429
|
*/
|
|
7185
|
-
Key:
|
|
7430
|
+
Key: OpsItemEventFilterKey | undefined;
|
|
7186
7431
|
/**
|
|
7187
|
-
* <p>
|
|
7432
|
+
* <p>The values for the filter, consisting of one or more OpsItem IDs.</p>
|
|
7188
7433
|
* @public
|
|
7189
7434
|
*/
|
|
7190
7435
|
Values: string[] | undefined;
|
|
7436
|
+
/**
|
|
7437
|
+
* <p>The operator used by the filter call. Currently, the only supported value is
|
|
7438
|
+
* <code>Equal</code>.</p>
|
|
7439
|
+
* @public
|
|
7440
|
+
*/
|
|
7441
|
+
Operator: OpsItemEventFilterOperator | undefined;
|
|
7191
7442
|
}
|
|
7192
7443
|
/**
|
|
7193
7444
|
* @public
|
|
7194
7445
|
*/
|
|
7195
|
-
export interface
|
|
7446
|
+
export interface ListOpsItemEventsRequest {
|
|
7196
7447
|
/**
|
|
7197
|
-
* <p>One or more filters
|
|
7448
|
+
* <p>One or more OpsItem filters. Use a filter to return a more specific list of results. </p>
|
|
7198
7449
|
* @public
|
|
7199
7450
|
*/
|
|
7200
|
-
Filters?:
|
|
7451
|
+
Filters?: OpsItemEventFilter[] | undefined;
|
|
7201
7452
|
/**
|
|
7202
7453
|
* <p>The maximum number of items to return for this call. The call also returns a token that you
|
|
7203
|
-
* can specify in a subsequent call to get the next set of results
|
|
7454
|
+
* can specify in a subsequent call to get the next set of results. </p>
|
|
7204
7455
|
* @public
|
|
7205
7456
|
*/
|
|
7206
7457
|
MaxResults?: number | undefined;
|
|
7207
7458
|
/**
|
|
7208
|
-
* <p>A token to start the list. Use this token to get the next set of results
|
|
7459
|
+
* <p>A token to start the list. Use this token to get the next set of results. </p>
|
|
7209
7460
|
* @public
|
|
7210
7461
|
*/
|
|
7211
7462
|
NextToken?: string | undefined;
|
|
7212
7463
|
}
|
|
7213
7464
|
/**
|
|
7214
|
-
* <p>
|
|
7465
|
+
* <p>Information about the user or resource that created an OpsItem event.</p>
|
|
7215
7466
|
* @public
|
|
7216
7467
|
*/
|
|
7217
|
-
export interface
|
|
7468
|
+
export interface OpsItemIdentity {
|
|
7218
7469
|
/**
|
|
7219
|
-
* <p>The
|
|
7470
|
+
* <p>The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem
|
|
7471
|
+
* event.</p>
|
|
7220
7472
|
* @public
|
|
7221
7473
|
*/
|
|
7222
|
-
|
|
7474
|
+
Arn?: string | undefined;
|
|
7475
|
+
}
|
|
7476
|
+
/**
|
|
7477
|
+
* <p>Summary information about an OpsItem event or that associated an OpsItem with a related
|
|
7478
|
+
* item.</p>
|
|
7479
|
+
* @public
|
|
7480
|
+
*/
|
|
7481
|
+
export interface OpsItemEventSummary {
|
|
7223
7482
|
/**
|
|
7224
|
-
* <p>The
|
|
7483
|
+
* <p>The ID of the OpsItem.</p>
|
|
7225
7484
|
* @public
|
|
7226
7485
|
*/
|
|
7227
|
-
|
|
7486
|
+
OpsItemId?: string | undefined;
|
|
7228
7487
|
/**
|
|
7229
|
-
* <p>The
|
|
7488
|
+
* <p>The ID of the OpsItem event.</p>
|
|
7230
7489
|
* @public
|
|
7231
7490
|
*/
|
|
7232
|
-
|
|
7491
|
+
EventId?: string | undefined;
|
|
7233
7492
|
/**
|
|
7234
|
-
* <p>The
|
|
7493
|
+
* <p>The source of the OpsItem event.</p>
|
|
7235
7494
|
* @public
|
|
7236
7495
|
*/
|
|
7237
|
-
|
|
7496
|
+
Source?: string | undefined;
|
|
7238
7497
|
/**
|
|
7239
|
-
* <p>The
|
|
7498
|
+
* <p>The type of information provided as a detail.</p>
|
|
7240
7499
|
* @public
|
|
7241
7500
|
*/
|
|
7242
|
-
|
|
7243
|
-
}
|
|
7244
|
-
/**
|
|
7245
|
-
* @public
|
|
7246
|
-
*/
|
|
7247
|
-
export interface ListOpsMetadataResult {
|
|
7501
|
+
DetailType?: string | undefined;
|
|
7248
7502
|
/**
|
|
7249
|
-
* <p>
|
|
7503
|
+
* <p>Specific information about the OpsItem event.</p>
|
|
7250
7504
|
* @public
|
|
7251
7505
|
*/
|
|
7252
|
-
|
|
7506
|
+
Detail?: string | undefined;
|
|
7253
7507
|
/**
|
|
7254
|
-
* <p>
|
|
7255
|
-
* results.</p>
|
|
7508
|
+
* <p>Information about the user or resource that created the OpsItem event.</p>
|
|
7256
7509
|
* @public
|
|
7257
7510
|
*/
|
|
7258
|
-
|
|
7511
|
+
CreatedBy?: OpsItemIdentity | undefined;
|
|
7512
|
+
/**
|
|
7513
|
+
* <p>The date and time the OpsItem event was created.</p>
|
|
7514
|
+
* @public
|
|
7515
|
+
*/
|
|
7516
|
+
CreatedTime?: Date | undefined;
|
|
7259
7517
|
}
|
|
7260
7518
|
/**
|
|
7261
7519
|
* @public
|
|
7262
7520
|
*/
|
|
7263
|
-
export interface
|
|
7264
|
-
/**
|
|
7265
|
-
* <p>One or more filters. Use a filter to return a more specific list of results.</p>
|
|
7266
|
-
* @public
|
|
7267
|
-
*/
|
|
7268
|
-
Filters?: ComplianceStringFilter[] | undefined;
|
|
7521
|
+
export interface ListOpsItemEventsResponse {
|
|
7269
7522
|
/**
|
|
7270
|
-
* <p>
|
|
7523
|
+
* <p>The token for the next set of items to return. Use this token to get the next set of
|
|
7524
|
+
* results. </p>
|
|
7271
7525
|
* @public
|
|
7272
7526
|
*/
|
|
7273
7527
|
NextToken?: string | undefined;
|
|
7274
7528
|
/**
|
|
7275
|
-
* <p>
|
|
7276
|
-
* can specify in a subsequent call to get the next set of results.</p>
|
|
7529
|
+
* <p>A list of event information for the specified OpsItems.</p>
|
|
7277
7530
|
* @public
|
|
7278
7531
|
*/
|
|
7279
|
-
|
|
7532
|
+
Summaries?: OpsItemEventSummary[] | undefined;
|
|
7280
7533
|
}
|
|
7281
7534
|
/**
|
|
7282
|
-
* <p>Compliance summary information for a specific resource. </p>
|
|
7283
7535
|
* @public
|
|
7536
|
+
* @enum
|
|
7284
7537
|
*/
|
|
7285
|
-
export
|
|
7286
|
-
|
|
7287
|
-
|
|
7288
|
-
|
|
7289
|
-
|
|
7290
|
-
|
|
7538
|
+
export declare const OpsItemRelatedItemsFilterKey: {
|
|
7539
|
+
readonly ASSOCIATION_ID: "AssociationId";
|
|
7540
|
+
readonly RESOURCE_TYPE: "ResourceType";
|
|
7541
|
+
readonly RESOURCE_URI: "ResourceUri";
|
|
7542
|
+
};
|
|
7543
|
+
/**
|
|
7544
|
+
* @public
|
|
7545
|
+
*/
|
|
7546
|
+
export type OpsItemRelatedItemsFilterKey = (typeof OpsItemRelatedItemsFilterKey)[keyof typeof OpsItemRelatedItemsFilterKey];
|
|
7547
|
+
/**
|
|
7548
|
+
* @public
|
|
7549
|
+
* @enum
|
|
7550
|
+
*/
|
|
7551
|
+
export declare const OpsItemRelatedItemsFilterOperator: {
|
|
7552
|
+
readonly EQUAL: "Equal";
|
|
7553
|
+
};
|
|
7554
|
+
/**
|
|
7555
|
+
* @public
|
|
7556
|
+
*/
|
|
7557
|
+
export type OpsItemRelatedItemsFilterOperator = (typeof OpsItemRelatedItemsFilterOperator)[keyof typeof OpsItemRelatedItemsFilterOperator];
|
|
7558
|
+
/**
|
|
7559
|
+
* <p>Describes a filter for a specific list of related-item resources. </p>
|
|
7560
|
+
* @public
|
|
7561
|
+
*/
|
|
7562
|
+
export interface OpsItemRelatedItemsFilter {
|
|
7291
7563
|
/**
|
|
7292
|
-
* <p>The
|
|
7564
|
+
* <p>The name of the filter key. Supported values include <code>ResourceUri</code>,
|
|
7565
|
+
* <code>ResourceType</code>, or <code>AssociationId</code>.</p>
|
|
7293
7566
|
* @public
|
|
7294
7567
|
*/
|
|
7295
|
-
|
|
7568
|
+
Key: OpsItemRelatedItemsFilterKey | undefined;
|
|
7296
7569
|
/**
|
|
7297
|
-
* <p>The
|
|
7570
|
+
* <p>The values for the filter.</p>
|
|
7298
7571
|
* @public
|
|
7299
7572
|
*/
|
|
7300
|
-
|
|
7573
|
+
Values: string[] | undefined;
|
|
7301
7574
|
/**
|
|
7302
|
-
* <p>The
|
|
7575
|
+
* <p>The operator used by the filter call. The only supported operator is
|
|
7576
|
+
* <code>EQUAL</code>.</p>
|
|
7303
7577
|
* @public
|
|
7304
7578
|
*/
|
|
7305
|
-
|
|
7579
|
+
Operator: OpsItemRelatedItemsFilterOperator | undefined;
|
|
7580
|
+
}
|
|
7581
|
+
/**
|
|
7582
|
+
* @public
|
|
7583
|
+
*/
|
|
7584
|
+
export interface ListOpsItemRelatedItemsRequest {
|
|
7306
7585
|
/**
|
|
7307
|
-
* <p>The
|
|
7308
|
-
* item.</p>
|
|
7586
|
+
* <p>The ID of the OpsItem for which you want to list all related-item resources.</p>
|
|
7309
7587
|
* @public
|
|
7310
7588
|
*/
|
|
7311
|
-
|
|
7589
|
+
OpsItemId?: string | undefined;
|
|
7312
7590
|
/**
|
|
7313
|
-
* <p>
|
|
7591
|
+
* <p>One or more OpsItem filters. Use a filter to return a more specific list of results. </p>
|
|
7314
7592
|
* @public
|
|
7315
7593
|
*/
|
|
7316
|
-
|
|
7594
|
+
Filters?: OpsItemRelatedItemsFilter[] | undefined;
|
|
7317
7595
|
/**
|
|
7318
|
-
* <p>
|
|
7596
|
+
* <p>The maximum number of items to return for this call. The call also returns a token that you
|
|
7597
|
+
* can specify in a subsequent call to get the next set of results.</p>
|
|
7319
7598
|
* @public
|
|
7320
7599
|
*/
|
|
7321
|
-
|
|
7600
|
+
MaxResults?: number | undefined;
|
|
7322
7601
|
/**
|
|
7323
|
-
* <p>
|
|
7602
|
+
* <p>The token for the next set of items to return. (You received this token from a previous
|
|
7603
|
+
* call.)</p>
|
|
7324
7604
|
* @public
|
|
7325
7605
|
*/
|
|
7326
|
-
|
|
7606
|
+
NextToken?: string | undefined;
|
|
7327
7607
|
}
|
|
7328
7608
|
/**
|
|
7609
|
+
* <p>Summary information about related-item resources for an OpsItem.</p>
|
|
7329
7610
|
* @public
|
|
7330
7611
|
*/
|
|
7331
|
-
export interface
|
|
7612
|
+
export interface OpsItemRelatedItemSummary {
|
|
7332
7613
|
/**
|
|
7333
|
-
* <p>
|
|
7334
|
-
* about compliant and non-compliant State Manager associations, patch status, or custom items
|
|
7335
|
-
* according to the filter criteria that you specify. </p>
|
|
7614
|
+
* <p>The OpsItem ID.</p>
|
|
7336
7615
|
* @public
|
|
7337
7616
|
*/
|
|
7338
|
-
|
|
7617
|
+
OpsItemId?: string | undefined;
|
|
7339
7618
|
/**
|
|
7340
|
-
* <p>The
|
|
7341
|
-
* results.</p>
|
|
7619
|
+
* <p>The association ID.</p>
|
|
7342
7620
|
* @public
|
|
7343
7621
|
*/
|
|
7344
|
-
|
|
7345
|
-
|
|
7622
|
+
AssociationId?: string | undefined;
|
|
7623
|
+
/**
|
|
7624
|
+
* <p>The resource type.</p>
|
|
7625
|
+
* @public
|
|
7626
|
+
*/
|
|
7627
|
+
ResourceType?: string | undefined;
|
|
7628
|
+
/**
|
|
7629
|
+
* <p>The association type.</p>
|
|
7630
|
+
* @public
|
|
7631
|
+
*/
|
|
7632
|
+
AssociationType?: string | undefined;
|
|
7633
|
+
/**
|
|
7634
|
+
* <p>The Amazon Resource Name (ARN) of the related-item resource.</p>
|
|
7635
|
+
* @public
|
|
7636
|
+
*/
|
|
7637
|
+
ResourceUri?: string | undefined;
|
|
7638
|
+
/**
|
|
7639
|
+
* <p>Information about the user or resource that created an OpsItem event.</p>
|
|
7640
|
+
* @public
|
|
7641
|
+
*/
|
|
7642
|
+
CreatedBy?: OpsItemIdentity | undefined;
|
|
7643
|
+
/**
|
|
7644
|
+
* <p>The time the related-item association was created.</p>
|
|
7645
|
+
* @public
|
|
7646
|
+
*/
|
|
7647
|
+
CreatedTime?: Date | undefined;
|
|
7648
|
+
/**
|
|
7649
|
+
* <p>Information about the user or resource that created an OpsItem event.</p>
|
|
7650
|
+
* @public
|
|
7651
|
+
*/
|
|
7652
|
+
LastModifiedBy?: OpsItemIdentity | undefined;
|
|
7653
|
+
/**
|
|
7654
|
+
* <p>The time the related-item association was last updated.</p>
|
|
7655
|
+
* @public
|
|
7656
|
+
*/
|
|
7657
|
+
LastModifiedTime?: Date | undefined;
|
|
7658
|
+
}
|
|
7659
|
+
/**
|
|
7660
|
+
* @public
|
|
7661
|
+
*/
|
|
7662
|
+
export interface ListOpsItemRelatedItemsResponse {
|
|
7663
|
+
/**
|
|
7664
|
+
* <p>The token for the next set of items to return. Use this token to get the next set of
|
|
7665
|
+
* results.</p>
|
|
7666
|
+
* @public
|
|
7667
|
+
*/
|
|
7668
|
+
NextToken?: string | undefined;
|
|
7669
|
+
/**
|
|
7670
|
+
* <p>A list of related-item resources for the specified OpsItem.</p>
|
|
7671
|
+
* @public
|
|
7672
|
+
*/
|
|
7673
|
+
Summaries?: OpsItemRelatedItemSummary[] | undefined;
|
|
7674
|
+
}
|
|
7675
|
+
/**
|
|
7676
|
+
* <p>A filter to limit the number of OpsMetadata objects displayed.</p>
|
|
7677
|
+
* @public
|
|
7678
|
+
*/
|
|
7679
|
+
export interface OpsMetadataFilter {
|
|
7680
|
+
/**
|
|
7681
|
+
* <p>A filter key.</p>
|
|
7682
|
+
* @public
|
|
7683
|
+
*/
|
|
7684
|
+
Key: string | undefined;
|
|
7685
|
+
/**
|
|
7686
|
+
* <p>A filter value.</p>
|
|
7687
|
+
* @public
|
|
7688
|
+
*/
|
|
7689
|
+
Values: string[] | undefined;
|
|
7690
|
+
}
|
|
7691
|
+
/**
|
|
7692
|
+
* @public
|
|
7693
|
+
*/
|
|
7694
|
+
export interface ListOpsMetadataRequest {
|
|
7695
|
+
/**
|
|
7696
|
+
* <p>One or more filters to limit the number of OpsMetadata objects returned by the call.</p>
|
|
7697
|
+
* @public
|
|
7698
|
+
*/
|
|
7699
|
+
Filters?: OpsMetadataFilter[] | undefined;
|
|
7700
|
+
/**
|
|
7701
|
+
* <p>The maximum number of items to return for this call. The call also returns a token that you
|
|
7702
|
+
* can specify in a subsequent call to get the next set of results.</p>
|
|
7703
|
+
* @public
|
|
7704
|
+
*/
|
|
7705
|
+
MaxResults?: number | undefined;
|
|
7706
|
+
/**
|
|
7707
|
+
* <p>A token to start the list. Use this token to get the next set of results.</p>
|
|
7708
|
+
* @public
|
|
7709
|
+
*/
|
|
7710
|
+
NextToken?: string | undefined;
|
|
7711
|
+
}
|
|
7712
|
+
/**
|
|
7713
|
+
* <p>Operational metadata for an application in Application Manager.</p>
|
|
7714
|
+
* @public
|
|
7715
|
+
*/
|
|
7716
|
+
export interface OpsMetadata {
|
|
7717
|
+
/**
|
|
7718
|
+
* <p>The ID of the Application Manager application.</p>
|
|
7719
|
+
* @public
|
|
7720
|
+
*/
|
|
7721
|
+
ResourceId?: string | undefined;
|
|
7722
|
+
/**
|
|
7723
|
+
* <p>The Amazon Resource Name (ARN) of the OpsMetadata Object or blob.</p>
|
|
7724
|
+
* @public
|
|
7725
|
+
*/
|
|
7726
|
+
OpsMetadataArn?: string | undefined;
|
|
7727
|
+
/**
|
|
7728
|
+
* <p>The date the OpsMetadata object was last updated.</p>
|
|
7729
|
+
* @public
|
|
7730
|
+
*/
|
|
7731
|
+
LastModifiedDate?: Date | undefined;
|
|
7732
|
+
/**
|
|
7733
|
+
* <p>The user name who last updated the OpsMetadata object.</p>
|
|
7734
|
+
* @public
|
|
7735
|
+
*/
|
|
7736
|
+
LastModifiedUser?: string | undefined;
|
|
7737
|
+
/**
|
|
7738
|
+
* <p>The date the OpsMetadata objects was created.</p>
|
|
7739
|
+
* @public
|
|
7740
|
+
*/
|
|
7741
|
+
CreationDate?: Date | undefined;
|
|
7742
|
+
}
|
|
7743
|
+
/**
|
|
7744
|
+
* @public
|
|
7745
|
+
*/
|
|
7746
|
+
export interface ListOpsMetadataResult {
|
|
7747
|
+
/**
|
|
7748
|
+
* <p>Returns a list of OpsMetadata objects.</p>
|
|
7749
|
+
* @public
|
|
7750
|
+
*/
|
|
7751
|
+
OpsMetadataList?: OpsMetadata[] | undefined;
|
|
7752
|
+
/**
|
|
7753
|
+
* <p>The token for the next set of items to return. Use this token to get the next set of
|
|
7754
|
+
* results.</p>
|
|
7755
|
+
* @public
|
|
7756
|
+
*/
|
|
7757
|
+
NextToken?: string | undefined;
|
|
7758
|
+
}
|
|
7759
|
+
/**
|
|
7760
|
+
* @public
|
|
7761
|
+
*/
|
|
7762
|
+
export interface ListResourceComplianceSummariesRequest {
|
|
7763
|
+
/**
|
|
7764
|
+
* <p>One or more filters. Use a filter to return a more specific list of results.</p>
|
|
7765
|
+
* @public
|
|
7766
|
+
*/
|
|
7767
|
+
Filters?: ComplianceStringFilter[] | undefined;
|
|
7768
|
+
/**
|
|
7769
|
+
* <p>A token to start the list. Use this token to get the next set of results. </p>
|
|
7770
|
+
* @public
|
|
7771
|
+
*/
|
|
7772
|
+
NextToken?: string | undefined;
|
|
7773
|
+
/**
|
|
7774
|
+
* <p>The maximum number of items to return for this call. The call also returns a token that you
|
|
7775
|
+
* can specify in a subsequent call to get the next set of results.</p>
|
|
7776
|
+
* @public
|
|
7777
|
+
*/
|
|
7778
|
+
MaxResults?: number | undefined;
|
|
7779
|
+
}
|
|
7780
|
+
/**
|
|
7781
|
+
* <p>Compliance summary information for a specific resource. </p>
|
|
7782
|
+
* @public
|
|
7783
|
+
*/
|
|
7784
|
+
export interface ResourceComplianceSummaryItem {
|
|
7785
|
+
/**
|
|
7786
|
+
* <p>The compliance type.</p>
|
|
7787
|
+
* @public
|
|
7788
|
+
*/
|
|
7789
|
+
ComplianceType?: string | undefined;
|
|
7790
|
+
/**
|
|
7791
|
+
* <p>The resource type.</p>
|
|
7792
|
+
* @public
|
|
7793
|
+
*/
|
|
7794
|
+
ResourceType?: string | undefined;
|
|
7795
|
+
/**
|
|
7796
|
+
* <p>The resource ID.</p>
|
|
7797
|
+
* @public
|
|
7798
|
+
*/
|
|
7799
|
+
ResourceId?: string | undefined;
|
|
7800
|
+
/**
|
|
7801
|
+
* <p>The compliance status for the resource.</p>
|
|
7802
|
+
* @public
|
|
7803
|
+
*/
|
|
7804
|
+
Status?: ComplianceStatus | undefined;
|
|
7805
|
+
/**
|
|
7806
|
+
* <p>The highest severity item found for the resource. The resource is compliant for this
|
|
7807
|
+
* item.</p>
|
|
7808
|
+
* @public
|
|
7809
|
+
*/
|
|
7810
|
+
OverallSeverity?: ComplianceSeverity | undefined;
|
|
7811
|
+
/**
|
|
7812
|
+
* <p>Information about the execution.</p>
|
|
7813
|
+
* @public
|
|
7814
|
+
*/
|
|
7815
|
+
ExecutionSummary?: ComplianceExecutionSummary | undefined;
|
|
7816
|
+
/**
|
|
7817
|
+
* <p>A list of items that are compliant for the resource.</p>
|
|
7818
|
+
* @public
|
|
7819
|
+
*/
|
|
7820
|
+
CompliantSummary?: CompliantSummary | undefined;
|
|
7821
|
+
/**
|
|
7822
|
+
* <p>A list of items that aren't compliant for the resource.</p>
|
|
7823
|
+
* @public
|
|
7824
|
+
*/
|
|
7825
|
+
NonCompliantSummary?: NonCompliantSummary | undefined;
|
|
7826
|
+
}
|
|
7827
|
+
/**
|
|
7828
|
+
* @public
|
|
7829
|
+
*/
|
|
7830
|
+
export interface ListResourceComplianceSummariesResult {
|
|
7831
|
+
/**
|
|
7832
|
+
* <p>A summary count for specified or targeted managed nodes. Summary count includes information
|
|
7833
|
+
* about compliant and non-compliant State Manager associations, patch status, or custom items
|
|
7834
|
+
* according to the filter criteria that you specify. </p>
|
|
7835
|
+
* @public
|
|
7836
|
+
*/
|
|
7837
|
+
ResourceComplianceSummaryItems?: ResourceComplianceSummaryItem[] | undefined;
|
|
7838
|
+
/**
|
|
7839
|
+
* <p>The token for the next set of items to return. Use this token to get the next set of
|
|
7840
|
+
* results.</p>
|
|
7841
|
+
* @public
|
|
7842
|
+
*/
|
|
7843
|
+
NextToken?: string | undefined;
|
|
7844
|
+
}
|
|
7346
7845
|
/**
|
|
7347
7846
|
* @public
|
|
7348
7847
|
*/
|
|
@@ -8590,845 +9089,304 @@ export interface RegisterTargetWithMaintenanceWindowResult {
|
|
|
8590
9089
|
* @public
|
|
8591
9090
|
*/
|
|
8592
9091
|
export declare class FeatureNotAvailableException extends __BaseException {
|
|
8593
|
-
readonly name: "FeatureNotAvailableException";
|
|
8594
|
-
readonly $fault: "client";
|
|
8595
|
-
Message?: string | undefined;
|
|
8596
|
-
/**
|
|
8597
|
-
* @internal
|
|
8598
|
-
*/
|
|
8599
|
-
constructor(opts: __ExceptionOptionType<FeatureNotAvailableException, __BaseException>);
|
|
8600
|
-
}
|
|
8601
|
-
/**
|
|
8602
|
-
* @public
|
|
8603
|
-
*/
|
|
8604
|
-
export interface RegisterTaskWithMaintenanceWindowRequest {
|
|
8605
|
-
/**
|
|
8606
|
-
* <p>The ID of the maintenance window the task should be added to.</p>
|
|
8607
|
-
* @public
|
|
8608
|
-
*/
|
|
8609
|
-
WindowId: string | undefined;
|
|
8610
|
-
/**
|
|
8611
|
-
* <p>The targets (either managed nodes or maintenance window targets).</p>
|
|
8612
|
-
* <note>
|
|
8613
|
-
* <p>One or more targets must be specified for maintenance window Run Command-type tasks.
|
|
8614
|
-
* Depending on the task, targets are optional for other maintenance window task types (Automation,
|
|
8615
|
-
* Lambda, and Step Functions). For more information about running tasks
|
|
8616
|
-
* that don't specify targets, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html">Registering
|
|
8617
|
-
* maintenance window tasks without targets</a> in the
|
|
8618
|
-
* <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
8619
|
-
* </note>
|
|
8620
|
-
* <p>Specify managed nodes using the following format: </p>
|
|
8621
|
-
* <p>
|
|
8622
|
-
* <code>Key=InstanceIds,Values=<instance-id-1>,<instance-id-2></code>
|
|
8623
|
-
* </p>
|
|
8624
|
-
* <p>Specify maintenance window targets using the following format:</p>
|
|
8625
|
-
* <p>
|
|
8626
|
-
* <code>Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2></code>
|
|
8627
|
-
* </p>
|
|
8628
|
-
* @public
|
|
8629
|
-
*/
|
|
8630
|
-
Targets?: Target[] | undefined;
|
|
8631
|
-
/**
|
|
8632
|
-
* <p>The ARN of the task to run.</p>
|
|
8633
|
-
* @public
|
|
8634
|
-
*/
|
|
8635
|
-
TaskArn: string | undefined;
|
|
8636
|
-
/**
|
|
8637
|
-
* <p>The Amazon Resource Name (ARN) of the IAM service role for
|
|
8638
|
-
* Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a
|
|
8639
|
-
* service role ARN, Systems Manager uses a service-linked role in your account. If no
|
|
8640
|
-
* appropriate service-linked role for Systems Manager exists in your account, it is created when
|
|
8641
|
-
* you run <code>RegisterTaskWithMaintenanceWindow</code>.</p>
|
|
8642
|
-
* <p>However, for an improved security posture, we strongly recommend creating a custom
|
|
8643
|
-
* policy and custom service role for running your maintenance window tasks. The policy
|
|
8644
|
-
* can be crafted to provide only the permissions needed for your particular
|
|
8645
|
-
* 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
|
|
8646
|
-
* <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
8647
|
-
* @public
|
|
8648
|
-
*/
|
|
8649
|
-
ServiceRoleArn?: string | undefined;
|
|
8650
|
-
/**
|
|
8651
|
-
* <p>The type of task being registered.</p>
|
|
8652
|
-
* @public
|
|
8653
|
-
*/
|
|
8654
|
-
TaskType: MaintenanceWindowTaskType | undefined;
|
|
8655
|
-
/**
|
|
8656
|
-
* <p>The parameters that should be passed to the task when it is run.</p>
|
|
8657
|
-
* <note>
|
|
8658
|
-
* <p>
|
|
8659
|
-
* <code>TaskParameters</code> has been deprecated. To specify parameters to pass to a task when it runs,
|
|
8660
|
-
* instead use the <code>Parameters</code> option in the <code>TaskInvocationParameters</code> structure. For information
|
|
8661
|
-
* about how Systems Manager handles these options for the supported maintenance window task
|
|
8662
|
-
* types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p>
|
|
8663
|
-
* </note>
|
|
8664
|
-
* @public
|
|
8665
|
-
*/
|
|
8666
|
-
TaskParameters?: Record<string, MaintenanceWindowTaskParameterValueExpression> | undefined;
|
|
8667
|
-
/**
|
|
8668
|
-
* <p>The parameters that the task should use during execution. Populate only the fields that
|
|
8669
|
-
* match the task type. All other fields should be empty. </p>
|
|
8670
|
-
* @public
|
|
8671
|
-
*/
|
|
8672
|
-
TaskInvocationParameters?: MaintenanceWindowTaskInvocationParameters | undefined;
|
|
8673
|
-
/**
|
|
8674
|
-
* <p>The priority of the task in the maintenance window, the lower the number the higher the
|
|
8675
|
-
* priority. Tasks in a maintenance window are scheduled in priority order with tasks that have the
|
|
8676
|
-
* same priority scheduled in parallel.</p>
|
|
8677
|
-
* @public
|
|
8678
|
-
*/
|
|
8679
|
-
Priority?: number | undefined;
|
|
8680
|
-
/**
|
|
8681
|
-
* <p>The maximum number of targets this task can be run for, in parallel.</p>
|
|
8682
|
-
* <note>
|
|
8683
|
-
* <p>Although this element is listed as "Required: No", a value can be omitted only when you are
|
|
8684
|
-
* registering or updating a <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html">targetless
|
|
8685
|
-
* task</a> You must provide a value in all other cases.</p>
|
|
8686
|
-
* <p>For maintenance window tasks without a target specified, you can't supply a value for this
|
|
8687
|
-
* option. Instead, the system inserts a placeholder value of <code>1</code>. This value doesn't
|
|
8688
|
-
* affect the running of your task.</p>
|
|
8689
|
-
* </note>
|
|
8690
|
-
* @public
|
|
8691
|
-
*/
|
|
8692
|
-
MaxConcurrency?: string | undefined;
|
|
8693
|
-
/**
|
|
8694
|
-
* <p>The maximum number of errors allowed before this task stops being scheduled.</p>
|
|
8695
|
-
* <note>
|
|
8696
|
-
* <p>Although this element is listed as "Required: No", a value can be omitted only when you are
|
|
8697
|
-
* registering or updating a <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html">targetless
|
|
8698
|
-
* task</a> You must provide a value in all other cases.</p>
|
|
8699
|
-
* <p>For maintenance window tasks without a target specified, you can't supply a value for this
|
|
8700
|
-
* option. Instead, the system inserts a placeholder value of <code>1</code>. This value doesn't
|
|
8701
|
-
* affect the running of your task.</p>
|
|
8702
|
-
* </note>
|
|
8703
|
-
* @public
|
|
8704
|
-
*/
|
|
8705
|
-
MaxErrors?: string | undefined;
|
|
8706
|
-
/**
|
|
8707
|
-
* <p>A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket
|
|
8708
|
-
* to write managed node-level logs to. </p>
|
|
8709
|
-
* <note>
|
|
8710
|
-
* <p>
|
|
8711
|
-
* <code>LoggingInfo</code> has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the
|
|
8712
|
-
* <code>OutputS3BucketName</code> and <code>OutputS3KeyPrefix</code> options in the <code>TaskInvocationParameters</code> structure.
|
|
8713
|
-
* For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance
|
|
8714
|
-
* window task types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p>
|
|
8715
|
-
* </note>
|
|
8716
|
-
* @public
|
|
8717
|
-
*/
|
|
8718
|
-
LoggingInfo?: LoggingInfo | undefined;
|
|
8719
|
-
/**
|
|
8720
|
-
* <p>An optional name for the task.</p>
|
|
8721
|
-
* @public
|
|
8722
|
-
*/
|
|
8723
|
-
Name?: string | undefined;
|
|
8724
|
-
/**
|
|
8725
|
-
* <p>An optional description for the task.</p>
|
|
8726
|
-
* @public
|
|
8727
|
-
*/
|
|
8728
|
-
Description?: string | undefined;
|
|
8729
|
-
/**
|
|
8730
|
-
* <p>User-provided idempotency token.</p>
|
|
8731
|
-
* @public
|
|
8732
|
-
*/
|
|
8733
|
-
ClientToken?: string | undefined;
|
|
8734
|
-
/**
|
|
8735
|
-
* <p>Indicates whether tasks should continue to run after the cutoff time specified in the
|
|
8736
|
-
* maintenance windows is reached. </p>
|
|
8737
|
-
* <ul>
|
|
8738
|
-
* <li>
|
|
8739
|
-
* <p>
|
|
8740
|
-
* <code>CONTINUE_TASK</code>: When the cutoff time is reached, any tasks that are running
|
|
8741
|
-
* continue. The default value.</p>
|
|
8742
|
-
* </li>
|
|
8743
|
-
* <li>
|
|
8744
|
-
* <p>
|
|
8745
|
-
* <code>CANCEL_TASK</code>:</p>
|
|
8746
|
-
* <ul>
|
|
8747
|
-
* <li>
|
|
8748
|
-
* <p>For Automation, Lambda, Step Functions tasks: When the cutoff
|
|
8749
|
-
* time is reached, any task invocations that are already running continue, but no new task
|
|
8750
|
-
* invocations are started.</p>
|
|
8751
|
-
* </li>
|
|
8752
|
-
* <li>
|
|
8753
|
-
* <p>For Run Command tasks: When the cutoff time is reached, the system sends a <a>CancelCommand</a> operation that attempts to cancel the command associated with the
|
|
8754
|
-
* task. However, there is no guarantee that the command will be terminated and the underlying
|
|
8755
|
-
* process stopped.</p>
|
|
8756
|
-
* </li>
|
|
8757
|
-
* </ul>
|
|
8758
|
-
* <p>The status for tasks that are not completed is <code>TIMED_OUT</code>.</p>
|
|
8759
|
-
* </li>
|
|
8760
|
-
* </ul>
|
|
8761
|
-
* @public
|
|
8762
|
-
*/
|
|
8763
|
-
CutoffBehavior?: MaintenanceWindowTaskCutoffBehavior | undefined;
|
|
8764
|
-
/**
|
|
8765
|
-
* <p>The CloudWatch alarm you want to apply to your maintenance window task.</p>
|
|
8766
|
-
* @public
|
|
8767
|
-
*/
|
|
8768
|
-
AlarmConfiguration?: AlarmConfiguration | undefined;
|
|
8769
|
-
}
|
|
8770
|
-
/**
|
|
8771
|
-
* @public
|
|
8772
|
-
*/
|
|
8773
|
-
export interface RegisterTaskWithMaintenanceWindowResult {
|
|
8774
|
-
/**
|
|
8775
|
-
* <p>The ID of the task in the maintenance window.</p>
|
|
8776
|
-
* @public
|
|
8777
|
-
*/
|
|
8778
|
-
WindowTaskId?: string | undefined;
|
|
8779
|
-
}
|
|
8780
|
-
/**
|
|
8781
|
-
* @public
|
|
8782
|
-
*/
|
|
8783
|
-
export interface RemoveTagsFromResourceRequest {
|
|
8784
|
-
/**
|
|
8785
|
-
* <p>The type of resource from which you want to remove a tag.</p>
|
|
8786
|
-
* <note>
|
|
8787
|
-
* <p>The <code>ManagedInstance</code> type for this API operation is only for on-premises
|
|
8788
|
-
* managed nodes. Specify the name of the managed node in the following format:
|
|
8789
|
-
* <code>mi-<i>ID_number</i>
|
|
8790
|
-
* </code>. For example,
|
|
8791
|
-
* <code>mi-1a2b3c4d5e6f</code>.</p>
|
|
8792
|
-
* </note>
|
|
8793
|
-
* @public
|
|
8794
|
-
*/
|
|
8795
|
-
ResourceType: ResourceTypeForTagging | undefined;
|
|
8796
|
-
/**
|
|
8797
|
-
* <p>The ID of the resource from which you want to remove tags. For example:</p>
|
|
8798
|
-
* <p>ManagedInstance: mi-012345abcde</p>
|
|
8799
|
-
* <p>MaintenanceWindow: mw-012345abcde</p>
|
|
8800
|
-
* <p>
|
|
8801
|
-
* <code>Automation</code>: <code>example-c160-4567-8519-012345abcde</code>
|
|
8802
|
-
* </p>
|
|
8803
|
-
* <p>PatchBaseline: pb-012345abcde</p>
|
|
8804
|
-
* <p>OpsMetadata object: <code>ResourceID</code> for tagging is created from the Amazon Resource
|
|
8805
|
-
* Name (ARN) for the object. Specifically, <code>ResourceID</code> is created from the strings that
|
|
8806
|
-
* come after the word <code>opsmetadata</code> in the ARN. For example, an OpsMetadata object with
|
|
8807
|
-
* an ARN of <code>arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager</code>
|
|
8808
|
-
* has a <code>ResourceID</code> of either <code>aws/ssm/MyGroup/appmanager</code> or
|
|
8809
|
-
* <code>/aws/ssm/MyGroup/appmanager</code>.</p>
|
|
8810
|
-
* <p>For the Document and Parameter values, use the name of the resource.</p>
|
|
8811
|
-
* <note>
|
|
8812
|
-
* <p>The <code>ManagedInstance</code> type for this API operation is only for on-premises
|
|
8813
|
-
* managed nodes. Specify the name of the managed node in the following format: mi-ID_number. For
|
|
8814
|
-
* example, mi-1a2b3c4d5e6f.</p>
|
|
8815
|
-
* </note>
|
|
8816
|
-
* @public
|
|
8817
|
-
*/
|
|
8818
|
-
ResourceId: string | undefined;
|
|
8819
|
-
/**
|
|
8820
|
-
* <p>Tag keys that you want to remove from the specified resource.</p>
|
|
8821
|
-
* @public
|
|
8822
|
-
*/
|
|
8823
|
-
TagKeys: string[] | undefined;
|
|
8824
|
-
}
|
|
8825
|
-
/**
|
|
8826
|
-
* @public
|
|
8827
|
-
*/
|
|
8828
|
-
export interface RemoveTagsFromResourceResult {
|
|
8829
|
-
}
|
|
8830
|
-
/**
|
|
8831
|
-
* <p>The request body of the ResetServiceSetting API operation.</p>
|
|
8832
|
-
* @public
|
|
8833
|
-
*/
|
|
8834
|
-
export interface ResetServiceSettingRequest {
|
|
8835
|
-
/**
|
|
8836
|
-
* <p>The Amazon Resource Name (ARN) of the service setting to reset. The setting ID can be one of
|
|
8837
|
-
* the following.</p>
|
|
8838
|
-
* <ul>
|
|
8839
|
-
* <li>
|
|
8840
|
-
* <p>
|
|
8841
|
-
* <code>/ssm/managed-instance/default-ec2-instance-management-role</code>
|
|
8842
|
-
* </p>
|
|
8843
|
-
* </li>
|
|
8844
|
-
* <li>
|
|
8845
|
-
* <p>
|
|
8846
|
-
* <code>/ssm/automation/customer-script-log-destination</code>
|
|
8847
|
-
* </p>
|
|
8848
|
-
* </li>
|
|
8849
|
-
* <li>
|
|
8850
|
-
* <p>
|
|
8851
|
-
* <code>/ssm/automation/customer-script-log-group-name</code>
|
|
8852
|
-
* </p>
|
|
8853
|
-
* </li>
|
|
8854
|
-
* <li>
|
|
8855
|
-
* <p>
|
|
8856
|
-
* <code>/ssm/documents/console/public-sharing-permission</code>
|
|
8857
|
-
* </p>
|
|
8858
|
-
* </li>
|
|
8859
|
-
* <li>
|
|
8860
|
-
* <p>
|
|
8861
|
-
* <code>/ssm/managed-instance/activation-tier</code>
|
|
8862
|
-
* </p>
|
|
8863
|
-
* </li>
|
|
8864
|
-
* <li>
|
|
8865
|
-
* <p>
|
|
8866
|
-
* <code>/ssm/opsinsights/opscenter</code>
|
|
8867
|
-
* </p>
|
|
8868
|
-
* </li>
|
|
8869
|
-
* <li>
|
|
8870
|
-
* <p>
|
|
8871
|
-
* <code>/ssm/parameter-store/default-parameter-tier</code>
|
|
8872
|
-
* </p>
|
|
8873
|
-
* </li>
|
|
8874
|
-
* <li>
|
|
8875
|
-
* <p>
|
|
8876
|
-
* <code>/ssm/parameter-store/high-throughput-enabled</code>
|
|
8877
|
-
* </p>
|
|
8878
|
-
* </li>
|
|
8879
|
-
* </ul>
|
|
8880
|
-
* @public
|
|
8881
|
-
*/
|
|
8882
|
-
SettingId: string | undefined;
|
|
8883
|
-
}
|
|
8884
|
-
/**
|
|
8885
|
-
* <p>The result body of the ResetServiceSetting API operation.</p>
|
|
8886
|
-
* @public
|
|
8887
|
-
*/
|
|
8888
|
-
export interface ResetServiceSettingResult {
|
|
8889
|
-
/**
|
|
8890
|
-
* <p>The current, effective service setting after calling the ResetServiceSetting API
|
|
8891
|
-
* operation.</p>
|
|
8892
|
-
* @public
|
|
8893
|
-
*/
|
|
8894
|
-
ServiceSetting?: ServiceSetting | undefined;
|
|
8895
|
-
}
|
|
8896
|
-
/**
|
|
8897
|
-
* @public
|
|
8898
|
-
*/
|
|
8899
|
-
export interface ResumeSessionRequest {
|
|
8900
|
-
/**
|
|
8901
|
-
* <p>The ID of the disconnected session to resume.</p>
|
|
8902
|
-
* @public
|
|
8903
|
-
*/
|
|
8904
|
-
SessionId: string | undefined;
|
|
8905
|
-
}
|
|
8906
|
-
/**
|
|
8907
|
-
* @public
|
|
8908
|
-
*/
|
|
8909
|
-
export interface ResumeSessionResponse {
|
|
8910
|
-
/**
|
|
8911
|
-
* <p>The ID of the session.</p>
|
|
8912
|
-
* @public
|
|
8913
|
-
*/
|
|
8914
|
-
SessionId?: string | undefined;
|
|
8915
|
-
/**
|
|
8916
|
-
* <p>An encrypted token value containing session and caller information. Used to authenticate the
|
|
8917
|
-
* connection to the managed node.</p>
|
|
8918
|
-
* @public
|
|
8919
|
-
*/
|
|
8920
|
-
TokenValue?: string | undefined;
|
|
8921
|
-
/**
|
|
8922
|
-
* <p>A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and
|
|
8923
|
-
* receive output from the managed node. Format: <code>wss://ssmmessages.<b>region</b>.amazonaws.com/v1/data-channel/<b>session-id</b>?stream=(input|output)</code>.</p>
|
|
8924
|
-
* <p>
|
|
8925
|
-
* <b>region</b> represents the Region identifier for an
|
|
8926
|
-
* Amazon Web Services Region supported by Amazon Web Services Systems Manager, such as <code>us-east-2</code> for the US East (Ohio) Region.
|
|
8927
|
-
* 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
|
|
8928
|
-
* <i>Amazon Web Services General Reference</i>.</p>
|
|
8929
|
-
* <p>
|
|
8930
|
-
* <b>session-id</b> represents the ID of a Session Manager session, such as
|
|
8931
|
-
* <code>1a2b3c4dEXAMPLE</code>.</p>
|
|
8932
|
-
* @public
|
|
8933
|
-
*/
|
|
8934
|
-
StreamUrl?: string | undefined;
|
|
8935
|
-
}
|
|
8936
|
-
/**
|
|
8937
|
-
* <p>The specified step name and execution ID don't exist. Verify the information and try
|
|
8938
|
-
* again.</p>
|
|
8939
|
-
* @public
|
|
8940
|
-
*/
|
|
8941
|
-
export declare class AutomationStepNotFoundException extends __BaseException {
|
|
8942
|
-
readonly name: "AutomationStepNotFoundException";
|
|
8943
|
-
readonly $fault: "client";
|
|
8944
|
-
Message?: string | undefined;
|
|
8945
|
-
/**
|
|
8946
|
-
* @internal
|
|
8947
|
-
*/
|
|
8948
|
-
constructor(opts: __ExceptionOptionType<AutomationStepNotFoundException, __BaseException>);
|
|
8949
|
-
}
|
|
8950
|
-
/**
|
|
8951
|
-
* <p>The signal isn't valid for the current Automation execution.</p>
|
|
8952
|
-
* @public
|
|
8953
|
-
*/
|
|
8954
|
-
export declare class InvalidAutomationSignalException extends __BaseException {
|
|
8955
|
-
readonly name: "InvalidAutomationSignalException";
|
|
8956
|
-
readonly $fault: "client";
|
|
8957
|
-
Message?: string | undefined;
|
|
8958
|
-
/**
|
|
8959
|
-
* @internal
|
|
8960
|
-
*/
|
|
8961
|
-
constructor(opts: __ExceptionOptionType<InvalidAutomationSignalException, __BaseException>);
|
|
8962
|
-
}
|
|
8963
|
-
/**
|
|
8964
|
-
* @public
|
|
8965
|
-
* @enum
|
|
8966
|
-
*/
|
|
8967
|
-
export declare const SignalType: {
|
|
8968
|
-
readonly APPROVE: "Approve";
|
|
8969
|
-
readonly REJECT: "Reject";
|
|
8970
|
-
readonly RESUME: "Resume";
|
|
8971
|
-
readonly START_STEP: "StartStep";
|
|
8972
|
-
readonly STOP_STEP: "StopStep";
|
|
8973
|
-
};
|
|
8974
|
-
/**
|
|
8975
|
-
* @public
|
|
8976
|
-
*/
|
|
8977
|
-
export type SignalType = (typeof SignalType)[keyof typeof SignalType];
|
|
8978
|
-
/**
|
|
8979
|
-
* @public
|
|
8980
|
-
*/
|
|
8981
|
-
export interface SendAutomationSignalRequest {
|
|
8982
|
-
/**
|
|
8983
|
-
* <p>The unique identifier for an existing Automation execution that you want to send the signal
|
|
8984
|
-
* to.</p>
|
|
8985
|
-
* @public
|
|
8986
|
-
*/
|
|
8987
|
-
AutomationExecutionId: string | undefined;
|
|
8988
|
-
/**
|
|
8989
|
-
* <p>The type of signal to send to an Automation execution. </p>
|
|
8990
|
-
* @public
|
|
8991
|
-
*/
|
|
8992
|
-
SignalType: SignalType | undefined;
|
|
8993
|
-
/**
|
|
8994
|
-
* <p>The data sent with the signal. The data schema depends on the type of signal used in the
|
|
8995
|
-
* request.</p>
|
|
8996
|
-
* <p>For <code>Approve</code> and <code>Reject</code> signal types, the payload is an optional
|
|
8997
|
-
* comment that you can send with the signal type. For example:</p>
|
|
8998
|
-
* <p>
|
|
8999
|
-
* <code>Comment="Looks good"</code>
|
|
9000
|
-
* </p>
|
|
9001
|
-
* <p>For <code>StartStep</code> and <code>Resume</code> signal types, you must send the name of
|
|
9002
|
-
* the Automation step to start or resume as the payload. For example:</p>
|
|
9003
|
-
* <p>
|
|
9004
|
-
* <code>StepName="step1"</code>
|
|
9005
|
-
* </p>
|
|
9006
|
-
* <p>For the <code>StopStep</code> signal type, you must send the step execution ID as the
|
|
9007
|
-
* payload. For example:</p>
|
|
9008
|
-
* <p>
|
|
9009
|
-
* <code>StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"</code>
|
|
9010
|
-
* </p>
|
|
9011
|
-
* @public
|
|
9012
|
-
*/
|
|
9013
|
-
Payload?: Record<string, string[]> | undefined;
|
|
9014
|
-
}
|
|
9015
|
-
/**
|
|
9016
|
-
* @public
|
|
9017
|
-
*/
|
|
9018
|
-
export interface SendAutomationSignalResult {
|
|
9019
|
-
}
|
|
9020
|
-
/**
|
|
9021
|
-
* <p>One or more configuration items isn't valid. Verify that a valid Amazon Resource Name (ARN)
|
|
9022
|
-
* was provided for an Amazon Simple Notification Service topic.</p>
|
|
9023
|
-
* @public
|
|
9024
|
-
*/
|
|
9025
|
-
export declare class InvalidNotificationConfig extends __BaseException {
|
|
9026
|
-
readonly name: "InvalidNotificationConfig";
|
|
9027
|
-
readonly $fault: "client";
|
|
9028
|
-
Message?: string | undefined;
|
|
9029
|
-
/**
|
|
9030
|
-
* @internal
|
|
9031
|
-
*/
|
|
9032
|
-
constructor(opts: __ExceptionOptionType<InvalidNotificationConfig, __BaseException>);
|
|
9033
|
-
}
|
|
9034
|
-
/**
|
|
9035
|
-
* <p>The S3 bucket doesn't exist.</p>
|
|
9036
|
-
* @public
|
|
9037
|
-
*/
|
|
9038
|
-
export declare class InvalidOutputFolder extends __BaseException {
|
|
9039
|
-
readonly name: "InvalidOutputFolder";
|
|
9040
|
-
readonly $fault: "client";
|
|
9041
|
-
/**
|
|
9042
|
-
* @internal
|
|
9043
|
-
*/
|
|
9044
|
-
constructor(opts: __ExceptionOptionType<InvalidOutputFolder, __BaseException>);
|
|
9045
|
-
}
|
|
9046
|
-
/**
|
|
9047
|
-
* <p>The role name can't contain invalid characters. Also verify that you specified an IAM role for notifications that includes the required trust policy. For information about
|
|
9048
|
-
* configuring the IAM role for Run Command notifications, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html">Monitoring Systems Manager status changes using Amazon SNS notifications</a> in
|
|
9049
|
-
* the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
9050
|
-
* @public
|
|
9051
|
-
*/
|
|
9052
|
-
export declare class InvalidRole extends __BaseException {
|
|
9053
|
-
readonly name: "InvalidRole";
|
|
9054
|
-
readonly $fault: "client";
|
|
9055
|
-
Message?: string | undefined;
|
|
9056
|
-
/**
|
|
9057
|
-
* @internal
|
|
9058
|
-
*/
|
|
9059
|
-
constructor(opts: __ExceptionOptionType<InvalidRole, __BaseException>);
|
|
9060
|
-
}
|
|
9061
|
-
/**
|
|
9062
|
-
* @public
|
|
9063
|
-
*/
|
|
9064
|
-
export interface SendCommandRequest {
|
|
9065
|
-
/**
|
|
9066
|
-
* <p>The IDs of the managed nodes where the command should run. Specifying managed node IDs is
|
|
9067
|
-
* most useful when you are targeting a limited number of managed nodes, though you can specify up
|
|
9068
|
-
* to 50 IDs.</p>
|
|
9069
|
-
* <p>To target a larger number of managed nodes, or if you prefer not to list individual node
|
|
9070
|
-
* IDs, we recommend using the <code>Targets</code> option instead. Using <code>Targets</code>,
|
|
9071
|
-
* which accepts tag key-value pairs to identify the managed nodes to send commands to, you can a
|
|
9072
|
-
* send command to tens, hundreds, or thousands of nodes at once.</p>
|
|
9073
|
-
* <p>For more information about how to use targets, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html">Run commands at scale</a>
|
|
9074
|
-
* in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
9075
|
-
* @public
|
|
9076
|
-
*/
|
|
9077
|
-
InstanceIds?: string[] | undefined;
|
|
9078
|
-
/**
|
|
9079
|
-
* <p>An array of search criteria that targets managed nodes using a <code>Key,Value</code>
|
|
9080
|
-
* combination that you specify. Specifying targets is most useful when you want to send a command
|
|
9081
|
-
* to a large number of managed nodes at once. Using <code>Targets</code>, which accepts tag
|
|
9082
|
-
* key-value pairs to identify managed nodes, you can send a command to tens, hundreds, or thousands
|
|
9083
|
-
* of nodes at once.</p>
|
|
9084
|
-
* <p>To send a command to a smaller number of managed nodes, you can use the
|
|
9085
|
-
* <code>InstanceIds</code> option instead.</p>
|
|
9086
|
-
* <p>For more information about how to use targets, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html">Run commands at scale</a>
|
|
9087
|
-
* in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
9088
|
-
* @public
|
|
9089
|
-
*/
|
|
9090
|
-
Targets?: Target[] | undefined;
|
|
9091
|
-
/**
|
|
9092
|
-
* <p>The name of the Amazon Web Services Systems Manager document (SSM document) to run. This can be a public document or a
|
|
9093
|
-
* custom document. To run a shared document belonging to another account, specify the document
|
|
9094
|
-
* Amazon Resource Name (ARN). For more information about how to use shared documents, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-using-shared.html">Sharing SSM
|
|
9095
|
-
* documents</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
9096
|
-
* <note>
|
|
9097
|
-
* <p>If you specify a document name or ARN that hasn't been shared with your account, you
|
|
9098
|
-
* receive an <code>InvalidDocument</code> error. </p>
|
|
9099
|
-
* </note>
|
|
9100
|
-
* @public
|
|
9101
|
-
*/
|
|
9102
|
-
DocumentName: string | undefined;
|
|
9103
|
-
/**
|
|
9104
|
-
* <p>The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a
|
|
9105
|
-
* specific version number. If you run commands by using the Command Line Interface (Amazon Web Services CLI), then
|
|
9106
|
-
* you must escape the first two options by using a backslash. If you specify a version number, then
|
|
9107
|
-
* you don't need to use the backslash. For example:</p>
|
|
9108
|
-
* <p>--document-version "\$DEFAULT"</p>
|
|
9109
|
-
* <p>--document-version "\$LATEST"</p>
|
|
9110
|
-
* <p>--document-version "3"</p>
|
|
9111
|
-
* @public
|
|
9112
|
-
*/
|
|
9113
|
-
DocumentVersion?: string | undefined;
|
|
9114
|
-
/**
|
|
9115
|
-
* <p>The Sha256 or Sha1 hash created by the system when the document was created. </p>
|
|
9116
|
-
* <note>
|
|
9117
|
-
* <p>Sha1 hashes have been deprecated.</p>
|
|
9118
|
-
* </note>
|
|
9119
|
-
* @public
|
|
9120
|
-
*/
|
|
9121
|
-
DocumentHash?: string | undefined;
|
|
9122
|
-
/**
|
|
9123
|
-
* <p>Sha256 or Sha1.</p>
|
|
9124
|
-
* <note>
|
|
9125
|
-
* <p>Sha1 hashes have been deprecated.</p>
|
|
9126
|
-
* </note>
|
|
9127
|
-
* @public
|
|
9128
|
-
*/
|
|
9129
|
-
DocumentHashType?: DocumentHashType | undefined;
|
|
9130
|
-
/**
|
|
9131
|
-
* <p>If this time is reached and the command hasn't already started running, it won't run.</p>
|
|
9132
|
-
* @public
|
|
9133
|
-
*/
|
|
9134
|
-
TimeoutSeconds?: number | undefined;
|
|
9135
|
-
/**
|
|
9136
|
-
* <p>User-specified information about the command, such as a brief description of what the
|
|
9137
|
-
* command should do.</p>
|
|
9138
|
-
* @public
|
|
9139
|
-
*/
|
|
9140
|
-
Comment?: string | undefined;
|
|
9141
|
-
/**
|
|
9142
|
-
* <p>The required and optional parameters specified in the document being run.</p>
|
|
9143
|
-
* @public
|
|
9144
|
-
*/
|
|
9145
|
-
Parameters?: Record<string, string[]> | undefined;
|
|
9146
|
-
/**
|
|
9147
|
-
* <p>(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager
|
|
9148
|
-
* automatically determines the Amazon Web Services Region of the S3 bucket.</p>
|
|
9149
|
-
* @public
|
|
9150
|
-
*/
|
|
9151
|
-
OutputS3Region?: string | undefined;
|
|
9152
|
-
/**
|
|
9153
|
-
* <p>The name of the S3 bucket where command execution responses should be stored.</p>
|
|
9154
|
-
* @public
|
|
9155
|
-
*/
|
|
9156
|
-
OutputS3BucketName?: string | undefined;
|
|
9157
|
-
/**
|
|
9158
|
-
* <p>The directory structure within the S3 bucket where the responses should be stored.</p>
|
|
9159
|
-
* @public
|
|
9160
|
-
*/
|
|
9161
|
-
OutputS3KeyPrefix?: string | undefined;
|
|
9162
|
-
/**
|
|
9163
|
-
* <p>(Optional) The maximum number of managed nodes that are allowed to run the command at the
|
|
9164
|
-
* same time. You can specify a number such as 10 or a percentage such as 10%. The default value is
|
|
9165
|
-
* <code>50</code>. For more information about how to use <code>MaxConcurrency</code>, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-velocity">Using
|
|
9166
|
-
* concurrency controls</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
9167
|
-
* @public
|
|
9168
|
-
*/
|
|
9169
|
-
MaxConcurrency?: string | undefined;
|
|
9170
|
-
/**
|
|
9171
|
-
* <p>The maximum number of errors allowed without the command failing. When the command fails one
|
|
9172
|
-
* more time beyond the value of <code>MaxErrors</code>, the systems stops sending the command to
|
|
9173
|
-
* additional targets. You can specify a number like 10 or a percentage like 10%. The default value
|
|
9174
|
-
* is <code>0</code>. For more information about how to use <code>MaxErrors</code>, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-maxerrors">Using
|
|
9175
|
-
* error controls</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
9176
|
-
* @public
|
|
9177
|
-
*/
|
|
9178
|
-
MaxErrors?: string | undefined;
|
|
9179
|
-
/**
|
|
9180
|
-
* <p>The ARN of the Identity and Access Management (IAM) service role to use to publish
|
|
9181
|
-
* Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.</p>
|
|
9182
|
-
* <p>This role must provide the <code>sns:Publish</code> permission for your notification topic.
|
|
9183
|
-
* For information about creating and using this service role, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html">Monitoring Systems Manager status changes using Amazon SNS notifications</a> in the
|
|
9184
|
-
* <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
9185
|
-
* @public
|
|
9186
|
-
*/
|
|
9187
|
-
ServiceRoleArn?: string | undefined;
|
|
9188
|
-
/**
|
|
9189
|
-
* <p>Configurations for sending notifications.</p>
|
|
9190
|
-
* @public
|
|
9191
|
-
*/
|
|
9192
|
-
NotificationConfig?: NotificationConfig | undefined;
|
|
9193
|
-
/**
|
|
9194
|
-
* <p>Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a
|
|
9195
|
-
* capability of Amazon Web Services Systems Manager.</p>
|
|
9196
|
-
* @public
|
|
9197
|
-
*/
|
|
9198
|
-
CloudWatchOutputConfig?: CloudWatchOutputConfig | undefined;
|
|
9199
|
-
/**
|
|
9200
|
-
* <p>The CloudWatch alarm you want to apply to your command.</p>
|
|
9201
|
-
* @public
|
|
9202
|
-
*/
|
|
9203
|
-
AlarmConfiguration?: AlarmConfiguration | undefined;
|
|
9204
|
-
}
|
|
9205
|
-
/**
|
|
9206
|
-
* @public
|
|
9207
|
-
*/
|
|
9208
|
-
export interface SendCommandResult {
|
|
9209
|
-
/**
|
|
9210
|
-
* <p>The request as it was received by Systems Manager. Also provides the command ID which can be used
|
|
9211
|
-
* future references to this request.</p>
|
|
9212
|
-
* @public
|
|
9213
|
-
*/
|
|
9214
|
-
Command?: Command | undefined;
|
|
9215
|
-
}
|
|
9216
|
-
/**
|
|
9217
|
-
* <p>The association isn't valid or doesn't exist. </p>
|
|
9218
|
-
* @public
|
|
9219
|
-
*/
|
|
9220
|
-
export declare class InvalidAssociation extends __BaseException {
|
|
9221
|
-
readonly name: "InvalidAssociation";
|
|
9222
|
-
readonly $fault: "client";
|
|
9223
|
-
Message?: string | undefined;
|
|
9224
|
-
/**
|
|
9225
|
-
* @internal
|
|
9226
|
-
*/
|
|
9227
|
-
constructor(opts: __ExceptionOptionType<InvalidAssociation, __BaseException>);
|
|
9228
|
-
}
|
|
9229
|
-
/**
|
|
9230
|
-
* @public
|
|
9231
|
-
*/
|
|
9232
|
-
export interface StartAssociationsOnceRequest {
|
|
9233
|
-
/**
|
|
9234
|
-
* <p>The association IDs that you want to run immediately and only one time.</p>
|
|
9235
|
-
* @public
|
|
9236
|
-
*/
|
|
9237
|
-
AssociationIds: string[] | undefined;
|
|
9238
|
-
}
|
|
9239
|
-
/**
|
|
9240
|
-
* @public
|
|
9241
|
-
*/
|
|
9242
|
-
export interface StartAssociationsOnceResult {
|
|
9243
|
-
}
|
|
9244
|
-
/**
|
|
9245
|
-
* <p>An Automation runbook with the specified name couldn't be found.</p>
|
|
9246
|
-
* @public
|
|
9247
|
-
*/
|
|
9248
|
-
export declare class AutomationDefinitionNotFoundException extends __BaseException {
|
|
9249
|
-
readonly name: "AutomationDefinitionNotFoundException";
|
|
9250
|
-
readonly $fault: "client";
|
|
9251
|
-
Message?: string | undefined;
|
|
9252
|
-
/**
|
|
9253
|
-
* @internal
|
|
9254
|
-
*/
|
|
9255
|
-
constructor(opts: __ExceptionOptionType<AutomationDefinitionNotFoundException, __BaseException>);
|
|
9256
|
-
}
|
|
9257
|
-
/**
|
|
9258
|
-
* <p>An Automation runbook with the specified name and version couldn't be found.</p>
|
|
9259
|
-
* @public
|
|
9260
|
-
*/
|
|
9261
|
-
export declare class AutomationDefinitionVersionNotFoundException extends __BaseException {
|
|
9262
|
-
readonly name: "AutomationDefinitionVersionNotFoundException";
|
|
9263
|
-
readonly $fault: "client";
|
|
9264
|
-
Message?: string | undefined;
|
|
9265
|
-
/**
|
|
9266
|
-
* @internal
|
|
9267
|
-
*/
|
|
9268
|
-
constructor(opts: __ExceptionOptionType<AutomationDefinitionVersionNotFoundException, __BaseException>);
|
|
9269
|
-
}
|
|
9270
|
-
/**
|
|
9271
|
-
* <p>The number of simultaneously running Automation executions exceeded the allowable
|
|
9272
|
-
* limit.</p>
|
|
9273
|
-
* @public
|
|
9274
|
-
*/
|
|
9275
|
-
export declare class AutomationExecutionLimitExceededException extends __BaseException {
|
|
9276
|
-
readonly name: "AutomationExecutionLimitExceededException";
|
|
9277
|
-
readonly $fault: "client";
|
|
9278
|
-
Message?: string | undefined;
|
|
9279
|
-
/**
|
|
9280
|
-
* @internal
|
|
9281
|
-
*/
|
|
9282
|
-
constructor(opts: __ExceptionOptionType<AutomationExecutionLimitExceededException, __BaseException>);
|
|
9283
|
-
}
|
|
9284
|
-
/**
|
|
9285
|
-
* <p>The supplied parameters for invoking the specified Automation runbook are incorrect. For
|
|
9286
|
-
* example, they may not match the set of parameters permitted for the specified Automation
|
|
9287
|
-
* document.</p>
|
|
9288
|
-
* @public
|
|
9289
|
-
*/
|
|
9290
|
-
export declare class InvalidAutomationExecutionParametersException extends __BaseException {
|
|
9291
|
-
readonly name: "InvalidAutomationExecutionParametersException";
|
|
9092
|
+
readonly name: "FeatureNotAvailableException";
|
|
9292
9093
|
readonly $fault: "client";
|
|
9293
9094
|
Message?: string | undefined;
|
|
9294
9095
|
/**
|
|
9295
9096
|
* @internal
|
|
9296
9097
|
*/
|
|
9297
|
-
constructor(opts: __ExceptionOptionType<
|
|
9098
|
+
constructor(opts: __ExceptionOptionType<FeatureNotAvailableException, __BaseException>);
|
|
9298
9099
|
}
|
|
9299
9100
|
/**
|
|
9300
9101
|
* @public
|
|
9301
9102
|
*/
|
|
9302
|
-
export interface
|
|
9103
|
+
export interface RegisterTaskWithMaintenanceWindowRequest {
|
|
9303
9104
|
/**
|
|
9304
|
-
* <p>The
|
|
9305
|
-
* run a shared document belonging to another account, specify the document ARN. For more
|
|
9306
|
-
* information about how to use shared documents, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/documents-ssm-sharing.html">Sharing SSM documents</a>
|
|
9307
|
-
* in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
9105
|
+
* <p>The ID of the maintenance window the task should be added to.</p>
|
|
9308
9106
|
* @public
|
|
9309
9107
|
*/
|
|
9310
|
-
|
|
9108
|
+
WindowId: string | undefined;
|
|
9311
9109
|
/**
|
|
9312
|
-
* <p>The
|
|
9110
|
+
* <p>The targets (either managed nodes or maintenance window targets).</p>
|
|
9111
|
+
* <note>
|
|
9112
|
+
* <p>One or more targets must be specified for maintenance window Run Command-type tasks.
|
|
9113
|
+
* Depending on the task, targets are optional for other maintenance window task types (Automation,
|
|
9114
|
+
* Lambda, and Step Functions). For more information about running tasks
|
|
9115
|
+
* that don't specify targets, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html">Registering
|
|
9116
|
+
* maintenance window tasks without targets</a> in the
|
|
9117
|
+
* <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
9118
|
+
* </note>
|
|
9119
|
+
* <p>Specify managed nodes using the following format: </p>
|
|
9120
|
+
* <p>
|
|
9121
|
+
* <code>Key=InstanceIds,Values=<instance-id-1>,<instance-id-2></code>
|
|
9122
|
+
* </p>
|
|
9123
|
+
* <p>Specify maintenance window targets using the following format:</p>
|
|
9124
|
+
* <p>
|
|
9125
|
+
* <code>Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2></code>
|
|
9126
|
+
* </p>
|
|
9313
9127
|
* @public
|
|
9314
9128
|
*/
|
|
9315
|
-
|
|
9129
|
+
Targets?: Target[] | undefined;
|
|
9316
9130
|
/**
|
|
9317
|
-
* <p>
|
|
9318
|
-
* Automation runbook.</p>
|
|
9131
|
+
* <p>The ARN of the task to run.</p>
|
|
9319
9132
|
* @public
|
|
9320
9133
|
*/
|
|
9321
|
-
|
|
9134
|
+
TaskArn: string | undefined;
|
|
9322
9135
|
/**
|
|
9323
|
-
* <p>
|
|
9324
|
-
*
|
|
9136
|
+
* <p>The Amazon Resource Name (ARN) of the IAM service role for
|
|
9137
|
+
* Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a
|
|
9138
|
+
* service role ARN, Systems Manager uses a service-linked role in your account. If no
|
|
9139
|
+
* appropriate service-linked role for Systems Manager exists in your account, it is created when
|
|
9140
|
+
* you run <code>RegisterTaskWithMaintenanceWindow</code>.</p>
|
|
9141
|
+
* <p>However, for an improved security posture, we strongly recommend creating a custom
|
|
9142
|
+
* policy and custom service role for running your maintenance window tasks. The policy
|
|
9143
|
+
* can be crafted to provide only the permissions needed for your particular
|
|
9144
|
+
* 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
|
|
9145
|
+
* <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
9325
9146
|
* @public
|
|
9326
9147
|
*/
|
|
9327
|
-
|
|
9148
|
+
ServiceRoleArn?: string | undefined;
|
|
9328
9149
|
/**
|
|
9329
|
-
* <p>The
|
|
9330
|
-
* Interactive. The default mode is Auto.</p>
|
|
9150
|
+
* <p>The type of task being registered.</p>
|
|
9331
9151
|
* @public
|
|
9332
9152
|
*/
|
|
9333
|
-
|
|
9153
|
+
TaskType: MaintenanceWindowTaskType | undefined;
|
|
9334
9154
|
/**
|
|
9335
|
-
* <p>The
|
|
9336
|
-
*
|
|
9155
|
+
* <p>The parameters that should be passed to the task when it is run.</p>
|
|
9156
|
+
* <note>
|
|
9157
|
+
* <p>
|
|
9158
|
+
* <code>TaskParameters</code> has been deprecated. To specify parameters to pass to a task when it runs,
|
|
9159
|
+
* instead use the <code>Parameters</code> option in the <code>TaskInvocationParameters</code> structure. For information
|
|
9160
|
+
* about how Systems Manager handles these options for the supported maintenance window task
|
|
9161
|
+
* types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p>
|
|
9162
|
+
* </note>
|
|
9337
9163
|
* @public
|
|
9338
9164
|
*/
|
|
9339
|
-
|
|
9165
|
+
TaskParameters?: Record<string, MaintenanceWindowTaskParameterValueExpression> | undefined;
|
|
9340
9166
|
/**
|
|
9341
|
-
* <p>
|
|
9342
|
-
*
|
|
9343
|
-
* <code>TargetLocation:Targets</code> takes precedence.</p>
|
|
9167
|
+
* <p>The parameters that the task should use during execution. Populate only the fields that
|
|
9168
|
+
* match the task type. All other fields should be empty. </p>
|
|
9344
9169
|
* @public
|
|
9345
9170
|
*/
|
|
9346
|
-
|
|
9171
|
+
TaskInvocationParameters?: MaintenanceWindowTaskInvocationParameters | undefined;
|
|
9347
9172
|
/**
|
|
9348
|
-
* <p>
|
|
9349
|
-
*
|
|
9173
|
+
* <p>The priority of the task in the maintenance window, the lower the number the higher the
|
|
9174
|
+
* priority. Tasks in a maintenance window are scheduled in priority order with tasks that have the
|
|
9175
|
+
* same priority scheduled in parallel.</p>
|
|
9350
9176
|
* @public
|
|
9351
9177
|
*/
|
|
9352
|
-
|
|
9178
|
+
Priority?: number | undefined;
|
|
9353
9179
|
/**
|
|
9354
|
-
* <p>The maximum number of targets
|
|
9355
|
-
*
|
|
9356
|
-
*
|
|
9357
|
-
*
|
|
9180
|
+
* <p>The maximum number of targets this task can be run for, in parallel.</p>
|
|
9181
|
+
* <note>
|
|
9182
|
+
* <p>Although this element is listed as "Required: No", a value can be omitted only when you are
|
|
9183
|
+
* registering or updating a <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html">targetless
|
|
9184
|
+
* task</a> You must provide a value in all other cases.</p>
|
|
9185
|
+
* <p>For maintenance window tasks without a target specified, you can't supply a value for this
|
|
9186
|
+
* option. Instead, the system inserts a placeholder value of <code>1</code>. This value doesn't
|
|
9187
|
+
* affect the running of your task.</p>
|
|
9188
|
+
* </note>
|
|
9358
9189
|
* @public
|
|
9359
9190
|
*/
|
|
9360
9191
|
MaxConcurrency?: string | undefined;
|
|
9361
9192
|
/**
|
|
9362
|
-
* <p>The number of errors
|
|
9363
|
-
*
|
|
9364
|
-
*
|
|
9365
|
-
*
|
|
9366
|
-
*
|
|
9367
|
-
*
|
|
9368
|
-
*
|
|
9369
|
-
*
|
|
9370
|
-
*
|
|
9371
|
-
* be more than max-errors failed executions, set max-concurrency to 1 so the executions proceed one
|
|
9372
|
-
* at a time.</p>
|
|
9373
|
-
* <p>If this parameter and the <code>TargetLocation:TargetsMaxErrors</code> parameter are both
|
|
9374
|
-
* supplied, <code>TargetLocation:TargetsMaxErrors</code> takes precedence.</p>
|
|
9193
|
+
* <p>The maximum number of errors allowed before this task stops being scheduled.</p>
|
|
9194
|
+
* <note>
|
|
9195
|
+
* <p>Although this element is listed as "Required: No", a value can be omitted only when you are
|
|
9196
|
+
* registering or updating a <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html">targetless
|
|
9197
|
+
* task</a> You must provide a value in all other cases.</p>
|
|
9198
|
+
* <p>For maintenance window tasks without a target specified, you can't supply a value for this
|
|
9199
|
+
* option. Instead, the system inserts a placeholder value of <code>1</code>. This value doesn't
|
|
9200
|
+
* affect the running of your task.</p>
|
|
9201
|
+
* </note>
|
|
9375
9202
|
* @public
|
|
9376
9203
|
*/
|
|
9377
9204
|
MaxErrors?: string | undefined;
|
|
9378
9205
|
/**
|
|
9379
|
-
* <p>A
|
|
9380
|
-
*
|
|
9381
|
-
*
|
|
9382
|
-
*
|
|
9206
|
+
* <p>A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket
|
|
9207
|
+
* to write managed node-level logs to. </p>
|
|
9208
|
+
* <note>
|
|
9209
|
+
* <p>
|
|
9210
|
+
* <code>LoggingInfo</code> has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the
|
|
9211
|
+
* <code>OutputS3BucketName</code> and <code>OutputS3KeyPrefix</code> options in the <code>TaskInvocationParameters</code> structure.
|
|
9212
|
+
* For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance
|
|
9213
|
+
* window task types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p>
|
|
9214
|
+
* </note>
|
|
9215
|
+
* @public
|
|
9216
|
+
*/
|
|
9217
|
+
LoggingInfo?: LoggingInfo | undefined;
|
|
9218
|
+
/**
|
|
9219
|
+
* <p>An optional name for the task.</p>
|
|
9383
9220
|
* @public
|
|
9384
9221
|
*/
|
|
9385
|
-
|
|
9222
|
+
Name?: string | undefined;
|
|
9223
|
+
/**
|
|
9224
|
+
* <p>An optional description for the task.</p>
|
|
9225
|
+
* @public
|
|
9226
|
+
*/
|
|
9227
|
+
Description?: string | undefined;
|
|
9228
|
+
/**
|
|
9229
|
+
* <p>User-provided idempotency token.</p>
|
|
9230
|
+
* @public
|
|
9231
|
+
*/
|
|
9232
|
+
ClientToken?: string | undefined;
|
|
9386
9233
|
/**
|
|
9387
|
-
* <p>
|
|
9388
|
-
*
|
|
9389
|
-
* owner, or environment. For example, you might want to tag an automation to identify an
|
|
9390
|
-
* environment or operating system. In this case, you could specify the following key-value
|
|
9391
|
-
* pairs:</p>
|
|
9234
|
+
* <p>Indicates whether tasks should continue to run after the cutoff time specified in the
|
|
9235
|
+
* maintenance windows is reached. </p>
|
|
9392
9236
|
* <ul>
|
|
9393
9237
|
* <li>
|
|
9394
9238
|
* <p>
|
|
9395
|
-
* <code>
|
|
9396
|
-
*
|
|
9239
|
+
* <code>CONTINUE_TASK</code>: When the cutoff time is reached, any tasks that are running
|
|
9240
|
+
* continue. The default value.</p>
|
|
9397
9241
|
* </li>
|
|
9398
9242
|
* <li>
|
|
9399
9243
|
* <p>
|
|
9400
|
-
* <code>
|
|
9401
|
-
*
|
|
9244
|
+
* <code>CANCEL_TASK</code>:</p>
|
|
9245
|
+
* <ul>
|
|
9246
|
+
* <li>
|
|
9247
|
+
* <p>For Automation, Lambda, Step Functions tasks: When the cutoff
|
|
9248
|
+
* time is reached, any task invocations that are already running continue, but no new task
|
|
9249
|
+
* invocations are started.</p>
|
|
9250
|
+
* </li>
|
|
9251
|
+
* <li>
|
|
9252
|
+
* <p>For Run Command tasks: When the cutoff time is reached, the system sends a <a>CancelCommand</a> operation that attempts to cancel the command associated with the
|
|
9253
|
+
* task. However, there is no guarantee that the command will be terminated and the underlying
|
|
9254
|
+
* process stopped.</p>
|
|
9255
|
+
* </li>
|
|
9256
|
+
* </ul>
|
|
9257
|
+
* <p>The status for tasks that are not completed is <code>TIMED_OUT</code>.</p>
|
|
9402
9258
|
* </li>
|
|
9403
9259
|
* </ul>
|
|
9260
|
+
* @public
|
|
9261
|
+
*/
|
|
9262
|
+
CutoffBehavior?: MaintenanceWindowTaskCutoffBehavior | undefined;
|
|
9263
|
+
/**
|
|
9264
|
+
* <p>The CloudWatch alarm you want to apply to your maintenance window task.</p>
|
|
9265
|
+
* @public
|
|
9266
|
+
*/
|
|
9267
|
+
AlarmConfiguration?: AlarmConfiguration | undefined;
|
|
9268
|
+
}
|
|
9269
|
+
/**
|
|
9270
|
+
* @public
|
|
9271
|
+
*/
|
|
9272
|
+
export interface RegisterTaskWithMaintenanceWindowResult {
|
|
9273
|
+
/**
|
|
9274
|
+
* <p>The ID of the task in the maintenance window.</p>
|
|
9275
|
+
* @public
|
|
9276
|
+
*/
|
|
9277
|
+
WindowTaskId?: string | undefined;
|
|
9278
|
+
}
|
|
9279
|
+
/**
|
|
9280
|
+
* @public
|
|
9281
|
+
*/
|
|
9282
|
+
export interface RemoveTagsFromResourceRequest {
|
|
9283
|
+
/**
|
|
9284
|
+
* <p>The type of resource from which you want to remove a tag.</p>
|
|
9404
9285
|
* <note>
|
|
9405
|
-
* <p>
|
|
9406
|
-
*
|
|
9286
|
+
* <p>The <code>ManagedInstance</code> type for this API operation is only for on-premises
|
|
9287
|
+
* managed nodes. Specify the name of the managed node in the following format:
|
|
9288
|
+
* <code>mi-<i>ID_number</i>
|
|
9289
|
+
* </code>. For example,
|
|
9290
|
+
* <code>mi-1a2b3c4d5e6f</code>.</p>
|
|
9407
9291
|
* </note>
|
|
9408
9292
|
* @public
|
|
9409
9293
|
*/
|
|
9410
|
-
|
|
9294
|
+
ResourceType: ResourceTypeForTagging | undefined;
|
|
9411
9295
|
/**
|
|
9412
|
-
* <p>The
|
|
9296
|
+
* <p>The ID of the resource from which you want to remove tags. For example:</p>
|
|
9297
|
+
* <p>ManagedInstance: mi-012345abcde</p>
|
|
9298
|
+
* <p>MaintenanceWindow: mw-012345abcde</p>
|
|
9299
|
+
* <p>
|
|
9300
|
+
* <code>Automation</code>: <code>example-c160-4567-8519-012345abcde</code>
|
|
9301
|
+
* </p>
|
|
9302
|
+
* <p>PatchBaseline: pb-012345abcde</p>
|
|
9303
|
+
* <p>OpsMetadata object: <code>ResourceID</code> for tagging is created from the Amazon Resource
|
|
9304
|
+
* Name (ARN) for the object. Specifically, <code>ResourceID</code> is created from the strings that
|
|
9305
|
+
* come after the word <code>opsmetadata</code> in the ARN. For example, an OpsMetadata object with
|
|
9306
|
+
* an ARN of <code>arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager</code>
|
|
9307
|
+
* has a <code>ResourceID</code> of either <code>aws/ssm/MyGroup/appmanager</code> or
|
|
9308
|
+
* <code>/aws/ssm/MyGroup/appmanager</code>.</p>
|
|
9309
|
+
* <p>For the Document and Parameter values, use the name of the resource.</p>
|
|
9310
|
+
* <note>
|
|
9311
|
+
* <p>The <code>ManagedInstance</code> type for this API operation is only for on-premises
|
|
9312
|
+
* managed nodes. Specify the name of the managed node in the following format: mi-ID_number. For
|
|
9313
|
+
* example, mi-1a2b3c4d5e6f.</p>
|
|
9314
|
+
* </note>
|
|
9413
9315
|
* @public
|
|
9414
9316
|
*/
|
|
9415
|
-
|
|
9317
|
+
ResourceId: string | undefined;
|
|
9416
9318
|
/**
|
|
9417
|
-
* <p>
|
|
9418
|
-
* body. Currently, only files in presigned Amazon S3 buckets are supported. </p>
|
|
9319
|
+
* <p>Tag keys that you want to remove from the specified resource.</p>
|
|
9419
9320
|
* @public
|
|
9420
9321
|
*/
|
|
9421
|
-
|
|
9322
|
+
TagKeys: string[] | undefined;
|
|
9323
|
+
}
|
|
9324
|
+
/**
|
|
9325
|
+
* @public
|
|
9326
|
+
*/
|
|
9327
|
+
export interface RemoveTagsFromResourceResult {
|
|
9422
9328
|
}
|
|
9423
9329
|
/**
|
|
9330
|
+
* <p>The request body of the ResetServiceSetting API operation.</p>
|
|
9424
9331
|
* @public
|
|
9425
9332
|
*/
|
|
9426
|
-
export interface
|
|
9333
|
+
export interface ResetServiceSettingRequest {
|
|
9427
9334
|
/**
|
|
9428
|
-
* <p>The
|
|
9335
|
+
* <p>The Amazon Resource Name (ARN) of the service setting to reset. The setting ID can be one of
|
|
9336
|
+
* the following.</p>
|
|
9337
|
+
* <ul>
|
|
9338
|
+
* <li>
|
|
9339
|
+
* <p>
|
|
9340
|
+
* <code>/ssm/appmanager/appmanager-enabled</code>
|
|
9341
|
+
* </p>
|
|
9342
|
+
* </li>
|
|
9343
|
+
* <li>
|
|
9344
|
+
* <p>
|
|
9345
|
+
* <code>/ssm/automation/customer-script-log-destination</code>
|
|
9346
|
+
* </p>
|
|
9347
|
+
* </li>
|
|
9348
|
+
* <li>
|
|
9349
|
+
* <p>
|
|
9350
|
+
* <code>/ssm/automation/customer-script-log-group-name</code>
|
|
9351
|
+
* </p>
|
|
9352
|
+
* </li>
|
|
9353
|
+
* <li>
|
|
9354
|
+
* <p>/ssm/automation/enable-adaptive-concurrency</p>
|
|
9355
|
+
* </li>
|
|
9356
|
+
* <li>
|
|
9357
|
+
* <p>
|
|
9358
|
+
* <code>/ssm/documents/console/public-sharing-permission</code>
|
|
9359
|
+
* </p>
|
|
9360
|
+
* </li>
|
|
9361
|
+
* <li>
|
|
9362
|
+
* <p>
|
|
9363
|
+
* <code>/ssm/managed-instance/activation-tier</code>
|
|
9364
|
+
* </p>
|
|
9365
|
+
* </li>
|
|
9366
|
+
* <li>
|
|
9367
|
+
* <p>
|
|
9368
|
+
* <code>/ssm/managed-instance/default-ec2-instance-management-role</code>
|
|
9369
|
+
* </p>
|
|
9370
|
+
* </li>
|
|
9371
|
+
* <li>
|
|
9372
|
+
* <p>
|
|
9373
|
+
* <code>/ssm/opsinsights/opscenter</code>
|
|
9374
|
+
* </p>
|
|
9375
|
+
* </li>
|
|
9376
|
+
* <li>
|
|
9377
|
+
* <p>
|
|
9378
|
+
* <code>/ssm/parameter-store/default-parameter-tier</code>
|
|
9379
|
+
* </p>
|
|
9380
|
+
* </li>
|
|
9381
|
+
* <li>
|
|
9382
|
+
* <p>
|
|
9383
|
+
* <code>/ssm/parameter-store/high-throughput-enabled</code>
|
|
9384
|
+
* </p>
|
|
9385
|
+
* </li>
|
|
9386
|
+
* </ul>
|
|
9429
9387
|
* @public
|
|
9430
9388
|
*/
|
|
9431
|
-
|
|
9389
|
+
SettingId: string | undefined;
|
|
9432
9390
|
}
|
|
9433
9391
|
/**
|
|
9434
9392
|
* @internal
|
|
@@ -9537,20 +9495,28 @@ export declare const ListCommandsResultFilterSensitiveLog: (obj: ListCommandsRes
|
|
|
9537
9495
|
/**
|
|
9538
9496
|
* @internal
|
|
9539
9497
|
*/
|
|
9540
|
-
export declare const
|
|
9498
|
+
export declare const InstanceInfoFilterSensitiveLog: (obj: InstanceInfo) => any;
|
|
9541
9499
|
/**
|
|
9542
9500
|
* @internal
|
|
9543
9501
|
*/
|
|
9544
|
-
export declare const
|
|
9502
|
+
export declare const NodeTypeFilterSensitiveLog: (obj: NodeType) => any;
|
|
9545
9503
|
/**
|
|
9546
9504
|
* @internal
|
|
9547
9505
|
*/
|
|
9548
|
-
export declare const
|
|
9506
|
+
export declare const NodeFilterSensitiveLog: (obj: Node) => any;
|
|
9507
|
+
/**
|
|
9508
|
+
* @internal
|
|
9509
|
+
*/
|
|
9510
|
+
export declare const ListNodesResultFilterSensitiveLog: (obj: ListNodesResult) => any;
|
|
9511
|
+
/**
|
|
9512
|
+
* @internal
|
|
9513
|
+
*/
|
|
9514
|
+
export declare const PutParameterRequestFilterSensitiveLog: (obj: PutParameterRequest) => any;
|
|
9549
9515
|
/**
|
|
9550
9516
|
* @internal
|
|
9551
9517
|
*/
|
|
9552
|
-
export declare const
|
|
9518
|
+
export declare const RegisterTargetWithMaintenanceWindowRequestFilterSensitiveLog: (obj: RegisterTargetWithMaintenanceWindowRequest) => any;
|
|
9553
9519
|
/**
|
|
9554
9520
|
* @internal
|
|
9555
9521
|
*/
|
|
9556
|
-
export declare const
|
|
9522
|
+
export declare const RegisterTaskWithMaintenanceWindowRequestFilterSensitiveLog: (obj: RegisterTaskWithMaintenanceWindowRequest) => any;
|