2026/11/13 - Amazon Simple Systems Manager (SSM) - 9 updated api methods
Changes Adding Google Cloud Platform (GCP) support to SSM Cloud Connector to enable onboarding of GCP Compute Engine instances to AWS Systems Manager. Customers can now optionally create an SSM Cloud Connector without an AWS Config connector.
{'Configuration': {'GcpConfiguration': {'OrganizationId': 'string',
'ServiceAccountEmail': 'string',
'Targets': {'Projects': [{'ProjectDisplayName': 'string',
'ProjectId': 'string'}]},
'WorkloadIdentityPoolProvider': 'string'}}}
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'
},
]
}
},
'GcpConfiguration': {
'OrganizationId': 'string',
'WorkloadIdentityPoolProvider': 'string',
'ServiceAccountEmail': 'string',
'Targets': {
'Projects': [
{
'ProjectId': 'string',
'ProjectDisplayName': '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.
GcpConfiguration (dict) --
The access details and targets for connecting to a Google Cloud Platform (GCP) environment.
OrganizationId (string) --
The ID of the GCP organization.
WorkloadIdentityPoolProvider (string) -- [REQUIRED]
The full resource name of the GCP workload identity pool provider used for authentication.
ServiceAccountEmail (string) -- [REQUIRED]
The email address of the GCP service account used for authentication.
Targets (dict) --
The target GCP projects for the cloud connector.
Projects (list) --
A list of GCP projects to target.
(dict) --
Information about a GCP project targeted by the cloud connector.
ProjectId (string) -- [REQUIRED]
The ID of the GCP project.
ProjectDisplayName (string) --
The display name of the GCP project.
string
The ARN of the Amazon Web Services Config connector to associate with this cloud connector. If you omit it, the cloud connector is created without Amazon Web Services Config integration.
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.
{'InstanceInformationList': {'SourceType': {'compute.googleapis.com/Instance'}}}
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 | compute.googleapis.com/Instance
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'|'compute.googleapis.com/Instance',
'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. For Google Cloud Platform (GCP) Compute Engine Virtual Machines, SourceType is compute.googleapis.com/Instance.
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': {'SourceType': {'compute.googleapis.com/Instance'}}}
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'|'compute.googleapis.com/Instance',
'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 | compute.googleapis.com/Instance.
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.
{'AutomationExecution': {'TargetsSummary': {'CompletedCount': 'integer',
'FailedCount': 'integer',
'StartedCount': 'integer',
'SuccessfulCount': 'integer',
'TotalCount': 'integer'}}}
Get detailed information about a particular Automation execution.
See also: AWS API Documentation
Request Syntax
client.get_automation_execution(
AutomationExecutionId='string'
)
string
[REQUIRED]
The unique identifier for an existing automation execution to examine. The execution ID is returned by StartAutomationExecution when the execution of an Automation runbook is initiated.
dict
Response Syntax
{
'AutomationExecution': {
'AutomationExecutionId': 'string',
'DocumentName': 'string',
'DocumentVersion': 'string',
'ExecutionStartTime': datetime(2015, 1, 1),
'ExecutionEndTime': datetime(2015, 1, 1),
'AutomationExecutionStatus': 'Pending'|'InProgress'|'Waiting'|'Success'|'TimedOut'|'Cancelling'|'Cancelled'|'Failed'|'PendingApproval'|'Approved'|'Rejected'|'Scheduled'|'RunbookInProgress'|'PendingChangeCalendarOverride'|'ChangeCalendarOverrideApproved'|'ChangeCalendarOverrideRejected'|'CompletedWithSuccess'|'CompletedWithFailure'|'Exited',
'StepExecutions': [
{
'StepName': 'string',
'Action': 'string',
'TimeoutSeconds': 123,
'OnFailure': 'string',
'MaxAttempts': 123,
'ExecutionStartTime': datetime(2015, 1, 1),
'ExecutionEndTime': datetime(2015, 1, 1),
'StepStatus': 'Pending'|'InProgress'|'Waiting'|'Success'|'TimedOut'|'Cancelling'|'Cancelled'|'Failed'|'PendingApproval'|'Approved'|'Rejected'|'Scheduled'|'RunbookInProgress'|'PendingChangeCalendarOverride'|'ChangeCalendarOverrideApproved'|'ChangeCalendarOverrideRejected'|'CompletedWithSuccess'|'CompletedWithFailure'|'Exited',
'ResponseCode': 'string',
'Inputs': {
'string': 'string'
},
'Outputs': {
'string': [
'string',
]
},
'Response': 'string',
'FailureMessage': 'string',
'WarningMessage': 'string',
'FailureDetails': {
'FailureStage': 'string',
'FailureType': 'string',
'Details': {
'string': [
'string',
]
}
},
'StepExecutionId': 'string',
'OverriddenParameters': {
'string': [
'string',
]
},
'IsEnd': True|False,
'NextStep': 'string',
'IsCritical': True|False,
'ValidNextSteps': [
'string',
],
'Targets': [
{
'Key': 'string',
'Values': [
'string',
]
},
],
'TargetLocation': {
'Accounts': [
'string',
],
'Regions': [
'string',
],
'TargetLocationMaxConcurrency': 'string',
'TargetLocationMaxErrors': 'string',
'ExecutionRoleName': 'string',
'TargetLocationAlarmConfiguration': {
'IgnorePollAlarmFailure': True|False,
'Alarms': [
{
'Name': 'string'
},
]
},
'IncludeChildOrganizationUnits': True|False,
'ExcludeAccounts': [
'string',
],
'Targets': [
{
'Key': 'string',
'Values': [
'string',
]
},
],
'TargetsMaxConcurrency': 'string',
'TargetsMaxErrors': 'string'
},
'TriggeredAlarms': [
{
'Name': 'string',
'State': 'UNKNOWN'|'ALARM'
},
],
'ParentStepDetails': {
'StepExecutionId': 'string',
'StepName': 'string',
'Action': 'string',
'Iteration': 123,
'IteratorValue': 'string'
}
},
],
'StepExecutionsTruncated': True|False,
'Parameters': {
'string': [
'string',
]
},
'Outputs': {
'string': [
'string',
]
},
'FailureMessage': 'string',
'WarningMessage': 'string',
'Mode': 'Auto'|'Interactive',
'ParentAutomationExecutionId': 'string',
'ExecutedBy': 'string',
'CurrentStepName': 'string',
'CurrentAction': 'string',
'TargetParameterName': 'string',
'Targets': [
{
'Key': 'string',
'Values': [
'string',
]
},
],
'TargetMaps': [
{
'string': [
'string',
]
},
],
'ResolvedTargets': {
'ParameterValues': [
'string',
],
'Truncated': True|False
},
'MaxConcurrency': 'string',
'MaxErrors': 'string',
'Target': 'string',
'TargetLocations': [
{
'Accounts': [
'string',
],
'Regions': [
'string',
],
'TargetLocationMaxConcurrency': 'string',
'TargetLocationMaxErrors': 'string',
'ExecutionRoleName': 'string',
'TargetLocationAlarmConfiguration': {
'IgnorePollAlarmFailure': True|False,
'Alarms': [
{
'Name': 'string'
},
]
},
'IncludeChildOrganizationUnits': True|False,
'ExcludeAccounts': [
'string',
],
'Targets': [
{
'Key': 'string',
'Values': [
'string',
]
},
],
'TargetsMaxConcurrency': 'string',
'TargetsMaxErrors': 'string'
},
],
'ProgressCounters': {
'TotalSteps': 123,
'SuccessSteps': 123,
'FailedSteps': 123,
'CancelledSteps': 123,
'TimedOutSteps': 123
},
'AlarmConfiguration': {
'IgnorePollAlarmFailure': True|False,
'Alarms': [
{
'Name': 'string'
},
]
},
'TriggeredAlarms': [
{
'Name': 'string',
'State': 'UNKNOWN'|'ALARM'
},
],
'TargetLocationsURL': 'string',
'AutomationSubtype': 'ChangeRequest'|'AccessRequest',
'ScheduledTime': datetime(2015, 1, 1),
'Runbooks': [
{
'DocumentName': 'string',
'DocumentVersion': 'string',
'Parameters': {
'string': [
'string',
]
},
'TargetParameterName': 'string',
'Targets': [
{
'Key': 'string',
'Values': [
'string',
]
},
],
'TargetMaps': [
{
'string': [
'string',
]
},
],
'MaxConcurrency': 'string',
'MaxErrors': 'string',
'TargetLocations': [
{
'Accounts': [
'string',
],
'Regions': [
'string',
],
'TargetLocationMaxConcurrency': 'string',
'TargetLocationMaxErrors': 'string',
'ExecutionRoleName': 'string',
'TargetLocationAlarmConfiguration': {
'IgnorePollAlarmFailure': True|False,
'Alarms': [
{
'Name': 'string'
},
]
},
'IncludeChildOrganizationUnits': True|False,
'ExcludeAccounts': [
'string',
],
'Targets': [
{
'Key': 'string',
'Values': [
'string',
]
},
],
'TargetsMaxConcurrency': 'string',
'TargetsMaxErrors': 'string'
},
]
},
],
'OpsItemId': 'string',
'AssociationId': 'string',
'ChangeRequestName': 'string',
'Variables': {
'string': [
'string',
]
},
'TargetsSummary': {
'TotalCount': 123,
'StartedCount': 123,
'CompletedCount': 123,
'SuccessfulCount': 123,
'FailedCount': 123
}
}
}
Response Structure
(dict) --
AutomationExecution (dict) --
Detailed information about the current state of an automation execution.
AutomationExecutionId (string) --
The execution ID.
DocumentName (string) --
The name of the Automation runbook used during the execution.
DocumentVersion (string) --
The version of the document to use during execution.
ExecutionStartTime (datetime) --
The time the execution started.
ExecutionEndTime (datetime) --
The time the execution finished.
AutomationExecutionStatus (string) --
The execution status of the Automation.
StepExecutions (list) --
A list of details about the current state of all steps that comprise an execution. An Automation runbook contains a list of steps that are run in order.
(dict) --
Detailed information about an the execution state of an Automation step.
StepName (string) --
The name of this execution step.
Action (string) --
The action this step performs. The action determines the behavior of the step.
TimeoutSeconds (integer) --
The timeout seconds of the step.
OnFailure (string) --
The action to take if the step fails. The default value is Abort.
MaxAttempts (integer) --
The maximum number of tries to run the action of the step. The default value is 1.
ExecutionStartTime (datetime) --
If a step has begun execution, this contains the time the step started. If the step is in Pending status, this field isn't populated.
ExecutionEndTime (datetime) --
If a step has finished execution, this contains the time the execution ended. If the step hasn't yet concluded, this field isn't populated.
StepStatus (string) --
The execution status for this step.
ResponseCode (string) --
The response code returned by the execution of the step.
Inputs (dict) --
Fully-resolved values passed into the step before execution.
(string) --
(string) --
Outputs (dict) --
Returned values from the execution of the step.
(string) --
(list) --
(string) --
Response (string) --
A message associated with the response code for an execution.
FailureMessage (string) --
If a step failed, this message explains why the execution failed.
WarningMessage (string) --
A message that describes a non-critical issue that occurred during the step execution. Present only if the step status includes a warning.
FailureDetails (dict) --
Information about the Automation failure.
FailureStage (string) --
The stage of the Automation execution when the failure occurred. The stages include the following: InputValidation, PreVerification, Invocation, PostVerification.
FailureType (string) --
The type of Automation failure. Failure types include the following: Action, Permission, Throttling, Verification, Internal.
Details (dict) --
Detailed information about the Automation step failure.
(string) --
(list) --
(string) --
StepExecutionId (string) --
The unique ID of a step execution.
OverriddenParameters (dict) --
A user-specified list of parameters to override when running a step.
(string) --
(list) --
(string) --
IsEnd (boolean) --
The flag which can be used to end automation no matter whether the step succeeds or fails.
NextStep (string) --
The next step after the step succeeds.
IsCritical (boolean) --
The flag which can be used to help decide whether the failure of current step leads to the Automation failure.
ValidNextSteps (list) --
Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the step fails. Continue will ignore the failure of current step and allow automation to run the next step. With conditional branching, we add step:stepName to support the automation to go to another specific step.
(string) --
Targets (list) --
The targets for the step execution.
(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=*
Automation only, to target Microsoft Azure or Google Cloud Platform (GCP) resources:
Key=CloudConnector,Values=cloud-connector-id
Key=CloudConnector,Values={"CloudConnectorId":"cloud-connector-id","SsmManagedNodeFilter":"MANAGED","CloudProviderRegions":["eastus"]}
Supported JSON keys: CloudConnectorId (required), SsmManagedNodeFilter, CloudProviderRegions, and, for GCP, IncludesLabels, ExcludesLabels, OsPolicyComplianceFilter, and OsPolicyOrchestratorId.
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 associations that run an Automation runbook, to target Microsoft Azure or Google Cloud Platform (GCP) resources:
Key=CloudConnector,Values=cloud-connector-id
Key=CloudConnector,Values={"CloudConnectorId":"cloud-connector-id","SsmManagedNodeFilter":"UNMANAGED"}
Supported JSON keys: CloudConnectorId (required), SsmManagedNodeFilter, and CloudProviderRegions.
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) --
TargetLocation (dict) --
The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.
Accounts (list) --
The Amazon Web Services accounts targeted by the current Automation execution.
(string) --
Regions (list) --
The Amazon Web Services Regions targeted by the current Automation execution.
(string) --
TargetLocationMaxConcurrency (string) --
The maximum number of Amazon Web Services Regions and Amazon Web Services accounts allowed to run the Automation concurrently. TargetLocationMaxConcurrency has a default value of 1.
TargetLocationMaxErrors (string) --
The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation. TargetLocationMaxErrors has a default value of 0.
ExecutionRoleName (string) --
The Automation execution role used by the currently running Automation. If not specified, the default value is AWS-SystemsManager-AutomationExecutionRole.
TargetLocationAlarmConfiguration (dict) --
The details for the CloudWatch alarm you want to apply to an automation or command.
IgnorePollAlarmFailure (boolean) --
When this value is true, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is false.
Alarms (list) --
The name of the CloudWatch alarm specified in the configuration.
(dict) --
A CloudWatch alarm you apply to an automation or command.
Name (string) --
The name of your CloudWatch alarm.
IncludeChildOrganizationUnits (boolean) --
Indicates whether to include child organizational units (OUs) that are children of the targeted OUs. The default is false.
ExcludeAccounts (list) --
Amazon Web Services accounts or organizational units to exclude as expanded targets.
(string) --
Targets (list) --
A list of key-value mappings to target resources. If you specify values for this data type, you must also specify a value for TargetParameterName.
This Targets parameter takes precedence over the StartAutomationExecution:Targets parameter if both are supplied.
(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=*
Automation only, to target Microsoft Azure or Google Cloud Platform (GCP) resources:
Key=CloudConnector,Values=cloud-connector-id
Key=CloudConnector,Values={"CloudConnectorId":"cloud-connector-id","SsmManagedNodeFilter":"MANAGED","CloudProviderRegions":["eastus"]}
Supported JSON keys: CloudConnectorId (required), SsmManagedNodeFilter, CloudProviderRegions, and, for GCP, IncludesLabels, ExcludesLabels, OsPolicyComplianceFilter, and OsPolicyOrchestratorId.
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 associations that run an Automation runbook, to target Microsoft Azure or Google Cloud Platform (GCP) resources:
Key=CloudConnector,Values=cloud-connector-id
Key=CloudConnector,Values={"CloudConnectorId":"cloud-connector-id","SsmManagedNodeFilter":"UNMANAGED"}
Supported JSON keys: CloudConnectorId (required), SsmManagedNodeFilter, and CloudProviderRegions.
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) --
TargetsMaxConcurrency (string) --
The maximum number of targets allowed to run this task in parallel. This TargetsMaxConcurrency takes precedence over the StartAutomationExecution:MaxConcurrency parameter if both are supplied.
TargetsMaxErrors (string) --
The maximum number of errors that are allowed before the system stops running the automation on additional targets. This TargetsMaxErrors parameter takes precedence over the StartAutomationExecution:MaxErrors parameter if both are supplied.
TriggeredAlarms (list) --
The CloudWatch alarms that were invoked by the automation.
(dict) --
The details about the state of your CloudWatch alarm.
Name (string) --
The name of your CloudWatch alarm.
State (string) --
The state of your CloudWatch alarm.
ParentStepDetails (dict) --
Information about the parent step.
StepExecutionId (string) --
The unique ID of a step execution.
StepName (string) --
The name of the step.
Action (string) --
The name of the automation action.
Iteration (integer) --
The current repetition of the loop represented by an integer.
IteratorValue (string) --
The current value of the specified iterator in the loop.
StepExecutionsTruncated (boolean) --
A boolean value that indicates if the response contains the full list of the Automation step executions. If true, use the DescribeAutomationStepExecutions API operation to get the full list of step executions.
Parameters (dict) --
The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.
(string) --
(list) --
(string) --
Outputs (dict) --
The list of execution outputs as defined in the Automation runbook.
(string) --
(list) --
(string) --
FailureMessage (string) --
A message describing why an execution has failed, if the status is set to Failed.
WarningMessage (string) --
A message that describes a non-critical issue that occurred during the automation execution.
Mode (string) --
The automation execution mode.
ParentAutomationExecutionId (string) --
The AutomationExecutionId of the parent automation.
ExecutedBy (string) --
The Amazon Resource Name (ARN) of the user who ran the automation.
CurrentStepName (string) --
The name of the step that is currently running.
CurrentAction (string) --
The action of the step that is currently running.
TargetParameterName (string) --
The parameter name.
Targets (list) --
The specified targets.
(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=*
Automation only, to target Microsoft Azure or Google Cloud Platform (GCP) resources:
Key=CloudConnector,Values=cloud-connector-id
Key=CloudConnector,Values={"CloudConnectorId":"cloud-connector-id","SsmManagedNodeFilter":"MANAGED","CloudProviderRegions":["eastus"]}
Supported JSON keys: CloudConnectorId (required), SsmManagedNodeFilter, CloudProviderRegions, and, for GCP, IncludesLabels, ExcludesLabels, OsPolicyComplianceFilter, and OsPolicyOrchestratorId.
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 associations that run an Automation runbook, to target Microsoft Azure or Google Cloud Platform (GCP) resources:
Key=CloudConnector,Values=cloud-connector-id
Key=CloudConnector,Values={"CloudConnectorId":"cloud-connector-id","SsmManagedNodeFilter":"UNMANAGED"}
Supported JSON keys: CloudConnectorId (required), SsmManagedNodeFilter, and CloudProviderRegions.
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) --
TargetMaps (list) --
The specified key-value mapping of document parameters to target resources.
(dict) --
(string) --
(list) --
(string) --
ResolvedTargets (dict) --
A list of resolved targets in the rate control execution.
ParameterValues (list) --
A list of parameter values sent to targets that resolved during the Automation execution.
(string) --
Truncated (boolean) --
A boolean value indicating whether the resolved target list is truncated.
MaxConcurrency (string) --
The MaxConcurrency value specified by the user when the execution started.
MaxErrors (string) --
The MaxErrors value specified by the user when the execution started.
Target (string) --
The target of the execution.
TargetLocations (list) --
The combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the Automation.
(dict) --
The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.
Accounts (list) --
The Amazon Web Services accounts targeted by the current Automation execution.
(string) --
Regions (list) --
The Amazon Web Services Regions targeted by the current Automation execution.
(string) --
TargetLocationMaxConcurrency (string) --
The maximum number of Amazon Web Services Regions and Amazon Web Services accounts allowed to run the Automation concurrently. TargetLocationMaxConcurrency has a default value of 1.
TargetLocationMaxErrors (string) --
The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation. TargetLocationMaxErrors has a default value of 0.
ExecutionRoleName (string) --
The Automation execution role used by the currently running Automation. If not specified, the default value is AWS-SystemsManager-AutomationExecutionRole.
TargetLocationAlarmConfiguration (dict) --
The details for the CloudWatch alarm you want to apply to an automation or command.
IgnorePollAlarmFailure (boolean) --
When this value is true, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is false.
Alarms (list) --
The name of the CloudWatch alarm specified in the configuration.
(dict) --
A CloudWatch alarm you apply to an automation or command.
Name (string) --
The name of your CloudWatch alarm.
IncludeChildOrganizationUnits (boolean) --
Indicates whether to include child organizational units (OUs) that are children of the targeted OUs. The default is false.
ExcludeAccounts (list) --
Amazon Web Services accounts or organizational units to exclude as expanded targets.
(string) --
Targets (list) --
A list of key-value mappings to target resources. If you specify values for this data type, you must also specify a value for TargetParameterName.
This Targets parameter takes precedence over the StartAutomationExecution:Targets parameter if both are supplied.
(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=*
Automation only, to target Microsoft Azure or Google Cloud Platform (GCP) resources:
Key=CloudConnector,Values=cloud-connector-id
Key=CloudConnector,Values={"CloudConnectorId":"cloud-connector-id","SsmManagedNodeFilter":"MANAGED","CloudProviderRegions":["eastus"]}
Supported JSON keys: CloudConnectorId (required), SsmManagedNodeFilter, CloudProviderRegions, and, for GCP, IncludesLabels, ExcludesLabels, OsPolicyComplianceFilter, and OsPolicyOrchestratorId.
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 associations that run an Automation runbook, to target Microsoft Azure or Google Cloud Platform (GCP) resources:
Key=CloudConnector,Values=cloud-connector-id
Key=CloudConnector,Values={"CloudConnectorId":"cloud-connector-id","SsmManagedNodeFilter":"UNMANAGED"}
Supported JSON keys: CloudConnectorId (required), SsmManagedNodeFilter, and CloudProviderRegions.
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) --
TargetsMaxConcurrency (string) --
The maximum number of targets allowed to run this task in parallel. This TargetsMaxConcurrency takes precedence over the StartAutomationExecution:MaxConcurrency parameter if both are supplied.
TargetsMaxErrors (string) --
The maximum number of errors that are allowed before the system stops running the automation on additional targets. This TargetsMaxErrors parameter takes precedence over the StartAutomationExecution:MaxErrors parameter if both are supplied.
ProgressCounters (dict) --
An aggregate of step execution statuses displayed in the Amazon Web Services Systems Manager console for a multi-Region and multi-account Automation execution.
TotalSteps (integer) --
The total number of steps run in all specified Amazon Web Services Regions and Amazon Web Services accounts for the current Automation execution.
SuccessSteps (integer) --
The total number of steps that successfully completed in all specified Amazon Web Services Regions and Amazon Web Services accounts for the current Automation execution.
FailedSteps (integer) --
The total number of steps that failed to run in all specified Amazon Web Services Regions and Amazon Web Services accounts for the current Automation execution.
CancelledSteps (integer) --
The total number of steps that the system cancelled in all specified Amazon Web Services Regions and Amazon Web Services accounts for the current Automation execution.
TimedOutSteps (integer) --
The total number of steps that timed out in all specified Amazon Web Services Regions and Amazon Web Services accounts for the current Automation execution.
AlarmConfiguration (dict) --
The details for the CloudWatch alarm applied to your automation.
IgnorePollAlarmFailure (boolean) --
When this value is true, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is false.
Alarms (list) --
The name of the CloudWatch alarm specified in the configuration.
(dict) --
A CloudWatch alarm you apply to an automation or command.
Name (string) --
The name of your CloudWatch alarm.
TriggeredAlarms (list) --
The CloudWatch alarm that was invoked by the automation.
(dict) --
The details about the state of your CloudWatch alarm.
Name (string) --
The name of your CloudWatch alarm.
State (string) --
The state of your CloudWatch alarm.
TargetLocationsURL (string) --
A publicly accessible URL for a file that contains the TargetLocations body. Currently, only files in presigned Amazon S3 buckets are supported
AutomationSubtype (string) --
The subtype of the Automation operation. Currently, the only supported value is ChangeRequest.
ScheduledTime (datetime) --
The date and time the Automation operation is scheduled to start.
Runbooks (list) --
Information about the Automation runbooks that are run as part of a runbook workflow.
(dict) --
Information about an Automation runbook used in a runbook workflow in Change Manager.
DocumentName (string) --
The name of the Automation runbook used in a runbook workflow.
DocumentVersion (string) --
The version of the Automation runbook used in a runbook workflow.
Parameters (dict) --
The key-value map of execution parameters, which were supplied when calling StartChangeRequestExecution.
(string) --
(list) --
(string) --
TargetParameterName (string) --
The name of the parameter used as the target resource for the rate-controlled runbook workflow. Required if you specify Targets.
Targets (list) --
A key-value mapping to target resources that the runbook operation performs tasks on. Required if you specify TargetParameterName.
(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=*
Automation only, to target Microsoft Azure or Google Cloud Platform (GCP) resources:
Key=CloudConnector,Values=cloud-connector-id
Key=CloudConnector,Values={"CloudConnectorId":"cloud-connector-id","SsmManagedNodeFilter":"MANAGED","CloudProviderRegions":["eastus"]}
Supported JSON keys: CloudConnectorId (required), SsmManagedNodeFilter, CloudProviderRegions, and, for GCP, IncludesLabels, ExcludesLabels, OsPolicyComplianceFilter, and OsPolicyOrchestratorId.
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 associations that run an Automation runbook, to target Microsoft Azure or Google Cloud Platform (GCP) resources:
Key=CloudConnector,Values=cloud-connector-id
Key=CloudConnector,Values={"CloudConnectorId":"cloud-connector-id","SsmManagedNodeFilter":"UNMANAGED"}
Supported JSON keys: CloudConnectorId (required), SsmManagedNodeFilter, and CloudProviderRegions.
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) --
TargetMaps (list) --
A key-value mapping of runbook parameters to target resources. Both Targets and TargetMaps can't be specified together.
(dict) --
(string) --
(list) --
(string) --
MaxConcurrency (string) --
The MaxConcurrency value specified by the user when the operation started, indicating the maximum number of resources that the runbook operation can run on at the same time.
MaxErrors (string) --
The MaxErrors value specified by the user when the execution started, indicating the maximum number of errors that can occur during the operation before the updates are stopped or rolled back.
TargetLocations (list) --
Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Runbook operation.
(dict) --
The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.
Accounts (list) --
The Amazon Web Services accounts targeted by the current Automation execution.
(string) --
Regions (list) --
The Amazon Web Services Regions targeted by the current Automation execution.
(string) --
TargetLocationMaxConcurrency (string) --
The maximum number of Amazon Web Services Regions and Amazon Web Services accounts allowed to run the Automation concurrently. TargetLocationMaxConcurrency has a default value of 1.
TargetLocationMaxErrors (string) --
The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation. TargetLocationMaxErrors has a default value of 0.
ExecutionRoleName (string) --
The Automation execution role used by the currently running Automation. If not specified, the default value is AWS-SystemsManager-AutomationExecutionRole.
TargetLocationAlarmConfiguration (dict) --
The details for the CloudWatch alarm you want to apply to an automation or command.
IgnorePollAlarmFailure (boolean) --
When this value is true, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is false.
Alarms (list) --
The name of the CloudWatch alarm specified in the configuration.
(dict) --
A CloudWatch alarm you apply to an automation or command.
Name (string) --
The name of your CloudWatch alarm.
IncludeChildOrganizationUnits (boolean) --
Indicates whether to include child organizational units (OUs) that are children of the targeted OUs. The default is false.
ExcludeAccounts (list) --
Amazon Web Services accounts or organizational units to exclude as expanded targets.
(string) --
Targets (list) --
A list of key-value mappings to target resources. If you specify values for this data type, you must also specify a value for TargetParameterName.
This Targets parameter takes precedence over the StartAutomationExecution:Targets parameter if both are supplied.
(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=*
Automation only, to target Microsoft Azure or Google Cloud Platform (GCP) resources:
Key=CloudConnector,Values=cloud-connector-id
Key=CloudConnector,Values={"CloudConnectorId":"cloud-connector-id","SsmManagedNodeFilter":"MANAGED","CloudProviderRegions":["eastus"]}
Supported JSON keys: CloudConnectorId (required), SsmManagedNodeFilter, CloudProviderRegions, and, for GCP, IncludesLabels, ExcludesLabels, OsPolicyComplianceFilter, and OsPolicyOrchestratorId.
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 associations that run an Automation runbook, to target Microsoft Azure or Google Cloud Platform (GCP) resources:
Key=CloudConnector,Values=cloud-connector-id
Key=CloudConnector,Values={"CloudConnectorId":"cloud-connector-id","SsmManagedNodeFilter":"UNMANAGED"}
Supported JSON keys: CloudConnectorId (required), SsmManagedNodeFilter, and CloudProviderRegions.
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) --
TargetsMaxConcurrency (string) --
The maximum number of targets allowed to run this task in parallel. This TargetsMaxConcurrency takes precedence over the StartAutomationExecution:MaxConcurrency parameter if both are supplied.
TargetsMaxErrors (string) --
The maximum number of errors that are allowed before the system stops running the automation on additional targets. This TargetsMaxErrors parameter takes precedence over the StartAutomationExecution:MaxErrors parameter if both are supplied.
OpsItemId (string) --
The ID of an OpsItem that is created to represent a Change Manager change request.
AssociationId (string) --
The ID of a State Manager association used in the Automation operation.
ChangeRequestName (string) --
The name of the Change Manager change request.
Variables (dict) --
Variables defined for the automation.
(string) --
(list) --
(string) --
TargetsSummary (dict) --
A summary of the child executions that a rate control execution started for its targets. This field is returned only for rate control executions.
TotalCount (integer) --
The total number of targets in the rate control execution.
StartedCount (integer) --
The number of child executions that started.
CompletedCount (integer) --
The number of child executions that finished, whether they succeeded or failed.
SuccessfulCount (integer) --
The number of child executions that succeeded.
FailedCount (integer) --
The number of child executions that failed, timed out, or were canceled.
{'Configuration': {'GcpConfiguration': {'OrganizationId': 'string',
'ServiceAccountEmail': 'string',
'Targets': {'Projects': [{'ProjectDisplayName': 'string',
'ProjectId': 'string'}]},
'WorkloadIdentityPoolProvider': 'string'}}}
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'
},
]
}
},
'GcpConfiguration': {
'OrganizationId': 'string',
'WorkloadIdentityPoolProvider': 'string',
'ServiceAccountEmail': 'string',
'Targets': {
'Projects': [
{
'ProjectId': 'string',
'ProjectDisplayName': '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.
GcpConfiguration (dict) --
The access details and targets for connecting to a Google Cloud Platform (GCP) environment.
OrganizationId (string) --
The ID of the GCP organization.
WorkloadIdentityPoolProvider (string) --
The full resource name of the GCP workload identity pool provider used for authentication.
ServiceAccountEmail (string) --
The email address of the GCP service account used for authentication.
Targets (dict) --
The target GCP projects for the cloud connector.
Projects (list) --
A list of GCP projects to target.
(dict) --
Information about a GCP project targeted by the cloud connector.
ProjectId (string) --
The ID of the GCP project.
ProjectDisplayName (string) --
The display name of the GCP project.
ConfigConnectorArn (string) --
The ARN of the Amazon Web Services Config connector associated with this cloud connector. This value is returned only if the cloud connector was created with an Amazon Web Services Config connector.
CreatedAt (datetime) --
The date and time the cloud connector was created.
UpdatedAt (datetime) --
The date and time the cloud connector was last updated.
{'Filters': {'FilterKey': {'OrganizationId', 'ProjectId'}}}
Response {'CloudConnectors': {'ConfigConnectorArn': 'string', 'Provider': 'Azure | GCP'}}
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'|'ProjectId'|'OrganizationId',
'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.
ProjectId
The Google Cloud Platform (GCP) project ID to filter by. Filters the results to connectors that target the specified project.
OrganizationId
The GCP organization ID to filter by. Filters the results to connectors that target the entire specified organization.
You can't combine Azure filter keys ( SubscriptionId and TenantId) with GCP filter keys ( ProjectId and OrganizationId) in the same request.
(string) --
dict
Response Syntax
{
'CloudConnectors': [
{
'CloudConnectorId': 'string',
'DisplayName': 'string',
'Description': 'string',
'RoleArn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'Provider': 'Azure'|'GCP',
'ConfigConnectorArn': 'string'
},
],
'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.
Provider (string) --
The third-party cloud provider that the cloud connector connects to. Valid values: Azure | GCP.
ConfigConnectorArn (string) --
The ARN of the Amazon Web Services Config connector associated with this cloud connector. This value is returned only if the cloud connector was created with an Amazon Web Services Config connector.
NextToken (string) --
The token to use when requesting the next set of items.
{'Nodes': {'NodeType': {'Instance': {'SourceType': {'compute.googleapis.com/Instance'}}}}}
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'|'compute.googleapis.com/Instance',
'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. For Azure Virtual Machines, SourceType is Microsoft.Compute/virtualMachines. For Google Cloud Platform (GCP) Compute Engine Virtual Machines, SourceType is compute.googleapis.com/Instance.
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.
{'Configuration': {'GcpConfiguration': {'OrganizationId': 'string',
'ServiceAccountEmail': 'string',
'Targets': {'Projects': [{'ProjectDisplayName': 'string',
'ProjectId': 'string'}]},
'WorkloadIdentityPoolProvider': 'string'}}}
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'
},
]
}
},
'GcpConfiguration': {
'OrganizationId': 'string',
'WorkloadIdentityPoolProvider': 'string',
'ServiceAccountEmail': 'string',
'Targets': {
'Projects': [
{
'ProjectId': 'string',
'ProjectDisplayName': '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.
GcpConfiguration (dict) --
The access details and targets for connecting to a Google Cloud Platform (GCP) environment.
OrganizationId (string) --
The ID of the GCP organization.
WorkloadIdentityPoolProvider (string) -- [REQUIRED]
The full resource name of the GCP workload identity pool provider used for authentication.
ServiceAccountEmail (string) -- [REQUIRED]
The email address of the GCP service account used for authentication.
Targets (dict) --
The target GCP projects for the cloud connector.
Projects (list) --
A list of GCP projects to target.
(dict) --
Information about a GCP project targeted by the cloud connector.
ProjectId (string) -- [REQUIRED]
The ID of the GCP project.
ProjectDisplayName (string) --
The display name of the GCP project.
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.
{'ValidationFindings': {'Code': {'TargetApiDisabled',
'TargetMissingPermissions'},
'Scope': {'Type': {'gcp:project', 'gcp:organization'}}}}
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'|'TargetMissingPermissions'|'TargetApiDisabled'|'TargetStateWarning'|'AwsRoleAssumptionFailed'|'WebIdentityTokenFailed'|'OutboundWebIdentityFederationDisabled'|'ProviderCredentialCreationFailed'|'TenantSummary'|'SubscriptionAccessible',
'Message': 'string',
'ProviderMessage': 'string',
'Scope': {
'Type': 'azure:tenant'|'azure:subscription'|'gcp:organization'|'gcp:project',
'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.