aws:executeScript – スクリプトを実行する

指定されたランタイムとハンドラを使用して、提供された Python または PowerShell スクリプトを実行します。各 aws:executeScript アクションは、最大 600 秒 (10 分) 実行できます。timeoutSeconds ステップで aws:executeScript パラメータを指定して、タイムアウトを制限または延長することができます。

関数でリターンステートメントを使用して、出力ペイロードに出力を追加します。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 Core モジュールが含まれています。

プレインストールされていない PowerShell Core モジュールを使用するには、次のコマンドに示すように、スクリプトで -Force フラグを使用してモジュールをインストールする必要があります。AWSPowerShell.NetCore モジュールはサポートされていません。インストールするモジュールの ModuleName を置き換えます。

Install-Module ModuleName -Force

スクリプトで PowerShell Core コマンドレットを使用するには、次のコマンドに示すように、AWS.Tools モジュールを使用することをお勧めします。各リソースプレースホルダーの例をユーザー自身の情報に置き換えます。

スクリプトで PowerShell Core コマンドレットを使用するだけでなく、新しいオブジェクトを初期化する場合は、次のコマンドに示すように、モジュールもインポートする必要があります。

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 Core コマンドレットの使用例については、「オートメーションランブックのビジュアルデザインエクスペリエンス」を参照してください 。

Input

スクリプトを実行するために必要な情報を入力します。各リソースプレースホルダーの例をユーザー自身の情報に置き換えます。

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: マルチモジュールパッケージ

この例では、複雑な S3 バケットオペレーションで複数の Python モジュールを含む zip パッケージを使用する方法を示します。

パッケージ構造

次の構造で 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 アタッチメントに関する一般的な問題を解決するには、次のガイダンスを使用してください。

モジュールのインポートエラー

マルチモジュールパッケージの使用時にインポートエラーが発生した場合:

アタッチメントが見つからないエラー

オートメーションでアタッチメントが見つからない場合:

ハンドラー関数のエラー

ハンドラー関連のエラーが発生した場合:

スクリプト実行の失敗

実行中にスクリプトが失敗した場合:

終了コードとエラー処理

エラーを適切に処理して終了コードを返すには: