DescribeEﬀectiveInstanceAssociations

All associations for the managed node(s).

Request Syntax

{ "InstanceId": "string", "MaxResults": number, "NextToken": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 839).

The request accepts the following data in JSON format.

InstanceId (p. 146)

The managed node ID for which you want to view all associations.

Type: String

Pattern: (^i-(\w{8}|\w{17})$)|(^mi-\w{17}$) Required: Yes

MaxResults (p. 146)

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 5.

Required: No NextToken (p. 146)

The token for the next set of items to return. (You received this token from a previous call.) Type: String

Required: No

Response Syntax

{ "Associations": [ {

"AssociationId": "string", "AssociationVersion": "string", "Content": "string",

"InstanceId": "string"

Response Elements

} ],

"NextToken": "string"

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Associations (p. 146)

The associations for the requested managed node.

Type: Array of InstanceAssociation (p. 674) objects NextToken (p. 146)

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors (p. 841).

InternalServerError

An error occurred on the server side.

HTTP Status Code: 500 InvalidInstanceId

The following problems can cause this exception:

• You don't have permission to access the managed node.

• AWS Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.

• SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

• The managed node isn't in valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

HTTP Status Code: 400 InvalidNextToken

The speciﬁed token isn't valid.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of DescribeEﬀectiveInstanceAssociations.

See Also

Sample Request

POST / HTTP/1.1

Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity

X-Amz-Target: AmazonSSM.DescribeEffectiveInstanceAssociations Content-Type: application/x-amz-json-1.1

User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20200326T144721Z

Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20200326/us-east-2/ssm/

aws4_request,

SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 37

{

"InstanceId": "i-02573cafcfEXAMPLE"

}

Sample Response

{

"Associations": [ {

"AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE", "InstanceId": "i-02573cafcfEXAMPLE",

"Content": "{\n \"schemaVersion\": \"1.2\",\n \"description\": \"Update the Amazon SSM Agent to the latest version or specified version.\",\n--truncated--", "AssociationVersion": "1"

} ] }

Request Syntax

{

"BaselineId": "string", "MaxResults": number, "NextToken": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 839).

The request accepts the following data in JSON format.

BaselineId (p. 149)

The ID of the patch baseline to retrieve the eﬀective patches for.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_\-:/]{20,128}$

Required: Yes MaxResults (p. 149)

The maximum number of patches to return (per page).

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No NextToken (p. 149)

The token for the next set of items to return. (You received this token from a previous call.) Type: String

Required: No

Response Syntax

