aws:executeScript - 运行脚本

使用指定的运行时和处理程序提供的 Python 或 PowerShell 脚本。每个 aws:executeScript 操作最多可以运行 600 秒（10 分钟）时间。您可以通过指定 aws:executeScript 步骤的 timeoutSeconds 参数来限制超时。

在函数中使用 return 语句将输出添加到输出有效负载中。有关为您的 aws:executeScript 操作定义输出的示例，请参阅示例 2：脚本化运行手册。您还可以将运行手册中 aws:executeScript 操作的输出发送到您指定的 Amazon CloudWatch Logs 日志组。有关更多信息，请参阅 使用 CloudWatch Logs 记录自动化操作输出。

如果想要将 aws:executeScript 操作的输出发送到 CloudWatch Logs，或者如果您为 aws:executeScript 操作指定的脚本调用 AWS API 操作，则始终需要 AWS Identity and Access Management (IAM) 服务角色（或承担角色）运行运行手册。

aws:executeScript 操作包含以下预安装的 PowerShell 核心模块。

要使用未预装的 PowerShell 核心模块，脚本必须安装带有 -Force 标志的模块，如以下命令所示。不支持 AWSPowerShell.NetCore 模块。用您想要安装的模块替换 ModuleName。

Install-Module ModuleName -Force

要在脚本中使用 PowerShell 核心 cmdlet，我们建议您使用 AWS.Tools 模块，如以下命令所示。将每个示例资源占位符替换为您自己的信息。

如果脚本除了使用 PowerShell 核心 cmdlet 之外还初始化新对象，则还必须导入模块，如以下命令所示。

Install-Module AWS.Tools.EC2 -Force
Import-Module AWS.Tools.EC2

$tag = New-Object Amazon.EC2.Model.Tag
$tag.Key = "Tag"
$tag.Value = "TagValue"

New-EC2Tag -Resource i-02573cafcfEXAMPLE -Tag $tag

有关安装和导入 AWS.Tools 模块以及在运行手册中使用 PowerShell 核心 cmdlet 的示例，请参阅 自动化运行手册的视觉对象设计体验。

输入

提供运行脚本所需的信息。将每个示例资源占位符替换为您自己的信息。

YAML

action: "aws:executeScript"
inputs: 
 Runtime: runtime
 Handler: "functionName"
 InputPayload: 
  scriptInput: '{{parameterValue}}'
 Script: |-
   def functionName(events, context):
   ...
 Attachment: "scriptAttachment.zip"

JSON

{
    "action": "aws:executeScript",
    "inputs": {
        "Runtime": "runtime",
        "Handler": "functionName",
        "InputPayload": {
            "scriptInput": "{{parameterValue}}"
        },
        "Attachment": "scriptAttachment.zip"
    }
}

通过 aws:executeScript 使用附件

附件提供了一种强大的方法，可以将复杂的脚本、多个模块和外部依赖项打包并重复用于 aws:executeScript 操作。在您需要执行以下操作时，请使用附件：

附件结构和打包

您可以附加单个文件或包含多个文件的 zip 包。具体结构取决于使用案例：

单个文件附件

对于简单的脚本，您可以附加单个 .py 文件 (Python) 或包含单个 PowerShell 脚本的 .zip 文件。

多模块包

对于需要多个模块的复杂自动化，请创建具有以下建议结构的 zip 包：

my-automation-package.zip
├── main.py                    # Entry point script
├── utils/
│   ├── __init__.py           # Required for Python module imports
│   ├── helper_functions.py   # Utility functions
│   └── aws_operations.py     # AWS-specific operations
├── config/
│   ├── __init__.py
│   └── settings.py           # Configuration settings
└── requirements.txt          # Optional: document dependencies

PowerShell 包结构

PowerShell 附件必须打包为 zip 文件，其结构如下：

my-powershell-package.zip
├── Main.ps1                  # Entry point script
├── Modules/
│   ├── HelperFunctions.ps1   # Utility functions
│   └── AWSOperations.ps1     # AWS-specific operations
└── Config/
    └── Settings.ps1          # Configuration settings

创建带附件的运行手册

请按照以下步骤创建带附件的运行手册：

aws:executeScript 附件示例

以下示例演示了使用附件和 aws:executeScript 操作的不同方法。

示例 1：单个文件附件

此示例展示如何使用单个 Python 文件作为附件来处理 EC2 实例数据。

附件文件：process_instance.py

创建一个包含以下内容的 Python 文件：

import boto3
import json

def process_instance_data(events, context):
    """Process EC2 instance data and return formatted results."""
    try:
        instance_id = events.get('instanceId')
        if not instance_id:
            raise ValueError("instanceId is required")
        
        ec2 = boto3.client('ec2')
        
        # Get instance details
        response = ec2.describe_instances(InstanceIds=[instance_id])
        instance = response['Reservations'][0]['Instances'][0]
        
        # Format the response
        result = {
            'instanceId': instance_id,
            'instanceType': instance['InstanceType'],
            'state': instance['State']['Name'],
            'availabilityZone': instance['Placement']['AvailabilityZone'],
            'tags': {tag['Key']: tag['Value'] for tag in instance.get('Tags', [])}
        }
        
        print(f"Successfully processed instance {instance_id}")
        return result
        
    except Exception as e:
        print(f"Error processing instance: {str(e)}")
        raise

完整运行手册

以下是使用单个文件附件的完整运行手册：

description: Process EC2 instance data using single file attachment
schemaVersion: '0.3'
assumeRole: '{{AutomationAssumeRole}}'
parameters:
  AutomationAssumeRole:
    type: String
    description: (Required) IAM role for automation execution
  InstanceId:
    type: String
    description: (Required) EC2 instance ID to process

files:
  process_instance.py:
    sourceType: "S3"
    sourceInfo:
      path: "s3://my-automation-bucket/scripts/process_instance.py"
      checksums:
        sha256: "abc123def456..."

mainSteps:
  - name: processInstance
    action: aws:executeScript
    inputs:
      Runtime: python3.11
      Handler: process_instance.process_instance_data
      Attachment: process_instance.py
      InputPayload:
        instanceId: '{{InstanceId}}'
    outputs:
      - Type: StringMap
        Name: InstanceData
        Selector: $.Payload

outputs:
  - processInstance.InstanceData

示例 2：多模块包

此示例演示如何使用包含多个 Python 模块的 zip 包进行复杂的 S3 存储桶操作。

包结构

创建具有以下结构的 zip 包：

s3-operations.zip
├── main.py
├── utils/
│   ├── __init__.py
│   ├── s3_helper.py
│   └── validation.py
└── config/
    ├── __init__.py
    └── settings.py

main.py（入口点）

编排操作的主脚本：

from utils.s3_helper import S3Operations
from utils.validation import validate_bucket_name
from config.settings import get_default_settings

def cleanup_s3_bucket(events, context):
    """Clean up S3 bucket based on specified criteria."""
    try:
        bucket_name = events.get('bucketName')
        max_age_days = events.get('maxAgeDays', 30)
        
        # Validate inputs
        if not validate_bucket_name(bucket_name):
            raise ValueError(f"Invalid bucket name: {bucket_name}")
        
        # Initialize S3 operations
        s3_ops = S3Operations()
        settings = get_default_settings()
        
        # Perform cleanup
        deleted_objects = s3_ops.delete_old_objects(
            bucket_name, 
            max_age_days,
            settings['dry_run']
        )
        
        result = {
            'bucketName': bucket_name,
            'deletedCount': len(deleted_objects),
            'deletedObjects': deleted_objects[:10],  # Return first 10 for brevity
            'dryRun': settings['dry_run']
        }
        
        print(f"Cleanup completed for bucket {bucket_name}")
        return result
        
    except Exception as e:
        print(f"Error during S3 cleanup: {str(e)}")
        raise

aws:executeScript 附件故障排除

使用以下指导来解决 aws:executeScript 附件的常见问题：

模块导入错误

如果在使用多模块包时收到导入错误：

未找到附件错误

如果自动化未能找到附件：

处理程序函数错误

如果收到与处理程序相关的错误：

脚本执行失败

如果脚本在执行过程中失败：

退出代码和错误处理

要正确处理错误并返回退出代码：