2026/07/07 - Amazon Simple Systems Manager (SSM) - 6 new 8 updated api methods
Changes Adding SSM Cloud Connector to support Azure Virtual Machines onboarding to AWS Systems Manager
Creates a cloud connector that establishes a connection between Systems Manager and a third-party cloud environment.
See also: AWS API Documentation
Request Syntax
client.create_cloud_connector(
DisplayName='string',
RoleArn='string',
Description='string',
Configuration={
'AzureConfiguration': {
'TenantId': 'string',
'TenantDisplayName': 'string',
'ApplicationId': 'string',
'ApplicationDisplayName': 'string',
'Targets': {
'Subscriptions': [
{
'Id': 'string',
'DisplayName': 'string'
},
]
}
}
},
ConfigConnectorArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
A friendly name for the cloud connector.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM role that the cloud connector uses to communicate with the third-party cloud environment.
string
A description for the cloud connector.
dict
[REQUIRED]
The configuration details for connecting to the third-party cloud environment.
AzureConfiguration (dict) --
The access details and targets for connecting to a Microsoft Azure environment.
TenantId (string) -- [REQUIRED]
The ID of the Azure tenant.
TenantDisplayName (string) --
The display name of the Azure tenant.
ApplicationId (string) -- [REQUIRED]
The ID of the Azure application registration used for authentication.
ApplicationDisplayName (string) --
The display name of the Azure application registration.
Targets (dict) --
The target Azure subscriptions for the cloud connector.
Subscriptions (list) --
A list of Azure subscriptions to target.
(dict) --
Information about an Azure subscription targeted by the cloud connector.
Id (string) -- [REQUIRED]
The ID of the Azure subscription.
DisplayName (string) --
The display name of the Azure subscription.
string
[REQUIRED]
The ARN of the Amazon Web Services Config connector associated with this cloud connector.
list
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment.
(dict) --
Metadata that you assign to your Amazon Web Services resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. In Amazon Web Services Systems Manager, you can apply tags to Systems Manager documents (SSM documents), managed nodes, maintenance windows, parameters, patch baselines, OpsItems, and OpsMetadata.
Key (string) -- [REQUIRED]
The name of the tag.
Value (string) -- [REQUIRED]
The value of the tag.
dict
Response Syntax
{
'CloudConnectorId': 'string'
}
Response Structure
(dict) --
CloudConnectorId (string) --
The ID of the cloud connector that was created.
Validates the configuration and connectivity of a cloud connector.
See also: AWS API Documentation
Request Syntax
client.validate_cloud_connector(
CloudConnectorId='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ID of the cloud connector to validate.
integer
The maximum number of validation findings to return.
string
The token for the next set of items to return. (You received this token from a previous call.)
dict
Response Syntax
{
'ValidationFindings': [
{
'Type': 'INFO'|'WARN'|'ERROR',
'Code': 'TargetInaccessible'|'TargetUnusable'|'TargetStateWarning'|'AwsRoleAssumptionFailed'|'WebIdentityTokenFailed'|'OutboundWebIdentityFederationDisabled'|'ProviderCredentialCreationFailed'|'TenantSummary'|'SubscriptionAccessible',
'Message': 'string',
'ProviderMessage': 'string',
'Scope': {
'Type': 'azure:tenant'|'azure:subscription',
'Id': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ValidationFindings (list) --
A list of validation findings for the cloud connector.
(dict) --
A validation finding from a cloud connector validation check.
Type (string) --
The type of the validation finding.
Code (string) --
A code that identifies the specific validation finding.
Message (string) --
A message that describes the validation finding.
ProviderMessage (string) --
A message from the third-party cloud provider related to the validation finding.
Scope (dict) --
The scope of the validation finding, identifying the specific resource affected.
Type (string) --
The type of the resource scope.
Id (string) --
The ID of the resource within the scope.
NextToken (string) --
The token to use when requesting the next set of items.
Deletes a cloud connector.
See also: AWS API Documentation
Request Syntax
client.delete_cloud_connector(
CloudConnectorId='string'
)
string
[REQUIRED]
The ID of the cloud connector to delete.
dict
Response Syntax
{
'CloudConnectorId': 'string'
}
Response Structure
(dict) --
CloudConnectorId (string) --
The ID of the cloud connector that was deleted.
Returns detailed information about a cloud connector.
See also: AWS API Documentation
Request Syntax
client.get_cloud_connector(
CloudConnectorId='string'
)
string
[REQUIRED]
The ID of the cloud connector to retrieve information about.
dict
Response Syntax
{
'CloudConnectorArn': 'string',
'DisplayName': 'string',
'Description': 'string',
'RoleArn': 'string',
'Configuration': {
'AzureConfiguration': {
'TenantId': 'string',
'TenantDisplayName': 'string',
'ApplicationId': 'string',
'ApplicationDisplayName': 'string',
'Targets': {
'Subscriptions': [
{
'Id': 'string',
'DisplayName': 'string'
},
]
}
}
},
'ConfigConnectorArn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
CloudConnectorArn (string) --
The ARN of the cloud connector.
DisplayName (string) --
The friendly name of the cloud connector.
Description (string) --
The description of the cloud connector.
RoleArn (string) --
The ARN of the IAM role used by the cloud connector.
Configuration (dict) --
The configuration details for the third-party cloud environment connection.
AzureConfiguration (dict) --
The access details and targets for connecting to a Microsoft Azure environment.
TenantId (string) --
The ID of the Azure tenant.
TenantDisplayName (string) --
The display name of the Azure tenant.
ApplicationId (string) --
The ID of the Azure application registration used for authentication.
ApplicationDisplayName (string) --
The display name of the Azure application registration.
Targets (dict) --
The target Azure subscriptions for the cloud connector.
Subscriptions (list) --
A list of Azure subscriptions to target.
(dict) --
Information about an Azure subscription targeted by the cloud connector.
Id (string) --
The ID of the Azure subscription.
DisplayName (string) --
The display name of the Azure subscription.
ConfigConnectorArn (string) --
The ARN of the Amazon Web Services Config connector associated with this cloud connector.
CreatedAt (datetime) --
The date and time the cloud connector was created.
UpdatedAt (datetime) --
The date and time the cloud connector was last updated.
Returns a list of cloud connectors in the current Amazon Web Services account and Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
client.list_cloud_connectors(
MaxResults=123,
NextToken='string',
Filters=[
{
'FilterKey': 'SubscriptionId'|'TenantId',
'FilterValues': [
'string',
]
},
]
)
integer
The maximum number of items to return for this call.
string
The token for the next set of items to return. (You received this token from a previous call.)
list
One or more filters to limit the cloud connectors returned in the response.
(dict) --
A filter for listing cloud connectors.
FilterKey (string) --
The name of the filter key.
FilterValues (list) --
The filter values. Valid values for each filter key are as follows:
SubscriptionId
The Azure subscription ID to filter by. To return only tenant-level connectors, specify NONE.
TenantId
The Azure tenant ID to filter by. Filters the results to connectors that target the specified tenant.
(string) --
dict
Response Syntax
{
'CloudConnectors': [
{
'CloudConnectorId': 'string',
'DisplayName': 'string',
'Description': 'string',
'RoleArn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
CloudConnectors (list) --
A list of cloud connector summary objects.
(dict) --
Summary information about a cloud connector.
CloudConnectorId (string) --
The ID of the cloud connector.
DisplayName (string) --
The friendly name of the cloud connector.
Description (string) --
The description of the cloud connector.
RoleArn (string) --
The ARN of the IAM role used by the cloud connector.
CreatedAt (datetime) --
The date and time the cloud connector was created.
UpdatedAt (datetime) --
The date and time the cloud connector was last updated.
NextToken (string) --
The token to use when requesting the next set of items.
Updates an existing cloud connector with new configuration details.
See also: AWS API Documentation
Request Syntax
client.update_cloud_connector(
CloudConnectorId='string',
DisplayName='string',
Configuration={
'AzureConfiguration': {
'TenantId': 'string',
'TenantDisplayName': 'string',
'ApplicationId': 'string',
'ApplicationDisplayName': 'string',
'Targets': {
'Subscriptions': [
{
'Id': 'string',
'DisplayName': 'string'
},
]
}
}
},
Description='string'
)
string
[REQUIRED]
The ID of the cloud connector to update.
string
A new friendly name for the cloud connector.
dict
The updated configuration details for connecting to the third-party cloud environment.
AzureConfiguration (dict) --
The access details and targets for connecting to a Microsoft Azure environment.
TenantId (string) -- [REQUIRED]
The ID of the Azure tenant.
TenantDisplayName (string) --
The display name of the Azure tenant.
ApplicationId (string) -- [REQUIRED]
The ID of the Azure application registration used for authentication.
ApplicationDisplayName (string) --
The display name of the Azure application registration.
Targets (dict) --
The target Azure subscriptions for the cloud connector.
Subscriptions (list) --
A list of Azure subscriptions to target.
(dict) --
Information about an Azure subscription targeted by the cloud connector.
Id (string) -- [REQUIRED]
The ID of the Azure subscription.
DisplayName (string) --
The display name of the Azure subscription.
string
A new description for the cloud connector.
dict
Response Syntax
{
'CloudConnectorId': 'string'
}
Response Structure
(dict) --
CloudConnectorId (string) --
The ID of the cloud connector that was updated.
{'ResourceType': {'CloudConnector'}}
Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your automations, documents, managed nodes, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed nodes that helps you track each node's owner and stack level. For example:
Key=Owner,Value=DbAdmin
Key=Owner,Value=SysAdmin
Key=Owner,Value=Dev
Key=Stack,Value=Production
Key=Stack,Value=Pre-Production
Key=Stack,Value=Test
Most resources can have a maximum of 50 tags. Automations can have a maximum of 5 tags.
We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of characters.
For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tag your Amazon EC2 resources in the Amazon EC2 User Guide.
See also: AWS API Documentation
Request Syntax
client.add_tags_to_resource(
ResourceType='Document'|'ManagedInstance'|'MaintenanceWindow'|'Parameter'|'PatchBaseline'|'OpsItem'|'OpsMetadata'|'Automation'|'Association'|'CloudConnector',
ResourceId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
Specifies the type of resource you are tagging.
string
[REQUIRED]
The resource ID you want to tag.
Use the ID of the resource. Here are some examples:
MaintenanceWindow: mw-012345abcde
PatchBaseline: pb-012345abcde
Automation: example-c160-4567-8519-012345abcde
OpsMetadata object: ResourceID for tagging is created from the Amazon Resource Name (ARN) for the object. Specifically, ResourceID is created from the strings that come after the word opsmetadata in the ARN. For example, an OpsMetadata object with an ARN of arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a ResourceID of either aws/ssm/MyGroup/appmanager or /aws/ssm/MyGroup/appmanager.
For the Document and Parameter values, use the name of the resource. If you're tagging a shared document, you must use the full ARN of the document.
ManagedInstance: mi-012345abcde
list
[REQUIRED]
One or more tags. The value parameter is required.
(dict) --
Metadata that you assign to your Amazon Web Services resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. In Amazon Web Services Systems Manager, you can apply tags to Systems Manager documents (SSM documents), managed nodes, maintenance windows, parameters, patch baselines, OpsItems, and OpsMetadata.
Key (string) -- [REQUIRED]
The name of the tag.
Value (string) -- [REQUIRED]
The value of the tag.
dict
Response Syntax
{}
Response Structure
(dict) --
{'InstanceInformationList': {'SourceLocation': 'string',
'SourceType': {'Microsoft.Compute/virtualMachines'}}}
Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address. This operation does not return information for nodes that are either Stopped or Terminated.
If you specify one or more node IDs, the operation returns information for those managed nodes. If you don't specify node IDs, it returns information for all your managed nodes. If you specify a node ID that isn't valid or a node that you don't own, you receive an error.
See also: AWS API Documentation
Request Syntax
client.describe_instance_information(
InstanceInformationFilterList=[
{
'key': 'InstanceIds'|'AgentVersion'|'PingStatus'|'PlatformTypes'|'ActivationIds'|'IamRole'|'ResourceType'|'AssociationStatus',
'valueSet': [
'string',
]
},
],
Filters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
list
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 filtering based on tags applied to managed nodes.
(dict) --
Describes a filter for a specific list of managed nodes. You can filter node information by using tags. You specify tags by using a key-value mapping.
Use this operation instead of the DescribeInstanceInformationRequest$InstanceInformationFilterList method. The InstanceInformationFilterList method is a legacy method and doesn't support tags.
key (string) -- [REQUIRED]
The name of the filter.
valueSet (list) -- [REQUIRED]
The filter values.
(string) --
list
One or more filters. Use a filter to return a more specific list of managed nodes. You can filter based on tags applied to your managed nodes. Tag filters can't be combined with other filter types. Use this Filters data type instead of InstanceInformationFilterList, which is deprecated.
(dict) --
The filters to describe or get information about your managed nodes.
Key (string) -- [REQUIRED]
The filter key name to describe your managed nodes.
Valid filter key values: ActivationIds | AgentVersion | AssociationStatus | IamRole | InstanceIds | PingStatus | PlatformTypes | ResourceType | SourceIds | SourceTypes | "tag-key" | "tag: {keyname}
Valid values for the AssociationStatus filter key: Success | Pending | Failed
Valid values for the PingStatus filter key: Online | ConnectionLost | Inactive (deprecated)
Valid values for the PlatformTypes filter key: Windows | Linux | MacOS
Valid values for the ResourceType filter key: EC2Instance | ManagedInstance
Valid values for the SourceType filter key: AWS::EC2::Instance | AWS::SSM::ManagedInstance | AWS::IoT::Thing | Microsoft.Compute/virtualMachines
Valid tag examples: Key=tag-key,Values=Purpose | Key=tag:Purpose,Values=Test.
Values (list) -- [REQUIRED]
The filter values.
(string) --
integer
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. The default value is 10 items.
string
The token for the next set of items to return. (You received this token from a previous call.)
dict
Response Syntax
{
'InstanceInformationList': [
{
'InstanceId': 'string',
'PingStatus': 'Online'|'ConnectionLost'|'Inactive',
'LastPingDateTime': datetime(2015, 1, 1),
'AgentVersion': 'string',
'IsLatestVersion': True|False,
'PlatformType': 'Windows'|'Linux'|'MacOS',
'PlatformName': 'string',
'PlatformVersion': 'string',
'ActivationId': 'string',
'IamRole': 'string',
'RegistrationDate': datetime(2015, 1, 1),
'ResourceType': 'ManagedInstance'|'EC2Instance',
'Name': 'string',
'IPAddress': 'string',
'ComputerName': 'string',
'AssociationStatus': 'string',
'LastAssociationExecutionDate': datetime(2015, 1, 1),
'LastSuccessfulAssociationExecutionDate': datetime(2015, 1, 1),
'AssociationOverview': {
'DetailedStatus': 'string',
'InstanceAssociationStatusAggregatedCount': {
'string': 123
}
},
'SourceId': 'string',
'SourceType': 'AWS::EC2::Instance'|'AWS::IoT::Thing'|'AWS::SSM::ManagedInstance'|'Microsoft.Compute/virtualMachines',
'SourceLocation': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
InstanceInformationList (list) --
The managed node information list.
(dict) --
Describes a filter for a specific list of managed nodes.
InstanceId (string) --
The managed node ID.
PingStatus (string) --
Connection status of SSM Agent.
LastPingDateTime (datetime) --
The date and time when the agent last pinged the Systems Manager service.
AgentVersion (string) --
The version of SSM Agent running on your Linux managed node.
IsLatestVersion (boolean) --
Indicates whether the latest version of SSM Agent is running on your Linux managed node. This field doesn't indicate whether or not the latest version is installed on Windows managed nodes, because some older versions of Windows Server use the EC2Config service to process Systems Manager requests.
PlatformType (string) --
The operating system platform type.
PlatformName (string) --
The name of the operating system platform running on your managed node.
PlatformVersion (string) --
The version of the OS platform running on your managed node.
ActivationId (string) --
The activation ID created by Amazon Web Services Systems Manager when the server or virtual machine (VM) was registered.
IamRole (string) --
The role assigned to an Amazon EC2 instance configured with a Systems Manager Quick Setup host management configuration or the role assigned to an on-premises managed node.
This call doesn't return the IAM role for unmanaged Amazon EC2 instances (instances not configured for Systems Manager). To retrieve the role for an unmanaged instance, use the Amazon EC2 DescribeInstances operation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the Amazon Web Services CLI Command Reference.
RegistrationDate (datetime) --
The date the server or VM was registered with Amazon Web Services as a managed node.
ResourceType (string) --
The type of instance. Instances are either EC2 instances or managed instances.
Name (string) --
The name assigned to an on-premises server, edge device, or virtual machine (VM) when it is activated as a Systems Manager managed node. The name is specified as the DefaultInstanceName property using the CreateActivation command. It is applied to the managed node by specifying the Activation Code and Activation ID when you install SSM Agent on the node, as explained in How to install SSM Agent on hybrid Linux nodes and How to install SSM Agent on hybrid Windows Server nodes. To retrieve the Name tag of an EC2 instance, use the Amazon EC2 DescribeInstances operation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the Amazon Web Services CLI Command Reference.
IPAddress (string) --
The IP address of the managed node.
ComputerName (string) --
The fully qualified host name of the managed node.
AssociationStatus (string) --
The status of the association.
LastAssociationExecutionDate (datetime) --
The date the association was last run.
LastSuccessfulAssociationExecutionDate (datetime) --
The last date the association was successfully run.
AssociationOverview (dict) --
Information about the association.
DetailedStatus (string) --
Detailed status information about the aggregated associations.
InstanceAssociationStatusAggregatedCount (dict) --
The number of associations for the managed nodes.
(string) --
(integer) --
SourceId (string) --
The ID of the source resource. For IoT Greengrass devices, SourceId is the Thing name.
SourceType (string) --
The type of the source resource. For IoT Greengrass devices, SourceType is AWS::IoT::Thing. For Azure Virtual Machines, SourceType is Microsoft.Compute/virtualMachines.
SourceLocation (string) --
The location of the source resource in the third-party cloud environment.
NextToken (string) --
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
{'InstanceProperties': {'AvailabilityZone': 'string',
'SourceLocation': 'string',
'SourceType': {'Microsoft.Compute/virtualMachines'}}}
An API operation used by the Systems Manager console to display information about Systems Manager managed nodes.
See also: AWS API Documentation
Request Syntax
client.describe_instance_properties(
InstancePropertyFilterList=[
{
'key': 'InstanceIds'|'AgentVersion'|'PingStatus'|'PlatformTypes'|'DocumentName'|'ActivationIds'|'IamRole'|'ResourceType'|'AssociationStatus',
'valueSet': [
'string',
]
},
],
FiltersWithOperator=[
{
'Key': 'string',
'Values': [
'string',
],
'Operator': 'Equal'|'NotEqual'|'BeginWith'|'LessThan'|'GreaterThan'
},
],
MaxResults=123,
NextToken='string'
)
list
An array of instance property filters.
(dict) --
Describes a filter for a specific list of managed nodes. You can filter node information by using tags. You specify tags by using a key-value mapping.
key (string) -- [REQUIRED]
The name of the filter.
valueSet (list) -- [REQUIRED]
The filter values.
(string) --
list
The request filters to use with the operator.
(dict) --
The filters to describe or get information about your managed nodes.
Key (string) -- [REQUIRED]
The filter key name to describe your managed nodes.
Values (list) -- [REQUIRED]
The filter key name to describe your managed nodes.
(string) --
Operator (string) --
The operator used by the filter call.
integer
The maximum number of items to return for the call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
string
The token provided by a previous request to use to return the next set of properties.
dict
Response Syntax
{
'InstanceProperties': [
{
'Name': 'string',
'InstanceId': 'string',
'InstanceType': 'string',
'InstanceRole': 'string',
'KeyName': 'string',
'InstanceState': 'string',
'Architecture': 'string',
'IPAddress': 'string',
'LaunchTime': datetime(2015, 1, 1),
'PingStatus': 'Online'|'ConnectionLost'|'Inactive',
'LastPingDateTime': datetime(2015, 1, 1),
'AgentVersion': 'string',
'PlatformType': 'Windows'|'Linux'|'MacOS',
'PlatformName': 'string',
'PlatformVersion': 'string',
'ActivationId': 'string',
'IamRole': 'string',
'RegistrationDate': datetime(2015, 1, 1),
'ResourceType': 'string',
'ComputerName': 'string',
'AssociationStatus': 'string',
'LastAssociationExecutionDate': datetime(2015, 1, 1),
'LastSuccessfulAssociationExecutionDate': datetime(2015, 1, 1),
'AssociationOverview': {
'DetailedStatus': 'string',
'InstanceAssociationStatusAggregatedCount': {
'string': 123
}
},
'SourceId': 'string',
'SourceType': 'AWS::EC2::Instance'|'AWS::IoT::Thing'|'AWS::SSM::ManagedInstance'|'Microsoft.Compute/virtualMachines',
'SourceLocation': 'string',
'AvailabilityZone': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
InstanceProperties (list) --
Properties for the managed instances.
(dict) --
An object containing various properties of a managed node.
Name (string) --
The value of the EC2 Name tag associated with the node. If a Name tag hasn't been applied to the node, this value is blank.
InstanceId (string) --
The ID of the managed node.
InstanceType (string) --
The instance type of the managed node. For example, t3.large.
InstanceRole (string) --
The instance profile attached to the node. If an instance profile isn't attached to the node, this value is blank.
KeyName (string) --
The name of the key pair associated with the node. If a key pair isnt't associated with the node, this value is blank.
InstanceState (string) --
The current state of the node.
Architecture (string) --
The CPU architecture of the node. For example, x86_64.
IPAddress (string) --
The public IPv4 address assigned to the node. If a public IPv4 address isn't assigned to the node, this value is blank.
LaunchTime (datetime) --
The timestamp for when the node was launched.
PingStatus (string) --
Connection status of the SSM Agent on the managed node.
LastPingDateTime (datetime) --
The date and time when the SSM Agent last pinged the Systems Manager service.
AgentVersion (string) --
The version of SSM Agent running on your managed node.
PlatformType (string) --
The operating system platform type of the managed node. For example, Windows Server or Amazon Linux 2.
PlatformName (string) --
The name of the operating system platform running on your managed node.
PlatformVersion (string) --
The version of the OS platform running on your managed node.
ActivationId (string) --
The activation ID created by Systems Manager when the server or virtual machine (VM) was registered
IamRole (string) --
The IAM role used in the hybrid activation to register the node with Systems Manager.
RegistrationDate (datetime) --
The date the node was registered with Systems Manager.
ResourceType (string) --
The type of managed node.
ComputerName (string) --
The fully qualified host name of the managed node.
AssociationStatus (string) --
The status of the State Manager association applied to the managed node.
LastAssociationExecutionDate (datetime) --
The date the association was last run.
LastSuccessfulAssociationExecutionDate (datetime) --
The last date the association was successfully run.
AssociationOverview (dict) --
Status information about the aggregated associations.
DetailedStatus (string) --
Detailed status information about the aggregated associations.
InstanceAssociationStatusAggregatedCount (dict) --
The number of associations for the managed nodes.
(string) --
(integer) --
SourceId (string) --
The ID of the source resource.
SourceType (string) --
The type of the source resource. Valid values: AWS::EC2::Instance | AWS::SSM::ManagedInstance | AWS::IoT::Thing | Microsoft.Compute/virtualMachines.
SourceLocation (string) --
The location of the source resource in the third-party cloud environment.
AvailabilityZone (string) --
The Availability Zone where the managed node is located.
NextToken (string) --
The token for the next set of properties to return. Use this token to get the next set of results.
{'AssociationFilterList': {'key': {'CloudConnectorId'}}}
Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results to a specific State Manager association document or managed node by specifying a filter. State Manager is a tool in Amazon Web Services Systems Manager.
See also: AWS API Documentation
Request Syntax
client.list_associations(
AssociationFilterList=[
{
'key': 'InstanceId'|'Name'|'AssociationId'|'AssociationStatusName'|'LastExecutedBefore'|'LastExecutedAfter'|'AssociationName'|'ResourceGroupName'|'CloudConnectorId',
'value': 'string'
},
],
MaxResults=123,
NextToken='string'
)
list
One or more filters. Use a filter to return a more specific list of results.
(dict) --
Describes a filter.
key (string) -- [REQUIRED]
The name of the filter.
value (string) -- [REQUIRED]
The filter value.
integer
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.
string
The token for the next set of items to return. (You received this token from a previous call.)
dict
Response Syntax
{
'Associations': [
{
'Name': 'string',
'InstanceId': 'string',
'AssociationId': 'string',
'AssociationVersion': 'string',
'DocumentVersion': 'string',
'Targets': [
{
'Key': 'string',
'Values': [
'string',
]
},
],
'LastExecutionDate': datetime(2015, 1, 1),
'Overview': {
'Status': 'string',
'DetailedStatus': 'string',
'AssociationStatusAggregatedCount': {
'string': 123
}
},
'ScheduleExpression': 'string',
'AssociationName': 'string',
'ScheduleOffset': 123,
'Duration': 123,
'TargetMaps': [
{
'string': [
'string',
]
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Associations (list) --
The associations.
(dict) --
Describes an association of a Amazon Web Services Systems Manager document (SSM document) and a managed node.
Name (string) --
The name of the SSM document.
InstanceId (string) --
The managed node ID.
AssociationId (string) --
The ID created by the system when you create an association. An association is a binding between a document and a set of targets with a schedule.
AssociationVersion (string) --
The association version.
DocumentVersion (string) --
The version of the document used in the association. If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.
Targets (list) --
The managed nodes targeted by the request to create an association. You can target all managed nodes in an Amazon Web Services account by specifying the InstanceIds key with a value of *.
(dict) --
An array of search criteria that targets managed nodes using a key-value pair that you specify.
Supported formats include the following.
For all Systems Manager tools:
Key=tag-key,Values=tag-value-1,tag-value-2
For Automation and Change Manager:
Key=tag:tag-key,Values=tag-value
Key=ResourceGroup,Values=resource-group-name
Key=ParameterValues,Values=value-1,value-2,value-3
To target all instances in the Amazon Web Services Region:
Key=AWS::EC2::Instance,Values=*
Key=InstanceIds,Values=*
For Run Command and Maintenance Windows:
Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3
Key=tag:tag-key,Values=tag-value-1,tag-value-2
Key=resource-groups:Name,Values=resource-group-name
Additionally, Maintenance Windows support targeting resource types:
Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2
For State Manager:
Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3
Key=tag:tag-key,Values=tag-value-1,tag-value-2
To target all instances in the Amazon Web Services Region:
Key=InstanceIds,Values=*
For more information about how to send commands that target managed nodes using Key,Value parameters, see Targeting multiple managed nodes in the Amazon Web Services Systems Manager User Guide.
Key (string) --
User-defined criteria for sending commands that target managed nodes that meet the criteria.
Values (list) --
User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include EC2 tags of ServerRole,WebServer.
Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.
(string) --
LastExecutionDate (datetime) --
The date on which the association was last run.
Overview (dict) --
Information about the association.
Status (string) --
The status of the association. Status can be: Pending, Success, or Failed.
DetailedStatus (string) --
A detailed status of the association.
AssociationStatusAggregatedCount (dict) --
Returns the number of targets for the association status. For example, if you created an association with two managed nodes, and one of them was successful, this would return the count of managed nodes by status.
(string) --
(integer) --
ScheduleExpression (string) --
A cron expression that specifies a schedule when the association runs. The schedule runs in Coordinated Universal Time (UTC).
AssociationName (string) --
The association name.
ScheduleOffset (integer) --
Number of days to wait after the scheduled day to run an association.
Duration (integer) --
The number of hours that an association can run on specified targets. After the resulting cutoff time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets.
TargetMaps (list) --
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
(dict) --
(string) --
(list) --
(string) --
NextToken (string) --
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
{'Filters': {'Key': {'AvailabilityZone',
'AvailabilityZoneId',
'SourceId',
'SourceLocation',
'SourceType'}}}
Response {'Nodes': {'NodeType': {'Instance': {'AvailabilityZone': 'string',
'AvailabilityZoneId': 'string',
'Name': 'string',
'SourceId': 'string',
'SourceLocation': 'string',
'SourceType': 'AWS::EC2::Instance | '
'AWS::IoT::Thing | '
'AWS::SSM::ManagedInstance '
'| '
'Microsoft.Compute/virtualMachines'}}}}
Takes in filters and returns a list of managed nodes matching the filter criteria.
See also: AWS API Documentation
Request Syntax
client.list_nodes(
SyncName='string',
Filters=[
{
'Key': 'AgentType'|'AgentVersion'|'ComputerName'|'InstanceId'|'InstanceStatus'|'IpAddress'|'ManagedStatus'|'PlatformName'|'PlatformType'|'PlatformVersion'|'ResourceType'|'OrganizationalUnitId'|'OrganizationalUnitPath'|'Region'|'AccountId'|'SourceType'|'SourceId'|'SourceLocation'|'AvailabilityZone'|'AvailabilityZoneId',
'Values': [
'string',
],
'Type': 'Equal'|'NotEqual'|'BeginWith'
},
],
NextToken='string',
MaxResults=123
)
string
The name of the Amazon Web Services managed resource data sync to retrieve information about.
For cross-account/cross-Region configurations, this parameter is required, and the name of the supported resource data sync is AWS-QuickSetup-ManagedNode.
For single account/single-Region configurations, the parameter is not required.
list
One or more filters. Use a filter to return a more specific list of managed nodes.
(dict) --
The filters for the operation.
Key (string) -- [REQUIRED]
The name of the filter.
Values (list) -- [REQUIRED]
A filter value supported by the specified key. For example, for the key PlatformType, supported values include Linux and Windows.
(string) --
Type (string) --
The type of filter operator.
string
The token for the next set of items to return. (You received this token from a previous call.)
integer
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.
dict
Response Syntax
{
'Nodes': [
{
'CaptureTime': datetime(2015, 1, 1),
'Id': 'string',
'Owner': {
'AccountId': 'string',
'OrganizationalUnitId': 'string',
'OrganizationalUnitPath': 'string'
},
'Region': 'string',
'NodeType': {
'Instance': {
'AgentType': 'string',
'AgentVersion': 'string',
'ComputerName': 'string',
'InstanceStatus': 'string',
'IpAddress': 'string',
'ManagedStatus': 'All'|'Managed'|'Unmanaged',
'Name': 'string',
'PlatformType': 'Windows'|'Linux'|'MacOS',
'PlatformName': 'string',
'PlatformVersion': 'string',
'ResourceType': 'ManagedInstance'|'EC2Instance',
'SourceType': 'AWS::EC2::Instance'|'AWS::IoT::Thing'|'AWS::SSM::ManagedInstance'|'Microsoft.Compute/virtualMachines',
'SourceId': 'string',
'SourceLocation': 'string',
'AvailabilityZone': 'string',
'AvailabilityZoneId': 'string'
}
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Nodes (list) --
A list of managed nodes that match the specified filter criteria.
(dict) --
Details about an individual managed node.
CaptureTime (datetime) --
The UTC timestamp for when the managed node data was last captured.
Id (string) --
The ID of the managed node.
Owner (dict) --
Information about the ownership of the managed node.
AccountId (string) --
The ID of the Amazon Web Services account that owns the managed node.
OrganizationalUnitId (string) --
The ID of the organization unit (OU) that the account is part of.
OrganizationalUnitPath (string) --
The path for the organizational unit (OU) that owns the managed node. The path for the OU is built using the IDs of the organization, root, and all OUs in the path down to and including the OU. For example:
o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-ghi0-awsccccc/ou-jkl0-awsddddd/
Region (string) --
The Amazon Web Services Region that a managed node was created in or assigned to.
NodeType (dict) --
Information about the type of node.
Instance (dict) --
Information about a specific managed node.
AgentType (string) --
The type of agent installed on the node.
AgentVersion (string) --
The version number of the agent installed on the node.
ComputerName (string) --
The fully qualified host name of the managed node.
InstanceStatus (string) --
The current status of the managed node.
IpAddress (string) --
The IP address of the managed node.
ManagedStatus (string) --
Indicates whether the node is managed by Systems Manager.
Name (string) --
The name assigned to the managed node.
PlatformType (string) --
The operating system platform type of the managed node.
PlatformName (string) --
The name of the operating system platform running on your managed node.
PlatformVersion (string) --
The version of the OS platform running on your managed node.
ResourceType (string) --
The type of instance, either an EC2 instance or another supported machine type in a hybrid fleet.
SourceType (string) --
The type of the source resource. For IoT Greengrass devices, SourceType is AWS::IoT::Thing.
SourceId (string) --
The ID of the source resource. For IoT Greengrass devices, SourceId is the Thing name.
SourceLocation (string) --
The location of the source resource in the third-party cloud environment.
AvailabilityZone (string) --
The Availability Zone where the managed node is located.
AvailabilityZoneId (string) --
The Availability Zone ID where the managed node is located.
NextToken (string) --
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
{'Aggregators': {'AttributeName': {'SourceType', 'AvailabilityZone'}},
'Filters': {'Key': {'AvailabilityZone',
'AvailabilityZoneId',
'SourceId',
'SourceLocation',
'SourceType'}}}
Generates a summary of managed instance/node metadata based on the filters and aggregators you specify. Results are grouped by the input aggregator you specify.
See also: AWS API Documentation
Request Syntax
client.list_nodes_summary(
SyncName='string',
Filters=[
{
'Key': 'AgentType'|'AgentVersion'|'ComputerName'|'InstanceId'|'InstanceStatus'|'IpAddress'|'ManagedStatus'|'PlatformName'|'PlatformType'|'PlatformVersion'|'ResourceType'|'OrganizationalUnitId'|'OrganizationalUnitPath'|'Region'|'AccountId'|'SourceType'|'SourceId'|'SourceLocation'|'AvailabilityZone'|'AvailabilityZoneId',
'Values': [
'string',
],
'Type': 'Equal'|'NotEqual'|'BeginWith'
},
],
Aggregators=[
{
'AggregatorType': 'Count',
'TypeName': 'Instance',
'AttributeName': 'AgentVersion'|'PlatformName'|'PlatformType'|'PlatformVersion'|'Region'|'ResourceType'|'SourceType'|'AvailabilityZone',
'Aggregators': {'... recursive ...'}
},
],
NextToken='string',
MaxResults=123
)
string
The name of the Amazon Web Services managed resource data sync to retrieve information about.
For cross-account/cross-Region configurations, this parameter is required, and the name of the supported resource data sync is AWS-QuickSetup-ManagedNode.
For single account/single-Region configurations, the parameter is not required.
list
One or more filters. Use a filter to generate a summary that matches your specified filter criteria.
(dict) --
The filters for the operation.
Key (string) -- [REQUIRED]
The name of the filter.
Values (list) -- [REQUIRED]
A filter value supported by the specified key. For example, for the key PlatformType, supported values include Linux and Windows.
(string) --
Type (string) --
The type of filter operator.
list
[REQUIRED]
Specify one or more aggregators to return a count of managed nodes that match that expression. For example, a count of managed nodes by operating system.
(dict) --
One or more aggregators for viewing counts of nodes using different dimensions.
AggregatorType (string) -- [REQUIRED]
The aggregator type for limiting a node summary. Currently, only Count is supported.
TypeName (string) -- [REQUIRED]
The data type name to use for viewing counts of nodes. Currently, only Instance is supported.
AttributeName (string) -- [REQUIRED]
The name of a node attribute on which to limit the count of nodes.
Aggregators (list) --
Information about aggregators used to refine a node summary.
string
The token for the next set of items to return. (You received this token from a previous call.) The call also returns a token that you can specify in a subsequent call to get the next set of results.
integer
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.
dict
Response Syntax
{
'Summary': [
{
'string': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Summary (list) --
A collection of objects reporting information about your managed nodes, such as the count of nodes by operating system.
(dict) --
(string) --
(string) --
NextToken (string) --
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
{'ResourceType': {'CloudConnector'}}
Returns a list of the tags assigned to the specified resource.
For information about the ID format for each supported resource type, see AddTagsToResource.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
ResourceType='Document'|'ManagedInstance'|'MaintenanceWindow'|'Parameter'|'PatchBaseline'|'OpsItem'|'OpsMetadata'|'Automation'|'Association'|'CloudConnector',
ResourceId='string'
)
string
[REQUIRED]
Returns a list of tags for a specific resource type.
string
[REQUIRED]
The resource ID for which you want to see a list of tags.
dict
Response Syntax
{
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
TagList (list) --
A list of tags.
(dict) --
Metadata that you assign to your Amazon Web Services resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. In Amazon Web Services Systems Manager, you can apply tags to Systems Manager documents (SSM documents), managed nodes, maintenance windows, parameters, patch baselines, OpsItems, and OpsMetadata.
Key (string) --
The name of the tag.
Value (string) --
The value of the tag.
{'ResourceType': {'CloudConnector'}}
Removes tag keys from the specified resource.
See also: AWS API Documentation
Request Syntax
client.remove_tags_from_resource(
ResourceType='Document'|'ManagedInstance'|'MaintenanceWindow'|'Parameter'|'PatchBaseline'|'OpsItem'|'OpsMetadata'|'Automation'|'Association'|'CloudConnector',
ResourceId='string',
TagKeys=[
'string',
]
)
string
[REQUIRED]
The type of resource from which you want to remove a tag.
string
[REQUIRED]
The ID of the resource from which you want to remove tags. For example:
ManagedInstance: mi-012345abcde
MaintenanceWindow: mw-012345abcde
Automation: example-c160-4567-8519-012345abcde
PatchBaseline: pb-012345abcde
OpsMetadata object: ResourceID for tagging is created from the Amazon Resource Name (ARN) for the object. Specifically, ResourceID is created from the strings that come after the word opsmetadata in the ARN. For example, an OpsMetadata object with an ARN of arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a ResourceID of either aws/ssm/MyGroup/appmanager or /aws/ssm/MyGroup/appmanager.
For the Document and Parameter values, use the name of the resource.
list
[REQUIRED]
Tag keys that you want to remove from the specified resource.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --