SSM / Client / send_command

send_command#

SSM.Client.send_command(**kwargs)#

Runs commands on one or more managed nodes.

Request Syntax

response = client.send_command(
    InstanceIds=[
        'string',
    ],
    Targets=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    DocumentName='string',
    DocumentVersion='string',
    DocumentHash='string',
    DocumentHashType='Sha256'|'Sha1',
    TimeoutSeconds=123,
    Comment='string',
    Parameters={
        'string': [
            'string',
        ]
    },
    OutputS3Region='string',
    OutputS3BucketName='string',
    OutputS3KeyPrefix='string',
    MaxConcurrency='string',
    MaxErrors='string',
    ServiceRoleArn='string',
    NotificationConfig={
        'NotificationArn': 'string',
        'NotificationEvents': [
            'All'|'InProgress'|'Success'|'TimedOut'|'Cancelled'|'Failed',
        ],
        'NotificationType': 'Command'|'Invocation'
    },
    CloudWatchOutputConfig={
        'CloudWatchLogGroupName': 'string',
        'CloudWatchOutputEnabled': True|False
    },
    AlarmConfiguration={
        'IgnorePollAlarmFailure': True|False,
        'Alarms': [
            {
                'Name': 'string'
            },
        ]
    }
)

Parameters:

InstanceIds (list) –
The IDs of the managed nodes where the command should run. Specifying managed node IDs is most useful when you are targeting a limited number of managed nodes, though you can specify up to 50 IDs.

To target a larger number of managed nodes, or if you prefer not to list individual node IDs, we recommend using the Targets option instead. Using Targets, which accepts tag key-value pairs to identify the managed nodes to send commands to, you can a send command to tens, hundreds, or thousands of nodes at once.

For more information about how to use targets, see Run commands at scale in the Amazon Web Services Systems Manager User Guide.
- (string) –
Targets (list) –
An array of search criteria that targets managed nodes using a Key,Value combination that you specify. Specifying targets is most useful when you want to send a command to a large number of managed nodes at once. Using Targets, which accepts tag key-value pairs to identify managed nodes, you can send a command to tens, hundreds, or thousands of nodes at once.

To send a command to a smaller number of managed nodes, you can use the InstanceIds option instead.

For more information about how to use targets, see Run commands at scale in the Amazon Web Services Systems Manager User Guide.
- (dict) –
  
  An array of search criteria that targets managed nodes using a key-value pair that you specify.
  
  Note
  One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don’t specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.
  
  Supported formats include the following.
  - Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3>
  - Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2>
  - Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2>
  - Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=<resource-group-name>
  - Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=<resource-type-1>,<resource-type-2>
  - Automation targets only: Key=ResourceGroup;Values=<resource-group-name>
  For example:
  - Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE
  - Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3
  - Key=tag-key,Values=Name,Instance-Type,CostCenter
  - Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=ProductionResourceGroup This example demonstrates how to target all resources in the resource group ProductionResourceGroup in your maintenance window.
  - Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC This example demonstrates how to target only Amazon Elastic Compute Cloud (Amazon EC2) instances and VPCs in your maintenance window.
  - Automation targets only: Key=ResourceGroup,Values=MyResourceGroup
  - State Manager association targets only: Key=InstanceIds,Values=* This example demonstrates how to target all managed instances in the Amazon Web Services Region where the association was created.
  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) –
DocumentName (string) –
[REQUIRED]

The name of the Amazon Web Services Systems Manager document (SSM document) to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document Amazon Resource Name (ARN). For more information about how to use shared documents, see Sharing SSM documents in the Amazon Web Services Systems Manager User Guide.

Note
If you specify a document name or ARN that hasn’t been shared with your account, you receive an InvalidDocument error.
DocumentVersion (string) –
The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Command Line Interface (Amazon Web Services CLI), then you must escape the first two options by using a backslash. If you specify a version number, then you don’t need to use the backslash. For example:

–document-version “$DEFAULT”

–document-version “$LATEST”

–document-version “3”
DocumentHash (string) –
The Sha256 or Sha1 hash created by the system when the document was created.

Note
Sha1 hashes have been deprecated.
DocumentHashType (string) –
Sha256 or Sha1.

Note
Sha1 hashes have been deprecated.
TimeoutSeconds (integer) – If this time is reached and the command hasn’t already started running, it won’t run.
Comment (string) – User-specified information about the command, such as a brief description of what the command should do.
Parameters (dict) –
The required and optional parameters specified in the document being run.
- (string) –
  - (list) –
    - (string) –
OutputS3Region (string) – (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon Web Services Region of the S3 bucket.
OutputS3BucketName (string) – The name of the S3 bucket where command execution responses should be stored.
OutputS3KeyPrefix (string) – The directory structure within the S3 bucket where the responses should be stored.
MaxConcurrency (string) – (Optional) The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using concurrency controls in the Amazon Web Services Systems Manager User Guide.
MaxErrors (string) – The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 0. For more information about how to use MaxErrors, see Using error controls in the Amazon Web Services Systems Manager User Guide.
ServiceRoleArn (string) –
The ARN of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.

This role must provide the sns:Publish permission for your notification topic. For information about creating and using this service role, see Monitoring Systems Manager status changes using Amazon SNS notifications in the Amazon Web Services Systems Manager User Guide.
NotificationConfig (dict) –
Configurations for sending notifications.
- NotificationArn (string) –
  
  An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon SNS) topic. Run Command pushes notifications about command status changes to this topic.
- NotificationEvents (list) –
  
  The different events for which you can receive notifications. To learn more about these events, see Monitoring Systems Manager status changes using Amazon SNS notifications in the Amazon Web Services Systems Manager User Guide.
  - (string) –
- NotificationType (string) –
  
  The type of notification.
  - Command: Receive notification when the status of a command changes.
  - Invocation: For commands sent to multiple managed nodes, receive notification on a per-node basis when the status of a command changes.
CloudWatchOutputConfig (dict) –
Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a capability of Amazon Web Services Systems Manager.
- CloudWatchLogGroupName (string) –
  
  The name of the CloudWatch Logs log group where you want to send command output. If you don’t specify a group name, Amazon Web Services Systems Manager automatically creates a log group for you. The log group uses the following naming format:
  
  aws/ssm/SystemsManagerDocumentName
- CloudWatchOutputEnabled (boolean) –
  
  Enables Systems Manager to send command output to CloudWatch Logs.
AlarmConfiguration (dict) –
The CloudWatch alarm you want to apply to your 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) – [REQUIRED]
  
  The name of the CloudWatch alarm specified in the configuration.
  - (dict) –
    
    A CloudWatch alarm you apply to an automation or command.
    - Name (string) – [REQUIRED]
      
      The name of your CloudWatch alarm.

Return type:

dict

Returns:

Response Syntax

{
    'Command': {
        'CommandId': 'string',
        'DocumentName': 'string',
        'DocumentVersion': 'string',
        'Comment': 'string',
        'ExpiresAfter': datetime(2015, 1, 1),
        'Parameters': {
            'string': [
                'string',
            ]
        },
        'InstanceIds': [
            'string',
        ],
        'Targets': [
            {
                'Key': 'string',
                'Values': [
                    'string',
                ]
            },
        ],
        'RequestedDateTime': datetime(2015, 1, 1),
        'Status': 'Pending'|'InProgress'|'Success'|'Cancelled'|'Failed'|'TimedOut'|'Cancelling',
        'StatusDetails': 'string',
        'OutputS3Region': 'string',
        'OutputS3BucketName': 'string',
        'OutputS3KeyPrefix': 'string',
        'MaxConcurrency': 'string',
        'MaxErrors': 'string',
        'TargetCount': 123,
        'CompletedCount': 123,
        'ErrorCount': 123,
        'DeliveryTimedOutCount': 123,
        'ServiceRole': 'string',
        'NotificationConfig': {
            'NotificationArn': 'string',
            'NotificationEvents': [
                'All'|'InProgress'|'Success'|'TimedOut'|'Cancelled'|'Failed',
            ],
            'NotificationType': 'Command'|'Invocation'
        },
        'CloudWatchOutputConfig': {
            'CloudWatchLogGroupName': 'string',
            'CloudWatchOutputEnabled': True|False
        },
        'TimeoutSeconds': 123,
        'AlarmConfiguration': {
            'IgnorePollAlarmFailure': True|False,
            'Alarms': [
                {
                    'Name': 'string'
                },
            ]
        },
        'TriggeredAlarms': [
            {
                'Name': 'string',
                'State': 'UNKNOWN'|'ALARM'
            },
        ]
    }
}

Response Structure

(dict) –
- Command (dict) –
  
  The request as it was received by Systems Manager. Also provides the command ID which can be used future references to this request.
  - CommandId (string) –
    
    A unique identifier for this command.
  - DocumentName (string) –
    
    The name of the document requested for execution.
  - DocumentVersion (string) –
    
    The Systems Manager document (SSM document) version.
  - Comment (string) –
    
    User-specified information about the command, such as a brief description of what the command should do.
  - ExpiresAfter (datetime) –
    
    If a command expires, it changes status to DeliveryTimedOut for all invocations that have the status InProgress, Pending, or Delayed. ExpiresAfter is calculated based on the total timeout for the overall command. For more information, see Understanding command timeout values in the Amazon Web Services Systems Manager User Guide.
  - Parameters (dict) –
    
    The parameter values to be inserted in the document when running the command.
    - (string) –
      - (list) –
        
        (string) –
  - InstanceIds (list) –
    
    The managed node IDs against which this command was requested.
    - (string) –
  - Targets (list) –
    
    An array of search criteria that targets managed nodes using a Key,Value combination that you specify. Targets is required if you don’t provide one or more managed node IDs in the call.
    - (dict) –
      
      An array of search criteria that targets managed nodes using a key-value pair that you specify.
      
      Note
      One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don’t specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.
      
      Supported formats include the following.
      - Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3>
      - Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2>
      - Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2>
      - Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=<resource-group-name>
      - Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=<resource-type-1>,<resource-type-2>
      - Automation targets only: Key=ResourceGroup;Values=<resource-group-name>
      For example:
      - Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE
      - Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3
      - Key=tag-key,Values=Name,Instance-Type,CostCenter
      - Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=ProductionResourceGroup This example demonstrates how to target all resources in the resource group ProductionResourceGroup in your maintenance window.
      - Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC This example demonstrates how to target only Amazon Elastic Compute Cloud (Amazon EC2) instances and VPCs in your maintenance window.
      - Automation targets only: Key=ResourceGroup,Values=MyResourceGroup
      - State Manager association targets only: Key=InstanceIds,Values=* This example demonstrates how to target all managed instances in the Amazon Web Services Region where the association was created.
      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) –
  - RequestedDateTime (datetime) –
    
    The date and time the command was requested.
  - Status (string) –
    
    The status of the command.
  - StatusDetails (string) –
    
    A detailed status of the command execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the following values:
    - Pending: The command hasn’t been sent to any managed nodes.
    - In Progress: The command has been sent to at least one managed node but hasn’t reached a final state on all managed nodes.
    - Success: The command successfully ran on all invocations. This is a terminal state.
    - Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.
    - Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.
    - Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.
    - Incomplete: The command was attempted on all managed nodes and one or more invocations doesn’t have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.
    - Cancelled: The command was terminated before it was completed. This is a terminal state.
    - Rate Exceeded: The number of managed nodes targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any managed node. This is a terminal state.
    - Delayed: The system attempted to send the command to the managed node but wasn’t successful. The system retries again.
  - OutputS3Region (string) –
    
    (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon Web Services Region of the S3 bucket.
  - OutputS3BucketName (string) –
    
    The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.
  - OutputS3KeyPrefix (string) –
    
    The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.
  - MaxConcurrency (string) –
    
    The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a number of managed nodes, such as 10, or a percentage of nodes, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Amazon Web Services Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
  - MaxErrors (string) –
    
    The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 0. For more information about how to use MaxErrors, see Amazon Web Services Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
  - TargetCount (integer) –
    
    The number of targets for the command.
  - CompletedCount (integer) –
    
    The number of targets for which the command invocation reached a terminal state. Terminal states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Cancelled, Terminated, or Undeliverable.
  - ErrorCount (integer) –
    
    The number of targets for which the status is Failed or Execution Timed Out.
  - DeliveryTimedOutCount (integer) –
    
    The number of targets for which the status is Delivery Timed Out.
  - ServiceRole (string) –
    
    The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes.
  - NotificationConfig (dict) –
    
    Configurations for sending notifications about command status changes.
    - NotificationArn (string) –
      
      An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon SNS) topic. Run Command pushes notifications about command status changes to this topic.
    - NotificationEvents (list) –
      
      The different events for which you can receive notifications. To learn more about these events, see Monitoring Systems Manager status changes using Amazon SNS notifications in the Amazon Web Services Systems Manager User Guide.
      - (string) –
    - NotificationType (string) –
      
      The type of notification.
      - Command: Receive notification when the status of a command changes.
      - Invocation: For commands sent to multiple managed nodes, receive notification on a per-node basis when the status of a command changes.
  - CloudWatchOutputConfig (dict) –
    
    Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.
    - CloudWatchLogGroupName (string) –
      
      The name of the CloudWatch Logs log group where you want to send command output. If you don’t specify a group name, Amazon Web Services Systems Manager automatically creates a log group for you. The log group uses the following naming format:
      
      aws/ssm/SystemsManagerDocumentName
    - CloudWatchOutputEnabled (boolean) –
      
      Enables Systems Manager to send command output to CloudWatch Logs.
  - TimeoutSeconds (integer) –
    
    The TimeoutSeconds value specified for a command.
  - AlarmConfiguration (dict) –
    
    The details for the CloudWatch alarm applied to your 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.
  - TriggeredAlarms (list) –
    
    The CloudWatch alarm that was invoked by the command.
    - (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.

Exceptions

SSM.Client.exceptions.DuplicateInstanceId
SSM.Client.exceptions.InternalServerError
SSM.Client.exceptions.InvalidInstanceId
SSM.Client.exceptions.InvalidDocument
SSM.Client.exceptions.InvalidDocumentVersion
SSM.Client.exceptions.InvalidOutputFolder
SSM.Client.exceptions.InvalidParameters
SSM.Client.exceptions.UnsupportedPlatformType
SSM.Client.exceptions.MaxDocumentSizeExceeded
SSM.Client.exceptions.InvalidRole
SSM.Client.exceptions.InvalidNotificationConfig