{ "EffectivePatches": [ {

"Patch": {

Response Elements

"NextToken": "string"

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

EﬀectivePatches (p. 149)

An array of patches and patch status.

Type: Array of EﬀectivePatch (p. 670) objects NextToken (p. 149)

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors (p. 841).

DoesNotExistException

Error returned when the ID speciﬁed for a resource, such as a maintenance window or patch baseline, doesn't exist.

Examples

For information about resource quotas in AWS Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

HTTP Status Code: 400 InternalServerError

An error occurred on the server side.

HTTP Status Code: 500 InvalidResourceId

The resource ID isn't valid. Verify that you entered the correct ID and try again.

HTTP Status Code: 400 UnsupportedOperatingSystem

The operating systems you speciﬁed isn't supported, or the operation isn't supported for the operating system.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of DescribeEﬀectivePatchesForPatchBaseline.

Sample Request

POST / HTTP/1.1

Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity

Content-Length: 38

X-Amz-Target: AmazonSSM.DescribeEffectivePatchesForPatchBaseline X-Amz-Date: 20180309T061447Z

User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Content-Type: application/x-amz-json-1.1

Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20180309/us-east-2/ssm/

aws4_request,

SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "BaselineId": "pb-0c10e65780EXAMPLE"

}

Sample Response

{

"EffectivePatches": [ {

"Patch": {

"Classification": "SecurityUpdates",

"ContentUrl": "https://support.microsoft.com/en-us/kb/2032276",

"Description": "A security issue has been identified that could allow an unauthenticated remote attacker to compromise your system and gain control over it. You can help protect your system by installing this update from Microsoft. After you install this update, you may have to restart your system.",

Examples

"ContentUrl": "https://support.microsoft.com/en-us/kb/2124261",

"Description": "A security issue has been identified that could allow an

"ContentUrl": "https://support.microsoft.com/en-us/kb/2124261",

"Description": "A security issue has been identified that could allow an

See Also

"ApprovalDate": 1284742800, "ComplianceLevel": "UNSPECIFIED", "DeploymentStatus": "APPROVED"

} }

// There may be more content here ]

}

Request Syntax

{ "InstanceId": "string", "MaxResults": number, "NextToken": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 839).

The request accepts the following data in JSON format.

InstanceId (p. 154)

The managed node IDs for which you want association status information.

Type: String

Pattern: (^i-(\w{8}|\w{17})$)|(^mi-\w{17}$) Required: Yes

MaxResults (p. 154)

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No NextToken (p. 154)

The token for the next set of items to return. (You received this token from a previous call.) Type: String

Required: No

Response Syntax

{ "InstanceAssociationStatusInfos": [ {

"AssociationId": "string", "AssociationName": "string", "AssociationVersion": "string", "DetailedStatus": "string",

Response Elements

"DocumentVersion": "string", "ErrorCode": "string", "ExecutionDate": number, "ExecutionSummary": "string", "InstanceId": "string", "Name": "string", "OutputUrl": { "S3OutputUrl": { "OutputUrl": "string"

} },

"Status": "string"

} ],

"NextToken": "string"

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

InstanceAssociationStatusInfos (p. 154) Status information about the association.

Type: Array of InstanceAssociationStatusInfo (p. 677) objects NextToken (p. 154)

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors (p. 841).

InternalServerError

An error occurred on the server side.

HTTP Status Code: 500 InvalidInstanceId

The following problems can cause this exception:

• You don't have permission to access the managed node.

• AWS Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.

• SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

• The managed node isn't in valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

HTTP Status Code: 400 InvalidNextToken

The speciﬁed token isn't valid.

Examples

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of DescribeInstanceAssociationsStatus.

Sample Request

POST / HTTP/1.1

Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity

X-Amz-Target: AmazonSSM.DescribeInstanceAssociationsStatus Content-Type: application/x-amz-json-1.1

User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20200324T185152Z

Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20200324/us-east-2/ssm/

aws4_request,

SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 37

{ "InstanceId": "i-02573cafcfEXAMPLE"

}

Sample Response

{ "InstanceAssociationStatusInfos": [ {

"AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE", "AssociationVersion": "1",

"DetailedStatus": "Success", "DocumentVersion": "1",

"ExecutionDate": 1581948052.198, "InstanceId": "i-02573cafcfEXAMPLE", "Name": "AWS-UpdateSSMAgent", "Status": "Success"

} ] }

Request Syntax

{

"Filters": [ {

"Key": "string", "Values": [ "string" ] }

"InstanceInformationFilterList": [ {

"key": "string",

"valueSet": [ "string" ] }

"MaxResults": number, "NextToken": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 839).

The request accepts the following data in JSON format.

Filters (p. 158)

One or more ﬁlters. Use a ﬁlter to return a more speciﬁc list of managed nodes. You can ﬁlter based on tags applied to EC2 instances. Use this Filters data type instead of InstanceInformationFilterList, which is deprecated.

Type: Array of InstanceInformationStringFilter (p. 685) objects Array Members: Minimum number of 0 items.

Required: No

InstanceInformationFilterList (p. 158)

This is a legacy method. We recommend that you don't use this method. Instead, use the Filters data type. Filters enables you to return node information by ﬁltering based on tags applied to managed nodes.

NoteAttempting to use InstanceInformationFilterList and Filters leads to an exception error.

Response Syntax

Type: Array of InstanceInformationFilter (p. 684) objects Array Members: Minimum number of 0 items.

Required: No MaxResults (p. 158)

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Type: Integer

Valid Range: Minimum value of 5. Maximum value of 50.

Required: No NextToken (p. 158)

The token for the next set of items to return. (You received this token from a previous call.) Type: String

Required: No

Response Syntax

{

"InstanceInformationList": [ {

"LastAssociationExecutionDate": number, "LastPingDateTime": number,

"LastSuccessfulAssociationExecutionDate": number, "Name": "string",

"NextToken": "string"

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

InstanceInformationList (p. 159)

The managed node information list.

Type: Array of InstanceInformation (p. 680) objects NextToken (p. 159)

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors (p. 841).

InternalServerError

An error occurred on the server side.

HTTP Status Code: 500 InvalidFilterKey

The speciﬁed key isn't valid.

HTTP Status Code: 400 InvalidInstanceId

The following problems can cause this exception:

• You don't have permission to access the managed node.

• AWS Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.

• SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

• The managed node isn't in valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

HTTP Status Code: 400

InvalidInstanceInformationFilterValue

The speciﬁed ﬁlter value isn't valid.

HTTP Status Code: 400 InvalidNextToken

The speciﬁed token isn't valid.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of DescribeInstanceInformation.

Sample Request

User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4 X-Amz-Date: 20200220T234247Z

"InstanceInformationList": [ {

"ComputerName": "WIN-11RMS222RPK.WORKGROUP", "IPAddress": "203.0.113.0",

"InstanceId": "i-02573cafcfEXAMPLE", "IsLatestVersion": false,

"LastAssociationExecutionDate": 1582242019, "LastPingDateTime": 1582242018.094,

"PingStatus": "Online",

"PlatformName": "Microsoft Windows Server 2008 R2 Datacenter", "PlatformType": "Windows",

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

DescribeInstancePatches

Retrieves information about the patches on the speciﬁed managed node and their state relative to the patch baseline being used for the node.

Request Syntax

{ "Filters": [ {

"Key": "string", "Values": [ "string" ] }

"InstanceId": "string", "MaxResults": number, "NextToken": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 839).

The request accepts the following data in JSON format.

Filters (p. 163)

Each element in the array is a structure containing a key-value pair.

Supported keys for DescribeInstancePatchesinclude the following:

• Classification

Sample values: Security | SecurityUpdates

• KBId

Sample values: KB4480056 | java-1.7.0-openjdk.x86_64

• Severity

Sample values: Important | Medium | Low

• State

Sample values: Installed | InstalledOther | InstalledPendingReboot Type: Array of PatchOrchestratorFilter (p. 789) objects

Array Members: Minimum number of 0 items. Maximum number of 5 items.

Required: No InstanceId (p. 163)

The ID of the managed node whose patch state information should be retrieved.

Type: String

Pattern: (^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)

Response Syntax

Required: Yes MaxResults (p. 163)

The maximum number of patches to return (per page).

Type: Integer

Valid Range: Minimum value of 10. Maximum value of 100.

Required: No NextToken (p. 163)

The token for the next set of items to return. (You received this token from a previous call.) Type: String

Required: No

Response Syntax

{ "NextToken": "string", "Patches": [

{

"Classification": "string", "CVEIds": "string",

"InstalledTime": number, "KBId": "string", "Severity": "string", "State": "string", "Title": "string"

} ]}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken (p. 164)

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Type: String Patches (p. 164)

Each entry in the array is a structure containing:

• Title (string)

• KBId (string)

• Classiﬁcation (string)

• Severity (string)

• State (string, such as "INSTALLED" or "FAILED")

• InstalledTime (DateTime)

Errors

• InstalledBy (string)

Type: Array of PatchComplianceData (p. 783) objects

Errors

For information about the errors that are common to all actions, see Common Errors (p. 841).

InternalServerError

An error occurred on the server side.

HTTP Status Code: 500 InvalidFilter

The ﬁlter name isn't valid. Verify the you entered the correct name and try again.

HTTP Status Code: 400 InvalidInstanceId

The following problems can cause this exception:

• You don't have permission to access the managed node.

• AWS Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.

• SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

• The managed node isn't in valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

HTTP Status Code: 400 InvalidNextToken

The speciﬁed token isn't valid.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of DescribeInstancePatches.

Sample Request

POST / HTTP/1.1

Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity

Content-Length: 37

X-Amz-Target: AmazonSSM.DescribeInstancePatches X-Amz-Date: 20180308T205131Z

User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Content-Type: application/x-amz-json-1.1

Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20180308/us-east-2/ssm/

aws4_request,

SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE {

See Also

"InstanceId": "i-02573cafcfEXAMPLE"

}

Sample Response

{ "Patches": [ {

"Title": "NetworkManager.x86_64:1:1.30.0-7.el8", "KBId": "NetworkManager.x86_64",

"Classification": "Security", "Severity": "Moderate", "State": "Installed",

"InstalledTime": "2021-05-19T10:03:07-07:00"

}, {

"Title": "bash.x86_64:0:4.4.19-14.el8", "KBId": "bash.x86_64",

"Classification": "Security", "Severity": "Low",

"State": "Installed",

"InstalledTime": "2021-05-19T10:03:25-07:00"

}, {

"Title": "kernel-modules.x86_64:0:4.18.0-305.10.2.el8_4", "KBId": "kernel-modules.x86_64",

"Classification": "Security", "Severity": "Important", "State": "Installed",

"InstalledTime": "2021-08-04T10:45:42-07:00"

}

// There may be more content here ]

}

Request Syntax

{ "InstanceIds": [ "string" ], "MaxResults": number,

"NextToken": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 839).

The request accepts the following data in JSON format.

InstanceIds (p. 167)

The ID of the managed node for which patch state information should be retrieved.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Pattern: (^i-(\w{8}|\w{17})$)|(^mi-\w{17}$) Required: Yes

MaxResults (p. 167)

The maximum number of managed nodes to return (per page).

Type: Integer

Valid Range: Minimum value of 10. Maximum value of 100.

Required: No NextToken (p. 167)

The token for the next set of items to return. (You received this token from a previous call.) Type: String

Required: No

Response Syntax

{ "InstancePatchStates": [ {

"BaselineId": "string",

Response Elements

"CriticalNonCompliantCount": number, "FailedCount": number,

"InstalledCount": number, "InstalledOtherCount": number,

"InstalledPendingRebootCount": number, "InstalledRejectedCount": number, "InstallOverrideList": "string", "InstanceId": "string",

"LastNoRebootInstallOperationTime": number, "MissingCount": number,

"NotApplicableCount": number, "Operation": "string", "OperationEndTime": number, "OperationStartTime": number, "OtherNonCompliantCount": number, "OwnerInformation": "string", "PatchGroup": "string", "RebootOption": "string",

"SecurityNonCompliantCount": number, "SnapshotId": "string",

"UnreportedNotApplicableCount": number }

"NextToken": "string"

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

InstancePatchStates (p. 167)

The high-level patch state for the requested managed nodes.

Type: Array of InstancePatchState (p. 686) objects NextToken (p. 167)

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors (p. 841).

InternalServerError

An error occurred on the server side.

HTTP Status Code: 500 InvalidNextToken

The speciﬁed token isn't valid.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of DescribeInstancePatchStates.

Sample Request

User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Content-Type: application/x-amz-json-1.1

{ "InstancePatchStates": [ {

"InstanceId": "i-02573cafcfEXAMPLE", "PatchGroup": "mypatchgroup",

"BaselineId": "pb-0c10e65780EXAMPLE", "SnapshotId": "a3f5ff34-9bc4-4d2c-a665-4d1c1EXAMPLE", "CriticalNonCompliantCount": 2,

"OperationStartTime": "2021-05-03T11:00:56-07:00", "OperationEndTime": "2021-05-03T11:01:09-07:00", "Operation": "Scan",

"LastNoRebootInstallOperationTime": "2020-06-14T12:17:41-07:00", "RebootOption": "RebootIfNeeded"

} ] }

Request Syntax

{ "Filters": [ {

"Key": "string", "Type": "string", "Values": [ "string" ] }

"MaxResults": number, "NextToken": "string", "PatchGroup": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 839).

The request accepts the following data in JSON format.

Filters (p. 171)

Each entry in the array is a structure containing:

• Key (string between 1 and 200 characters)

• Values (array containing a single string)

• Type (string "Equal", "NotEqual", "LessThan", "GreaterThan") Type: Array of InstancePatchStateFilter (p. 691) objects

Array Members: Minimum number of 0 items. Maximum number of 4 items.

Required: No MaxResults (p. 171)

The maximum number of patches to return (per page).

Type: Integer

Valid Range: Minimum value of 10. Maximum value of 100.

Required: No NextToken (p. 171)

The token for the next set of items to return. (You received this token from a previous call.) Type: String

Required: No PatchGroup (p. 171)

The name of the patch group for which the patch state information should be retrieved.

在文檔中 AWS Systems Manager (頁 175-200)

DescribeEﬀectiveInstanceAssociations