@aws-sdk/client-ssm 3.798.0 → 3.799.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 +16 -0
- package/dist-cjs/index.js +333 -71
- package/dist-cjs/runtimeConfig.js +1 -0
- package/dist-es/SSM.js +4 -0
- package/dist-es/commands/GetAccessTokenCommand.js +23 -0
- package/dist-es/commands/RegisterTargetWithMaintenanceWindowCommand.js +1 -1
- package/dist-es/commands/RegisterTaskWithMaintenanceWindowCommand.js +1 -1
- package/dist-es/commands/StartAccessRequestCommand.js +22 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/models_0.js +24 -4
- package/dist-es/models/models_1.js +57 -27
- package/dist-es/models/models_2.js +50 -16
- package/dist-es/protocols/Aws_json1_1.js +94 -6
- package/dist-es/runtimeConfig.js +2 -1
- package/dist-types/SSM.d.ts +14 -0
- package/dist-types/SSMClient.d.ts +4 -2
- package/dist-types/commands/CreateDocumentCommand.d.ts +2 -2
- package/dist-types/commands/DescribeAutomationExecutionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDocumentCommand.d.ts +1 -1
- package/dist-types/commands/DescribeMaintenanceWindowScheduleCommand.d.ts +1 -2
- package/dist-types/commands/DescribeOpsItemsCommand.d.ts +2 -2
- package/dist-types/commands/GetAccessTokenCommand.d.ts +94 -0
- package/dist-types/commands/GetAutomationExecutionCommand.d.ts +1 -1
- package/dist-types/commands/GetDocumentCommand.d.ts +1 -1
- package/dist-types/commands/GetOpsItemCommand.d.ts +1 -1
- package/dist-types/commands/ListDocumentsCommand.d.ts +1 -1
- package/dist-types/commands/RegisterTargetWithMaintenanceWindowCommand.d.ts +1 -1
- package/dist-types/commands/RegisterTaskWithMaintenanceWindowCommand.d.ts +1 -1
- package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +1 -1
- package/dist-types/commands/SendAutomationSignalCommand.d.ts +1 -1
- package/dist-types/commands/StartAccessRequestCommand.d.ts +105 -0
- package/dist-types/commands/UpdateDocumentCommand.d.ts +1 -1
- package/dist-types/commands/UpdateOpsItemCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +31 -51
- package/dist-types/models/models_1.d.ts +163 -348
- package/dist-types/models/models_2.d.ts +413 -21
- package/dist-types/protocols/Aws_json1_1.d.ts +18 -0
- package/dist-types/runtimeConfig.d.ts +1 -1
- package/dist-types/ts3.4/SSM.d.ts +34 -0
- package/dist-types/ts3.4/SSMClient.d.ts +12 -0
- package/dist-types/ts3.4/commands/DescribeMaintenanceWindowScheduleCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/GetAccessTokenCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/RegisterTargetWithMaintenanceWindowCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/RegisterTaskWithMaintenanceWindowCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/RemoveTagsFromResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartAccessRequestCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/models_0.d.ts +20 -14
- package/dist-types/ts3.4/models/models_1.d.ts +61 -58
- package/dist-types/ts3.4/models/models_2.d.ts +81 -9
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +24 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -4
- package/package.json +5 -5
|
@@ -1,5 +1,33 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { SSMServiceException as __BaseException } from "./SSMServiceException";
|
|
3
|
+
/**
|
|
4
|
+
* <p>The requester doesn't have permissions to perform the requested operation.</p>
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export declare class AccessDeniedException extends __BaseException {
|
|
8
|
+
readonly name: "AccessDeniedException";
|
|
9
|
+
readonly $fault: "client";
|
|
10
|
+
Message: string | undefined;
|
|
11
|
+
/**
|
|
12
|
+
* @internal
|
|
13
|
+
*/
|
|
14
|
+
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
* @enum
|
|
19
|
+
*/
|
|
20
|
+
export declare const AccessRequestStatus: {
|
|
21
|
+
readonly APPROVED: "Approved";
|
|
22
|
+
readonly EXPIRED: "Expired";
|
|
23
|
+
readonly PENDING: "Pending";
|
|
24
|
+
readonly REJECTED: "Rejected";
|
|
25
|
+
readonly REVOKED: "Revoked";
|
|
26
|
+
};
|
|
27
|
+
/**
|
|
28
|
+
* @public
|
|
29
|
+
*/
|
|
30
|
+
export type AccessRequestStatus = (typeof AccessRequestStatus)[keyof typeof AccessRequestStatus];
|
|
3
31
|
/**
|
|
4
32
|
* <p>Information includes the Amazon Web Services account ID where the current document is shared and the
|
|
5
33
|
* version shared with that account.</p>
|
|
@@ -1886,6 +1914,7 @@ export type DocumentFormat = (typeof DocumentFormat)[keyof typeof DocumentFormat
|
|
|
1886
1914
|
export declare const DocumentType: {
|
|
1887
1915
|
readonly ApplicationConfiguration: "ApplicationConfiguration";
|
|
1888
1916
|
readonly ApplicationConfigurationSchema: "ApplicationConfigurationSchema";
|
|
1917
|
+
readonly AutoApprovalPolicy: "AutoApprovalPolicy";
|
|
1889
1918
|
readonly Automation: "Automation";
|
|
1890
1919
|
readonly ChangeCalendar: "ChangeCalendar";
|
|
1891
1920
|
readonly ChangeTemplate: "Automation.ChangeTemplate";
|
|
@@ -1893,6 +1922,7 @@ export declare const DocumentType: {
|
|
|
1893
1922
|
readonly Command: "Command";
|
|
1894
1923
|
readonly ConformancePackTemplate: "ConformancePackTemplate";
|
|
1895
1924
|
readonly DeploymentStrategy: "DeploymentStrategy";
|
|
1925
|
+
readonly ManualApprovalPolicy: "ManualApprovalPolicy";
|
|
1896
1926
|
readonly Package: "Package";
|
|
1897
1927
|
readonly Policy: "Policy";
|
|
1898
1928
|
readonly ProblemAnalysis: "ProblemAnalysis";
|
|
@@ -4867,6 +4897,7 @@ export type AutomationExecutionStatus = (typeof AutomationExecutionStatus)[keyof
|
|
|
4867
4897
|
* @enum
|
|
4868
4898
|
*/
|
|
4869
4899
|
export declare const AutomationSubtype: {
|
|
4900
|
+
readonly AccessRequest: "AccessRequest";
|
|
4870
4901
|
readonly ChangeRequest: "ChangeRequest";
|
|
4871
4902
|
};
|
|
4872
4903
|
/**
|
|
@@ -8092,57 +8123,6 @@ export interface DescribeMaintenanceWindowsResult {
|
|
|
8092
8123
|
*/
|
|
8093
8124
|
NextToken?: string | undefined;
|
|
8094
8125
|
}
|
|
8095
|
-
/**
|
|
8096
|
-
* @public
|
|
8097
|
-
* @enum
|
|
8098
|
-
*/
|
|
8099
|
-
export declare const MaintenanceWindowResourceType: {
|
|
8100
|
-
readonly Instance: "INSTANCE";
|
|
8101
|
-
readonly ResourceGroup: "RESOURCE_GROUP";
|
|
8102
|
-
};
|
|
8103
|
-
/**
|
|
8104
|
-
* @public
|
|
8105
|
-
*/
|
|
8106
|
-
export type MaintenanceWindowResourceType = (typeof MaintenanceWindowResourceType)[keyof typeof MaintenanceWindowResourceType];
|
|
8107
|
-
/**
|
|
8108
|
-
* @public
|
|
8109
|
-
*/
|
|
8110
|
-
export interface DescribeMaintenanceWindowScheduleRequest {
|
|
8111
|
-
/**
|
|
8112
|
-
* <p>The ID of the maintenance window to retrieve information about.</p>
|
|
8113
|
-
* @public
|
|
8114
|
-
*/
|
|
8115
|
-
WindowId?: string | undefined;
|
|
8116
|
-
/**
|
|
8117
|
-
* <p>The managed node ID or key-value pair to retrieve information about.</p>
|
|
8118
|
-
* @public
|
|
8119
|
-
*/
|
|
8120
|
-
Targets?: Target[] | undefined;
|
|
8121
|
-
/**
|
|
8122
|
-
* <p>The type of resource you want to retrieve information about. For example,
|
|
8123
|
-
* <code>INSTANCE</code>.</p>
|
|
8124
|
-
* @public
|
|
8125
|
-
*/
|
|
8126
|
-
ResourceType?: MaintenanceWindowResourceType | undefined;
|
|
8127
|
-
/**
|
|
8128
|
-
* <p>Filters used to limit the range of results. For example, you can limit maintenance window
|
|
8129
|
-
* executions to only those scheduled before or after a certain date and time.</p>
|
|
8130
|
-
* @public
|
|
8131
|
-
*/
|
|
8132
|
-
Filters?: PatchOrchestratorFilter[] | undefined;
|
|
8133
|
-
/**
|
|
8134
|
-
* <p>The maximum number of items to return for this call. The call also returns a token that you
|
|
8135
|
-
* can specify in a subsequent call to get the next set of results.</p>
|
|
8136
|
-
* @public
|
|
8137
|
-
*/
|
|
8138
|
-
MaxResults?: number | undefined;
|
|
8139
|
-
/**
|
|
8140
|
-
* <p>The token for the next set of items to return. (You received this token from a previous
|
|
8141
|
-
* call.)</p>
|
|
8142
|
-
* @public
|
|
8143
|
-
*/
|
|
8144
|
-
NextToken?: string | undefined;
|
|
8145
|
-
}
|
|
8146
8126
|
/**
|
|
8147
8127
|
* @internal
|
|
8148
8128
|
*/
|
|
@@ -1,6 +1,57 @@
|
|
|
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,
|
|
2
|
+
import { AccessRequestStatus, AlarmConfiguration, AlarmStateInformation, AssociationComplianceSeverity, AssociationOverview, AssociationSyncCompliance, AutomationExecutionStatus, AutomationSubtype, DocumentFormat, DocumentHashType, DocumentPermissionType, DocumentRequires, DocumentStatus, DocumentType, ExecutionMode, InstanceAssociationOutputLocation, MaintenanceWindowExecutionStatus, MaintenanceWindowFilter, MaintenanceWindowTaskType, MetadataValue, OperatingSystem, OpsItemDataValue, OpsItemNotification, PatchAction, PatchComplianceLevel, PatchComplianceStatus, PatchFilterGroup, PatchOrchestratorFilter, PatchRuleGroup, PatchSource, PlatformType, RelatedOpsItem, ResolvedTargets, ResourceDataSyncAwsOrganizationsSource, ResourceDataSyncS3Destination, ResourceType, ResourceTypeForTagging, ReviewStatus, Runbook, StepExecution, Tag, Target, TargetLocation } from "./models_0";
|
|
3
3
|
import { SSMServiceException as __BaseException } from "./SSMServiceException";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
* @enum
|
|
7
|
+
*/
|
|
8
|
+
export declare const MaintenanceWindowResourceType: {
|
|
9
|
+
readonly Instance: "INSTANCE";
|
|
10
|
+
readonly ResourceGroup: "RESOURCE_GROUP";
|
|
11
|
+
};
|
|
12
|
+
/**
|
|
13
|
+
* @public
|
|
14
|
+
*/
|
|
15
|
+
export type MaintenanceWindowResourceType = (typeof MaintenanceWindowResourceType)[keyof typeof MaintenanceWindowResourceType];
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
*/
|
|
19
|
+
export interface DescribeMaintenanceWindowScheduleRequest {
|
|
20
|
+
/**
|
|
21
|
+
* <p>The ID of the maintenance window to retrieve information about.</p>
|
|
22
|
+
* @public
|
|
23
|
+
*/
|
|
24
|
+
WindowId?: string | undefined;
|
|
25
|
+
/**
|
|
26
|
+
* <p>The managed node ID or key-value pair to retrieve information about.</p>
|
|
27
|
+
* @public
|
|
28
|
+
*/
|
|
29
|
+
Targets?: Target[] | undefined;
|
|
30
|
+
/**
|
|
31
|
+
* <p>The type of resource you want to retrieve information about. For example,
|
|
32
|
+
* <code>INSTANCE</code>.</p>
|
|
33
|
+
* @public
|
|
34
|
+
*/
|
|
35
|
+
ResourceType?: MaintenanceWindowResourceType | undefined;
|
|
36
|
+
/**
|
|
37
|
+
* <p>Filters used to limit the range of results. For example, you can limit maintenance window
|
|
38
|
+
* executions to only those scheduled before or after a certain date and time.</p>
|
|
39
|
+
* @public
|
|
40
|
+
*/
|
|
41
|
+
Filters?: PatchOrchestratorFilter[] | undefined;
|
|
42
|
+
/**
|
|
43
|
+
* <p>The maximum number of items to return for this call. The call also returns a token that you
|
|
44
|
+
* can specify in a subsequent call to get the next set of results.</p>
|
|
45
|
+
* @public
|
|
46
|
+
*/
|
|
47
|
+
MaxResults?: number | undefined;
|
|
48
|
+
/**
|
|
49
|
+
* <p>The token for the next set of items to return. (You received this token from a previous
|
|
50
|
+
* call.)</p>
|
|
51
|
+
* @public
|
|
52
|
+
*/
|
|
53
|
+
NextToken?: string | undefined;
|
|
54
|
+
}
|
|
4
55
|
/**
|
|
5
56
|
* <p>Information about a scheduled execution for a maintenance window.</p>
|
|
6
57
|
* @public
|
|
@@ -423,6 +474,15 @@ export interface DescribeMaintenanceWindowTasksResult {
|
|
|
423
474
|
* @enum
|
|
424
475
|
*/
|
|
425
476
|
export declare const OpsItemFilterKey: {
|
|
477
|
+
readonly ACCESS_REQUEST_APPROVER_ARN: "AccessRequestByApproverArn";
|
|
478
|
+
readonly ACCESS_REQUEST_APPROVER_ID: "AccessRequestByApproverId";
|
|
479
|
+
readonly ACCESS_REQUEST_IS_REPLICA: "AccessRequestByIsReplica";
|
|
480
|
+
readonly ACCESS_REQUEST_REQUESTER_ARN: "AccessRequestByRequesterArn";
|
|
481
|
+
readonly ACCESS_REQUEST_REQUESTER_ID: "AccessRequestByRequesterId";
|
|
482
|
+
readonly ACCESS_REQUEST_SOURCE_ACCOUNT_ID: "AccessRequestBySourceAccountId";
|
|
483
|
+
readonly ACCESS_REQUEST_SOURCE_OPS_ITEM_ID: "AccessRequestBySourceOpsItemId";
|
|
484
|
+
readonly ACCESS_REQUEST_SOURCE_REGION: "AccessRequestBySourceRegion";
|
|
485
|
+
readonly ACCESS_REQUEST_TARGET_RESOURCE_ID: "AccessRequestByTargetResourceId";
|
|
426
486
|
readonly ACCOUNT_ID: "AccountId";
|
|
427
487
|
readonly ACTUAL_END_TIME: "ActualEndTime";
|
|
428
488
|
readonly ACTUAL_START_TIME: "ActualStartTime";
|
|
@@ -596,6 +656,7 @@ export declare const OpsItemStatus: {
|
|
|
596
656
|
readonly PENDING_CHANGE_CALENDAR_OVERRIDE: "PendingChangeCalendarOverride";
|
|
597
657
|
readonly REJECTED: "Rejected";
|
|
598
658
|
readonly RESOLVED: "Resolved";
|
|
659
|
+
readonly REVOKED: "Revoked";
|
|
599
660
|
readonly RUNBOOK_IN_PROGRESS: "RunbookInProgress";
|
|
600
661
|
readonly SCHEDULED: "Scheduled";
|
|
601
662
|
readonly TIMED_OUT: "TimedOut";
|
|
@@ -1625,6 +1686,99 @@ export declare class OpsItemRelatedItemAssociationNotFoundException extends __Ba
|
|
|
1625
1686
|
*/
|
|
1626
1687
|
constructor(opts: __ExceptionOptionType<OpsItemRelatedItemAssociationNotFoundException, __BaseException>);
|
|
1627
1688
|
}
|
|
1689
|
+
/**
|
|
1690
|
+
* @public
|
|
1691
|
+
*/
|
|
1692
|
+
export interface GetAccessTokenRequest {
|
|
1693
|
+
/**
|
|
1694
|
+
* <p>The ID of a just-in-time node access request.</p>
|
|
1695
|
+
* @public
|
|
1696
|
+
*/
|
|
1697
|
+
AccessRequestId: string | undefined;
|
|
1698
|
+
}
|
|
1699
|
+
/**
|
|
1700
|
+
* <p>The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.</p>
|
|
1701
|
+
* @public
|
|
1702
|
+
*/
|
|
1703
|
+
export interface Credentials {
|
|
1704
|
+
/**
|
|
1705
|
+
* <p>The access key ID that identifies the temporary security credentials.</p>
|
|
1706
|
+
* @public
|
|
1707
|
+
*/
|
|
1708
|
+
AccessKeyId: string | undefined;
|
|
1709
|
+
/**
|
|
1710
|
+
* <p>The secret access key that can be used to sign requests.</p>
|
|
1711
|
+
* @public
|
|
1712
|
+
*/
|
|
1713
|
+
SecretAccessKey: string | undefined;
|
|
1714
|
+
/**
|
|
1715
|
+
* <p>The token that users must pass to the service API to use the temporary credentials.</p>
|
|
1716
|
+
* @public
|
|
1717
|
+
*/
|
|
1718
|
+
SessionToken: string | undefined;
|
|
1719
|
+
/**
|
|
1720
|
+
* <p>The datetime on which the current credentials expire.</p>
|
|
1721
|
+
* @public
|
|
1722
|
+
*/
|
|
1723
|
+
ExpirationTime: Date | undefined;
|
|
1724
|
+
}
|
|
1725
|
+
/**
|
|
1726
|
+
* @public
|
|
1727
|
+
*/
|
|
1728
|
+
export interface GetAccessTokenResponse {
|
|
1729
|
+
/**
|
|
1730
|
+
* <p>The temporary security credentials which can be used to start just-in-time node access sessions.</p>
|
|
1731
|
+
* @public
|
|
1732
|
+
*/
|
|
1733
|
+
Credentials?: Credentials | undefined;
|
|
1734
|
+
/**
|
|
1735
|
+
* <p>The status of the access request.</p>
|
|
1736
|
+
* @public
|
|
1737
|
+
*/
|
|
1738
|
+
AccessRequestStatus?: AccessRequestStatus | undefined;
|
|
1739
|
+
}
|
|
1740
|
+
/**
|
|
1741
|
+
* <p>The request or operation couldn't be performed because the service is throttling requests.</p>
|
|
1742
|
+
* @public
|
|
1743
|
+
*/
|
|
1744
|
+
export declare class ThrottlingException extends __BaseException {
|
|
1745
|
+
readonly name: "ThrottlingException";
|
|
1746
|
+
readonly $fault: "client";
|
|
1747
|
+
Message: string | undefined;
|
|
1748
|
+
/**
|
|
1749
|
+
* <p>The quota code recognized by the Amazon Web Services Service Quotas service.</p>
|
|
1750
|
+
* @public
|
|
1751
|
+
*/
|
|
1752
|
+
QuotaCode?: string | undefined;
|
|
1753
|
+
/**
|
|
1754
|
+
* <p>The code for the Amazon Web Services service that owns the quota.</p>
|
|
1755
|
+
* @public
|
|
1756
|
+
*/
|
|
1757
|
+
ServiceCode?: string | undefined;
|
|
1758
|
+
/**
|
|
1759
|
+
* @internal
|
|
1760
|
+
*/
|
|
1761
|
+
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
1762
|
+
}
|
|
1763
|
+
/**
|
|
1764
|
+
* <p>The request isn't valid. Verify that you entered valid contents for the command and try
|
|
1765
|
+
* again.</p>
|
|
1766
|
+
* @public
|
|
1767
|
+
*/
|
|
1768
|
+
export declare class ValidationException extends __BaseException {
|
|
1769
|
+
readonly name: "ValidationException";
|
|
1770
|
+
readonly $fault: "client";
|
|
1771
|
+
Message?: string | undefined;
|
|
1772
|
+
/**
|
|
1773
|
+
* <p>The reason code for the invalid request.</p>
|
|
1774
|
+
* @public
|
|
1775
|
+
*/
|
|
1776
|
+
ReasonCode?: string | undefined;
|
|
1777
|
+
/**
|
|
1778
|
+
* @internal
|
|
1779
|
+
*/
|
|
1780
|
+
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
1781
|
+
}
|
|
1628
1782
|
/**
|
|
1629
1783
|
* @public
|
|
1630
1784
|
*/
|
|
@@ -9040,345 +9194,6 @@ export interface RegisterPatchBaselineForPatchGroupResult {
|
|
|
9040
9194
|
*/
|
|
9041
9195
|
PatchGroup?: string | undefined;
|
|
9042
9196
|
}
|
|
9043
|
-
/**
|
|
9044
|
-
* @public
|
|
9045
|
-
*/
|
|
9046
|
-
export interface RegisterTargetWithMaintenanceWindowRequest {
|
|
9047
|
-
/**
|
|
9048
|
-
* <p>The ID of the maintenance window the target should be registered with.</p>
|
|
9049
|
-
* @public
|
|
9050
|
-
*/
|
|
9051
|
-
WindowId: string | undefined;
|
|
9052
|
-
/**
|
|
9053
|
-
* <p>The type of target being registered with the maintenance window.</p>
|
|
9054
|
-
* @public
|
|
9055
|
-
*/
|
|
9056
|
-
ResourceType: MaintenanceWindowResourceType | undefined;
|
|
9057
|
-
/**
|
|
9058
|
-
* <p>The targets to register with the maintenance window. In other words, the managed nodes to
|
|
9059
|
-
* run commands on when the maintenance window runs.</p>
|
|
9060
|
-
* <note>
|
|
9061
|
-
* <p>If a single maintenance window task is registered with multiple targets, its task
|
|
9062
|
-
* invocations occur sequentially and not in parallel. If your task must run on multiple targets at
|
|
9063
|
-
* the same time, register a task for each target individually and assign each task the same
|
|
9064
|
-
* priority level.</p>
|
|
9065
|
-
* </note>
|
|
9066
|
-
* <p>You can specify targets using managed node IDs, resource group names, or tags that have been
|
|
9067
|
-
* applied to managed nodes.</p>
|
|
9068
|
-
* <p>
|
|
9069
|
-
* <b>Example 1</b>: Specify managed node IDs</p>
|
|
9070
|
-
* <p>
|
|
9071
|
-
* <code>Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3></code>
|
|
9072
|
-
* </p>
|
|
9073
|
-
* <p>
|
|
9074
|
-
* <b>Example 2</b>: Use tag key-pairs applied to managed
|
|
9075
|
-
* nodes</p>
|
|
9076
|
-
* <p>
|
|
9077
|
-
* <code>Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2></code>
|
|
9078
|
-
* </p>
|
|
9079
|
-
* <p>
|
|
9080
|
-
* <b>Example 3</b>: Use tag-keys applied to managed nodes</p>
|
|
9081
|
-
* <p>
|
|
9082
|
-
* <code>Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2></code>
|
|
9083
|
-
* </p>
|
|
9084
|
-
* <p>
|
|
9085
|
-
* <b>Example 4</b>: Use resource group names</p>
|
|
9086
|
-
* <p>
|
|
9087
|
-
* <code>Key=resource-groups:Name,Values=<resource-group-name></code>
|
|
9088
|
-
* </p>
|
|
9089
|
-
* <p>
|
|
9090
|
-
* <b>Example 5</b>: Use filters for resource group types</p>
|
|
9091
|
-
* <p>
|
|
9092
|
-
* <code>Key=resource-groups:ResourceTypeFilters,Values=<resource-type-1>,<resource-type-2></code>
|
|
9093
|
-
* </p>
|
|
9094
|
-
* <note>
|
|
9095
|
-
* <p>For <code>Key=resource-groups:ResourceTypeFilters</code>, specify resource types in the
|
|
9096
|
-
* following format</p>
|
|
9097
|
-
* <p>
|
|
9098
|
-
* <code>Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC</code>
|
|
9099
|
-
* </p>
|
|
9100
|
-
* </note>
|
|
9101
|
-
* <p>For more information about these examples formats, including the best use case for each one,
|
|
9102
|
-
* see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-targets-examples.html">Examples: Register
|
|
9103
|
-
* targets with a maintenance window</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
9104
|
-
* @public
|
|
9105
|
-
*/
|
|
9106
|
-
Targets: Target[] | undefined;
|
|
9107
|
-
/**
|
|
9108
|
-
* <p>User-provided value that will be included in any Amazon CloudWatch Events events raised while
|
|
9109
|
-
* running tasks for these targets in this maintenance window.</p>
|
|
9110
|
-
* @public
|
|
9111
|
-
*/
|
|
9112
|
-
OwnerInformation?: string | undefined;
|
|
9113
|
-
/**
|
|
9114
|
-
* <p>An optional name for the target.</p>
|
|
9115
|
-
* @public
|
|
9116
|
-
*/
|
|
9117
|
-
Name?: string | undefined;
|
|
9118
|
-
/**
|
|
9119
|
-
* <p>An optional description for the target.</p>
|
|
9120
|
-
* @public
|
|
9121
|
-
*/
|
|
9122
|
-
Description?: string | undefined;
|
|
9123
|
-
/**
|
|
9124
|
-
* <p>User-provided idempotency token.</p>
|
|
9125
|
-
* @public
|
|
9126
|
-
*/
|
|
9127
|
-
ClientToken?: string | undefined;
|
|
9128
|
-
}
|
|
9129
|
-
/**
|
|
9130
|
-
* @public
|
|
9131
|
-
*/
|
|
9132
|
-
export interface RegisterTargetWithMaintenanceWindowResult {
|
|
9133
|
-
/**
|
|
9134
|
-
* <p>The ID of the target definition in this maintenance window.</p>
|
|
9135
|
-
* @public
|
|
9136
|
-
*/
|
|
9137
|
-
WindowTargetId?: string | undefined;
|
|
9138
|
-
}
|
|
9139
|
-
/**
|
|
9140
|
-
* <p>You attempted to register a <code>LAMBDA</code> or <code>STEP_FUNCTIONS</code> task in a
|
|
9141
|
-
* region where the corresponding service isn't available. </p>
|
|
9142
|
-
* @public
|
|
9143
|
-
*/
|
|
9144
|
-
export declare class FeatureNotAvailableException extends __BaseException {
|
|
9145
|
-
readonly name: "FeatureNotAvailableException";
|
|
9146
|
-
readonly $fault: "client";
|
|
9147
|
-
Message?: string | undefined;
|
|
9148
|
-
/**
|
|
9149
|
-
* @internal
|
|
9150
|
-
*/
|
|
9151
|
-
constructor(opts: __ExceptionOptionType<FeatureNotAvailableException, __BaseException>);
|
|
9152
|
-
}
|
|
9153
|
-
/**
|
|
9154
|
-
* @public
|
|
9155
|
-
*/
|
|
9156
|
-
export interface RegisterTaskWithMaintenanceWindowRequest {
|
|
9157
|
-
/**
|
|
9158
|
-
* <p>The ID of the maintenance window the task should be added to.</p>
|
|
9159
|
-
* @public
|
|
9160
|
-
*/
|
|
9161
|
-
WindowId: string | undefined;
|
|
9162
|
-
/**
|
|
9163
|
-
* <p>The targets (either managed nodes or maintenance window targets).</p>
|
|
9164
|
-
* <note>
|
|
9165
|
-
* <p>One or more targets must be specified for maintenance window Run Command-type tasks.
|
|
9166
|
-
* Depending on the task, targets are optional for other maintenance window task types (Automation,
|
|
9167
|
-
* Lambda, and Step Functions). For more information about running tasks
|
|
9168
|
-
* that don't specify targets, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html">Registering
|
|
9169
|
-
* maintenance window tasks without targets</a> in the
|
|
9170
|
-
* <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
9171
|
-
* </note>
|
|
9172
|
-
* <p>Specify managed nodes using the following format: </p>
|
|
9173
|
-
* <p>
|
|
9174
|
-
* <code>Key=InstanceIds,Values=<instance-id-1>,<instance-id-2></code>
|
|
9175
|
-
* </p>
|
|
9176
|
-
* <p>Specify maintenance window targets using the following format:</p>
|
|
9177
|
-
* <p>
|
|
9178
|
-
* <code>Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2></code>
|
|
9179
|
-
* </p>
|
|
9180
|
-
* @public
|
|
9181
|
-
*/
|
|
9182
|
-
Targets?: Target[] | undefined;
|
|
9183
|
-
/**
|
|
9184
|
-
* <p>The ARN of the task to run.</p>
|
|
9185
|
-
* @public
|
|
9186
|
-
*/
|
|
9187
|
-
TaskArn: string | undefined;
|
|
9188
|
-
/**
|
|
9189
|
-
* <p>The Amazon Resource Name (ARN) of the IAM service role for
|
|
9190
|
-
* Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a
|
|
9191
|
-
* service role ARN, Systems Manager uses a service-linked role in your account. If no
|
|
9192
|
-
* appropriate service-linked role for Systems Manager exists in your account, it is created when
|
|
9193
|
-
* you run <code>RegisterTaskWithMaintenanceWindow</code>.</p>
|
|
9194
|
-
* <p>However, for an improved security posture, we strongly recommend creating a custom
|
|
9195
|
-
* policy and custom service role for running your maintenance window tasks. The policy
|
|
9196
|
-
* can be crafted to provide only the permissions needed for your particular
|
|
9197
|
-
* 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
|
|
9198
|
-
* <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
9199
|
-
* @public
|
|
9200
|
-
*/
|
|
9201
|
-
ServiceRoleArn?: string | undefined;
|
|
9202
|
-
/**
|
|
9203
|
-
* <p>The type of task being registered.</p>
|
|
9204
|
-
* @public
|
|
9205
|
-
*/
|
|
9206
|
-
TaskType: MaintenanceWindowTaskType | undefined;
|
|
9207
|
-
/**
|
|
9208
|
-
* <p>The parameters that should be passed to the task when it is run.</p>
|
|
9209
|
-
* <note>
|
|
9210
|
-
* <p>
|
|
9211
|
-
* <code>TaskParameters</code> has been deprecated. To specify parameters to pass to a task when it runs,
|
|
9212
|
-
* instead use the <code>Parameters</code> option in the <code>TaskInvocationParameters</code> structure. For information
|
|
9213
|
-
* about how Systems Manager handles these options for the supported maintenance window task
|
|
9214
|
-
* types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p>
|
|
9215
|
-
* </note>
|
|
9216
|
-
* @public
|
|
9217
|
-
*/
|
|
9218
|
-
TaskParameters?: Record<string, MaintenanceWindowTaskParameterValueExpression> | undefined;
|
|
9219
|
-
/**
|
|
9220
|
-
* <p>The parameters that the task should use during execution. Populate only the fields that
|
|
9221
|
-
* match the task type. All other fields should be empty. </p>
|
|
9222
|
-
* @public
|
|
9223
|
-
*/
|
|
9224
|
-
TaskInvocationParameters?: MaintenanceWindowTaskInvocationParameters | undefined;
|
|
9225
|
-
/**
|
|
9226
|
-
* <p>The priority of the task in the maintenance window, the lower the number the higher the
|
|
9227
|
-
* priority. Tasks in a maintenance window are scheduled in priority order with tasks that have the
|
|
9228
|
-
* same priority scheduled in parallel.</p>
|
|
9229
|
-
* @public
|
|
9230
|
-
*/
|
|
9231
|
-
Priority?: number | undefined;
|
|
9232
|
-
/**
|
|
9233
|
-
* <p>The maximum number of targets this task can be run for, in parallel.</p>
|
|
9234
|
-
* <note>
|
|
9235
|
-
* <p>Although this element is listed as "Required: No", a value can be omitted only when you are
|
|
9236
|
-
* registering or updating a <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html">targetless
|
|
9237
|
-
* task</a> You must provide a value in all other cases.</p>
|
|
9238
|
-
* <p>For maintenance window tasks without a target specified, you can't supply a value for this
|
|
9239
|
-
* option. Instead, the system inserts a placeholder value of <code>1</code>. This value doesn't
|
|
9240
|
-
* affect the running of your task.</p>
|
|
9241
|
-
* </note>
|
|
9242
|
-
* @public
|
|
9243
|
-
*/
|
|
9244
|
-
MaxConcurrency?: string | undefined;
|
|
9245
|
-
/**
|
|
9246
|
-
* <p>The maximum number of errors allowed before this task stops being scheduled.</p>
|
|
9247
|
-
* <note>
|
|
9248
|
-
* <p>Although this element is listed as "Required: No", a value can be omitted only when you are
|
|
9249
|
-
* registering or updating a <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html">targetless
|
|
9250
|
-
* task</a> You must provide a value in all other cases.</p>
|
|
9251
|
-
* <p>For maintenance window tasks without a target specified, you can't supply a value for this
|
|
9252
|
-
* option. Instead, the system inserts a placeholder value of <code>1</code>. This value doesn't
|
|
9253
|
-
* affect the running of your task.</p>
|
|
9254
|
-
* </note>
|
|
9255
|
-
* @public
|
|
9256
|
-
*/
|
|
9257
|
-
MaxErrors?: string | undefined;
|
|
9258
|
-
/**
|
|
9259
|
-
* <p>A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket
|
|
9260
|
-
* to write managed node-level logs to. </p>
|
|
9261
|
-
* <note>
|
|
9262
|
-
* <p>
|
|
9263
|
-
* <code>LoggingInfo</code> has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the
|
|
9264
|
-
* <code>OutputS3BucketName</code> and <code>OutputS3KeyPrefix</code> options in the <code>TaskInvocationParameters</code> structure.
|
|
9265
|
-
* For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance
|
|
9266
|
-
* window task types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p>
|
|
9267
|
-
* </note>
|
|
9268
|
-
* @public
|
|
9269
|
-
*/
|
|
9270
|
-
LoggingInfo?: LoggingInfo | undefined;
|
|
9271
|
-
/**
|
|
9272
|
-
* <p>An optional name for the task.</p>
|
|
9273
|
-
* @public
|
|
9274
|
-
*/
|
|
9275
|
-
Name?: string | undefined;
|
|
9276
|
-
/**
|
|
9277
|
-
* <p>An optional description for the task.</p>
|
|
9278
|
-
* @public
|
|
9279
|
-
*/
|
|
9280
|
-
Description?: string | undefined;
|
|
9281
|
-
/**
|
|
9282
|
-
* <p>User-provided idempotency token.</p>
|
|
9283
|
-
* @public
|
|
9284
|
-
*/
|
|
9285
|
-
ClientToken?: string | undefined;
|
|
9286
|
-
/**
|
|
9287
|
-
* <p>Indicates whether tasks should continue to run after the cutoff time specified in the
|
|
9288
|
-
* maintenance windows is reached. </p>
|
|
9289
|
-
* <ul>
|
|
9290
|
-
* <li>
|
|
9291
|
-
* <p>
|
|
9292
|
-
* <code>CONTINUE_TASK</code>: When the cutoff time is reached, any tasks that are running
|
|
9293
|
-
* continue. The default value.</p>
|
|
9294
|
-
* </li>
|
|
9295
|
-
* <li>
|
|
9296
|
-
* <p>
|
|
9297
|
-
* <code>CANCEL_TASK</code>:</p>
|
|
9298
|
-
* <ul>
|
|
9299
|
-
* <li>
|
|
9300
|
-
* <p>For Automation, Lambda, Step Functions tasks: When the cutoff
|
|
9301
|
-
* time is reached, any task invocations that are already running continue, but no new task
|
|
9302
|
-
* invocations are started.</p>
|
|
9303
|
-
* </li>
|
|
9304
|
-
* <li>
|
|
9305
|
-
* <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
|
|
9306
|
-
* task. However, there is no guarantee that the command will be terminated and the underlying
|
|
9307
|
-
* process stopped.</p>
|
|
9308
|
-
* </li>
|
|
9309
|
-
* </ul>
|
|
9310
|
-
* <p>The status for tasks that are not completed is <code>TIMED_OUT</code>.</p>
|
|
9311
|
-
* </li>
|
|
9312
|
-
* </ul>
|
|
9313
|
-
* @public
|
|
9314
|
-
*/
|
|
9315
|
-
CutoffBehavior?: MaintenanceWindowTaskCutoffBehavior | undefined;
|
|
9316
|
-
/**
|
|
9317
|
-
* <p>The CloudWatch alarm you want to apply to your maintenance window task.</p>
|
|
9318
|
-
* @public
|
|
9319
|
-
*/
|
|
9320
|
-
AlarmConfiguration?: AlarmConfiguration | undefined;
|
|
9321
|
-
}
|
|
9322
|
-
/**
|
|
9323
|
-
* @public
|
|
9324
|
-
*/
|
|
9325
|
-
export interface RegisterTaskWithMaintenanceWindowResult {
|
|
9326
|
-
/**
|
|
9327
|
-
* <p>The ID of the task in the maintenance window.</p>
|
|
9328
|
-
* @public
|
|
9329
|
-
*/
|
|
9330
|
-
WindowTaskId?: string | undefined;
|
|
9331
|
-
}
|
|
9332
|
-
/**
|
|
9333
|
-
* @public
|
|
9334
|
-
*/
|
|
9335
|
-
export interface RemoveTagsFromResourceRequest {
|
|
9336
|
-
/**
|
|
9337
|
-
* <p>The type of resource from which you want to remove a tag.</p>
|
|
9338
|
-
* <note>
|
|
9339
|
-
* <p>The <code>ManagedInstance</code> type for this API operation is only for on-premises
|
|
9340
|
-
* managed nodes. Specify the name of the managed node in the following format:
|
|
9341
|
-
* <code>mi-<i>ID_number</i>
|
|
9342
|
-
* </code>. For example,
|
|
9343
|
-
* <code>mi-1a2b3c4d5e6f</code>.</p>
|
|
9344
|
-
* </note>
|
|
9345
|
-
* @public
|
|
9346
|
-
*/
|
|
9347
|
-
ResourceType: ResourceTypeForTagging | undefined;
|
|
9348
|
-
/**
|
|
9349
|
-
* <p>The ID of the resource from which you want to remove tags. For example:</p>
|
|
9350
|
-
* <p>ManagedInstance: mi-012345abcde</p>
|
|
9351
|
-
* <p>MaintenanceWindow: mw-012345abcde</p>
|
|
9352
|
-
* <p>
|
|
9353
|
-
* <code>Automation</code>: <code>example-c160-4567-8519-012345abcde</code>
|
|
9354
|
-
* </p>
|
|
9355
|
-
* <p>PatchBaseline: pb-012345abcde</p>
|
|
9356
|
-
* <p>OpsMetadata object: <code>ResourceID</code> for tagging is created from the Amazon Resource
|
|
9357
|
-
* Name (ARN) for the object. Specifically, <code>ResourceID</code> is created from the strings that
|
|
9358
|
-
* come after the word <code>opsmetadata</code> in the ARN. For example, an OpsMetadata object with
|
|
9359
|
-
* an ARN of <code>arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager</code>
|
|
9360
|
-
* has a <code>ResourceID</code> of either <code>aws/ssm/MyGroup/appmanager</code> or
|
|
9361
|
-
* <code>/aws/ssm/MyGroup/appmanager</code>.</p>
|
|
9362
|
-
* <p>For the Document and Parameter values, use the name of the resource.</p>
|
|
9363
|
-
* <note>
|
|
9364
|
-
* <p>The <code>ManagedInstance</code> type for this API operation is only for on-premises
|
|
9365
|
-
* managed nodes. Specify the name of the managed node in the following format: mi-ID_number. For
|
|
9366
|
-
* example, mi-1a2b3c4d5e6f.</p>
|
|
9367
|
-
* </note>
|
|
9368
|
-
* @public
|
|
9369
|
-
*/
|
|
9370
|
-
ResourceId: string | undefined;
|
|
9371
|
-
/**
|
|
9372
|
-
* <p>Tag keys that you want to remove from the specified resource.</p>
|
|
9373
|
-
* @public
|
|
9374
|
-
*/
|
|
9375
|
-
TagKeys: string[] | undefined;
|
|
9376
|
-
}
|
|
9377
|
-
/**
|
|
9378
|
-
* @public
|
|
9379
|
-
*/
|
|
9380
|
-
export interface RemoveTagsFromResourceResult {
|
|
9381
|
-
}
|
|
9382
9197
|
/**
|
|
9383
9198
|
* @internal
|
|
9384
9199
|
*/
|
|
@@ -9399,6 +9214,14 @@ export declare const MaintenanceWindowTaskFilterSensitiveLog: (obj: MaintenanceW
|
|
|
9399
9214
|
* @internal
|
|
9400
9215
|
*/
|
|
9401
9216
|
export declare const DescribeMaintenanceWindowTasksResultFilterSensitiveLog: (obj: DescribeMaintenanceWindowTasksResult) => any;
|
|
9217
|
+
/**
|
|
9218
|
+
* @internal
|
|
9219
|
+
*/
|
|
9220
|
+
export declare const CredentialsFilterSensitiveLog: (obj: Credentials) => any;
|
|
9221
|
+
/**
|
|
9222
|
+
* @internal
|
|
9223
|
+
*/
|
|
9224
|
+
export declare const GetAccessTokenResponseFilterSensitiveLog: (obj: GetAccessTokenResponse) => any;
|
|
9402
9225
|
/**
|
|
9403
9226
|
* @internal
|
|
9404
9227
|
*/
|
|
@@ -9503,11 +9326,3 @@ export declare const ListNodesResultFilterSensitiveLog: (obj: ListNodesResult) =
|
|
|
9503
9326
|
* @internal
|
|
9504
9327
|
*/
|
|
9505
9328
|
export declare const PutParameterRequestFilterSensitiveLog: (obj: PutParameterRequest) => any;
|
|
9506
|
-
/**
|
|
9507
|
-
* @internal
|
|
9508
|
-
*/
|
|
9509
|
-
export declare const RegisterTargetWithMaintenanceWindowRequestFilterSensitiveLog: (obj: RegisterTargetWithMaintenanceWindowRequest) => any;
|
|
9510
|
-
/**
|
|
9511
|
-
* @internal
|
|
9512
|
-
*/
|
|
9513
|
-
export declare const RegisterTaskWithMaintenanceWindowRequestFilterSensitiveLog: (obj: RegisterTaskWithMaintenanceWindowRequest) => any;
|