Back to top

Cloud Automator API

Cloud AutomatorのAPIです。

認証

Authorization: Bearer ヘッダーを利用して認証します。 認証に利用するAPIキーは、Cloud Automatorのユーザー情報設定から生成することができます。

curlでの実行例は以下になります。

$ curl "https://manager.cloudautomator.com/api/v1/jobs" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 49046d4e374b77d8b0af0fd5959d4c11"

レスポンス形式

レスポンスボディの形式はJSON APIの仕様に準拠しています。

Resource Group

グループAWSアカウント

Create Group AwsAccount
POST/groups/{group_id}/aws_accounts

新しいAWSアカウントをグループに追加します。

リクエストボディに含めるパラメーター

名前 型 必須かどうか 説明
name string required AWSアカウントの名前
access_key_id string required AWSアクセスキーID
secret_access_key string required AWSシークレットアクセスキー

Example URI

POST https://manager.cloudautomator.com/api/v1/groups/1/aws_accounts
URI Parameters
HideShow
group_id
number (required) Example: 1

グループID

Request  サンプルリクエスト
HideShow
Headers
Content-Type: application/json
Body
{
  "name": "本番環境用AWSアカウント",
  "access_key_id": "AKIAAAAABBBBCCCCDDDD",
  "secret_access_key": "eb48e3a73904d634803ad19e341bed77eb48e3a7"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "任意のAWSアカウント名"
    },
    "access_key_id": {
      "type": "string",
      "description": "AWSアクセスキーID"
    },
    "secret_access_key": {
      "type": "string",
      "description": "AWSシークレットアクセスキー"
    }
  },
  "required": [
    "name",
    "access_key_id",
    "secret_access_key"
  ]
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": "1",
    "type": "aws_accounts",
    "attributes": {
      "name": "本番環境用AWSアカウント"
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "AWSアカウントID"
        },
        "type": {
          "type": "string",
          "description": "データ型"
        },
        "attributes": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "AWSアカウント名"
            }
          }
        }
      },
      "description": "作成されたAWSアカウント"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "source": {
        "pointer": "/data/attributes/name"
      },
      "detail": "を入力してください"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array"
    }
  }
}

Get Group AwsAccounts
GET/groups/{group_id}/aws_accounts

グループが保持している複数のAWSアカウントを取得します。

Example URI

GET https://manager.cloudautomator.com/api/v1/groups/1/aws_accounts
URI Parameters
HideShow
group_id
number (required) Example: 1

グループID

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": "1",
      "type": "aws_accounts",
      "attributes": {
        "name": "本番環境用AWSアカウント"
      }
    }
  ],
  "links": {
    "self": "https://manager.cloudautomator.com/api/v1/groups/1/aws_accounts?page%5Bnumber%5D=1&page%5Bsize%5D=5",
    "first": "https://manager.cloudautomator.com/api/v1/groups/1/aws_accounts?page%5Bnumber%5D=1&page%5Bsize%5D=5",
    "prev": "https://manager.cloudautomator.com/api/v1/groups/1/aws_accounts?page%5Bnumber%5D=1&page%5Bsize%5D=5",
    "next": "https://manager.cloudautomator.com/api/v1/groups/1/aws_accounts?page%5Bnumber%5D=2&page%5Bsize%5D=5",
    "last": "https://manager.cloudautomator.com/api/v1/groups/1/aws_accounts?page%5Bnumber%5D=3&page%5Bsize%5D=5"
  },
  "meta": {
    "total": 12
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "description": "AWSアカウントの配列"
    },
    "links": {
      "type": "object",
      "properties": {
        "self": {
          "type": "string",
          "description": "現在のページを指すURL"
        },
        "first": {
          "type": "string",
          "description": "最初のページを指すURL"
        },
        "prev": {
          "type": [
            "string",
            "null"
          ],
          "description": "前のページを指すURL"
        },
        "next": {
          "type": [
            "string",
            "null"
          ],
          "description": "次のページを指すURL"
        },
        "last": {
          "type": "string",
          "description": "最後のページを指すURL"
        }
      },
      "description": "ページネーションリンク"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "グループが保持しているAWSアカウントの総数"
        }
      }
    }
  }
}

Get Group AwsAccount
GET/groups/{group_id}/aws_accounts/{id}

グループが保持している1件のAWSアカウントを取得します。

Example URI

GET https://manager.cloudautomator.com/api/v1/groups/1/aws_accounts/1
URI Parameters
HideShow
group_id
number (required) Example: 1

グループID

id
number (required) Example: 1

AWSアカウントID

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": "1",
    "type": "aws_accounts",
    "attributes": {
      "name": "本番環境用AWSアカウント"
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "AWSアカウントID"
        },
        "type": {
          "type": "string",
          "description": "データ型"
        },
        "attributes": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "AWSアカウント名"
            }
          }
        }
      },
      "description": "AWSアカウント"
    }
  }
}

Edit Group AwsAccount
PATCH/groups/{group_id}/aws_accounts/{id}

グループが保持しているAWSアカウントの情報を更新します。

リクエストボディに含めるパラメーター

名前 型 必須かどうか 説明
name string optional AWSアカウントの名前
access_key_id string optional AWSアクセスキーID
secret_access_key string optional AWSシークレットアクセスキー

Example URI

PATCH https://manager.cloudautomator.com/api/v1/groups/1/aws_accounts/1
URI Parameters
HideShow
group_id
number (required) Example: 1

グループID

id
number (required) Example: 1

AWSアカウントID

Request  サンプルリクエスト
HideShow
Headers
Content-Type: application/json
Body
{
  "name": "本番環境用AWSアカウント"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "変更後のAWSアカウント名"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": "1",
    "type": "aws_accounts",
    "attributes": {
      "name": "本番環境用AWSアカウント"
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "AWSアカウントID"
        },
        "type": {
          "type": "string",
          "description": "データ型"
        },
        "attributes": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "AWSアカウント名"
            }
          }
        }
      },
      "description": "更新後のAWSアカウント"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "source": {
        "pointer": "/data/attributes/name"
      },
      "detail": "を入力してください"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array"
    }
  }
}

Delete Group AwsAccount
DELETE/groups/{group_id}/aws_accounts/{id}

グループが保持しているAWSアカウントを削除します。

削除に成功した場合はステータスコード204 No Contentを返し、レスポンスボディは返しません。

Example URI

DELETE https://manager.cloudautomator.com/api/v1/groups/1/aws_accounts/1
URI Parameters
HideShow
group_id
number (required) Example: 1

グループID

id
number (required) Example: 1

AWSアカウントID

Response  204
HideShow
Headers
Content-Type: application/json

グループGoogle Cloudアカウント

Create Group GoogleCloudAccount
POST/groups/{group_id}/google_cloud_accounts

新しいGoogle Cloudアカウントをグループに追加します。

リクエストボディに含めるパラメーター

名前 型 必須かどうか 説明
name string required Google Cloudアカウントの名前
account_type string required アカウントの種別。サービスアカウントの場合は"service_account"という文字列。
credentials object required クレデンシャルのJSONオブジェクト

Example URI

POST https://manager.cloudautomator.com/api/v1/groups/1/google_cloud_accounts
URI Parameters
HideShow
group_id
number (required) Example: 1

グループID

Request  サンプルリクエスト
HideShow
Headers
Content-Type: application/json
Body
{
  "name": "本番環境用Google Cloudアカウント",
  "account_type": "service_account",
  "credentials": {
    "type": "service_account",
    "project_id": "gcp-test",
    "private_key_id": "3ab5187ad117dfcd6cdd411bb0af45653ab5187a",
    "private_key": "-----BEGIN PRIVATE KEY-----\\nTEST\\n-----END PRIVATE KEY-----\\n",
    "client_email": "test@gcp-dev-test.iam.example.com",
    "client_id": "000000000000000000000",
    "auth_uri": "https://accounts.example.com/o/oauth2/auth",
    "token_uri": "https://oauth2.example.com/token",
    "auth_provider_x509_cert_url": "https://www.example.com/oauth2/v1/certs",
    "client_x509_cert_url": "https://www.example.com/robot/v1/metadata/x509/test%40gcp-dev-test.iam.example.com"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "任意のGoogle Cloudアカウント名"
    },
    "account_type": {
      "type": "string",
      "description": "アカウントの種別"
    },
    "credentials": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string"
        },
        "project_id": {
          "type": "string"
        },
        "private_key_id": {
          "type": "string"
        },
        "private_key": {
          "type": "string"
        },
        "client_email": {
          "type": "string"
        },
        "client_id": {
          "type": "string"
        },
        "auth_uri": {
          "type": "string"
        },
        "token_uri": {
          "type": "string"
        },
        "auth_provider_x509_cert_url": {
          "type": "string"
        },
        "client_x509_cert_url": {
          "type": "string"
        }
      },
      "required": [
        "type",
        "project_id",
        "private_key_id",
        "private_key",
        "client_email",
        "client_id",
        "auth_uri",
        "token_uri",
        "auth_provider_x509_cert_url",
        "client_x509_cert_url"
      ],
      "description": "クレデンシャル"
    }
  },
  "required": [
    "name",
    "account_type",
    "credentials"
  ]
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": "1",
    "type": "google_cloud_accounts",
    "attributes": {
      "name": "本番環境用Google Cloudアカウント",
      "account_type": "service_account",
      "masked_private_key_id": "3ab**********************************87a"
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Google CloudアカウントID"
        },
        "type": {
          "type": "string",
          "description": "データ型"
        },
        "attributes": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "Google Cloudアカウント名"
            },
            "account_type": {
              "type": "string",
              "description": "アカウントの種別"
            },
            "masked_private_key_id": {
              "type": "string",
              "description": "クレデンシャルのprivate_key_idをマスクしたもの"
            }
          }
        }
      },
      "description": "作成されたGoogle Cloudアカウント"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "source": {
        "pointer": "/data/attributes/name"
      },
      "detail": "を入力してください"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array"
    }
  }
}

Get Group GoogleCloudAccounts
GET/groups/{group_id}/google_cloud_accounts

グループが保持している複数のGoogle Cloudアカウントを取得します。

Example URI

GET https://manager.cloudautomator.com/api/v1/groups/1/google_cloud_accounts
URI Parameters
HideShow
group_id
number (required) Example: 1

グループID

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": "1",
      "type": "google_cloud_accounts",
      "attributes": {
        "name": "本番環境用Google Cloudアカウント",
        "account_type": "service_account",
        "masked_private_key_id": "3ab**********************************87a"
      }
    }
  ],
  "links": {
    "self": "https://manager.cloudautomator.com/api/v1/groups/1/google_cloud_accounts?page%5Bnumber%5D=1&page%5Bsize%5D=5",
    "first": "https://manager.cloudautomator.com/api/v1/groups/1/google_cloud_accounts?page%5Bnumber%5D=1&page%5Bsize%5D=5",
    "prev": "https://manager.cloudautomator.com/api/v1/groups/1/google_cloud_accounts?page%5Bnumber%5D=1&page%5Bsize%5D=5",
    "next": "https://manager.cloudautomator.com/api/v1/groups/1/google_cloud_accounts?page%5Bnumber%5D=2&page%5Bsize%5D=5",
    "last": "https://manager.cloudautomator.com/api/v1/groups/1/google_cloud_accounts?page%5Bnumber%5D=3&page%5Bsize%5D=5"
  },
  "meta": {
    "total": 12
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "description": "Google Cloudアカウントの配列"
    },
    "links": {
      "type": "object",
      "properties": {
        "self": {
          "type": "string",
          "description": "現在のページを指すURL"
        },
        "first": {
          "type": "string",
          "description": "最初のページを指すURL"
        },
        "prev": {
          "type": [
            "string",
            "null"
          ],
          "description": "前のページを指すURL"
        },
        "next": {
          "type": [
            "string",
            "null"
          ],
          "description": "次のページを指すURL"
        },
        "last": {
          "type": "string",
          "description": "最後のページを指すURL"
        }
      },
      "description": "ページネーションリンク"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "グループが保持しているGoogle Cloudアカウントの総数"
        }
      }
    }
  }
}

Get Group GoogleCloudAccount
GET/groups/{group_id}/google_cloud_accounts/{id}

グループが保持している1件のGoogle Cloudアカウントを取得します。

Example URI

GET https://manager.cloudautomator.com/api/v1/groups/1/google_cloud_accounts/1
URI Parameters
HideShow
group_id
number (required) Example: 1

グループID

id
number (required) Example: 1

Google CloudアカウントID

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": "1",
    "type": "google_cloud_accounts",
    "attributes": {
      "name": "本番環境用Google Cloudアカウント",
      "account_type": "service_account",
      "masked_private_key_id": "3ab**********************************87a"
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Google CloudアカウントID"
        },
        "type": {
          "type": "string",
          "description": "データ型"
        },
        "attributes": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "Google Cloudアカウント名"
            },
            "account_type": {
              "type": "string",
              "description": "アカウントの種別"
            },
            "masked_private_key_id": {
              "type": "string",
              "description": "クレデンシャルのprivate_key_idをマスクしたもの"
            }
          }
        }
      },
      "description": "Google Cloudアカウント"
    }
  }
}

Edit Group GoogleCloudAccount
PATCH/groups/{group_id}/google_cloud_accounts/{id}

グループが保持しているGoogle Cloudアカウントの情報を更新します。

リクエストボディに含めるパラメーター

名前 型 必須かどうか 説明
name string optional Google Cloudアカウントの名前
credentials object optional クレデンシャルのJSONオブジェクト

Example URI

PATCH https://manager.cloudautomator.com/api/v1/groups/1/google_cloud_accounts/1
URI Parameters
HideShow
group_id
number (required) Example: 1

グループID

id
number (required) Example: 1

Google CloudアカウントID

Request  サンプルリクエスト
HideShow
Headers
Content-Type: application/json
Body
{
  "name": "本番環境用Google Cloudアカウント",
  "credentials": {
    "type": "service_account",
    "project_id": "gcp-test",
    "private_key_id": "3ab5187ad117dfcd6cdd411bb0af45653ab5187a",
    "private_key": "-----BEGIN PRIVATE KEY-----\\nTEST\\n-----END PRIVATE KEY-----\\n",
    "client_email": "test@gcp-dev-test.iam.example.com",
    "client_id": "000000000000000000000",
    "auth_uri": "https://accounts.example.com/o/oauth2/auth",
    "token_uri": "https://oauth2.example.com/token",
    "auth_provider_x509_cert_url": "https://www.example.com/oauth2/v1/certs",
    "client_x509_cert_url": "https://www.example.com/robot/v1/metadata/x509/test%40gcp-dev-test.iam.example.com"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "変更後のGoogle Cloudアカウント名"
    },
    "credentials": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string"
        },
        "project_id": {
          "type": "string"
        },
        "private_key_id": {
          "type": "string"
        },
        "private_key": {
          "type": "string"
        },
        "client_email": {
          "type": "string"
        },
        "client_id": {
          "type": "string"
        },
        "auth_uri": {
          "type": "string"
        },
        "token_uri": {
          "type": "string"
        },
        "auth_provider_x509_cert_url": {
          "type": "string"
        },
        "client_x509_cert_url": {
          "type": "string"
        }
      },
      "required": [
        "type",
        "project_id",
        "private_key_id",
        "private_key",
        "client_email",
        "client_id",
        "auth_uri",
        "token_uri",
        "auth_provider_x509_cert_url",
        "client_x509_cert_url"
      ],
      "description": "クレデンシャル - 変更する場合のみ値を指定する(省略時は変更されない)"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": "1",
    "type": "google_cloud_accounts",
    "attributes": {
      "name": "本番環境用Google Cloudアカウント",
      "account_type": "service_account",
      "masked_private_key_id": "3ab**********************************87a"
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Google CloudアカウントID"
        },
        "type": {
          "type": "string",
          "description": "データ型"
        },
        "attributes": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "Google Cloudアカウント名"
            },
            "account_type": {
              "type": "string",
              "description": "アカウントの種別"
            },
            "masked_private_key_id": {
              "type": "string",
              "description": "クレデンシャルのprivate_key_idをマスクしたもの"
            }
          }
        }
      },
      "description": "更新後のGoogle Cloudアカウント"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "source": {
        "pointer": "/data/attributes/name"
      },
      "detail": "を入力してください"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array"
    }
  }
}

Delete Group GoogleCloudAccount
DELETE/groups/{group_id}/google_cloud_accounts/{id}

グループが保持しているGoogle Cloudアカウントを削除します。

削除に成功した場合はステータスコード204 No Contentを返し、レスポンスボディは返しません。

Example URI

DELETE https://manager.cloudautomator.com/api/v1/groups/1/google_cloud_accounts/1
URI Parameters
HideShow
group_id
number (required) Example: 1

グループID

id
number (required) Example: 1

Google CloudアカウントID

Response  204
HideShow
Headers
Content-Type: application/json

ジョブ

Create Job
POST/jobs

新しいジョブを作成します。

リクエストボディに含めるパラメーター

名前 型 必須かどうか 説明
name string required ジョブの名前
group_id number required ジョブを所属させるグループのID
for_workflow boolean optional ジョブワークフロー専用ジョブにするかどうか
aws_account_id number optional ジョブの実行時に使うAWSアカウントのID。AWS用アクションの場合のみ必要
※AWSのアカウントIDではなくCloud Automator上のID
aws_account_ids array optional ジョブの実行時に使うAWSアカウントのIDの配列。
AWS用アクションのうち、action_typeがbulk_stop_instancesの場合に必要。
その場合、aws_account_idは指定不可。
google_cloud_account_id number optional ジョブの実行時に使うGoogle CloudアカウントのID。Google Cloud用アクションの場合のみ必要
※Google Cloud側のIDではなくCloud Automator上のID
rule_type string required トリガーのタイプ
cronなど
rule_value object required トリガーの設定値(後述)
action_type string required アクションのタイプ
create_imageなど
action_value object required アクションの設定値(後述)
※action_value内のboolean型のパラメータは基本的に文字列で設定すること
例) “true” ==> OK true ==> NG

ただし一部アクションのパラメータでは例外的にtrueやfalseをboolean型でそのまま設定する必要あり。
allow_runtime_action_values boolean optional アクションの設定値を実行時に指定するかどうか
※trueの場合、action_valueは空のオブジェクトである必要があります。
※トリガーとアクションの組み合わせが実行時の指定に対応していない場合は無視されます。
effective_date string optional ジョブの有効期間の開始日
yyyy/mm/dd形式 (JSTとして解釈されます)
※rule_typeがcronかつschedule_typeがone_time以外の場合のみ指定
※rule_typeがcronかつschedule_typeがone_timeの場合にこのパラメータを指定すると422 Unprocessable Entityを返します
expiration_date string optional ジョブの有効期間の終了日
yyyy/mm/dd形式 (JSTとして解釈されます)
※rule_typeがcronかつschedule_typeがone_time以外の場合のみ指定可能
※rule_typeがcronかつschedule_typeがone_timeの場合にこのパラメータを指定すると422 Unprocessable Entityを返します
completed_post_process_id array[number] optional ジョブが成功した場合に実行する後処理IDが含まれる配列
空の配列を指定すると現在の設定が削除されます。
パラメーターを指定しない場合は現在の設定が維持されます。
例) [1, 2, 3, 4]
failed_post_process_id array[number] optional ジョブが失敗した場合に実行する後処理IDが含まれる配列
空の配列を指定すると現在の設定が削除されます。
パラメーターを指定しない場合は現在の設定が維持されます。
例) [1, 2, 3, 4]

トリガーのタイプとしてrule_typeに指定できるのは以下のいずれかです。

タイプ 説明 rule_valueの要否
cron タイマートリガー 必要
immediate_execution 手動トリガー 不要
webhook HTTPトリガー 不要
schedule スケジュールトリガー 必要
sqs_v2 SQSトリガー 必要
amazon_sns SNSトリガー 不要
no_rule トリガーなし 不要
※for_workflow が true の場合のみ指定可能

トリガーのタイプがcronの場合のrule_valueの設定値

名前 型 必須かどうか デフォルト値 説明
hour number required - ジョブを実行するタイミング(時)
0〜23
minutes number required - ジョブを実行するタイミング(分)
0〜59
schedule_type string required - スケジュールのタイプ
以下のいずれかが指定可能
one_time(一度きり)
weekly(毎週)
monthly(毎月の日付)
monthly_day_of_week(毎月の曜日)
one_time_schedule string optional - ジョブの実行年月日
yyyy/mm/dd形式
※schedule_typeがone_timeの場合必須
※現在時刻よりも未来であること
weekly_schedule array[string] optional - ジョブの実行曜日
sunday〜saturdayまでの文字列を含む配列
例) [“monday”,“friday”]
※schedule_typeがweeklyの場合必須
monthly_schedule string, object optional - 毎月のジョブの実行日付または曜日
schedule_typeがmonthlyまたはmonthly_day_of_weekの場合に必須

schedule_typeがmonthlyの場合:
"1"〜"31"の日付または月末をあらわす "end_of_month" を文字列で指定する。
※2月31日のように該当日が月に存在しなかった場合、ジョブの実行はスキップされる

schedule_typeがmonthly_day_of_weekの場合:
{ friday: [2] } のように曜日名をキー、順序の配列を値として指定する。
※順序は、1〜4 (第1〜第4)および-1 (最終)の中からいずれか1つを数値で指定する。
※複数の曜日名や順序を指定した場合は、先頭の1件だけが使われる
※例：最終日曜日なら { sunday: [-1] } となり、第1月曜日なら { monday: [1] } となる
national_holiday_schedule string optional false ジョブの実行日と日本の祝日が重なっていた場合にジョブの実行をスキップするか否かのフラグ
"true" もしくは "false"
※"true" を指定した場合、ジョブの実行日と日本の祝日が重なっていた場合にジョブの実行をスキップします
start_timeout_minutes string optional - ジョブの開始が遅延した場合にジョブ実行の開始をキャンセルする遅延時間
指定しない場合はジョブの開始が遅延しても実行します。
time_zone string optional - Tokyo, Singapore, UTCなど、タイムゾーンを表す文字列
指定しない場合はジョブ作成ユーザーのタイムゾーンが設定されます。
dates_to_skip array[string] optional - ジョブ実行をスキップする日付を示す YYYY-MM-DD 形式の日付の配列 例) [“2020-01-01”, “2020-01-02”, “2020-01-03”]

ジョブの開始が遅延した場合に実行の開始をキャンセルする遅延時間start_timeout_minutesに指定できる設定値

設定値 説明
null ジョブの開始が遅延しても実行する
30 ジョブの開始が30分以上遅延した場合にジョブの開始をキャンセルする
60 ジョブの開始が1時間以上遅延した場合にジョブの開始をキャンセルする
180 ジョブの開始が3時間以上遅延した場合にジョブの開始をキャンセルする
360 ジョブの開始が6時間以上遅延した場合にジョブの開始をキャンセルする

タイムゾーンtime_zoneに指定できる設定値

設定値 オフセット
International Date Line West GMT-12:00
American Samoa GMT-11:00
Midway Island GMT-11:00
Hawaii GMT-10:00
Alaska GMT-09:00
Pacific Time (US & Canada) GMT-08:00
Tijuana GMT-08:00
Arizona GMT-07:00
Chihuahua GMT-07:00
Mazatlan GMT-07:00
Mountain Time (US & Canada) GMT-07:00
Central America GMT-06:00
Central Time (US & Canada) GMT-06:00
Guadalajara GMT-06:00
Mexico City GMT-06:00
Monterrey GMT-06:00
Saskatchewan GMT-06:00
Bogota GMT-05:00
Eastern Time (US & Canada) GMT-05:00
Indiana (East) GMT-05:00
Lima GMT-05:00
Quito GMT-05:00
Atlantic Time (Canada) GMT-04:00
Caracas GMT-04:00
Georgetown GMT-04:00
La Paz GMT-04:00
Puerto Rico GMT-04:00
Santiago GMT-04:00
Newfoundland GMT-03:30
Brasilia GMT-03:00
Buenos Aires GMT-03:00
Greenland GMT-03:00
Montevideo GMT-03:00
Mid-Atlantic GMT-02:00
Azores GMT-01:00
Cape Verde Is. GMT-01:00
Edinburgh GMT+00:00
Lisbon GMT+00:00
London GMT+00:00
Monrovia GMT+00:00
UTC GMT+00:00
Amsterdam GMT+01:00
Belgrade GMT+01:00
Berlin GMT+01:00
Bern GMT+01:00
Bratislava GMT+01:00
Brussels GMT+01:00
Budapest GMT+01:00
Casablanca GMT+01:00
Copenhagen GMT+01:00
Dublin GMT+01:00
Ljubljana GMT+01:00
Madrid GMT+01:00
Paris GMT+01:00
Prague GMT+01:00
Rome GMT+01:00
Sarajevo GMT+01:00
Skopje GMT+01:00
Stockholm GMT+01:00
Vienna GMT+01:00
Warsaw GMT+01:00
West Central Africa GMT+01:00
Zagreb GMT+01:00
Zurich GMT+01:00
Athens GMT+02:00
Bucharest GMT+02:00
Cairo GMT+02:00
Harare GMT+02:00
Helsinki GMT+02:00
Jerusalem GMT+02:00
Kaliningrad GMT+02:00
Kyiv GMT+02:00
Pretoria GMT+02:00
Riga GMT+02:00
Sofia GMT+02:00
Tallinn GMT+02:00
Vilnius GMT+02:00
Baghdad GMT+03:00
Istanbul GMT+03:00
Kuwait GMT+03:00
Minsk GMT+03:00
Moscow GMT+03:00
Nairobi GMT+03:00
Riyadh GMT+03:00
St. Petersburg GMT+03:00
Tehran GMT+03:30
Abu Dhabi GMT+04:00
Baku GMT+04:00
Muscat GMT+04:00
Samara GMT+04:00
Tbilisi GMT+04:00
Volgograd GMT+04:00
Yerevan GMT+04:00
Kabul GMT+04:30
Ekaterinburg GMT+05:00
Islamabad GMT+05:00
Karachi GMT+05:00
Tashkent GMT+05:00
Chennai GMT+05:30
Kolkata GMT+05:30
Mumbai GMT+05:30
New Delhi GMT+05:30
Sri Jayawardenepura GMT+05:30
Kathmandu GMT+05:45
Almaty GMT+06:00
Astana GMT+06:00
Dhaka GMT+06:00
Urumqi GMT+06:00
Rangoon GMT+06:30
Bangkok GMT+07:00
Hanoi GMT+07:00
Jakarta GMT+07:00
Krasnoyarsk GMT+07:00
Novosibirsk GMT+07:00
Beijing GMT+08:00
Chongqing GMT+08:00
Hong Kong GMT+08:00
Irkutsk GMT+08:00
Kuala Lumpur GMT+08:00
Perth GMT+08:00
Singapore GMT+08:00
Taipei GMT+08:00
Ulaanbaatar GMT+08:00
Osaka GMT+09:00
Sapporo GMT+09:00
Seoul GMT+09:00
Tokyo GMT+09:00
Yakutsk GMT+09:00
Adelaide GMT+09:30
Darwin GMT+09:30
Brisbane GMT+10:00
Canberra GMT+10:00
Guam GMT+10:00
Hobart GMT+10:00
Melbourne GMT+10:00
Port Moresby GMT+10:00
Sydney GMT+10:00
Vladivostok GMT+10:00
Magadan GMT+11:00
New Caledonia GMT+11:00
Solomon Is. GMT+11:00
Srednekolymsk GMT+11:00
Auckland GMT+12:00
Fiji GMT+12:00
Kamchatka GMT+12:00
Marshall Is. GMT+12:00
Wellington GMT+12:00
Chatham Is. GMT+12:45
Nuku’alofa GMT+13:00
Samoa GMT+13:00
Tokelau Is. GMT+13:00

トリガーのタイプがscheduleの場合のrule_valueの設定値

名前 型 必須かどうか デフォルト値 説明
schedule string required - ジョブの実行予定日時
YYYY-MM-DD HH:MM:SSの形式で\n区切りの文字列
1日に1件まで、最大で500件 10分単位で指定可能
現在時刻から60分以内の日時は指定不可

例えば 2020年12月31日10時10分と2021年1月1日22時40分に実行したい場合、以下のような値を指定します
- "2020-12-31 10:10:00\n2021-01-01 22:40:00"

以下のような入力はエラーと判定されます
- 2020/02/30 10:00:00 (日付の形式が正しくない)
- 2020-02-03 9:00 (時刻の形式が正しくない)
- 2020-03-01 10:11:00 (分が10分単位でない)
- 2020-02-30 10:00:00 (存在しない日付である)
time_zone string optional - 実行予定日時のタイムゾーン 指定しない場合はジョブ作成ユーザーのタイムゾーンが設定されます。

タイムゾーンtime_zoneに指定できる設定値

設定値 オフセット
International Date Line West GMT-12:00
American Samoa GMT-11:00
Midway Island GMT-11:00
Hawaii GMT-10:00
Alaska GMT-09:00
Pacific Time (US & Canada) GMT-08:00
Tijuana GMT-08:00
Arizona GMT-07:00
Chihuahua GMT-07:00
Mazatlan GMT-07:00
Mountain Time (US & Canada) GMT-07:00
Central America GMT-06:00
Central Time (US & Canada) GMT-06:00
Guadalajara GMT-06:00
Mexico City GMT-06:00
Monterrey GMT-06:00
Saskatchewan GMT-06:00
Bogota GMT-05:00
Eastern Time (US & Canada) GMT-05:00
Indiana (East) GMT-05:00
Lima GMT-05:00
Quito GMT-05:00
Atlantic Time (Canada) GMT-04:00
Caracas GMT-04:00
Georgetown GMT-04:00
La Paz GMT-04:00
Puerto Rico GMT-04:00
Santiago GMT-04:00
Newfoundland GMT-03:30
Brasilia GMT-03:00
Buenos Aires GMT-03:00
Greenland GMT-03:00
Montevideo GMT-03:00
Mid-Atlantic GMT-02:00
Azores GMT-01:00
Cape Verde Is. GMT-01:00
Edinburgh GMT+00:00
Lisbon GMT+00:00
London GMT+00:00
Monrovia GMT+00:00
UTC GMT+00:00
Amsterdam GMT+01:00
Belgrade GMT+01:00
Berlin GMT+01:00
Bern GMT+01:00
Bratislava GMT+01:00
Brussels GMT+01:00
Budapest GMT+01:00
Casablanca GMT+01:00
Copenhagen GMT+01:00
Dublin GMT+01:00
Ljubljana GMT+01:00
Madrid GMT+01:00
Paris GMT+01:00
Prague GMT+01:00
Rome GMT+01:00
Sarajevo GMT+01:00
Skopje GMT+01:00
Stockholm GMT+01:00
Vienna GMT+01:00
Warsaw GMT+01:00
West Central Africa GMT+01:00
Zagreb GMT+01:00
Zurich GMT+01:00
Athens GMT+02:00
Bucharest GMT+02:00
Cairo GMT+02:00
Harare GMT+02:00
Helsinki GMT+02:00
Jerusalem GMT+02:00
Kaliningrad GMT+02:00
Kyiv GMT+02:00
Pretoria GMT+02:00
Riga GMT+02:00
Sofia GMT+02:00
Tallinn GMT+02:00
Vilnius GMT+02:00
Baghdad GMT+03:00
Istanbul GMT+03:00
Kuwait GMT+03:00
Minsk GMT+03:00
Moscow GMT+03:00
Nairobi GMT+03:00
Riyadh GMT+03:00
St. Petersburg GMT+03:00
Tehran GMT+03:30
Abu Dhabi GMT+04:00
Baku GMT+04:00
Muscat GMT+04:00
Samara GMT+04:00
Tbilisi GMT+04:00
Volgograd GMT+04:00
Yerevan GMT+04:00
Kabul GMT+04:30
Ekaterinburg GMT+05:00
Islamabad GMT+05:00
Karachi GMT+05:00
Tashkent GMT+05:00
Chennai GMT+05:30
Kolkata GMT+05:30
Mumbai GMT+05:30
New Delhi GMT+05:30
Sri Jayawardenepura GMT+05:30
Kathmandu GMT+05:45
Almaty GMT+06:00
Astana GMT+06:00
Dhaka GMT+06:00
Urumqi GMT+06:00
Rangoon GMT+06:30
Bangkok GMT+07:00
Hanoi GMT+07:00
Jakarta GMT+07:00
Krasnoyarsk GMT+07:00
Novosibirsk GMT+07:00
Beijing GMT+08:00
Chongqing GMT+08:00
Hong Kong GMT+08:00
Irkutsk GMT+08:00
Kuala Lumpur GMT+08:00
Perth GMT+08:00
Singapore GMT+08:00
Taipei GMT+08:00
Ulaanbaatar GMT+08:00
Osaka GMT+09:00
Sapporo GMT+09:00
Seoul GMT+09:00
Tokyo GMT+09:00
Yakutsk GMT+09:00
Adelaide GMT+09:30
Darwin GMT+09:30
Brisbane GMT+10:00
Canberra GMT+10:00
Guam GMT+10:00
Hobart GMT+10:00
Melbourne GMT+10:00
Port Moresby GMT+10:00
Sydney GMT+10:00
Vladivostok GMT+10:00
Magadan GMT+11:00
New Caledonia GMT+11:00
Solomon Is. GMT+11:00
Srednekolymsk GMT+11:00
Auckland GMT+12:00
Fiji GMT+12:00
Kamchatka GMT+12:00
Marshall Is. GMT+12:00
Wellington GMT+12:00
Chatham Is. GMT+12:45
Nuku’alofa GMT+13:00
Samoa GMT+13:00
Tokelau Is. GMT+13:00

トリガーのタイプがsqs_v2の場合のrule_valueの設定値

名前 型 必須かどうか 説明
sqs_aws_account_id number required SQSキューが存在するAWSアカウント<>例) 1
※AWSのアカウントIDではなくCloud Automator上のID
sqs_region string required SQSキューが存在するリージョン
例) “ap-northeast-1”
queue string required SQSキュー名
※標準キューのみ対応しております。 FIFOキューはご利用いただけません。

アクションのタイプとしてaction_typeに指定できるのは以下のいずれかです。

AWS用アクション

これらのアクションを指定する場合は aws_account_id も指定する必要があります。

タイプ 説明
attach_user_policy IAM: ユーザーにポリシーをアタッチ
authorize_security_group_ingress EC2: セキュリティグループにインバウンドルールを追加
change_rds_cluster_instance_class RDS(Aurora): DBインスタンスクラスを変更
change_rds_instance_class RDS: DBインスタンスクラスを変更
change_instance_type EC2: インスタンスタイプを変更
copy_ebs_snapshot EC2: EBSスナップショットをリージョン間でコピー
copy_image EC2: AMIをリージョン間でコピー
create_ebs_snapshot EC2: EBSスナップショットを作成
create_image EC2: AMIを作成
create_rds_cluster_snapshot RDS(Aurora): DBクラスタースナップショットを作成
create_rds_snapshot RDS: DBスナップショットを作成
create_redshift_snapshot Redshift: クラスタースナップショットを作成
delete_cluster Redshift: クラスターを削除
delete_rds_cluster RDS(Aurora): DBクラスターを削除
delete_rds_instance RDS: DBインスタンスを削除
deregister_instances ELB(CLB): EC2インスタンスを登録解除
deregister_target_instances ELB(ALB/NLB): ターゲットグループからEC2インスタンスを登録解除
detach_user_policy IAM: ユーザーからポリシーをデタッチ
dynamodb_start_backup_job DynamoDB: テーブルをバックアップ
invoke_lambda_function Lambda: 関数を実行
reboot_rds_instances RDS: DBインスタンスを再起動
reboot_workspaces WorkSpaces: WorkSpaceを再起動
rebuild_workspaces WorkSpaces: WorkSpaceを再構築
register_instances ELB(CLB): EC2インスタンスを登録
register_target_instances ELB(ALB/NLB): ターゲットグループにEC2インスタンスを登録
restore_from_cluster_snapshot Redshift: スナップショットからリストア
restore_rds_cluster RDS(Aurora): DBクラスタースナップショットからリストア
restore_rds_instance RDS: DBスナップショットからリストア
revoke_security_group_ingress EC2: セキュリティグループからインバウンドルールを削除
run_ecs_tasks_fargate ECS: タスクを実行 (Fargate)
s3_start_backup_job S3: バケットをバックアップ
send_command EC2: インスタンスでコマンドを実行
start_instances EC2: インスタンスを起動
start_rds_clusters RDS(Aurora): DBクラスターを起動
start_rds_instances RDS: DBインスタンスを起動
stop_ecs_tasks ECS: タスクを停止
stop_instances EC2: インスタンスを停止
stop_rds_clusters RDS(Aurora): DBクラスターを停止
stop_rds_instances RDS: DBインスタンスを停止
start_workspaces WorkSpaces: WorkSpaceを起動
terminate_workspaces WorkSpaces: WorkSpaceを削除
update_record_set Route 53: リソースレコードセットを更新
windows_update EC2: インスタンスをWindows Update
windows_update_v2 EC2: インスタンスをWindows Update (新バージョン)

AWS用アクション (複数アカウント対応)

これらのアクションを指定する場合は aws_account_ids も指定する必要があります。

タイプ 説明
bulk_stop_instances EC2: インスタンスをすべて停止

Google Cloud用アクション

これらのアクションを指定する場合は google_cloud_account_id も指定する必要があります。

タイプ 説明
google_compute_insert_machine_image Compute Engine: マシンイメージを作成
google_compute_start_vm_instances Compute Engine: VMインスタンスを起動
google_compute_stop_vm_instances Compute Engine: VMインスタンスを停止

プロバイダなしのアクション

これらのアクションを指定する場合は aws_account_id および google_cloud_account_id のいずれも指定することはできません。

タイプ 説明
delay Other: 指定時間待機

アクションのタイプがattach_user_policyの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
user_name string required - 対象のIAMユーザー名
例) “example-user”
policy_arn string required - IAMポリシーのARN
例) “arn:aws:iam::123456789012:policy/example-policy”

アクションのタイプがauthorize_security_group_ingressの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - 変更対象のセキュリティグループが存在するAWSリージョン
specify_security_group string required - 対象のセキュリティグループの特定方法
セキュリティグループID: identifier
タグ: tag
security_group_id string optional - 対象のセキュリティグループID
※specify_security_groupでidentifierを指定した場合必須
tag_key string optional - セキュリティグループ特定に利用するタグのキー
※specify_security_groupでtagを指定した場合必須
tag_value string optional - セキュリティグループ特定に利用するタグの値
※specify_security_groupでtagを指定した場合必須
ip_protocol string required - 通信プロトコル
例) “tcp”
to_port string required - ポート番号
例) 80
cidr_ip string required - 送信元IPのCIDRアドレス
例) “172.31.0.0/16”

アクションのタイプがbulk_stop_instancesの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
exclude_by_tag boolean required - 特定のタグが付いたインスタンスを除外するかどうか
trueまたはfalse
exclude_by_tag_key string optional - 除外するインスタンスの特定に利用するタグのキー
※exclude_by_tagでtrueを指定した場合は必須
exclude_by_tag_value string optional - 除外するインスタンスの特定に利用するタグの値
※exclude_by_tagでtagを指定した場合は必須

アクションのタイプがchange_rds_cluster_instance_classの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - 変更対象のDBインスタンス(Auroraエンジン)が存在するAWSリージョン
specify_rds_instance string required - 対象のDBインスタンス(Auroraエンジン)の特定方法
インスタンスID: identifier
タグ: tag
rds_instance_id string optional - 対象のDBインスタンスID
※specify_instanceでidentifierを指定した場合必須
tag_key string optional - DBインスタンス特定に利用するタグのキー
※specify_instanceでtagを指定した場合必須
tag_value string optional - DBインスタンス特定に利用するタグの値
※specify_instanceでtagを指定した場合必須
db_instance_class string required - 変更後のDBインスタンスクラス
例) “db.t3.micro”

アクションのタイプがchange_rds_instance_classの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - 変更対象のDBインスタンスが存在するAWSリージョン
specify_rds_instance string required - 対象のDBインスタンスの特定方法
インスタンスID: identifier
タグ: tag
rds_instance_id string optional - 対象のDBインスタンスID
※specify_instanceでidentifierを指定した場合必須
tag_key string optional - DBインスタンス特定に利用するタグのキー
※specify_instanceでtagを指定した場合必須
tag_value string optional - DBインスタンス特定に利用するタグの値
※specify_instanceでtagを指定した場合必須
db_instance_class string required - 変更後のDBインスタンスクラス
例) “db.t3.micro”

アクションのタイプがchange_instance_typeの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - 変更対象のインスタンスが存在するAWSリージョン
specify_instance string required - 対象のEC2インスタンスの特定方法
インスタンスID: identifier
タグ: tag
instance_id string optional - 対象のEC2インスタンスID
※specify_instanceでidentifierを指定した場合必須
tag_key string optional - インスタンス特定に利用するタグのキー
※specify_instanceでtagを指定した場合必須
tag_value string optional - インスタンス特定に利用するタグの値
※specify_instanceでtagを指定した場合必須
instance_type string required - 変更後のインスタンスタイプ
例) “t2.medium”

アクションのタイプがcopy_ebs_snapshotの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
source_region string required - EBSスナップショットのコピー元のAWSリージョン
destination_region string required - EBSスナップショットのコピー先のAWSリージョン
specify_ebs_snapshot string required - 対象のEBSスナップショットの特定方法
EBSスナップショットID: identifier
タグ: tag
snapshot_id string optional - 対象のEBSスナップショットID
※specify_ebs_snapshotでidentifierを指定した場合必須
tag_key string optional - EBSスナップショット特定に利用するタグのキー
※specify_ebs_snapshotでtagを指定した場合必須
tag_value string optional - EBSスナップショット特定に利用するタグの値
※specify_ebs_snapshotでtagを指定した場合必須
trace_status string optional true EBSスナップショットのコピー完了をジョブ完了の判定にするフラグ
"true" もしくは "false"

アクションのタイプがcopy_imageの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
source_region string required - AMIのコピー元のAWSリージョン
destination_region string required - AMIのコピー先のAWSリージョン
specify_image string required - 対象のAMIの特定方法
EBSスナップショットID: identifier
タグ: tag
source_image_id string optional - 対象のAMIのID
※specify_imageでidentifierを指定した場合必須
tag_key string optional - AMI特定に利用するタグのキー
※specify_imageでtagを指定した場合必須
tag_value string optional - AMI特定に利用するタグの値
※specify_imageでtagを指定した場合必須
trace_status string optional true AMIのコピー完了をジョブ完了の判定にするフラグ
"true" もしくは "false"

アクションのタイプがcopy_rds_cluster_snapshotの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
source_region string required - DBクラスタースナップショットのコピー元のAWSリージョン
destination_region string required - DBクラスタースナップショットのコピー先のAWSリージョン
specify_rds_cluster_snapshot string required - 対象のDBクラスタースナップショットの特定方法
DBクラスタースナップショットID: rds_cluster_snapshot_id
RDSクラスターID: source_rds_cluster_id
rds_cluster_snapshot_id string optional - 対象のDBクラスタースナップショットID
※specify_rds_cluster_snapshotでrds_cluster_snapshot_idを指定した場合必須
source_rds_cluster_id string optional - 対象のRDSクラスターID
※specify_rds_cluster_snapshotでsource_rds_cluster_idを指定した場合必須
kms_key_id string optional - コピー先のAWSリージョンのKMSキー。対象のDBクラスタースナップショット、もしくはDBクラスターが暗号化されている場合必須。

アクションのタイプがcopy_rds_snapshotの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
source_region string required - DBスナップショットのコピー元のAWSリージョン
destination_region string required - DBスナップショットのコピー先のAWSリージョン
specify_rds_snapshot string required - 対象のDBスナップショットの特定方法
DBスナップショットID: identifier
DBインスタンスID: source_rds_instance_id
rds_snapshot_id string optional - 対象のDBスナップショットID
※specify_rds_snapshotでidentifierを指定した場合必須
source_rds_instance_id string optional - 対象のDBインスタンスID
※specify_rds_snapshotでsource_rds_instance_idを指定した場合必須
option_group_name string optional - コピー先リージョンに設定するオプショングループ名
指定しない場合はデフォルトのオプショングループが使用されます
例) “default:mysql-5-6”
kms_key_id string optional - コピー先のAWSリージョンのKMSキー。対象のDBスナップショット、もしくはDBインスタンスが暗号化されている場合必須。
trace_status string optional true DBスナップショットのコピー完了をジョブ完了の判定にするフラグ
"true" もしくは "false"

アクションのタイプがcreate_ebs_snapshotの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - EBSスナップショットを作成するAWSリージョン
specify_volume string required - 対象のEBSボリュームの特定方法
ボリュームID: identifier
タグ: tag
volume_id string optional - 対象のEBSボリュームID
※specify_volumeでidentifierを指定した場合必須
tag_key string optional - EBSボリューム特定に利用するタグのキー
※specify_volumeでtagを指定した場合必須
tag_value string optional - EBSボリューム特定に利用するタグの値
※specify_volumeでtagを指定した場合必須
generation number required - EBSボリュームの世代管理を行う数(1〜50)
description string optional - EBSボリュームに設定する説明
additional_tags string optional - 作成したEBSボリュームに割り当てるタグの配列
例) [{“key”: “key1”, “value”: “value1”}, {“key”: “key2”, “value”: “value2”}]
additional_tag_key string optional - 作成したEBSボリュームに割り当てるタグのキー
※additional_tagsと同時に指定した場合additional_tagsを優先
additional_tag_value string optional - 作成したEBSボリュームに割り当てるタグの値
※additional_tagsと同時に指定した場合additional_tagsを優先
trace_status string optional true EBSボリュームの作成完了をジョブ完了の判定にするフラグ
"true" もしくは "false"

アクションのタイプがcreate_fsx_backupの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - バックアップを作成するAWSリージョン
specify_file_system string required - 対象のファイルシステムの特定方法
ファイルシステムID: identifier
タグ: tag
file_system_id string optional - 対象のファイルシステムID
※specify_file_systemでidentifierを指定した場合必須
tag_key string optional - ファイルシステム特定に利用するタグのキー
※specify_file_systemでtagを指定した場合必須
tag_value string optional - ファイルシステム特定に利用するタグの値
※specify_file_systemでtagを指定した場合必須
generation number required - ファイルシステムの世代管理を行う数(0~100)
backup_name string optional - バックアップ名（英字、空白、数字、特殊文字. + - = _ : / を含む最大 256 の Unicode 文字を利用）

アクションのタイプがcreate_imageの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - AMIを作成するAWSリージョン
specify_image_instance string required - 対象のEC2インスタンスの特定方法
インスタンスID: identifier
タグ: tag
instance_id string optional - 対象のEC2インスタンスID
※specify_instanceでidentifierを指定した場合必須
tag_key string optional - インスタンス特定に利用するタグのキー
※specify_instanceでtagを指定した場合必須
tag_value string optional - インスタンス特定に利用するタグの値
※specify_instanceでtagを指定した場合必須
generation number required - AMIの世代管理を行う数(1~50)
0を指定すると世代管理を行いません
image_name string required - AMIに設定するイメージ名
description string optional - AMIに設定する説明
reboot_instance string required - AMI 作成時にインスタンスを再起動するか否かのフラグ
true もしくは false
additional_tags string optional - 作成した AMI に割り当てるタグの配列
例) [{“key”: “key1”, “value”: “value1”}, {“key”: “key2”, “value”: “value2”}]
additional_tag_key string optional - 作成した AMI に割り当てるタグのキー
※additional_tagsと同時に指定した場合additional_tagsを優先
additional_tag_value string optional - 作成した AMI に割り当てるタグの値
※additional_tagsと同時に指定した場合additional_tagsを優先
add_same_tag_to_snapshot string optional false AMIに割り当てたタグをEBSスナップショットにも追加するか否かのフラグ
true もしくは false
trace_status string optional true AMIの作成完了をジョブ完了の判定にするフラグ
"true" もしくは "false"
recreate_image_if_ami_status_failed string optional false ジョブ失敗時にリトライを行うか否かのフラグ
true もしくは false

アクションのタイプがcreate_rds_cluster_snapshotの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - DBクラスタースナップショットを作成するAWSリージョン
specify_rds_cluster string required - 対象のDBクラスターの特定方法
DBクラスターID: identifier
タグ: tag
db_cluster_identifier string optional - DBクラスターの特定に利用するID
※specify_rds_clusterでidentifierを指定した場合必須
tag_key string optional - DBクラスターの特定に利用するタグのキー
※specify_rds_clusterでtagを指定した場合必須
tag_value string optional - DBクラスターの特定に利用するタグの値
※specify_rds_clusterでtagを指定した場合必須
db_cluster_snapshot_identifier string required - 作成する DB クラスタースナップショットのプレフィックス
generation number required - DBクラスタースナップショットの世代管理を行う数(1〜50)
trace_status string optional true DBクラスタースナップショットの作成完了をジョブ完了の判定にするフラグ
"true" もしくは "false"

アクションのタイプがcreate_rds_snapshotの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - DBスナップショットを作成するAWSリージョン
specify_rds_instance string required - 対象のDBインスタンスの特定方法
ボリュームID: identifier
タグ: tag
rds_snapshot_id string required - DBスナップショットに設定する名前
例) “rds-snapshot”
rds_instance_id string optional - 対象のDBインスタンスID
※specify_rds_instanceでidentifierを指定した場合必須
tag_key string optional - DBインスタンス特定に利用するタグのキー
※specify_rds_instanceでtagを指定した場合必須
tag_value string optional - DBインスタンス特定に利用するタグの値
※specify_rds_instanceでtagを指定した場合必須
generation number required - DBスナップショットの世代管理を行う数(1〜50)
0を指定すると世代管理を行いません
trace_status string optional true DBスナップショットの作成完了をジョブ完了の判定にするフラグ
"true" もしくは "false"

アクションのタイプがcreate_redshift_snapshotの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - スナップショットを作成するAWSリージョン
specify_cluster string required - 対象のRedshiftクラスターの特定方法
クラスターID: identifier
タグ: tag
cluster_snapshot_identifier string required - スナップショットに設定する名前
例) “redshift-snapshot”
cluster_identifier string optional - 対象のクラスターID
※specify_clusterでidentifierを指定した場合必須
tag_key string optional - Redshiftクラスター特定に利用するタグのキー
※specify_clusterでtagを指定した場合必須
tag_value string optional - Redshiftクラスター特定に利用するタグの値
※specify_clusterでtagを指定した場合必須
generation number required - スナップショットの世代管理を行う数(1〜50)
trace_status string optional true スナップショットの作成完了をジョブ完了の判定にするフラグ
"true" もしくは "false"

アクションのタイプがdelete_clusterの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - Redshiftクラスターを削除するAWSリージョン
cluster_identifier string required - 対象のRedshiftクラスターのidentifier
final_cluster_snapshot_identifier string required - Redshiftクラスター削除時に取得するRedshiftクラスタースナップショット名
skip_final_cluster_snapshot string required - Redshiftクラスター削除時のRedshiftクラスタースナップショット取得をスキップするか
true もしくは false
trace_status string optional true Redshiftクラスターの削除完了をジョブ完了の判定にするフラグ
"true" もしくは "false"

アクションのタイプがdelete_rds_clusterの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - DBクラスターを削除するAWSリージョン
specify_rds_cluster string required - 対象のDBクラスターの特定方法
DBクラスターID: identifier
タグ: tag
db_cluster_identifier string optional - DBクラスターの特定に利用するID
※specify_rds_clusterでidentifierを指定した場合必須
tag_key string optional - DBクラスターの特定に利用するタグのキー
※specify_rds_clusterでtagを指定した場合必須
tag_value string optional - DBクラスターの特定に利用するタグの値
※specify_rds_clusterでtagを指定した場合必須
final_db_snapshot_identifier string required - DBクラスター削除時に取得するDBクラスタースナップショット名
skip_final_snapshot string required - DBクラスター削除時のDBクラスタースナップショット取得をスキップするか
true もしくは false
trace_status string optional true DBクラスターの削除完了をジョブ完了の判定にするフラグ
"true" もしくは "false"

アクションのタイプがdelete_rds_instanceの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - DBスナップショットを作成するAWSリージョン
specify_rds_instance string required - 対象のDBインスタンスの特定方法
ボリュームID: identifier
タグ: tag
rds_instance_id string optional - 対象のDBインスタンスID
※specify_rds_instanceでidentifierを指定した場合必須
tag_key string optional - DBインスタンス特定に利用するタグのキー
※specify_rds_instanceでtagを指定した場合必須
tag_value string optional - DBインスタンス特定に利用するタグの値
※specify_rds_instanceでtagを指定した場合必須
final_rds_snapshot_id string required - DBインスタンス削除時に取得するDBスナップショット名
skip_final_rds_snapshot string required - DBインスタンス削除時のDBスナップショット取得をスキップするか
true もしくは false
trace_status string optional true DBスナップショットの作成完了をジョブ完了の判定にするフラグ
"true" もしくは "false"

アクションのタイプがderegister_instancesの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - 対象のELB(CLB)が存在するAWSリージョン
specify_instance string required - 対象のEC2インスタンスの特定方法
インスタンスID: identifier
タグ: tag
instance_id string optional - 対象のEC2インスタンスID
※specify_instanceでidentifierを指定した場合必須
tag_key string optional - インスタンス特定に利用するタグのキー
※specify_instanceでtagを指定した場合必須
tag_value string optional - インスタンス特定に利用するタグの値
※specify_instanceでtagを指定した場合必須
load_balancer_name string required - EC2インスタンスを登録解除するELB(CLB)名
例) my-load-balancer

アクションのタイプがderegister_target_instancesの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - 対象のターゲットグループが存在するAWSリージョン
target_group_arn string required - 対象のターゲットグループのARN
tag_key string required - 登録解除するEC2インスタンスのタグのキー
tag_value string required - 登録解除するEC2インスタンスのタグの値

アクションのタイプがdetach_user_policyの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
user_name string required - 対象のIAMユーザー名
例) “example-user”
policy_arn string required - IAMポリシーのARN
例) “arn:aws:iam::123456789012:policy/example-policy”

アクションのタイプがdynamodb_start_backup_jobの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - 対象のテーブルとバックアップボールトが存在するAWSリージョン
例) "ap-northeast-1"
dynamodb_table_name string required - 対象のDynamoDBテーブルの名前
例) "TestTable"
backup_vault_name string required - 対象のバックアップボールトの名前
例) "TestBackup"
lifecycle_delete_after_days number, null optional - バックアップの保持期間(日数)
例) 7
ジョブ作成時に省略すると「無期限」となる。
ジョブ更新時に「無期限」とするには、値としてnullを指定する必要がある。
iam_role_arn string required - バックアップ取得時に使うIAMロールのARN
例) "arn:aws:iam::123456789012:role/RoleForBackup"
additional_tags array optional - 作成した復旧ポイントに割り当てるタグの配列
例) [{"key": "key1", "value": "value1"}, {"key": "key2", "value": "value2"}]

アクションのタイプがinvoke_lambda_functionの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - 対象のLambda関数が存在するAWSリージョン
function_name string required - Lambda関数名
payload string required - イベントJSON (Lambda関数実行時の入力として渡すJSON)

アクションのタイプがreboot_rds_instancesの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - 対象のDBインスタンスが存在するAWSリージョン
specify_rds_instance string required - 対象のDBインスタンスの特定方法
DBインスタンスID: identifier
タグ: tag
rds_instance_id string optional - 対象のDBインスタンスID
※specify_rds_instanceでidentifierを指定した場合必須
tag_key string optional - DBインスタンス特定に利用するタグのキー
※specify_rds_instanceでtagを指定した場合必須
tag_value string optional - DBインスタンス特定に利用するタグの値
※specify_rds_instanceでtagを指定した場合必須

アクションのタイプがreboot_workspacesの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - 対象のWorkSpaceが存在するAWSリージョン
tag_key string required - WorkSpaceの特定に利用するタグのキー
tag_value string required - WorkSpaceの特定に利用するタグの値

アクションのタイプがrebuild_workspacesの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - 対象のWorkSpaceが存在するAWSリージョン
tag_key string required - WorkSpaceの特定に利用するタグのキー
tag_value string required - WorkSpaceの特定に利用するタグの値

アクションのタイプがregister_instancesの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - 対象のELB(CLB)が存在するAWSリージョン
specify_instance string required - 対象のEC2インスタンスの特定方法
インスタンスID: identifier
タグ: tag
instance_id string optional - 対象のEC2インスタンスID
※specify_instanceでidentifierを指定した場合必須
tag_key string optional - インスタンス特定に利用するタグのキー
※specify_instanceでtagを指定した場合必須
tag_value string optional - インスタンス特定に利用するタグの値
※specify_instanceでtagを指定した場合必須
load_balancer_name string required - EC2インスタンスを登録するELB(CLB)名
例) my-load-balancer

アクションのタイプがregister_target_instancesの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - 対象のターゲットグループが存在するAWSリージョン
target_group_arn string required - 対象のターゲットグループのARN
tag_key string required - 登録するEC2インスタンスのタグのキー
tag_value string required - 登録するEC2インスタンスのタグの値

アクションのタイプがrestore_from_cluster_snapshotの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - RedshiftクラスタースナップショットからRedshiftクラスターをリストアするAWSリージョン
cluster_identifier string required - リストア後のRedshiftクラスターのidentifier
snapshot_identifier string required - リストアに使用するRedshiftスナップショットID
cluster_parameter_group_name string optional - リストア後のRedshiftクラスターに設定するパラメータグループ名
cluster_subnet_group_name string optional - リストア後のRedshiftクラスターを配置するサブネットグループ名
port number optional - リストア後のDBクラスターの接続ポート番号
publicly_accessible string optional false リストア後のRedshiftクラスターをパブリックアクセス可能にするか否か
true もしくは false
vpc_security_group_ids array[string] optional NULL リストア後のRedshiftクラスターに設定するセキュリティグループIDが含まれる配列
例) [“sg-00000001”, “sg-00000002”]
allow_version_upgrade string optional - リストア後のRedshiftクラスターで自動マイナーバージョンアップグレードを有効にするかどうか
true もしくは false
delete_cluster_snapshot string optional - リストアに利用したRedshiftスナップショットを削除するかどうか
true もしくは false

アクションのタイプがrestore_rds_clusterの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - DBクラスタースナップショットからDBクラスターをリストアするAWSリージョン
db_instance_identifier string required - リストア後のDBインスタンスのidentifier
db_cluster_identifier string required - リストア後のDBクラスターのidentifier
snapshot_identifier string required - リストアに使用するDBスナップショットID
engine string optional - リストア後のDBクラスターのDBエンジン
engine_version string optional - リストア後のDBクラスターのDBエンジンのバージョン
db_instance_class string optional - リストア後のDBクラスターのDBインスタンスクラス
例) “db.t2.micro”
db_subnet_group_name string optional - リストア後のDBクラスターを配置するDBサブネットグループ名
publicly_accessible string optional false リストア後のDBクラスターをパブリックアクセス可能にするか否か
true もしくは false
availability_zone string optional random リストア後のDBクラスターを配置するAZ
vpc_security_group_ids array[string] optional - リストア後のDBクラスターに設定するセキュリティグループIDが含まれる配列
例) [“sg-00000001”, “sg-00000002”]
port number optional - リストア後のDBクラスターの接続ポート番号
db_cluster_parameter_group_name string optional - リストア後のDBクラスターに設定するパラメータグループ名
例) “default.mysql5.6”
db_parameter_group_name string optional - リストア後のDBインスタンスに設定するパラメータグループ名
例) “default.mysql5.6”
option_group_name string optional - リストア後のDBクラスターに設定するオプショングループ名
例) “default:mysql-5-6”
auto_minor_version_upgrade string optional - リストア後のDBクラスターで自動マイナーバージョンアップグレードを有効にするかどうか
true もしくは false
delete_db_cluster_snapshot string optional - リストアに利用したDBスナップショットを削除するかどうか
true もしくは false

アクションのタイプがrestore_rds_instanceの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - DBスナップショットからDBインスタンスをリストアするAWSリージョン
rds_instance_id string required - リストア後のDBインスタンス名
rds_snapshot_id string required - リストアに使用するDBスナップショットID
db_engine string optional - リストア後のDBインスタンスのDBエンジン
license_model string optional - リストア後のDBインスタンスのライセンスモデル
db_instance_class string optional - リストア後のDBインスタンスのDBインスタンスクラス
例) “db.t2.micro”
multi_az string optional - リストア後のDBインスタンスをMulti-AZ構成にするか否か
true もしくは false
storage_type string optional - リストア後のDBインスタンスのストレージタイプ
スタンダード: standard
汎用SSD(gp3): gp3
汎用SSD(gp2): gp2
プロビジョンドIOPS(io1): io1
iops number optional - リストア後のDBインスタンスのIOPS値
1000〜30000
※storage_typeにio1を選んだとき必須
vpc string optional - リストア後のDBインスタンスを配置するVPCのID
例)“vpc-00000001”
subnet_group string optional - リストア後のDBインスタンスを配置するDBサブネットグループ名
publicly_accessible string optional false リストア後のDBインスタンスをパブリックアクセス可能にするか否か
true もしくは false
availability_zone string optional - リストア後のDBインスタンスを配置するAZ
※multi_azをtrueにしている場合は利用されない
vpc_security_group_ids array[string] optional - リストア後のDBインスタンスに設定するセキュリティグループIDが含まれる配列
例) [“sg-00000001”, “sg-00000002”]
db_name string optional - リストア後のDBインスタンスのデータベース名
port number optional - リストア後のDBインスタンスの接続ポート番号
parameter_group string optional - リストア後のDBインスタンスに設定するパラメータグループ名
例) “default”
option_group string optional - リストア後のDBインスタンスに設定するオプショングループ名
例) “default”
auto_minor_version_upgrade string optional - リストア後のDBインスタンスで自動マイナーバージョンアップグレードを有効にするかどうか
true もしくは false
delete_rds_snapshot string optional - リストアに利用したDBスナップショットを削除するかどうか
true もしくは false
additional_tag_key string optional - リストア後のDBインスタンスに割り当てるタグのキー
additional_tag_value string optional - リストア後のDBインスタンスの割り当てるタグの値
trace_status string optional true DBインスタンスの作成完了をジョブ完了の判定にするフラグ
"true" もしくは "false"

アクションのタイプがrevoke_security_group_ingressの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - 変更対象のセキュリティグループが存在するAWSリージョン
specify_security_group string required - 対象のセキュリティグループの特定方法
セキュリティグループID: identifier
タグ: tag
security_group_id string optional - 対象のセキュリティグループID
※specify_security_groupでidentifierを指定した場合必須
tag_key string optional - セキュリティグループ特定に利用するタグのキー
※specify_security_groupでtagを指定した場合必須
tag_value string optional - セキュリティグループ特定に利用するタグの値
※specify_security_groupでtagを指定した場合必須
ip_protocol string required - 通信プロトコル
例) “tcp”
to_port string required - ポート番号
例) 80
cidr_ip string required - 送信元IPのCIDRアドレス
例) “172.31.0.0/16”

アクションのタイプがrun_ecs_tasks_fargateの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - 対象のECSクラスターが存在するAWSリージョン
例) "ap-northeast-1"
ecs_cluster string required - 対象のECSクラスターの名前
例) "test-cluster"
platform_version string required - タスクが使用するプラットフォームのバージョン
"LATEST"、"1.4.0"、"1.3.0"のいずれか
ecs_task_definition_family string required - タスク定義のファミリー
例) "test-service"
ecs_task_count number required - 起動するタスク数
1〜10のいずれか
propagate_tags string required - タグをタスク定義からタスクに伝播するかどうか
伝播させる場合は"TASK_DEFINITION"、させない場合は"NONE"
enable_ecs_managed_tags boolean required - タスクにAmazon ECS管理タグを付与するかどうか
付与する場合はtrue、しない場合はfalse
注意: 文字列ではなくboolean値で指定すること
ecs_awsvpc_vpc string required - 使用するVPC
例) "vpc-00000001"
ecs_awsvpc_subnets string[] required - 使用するawsvpcのサブネット
例) ["subnet-00000001", "subnet-00000002"]
ecs_awsvpc_security_groups string[] required - 使用するawsvpcのセキュリティグループ
例) ["sg-00000001", "sg-00000002"]
ecs_awsvpc_assign_public_ip string required - パブリックIP割当を有効にするかどうか
"ENABLEDまたはDISABLED

アクションのタイプがs3_start_backup_jobの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - 対象のバケットとバックアップボールトが存在するAWSリージョン
例) "ap-northeast-1"
bucket_name string required - 対象のバケットの名前
例) "test-bucket"
backup_vault_name string required - 対象のバックアップボールトの名前
例) "TestBackup"
lifecycle_delete_after_days number, null optional - バックアップの保持期間(日数)
例) 7
ジョブ作成時に省略すると「無期限」となる。
ジョブ更新時に「無期限」とするには、値としてnullを指定する必要がある。
iam_role_arn string required - バックアップ取得時に使うIAMロールのARN
例) "arn:aws:iam::123456789012:role/RoleForBackup"
additional_tags array optional - 作成した復旧ポイントに割り当てるタグの配列
例) [{"key": "key1", "value": "value1"}, {"key": "key2", "value": "value2"}]

アクションのタイプがsend_commandの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - コマンドを実行するAWSリージョン
specify_instance string required - 対象のEC2インスタンスの特定方法
インスタンスID: identifier
タグ: tag
instance_id string optional - 対象のEC2インスタンスID
※specify_instanceでidentifierを指定した場合必須
tag_key string optional - インスタンス特定に利用するタグのキー
※specify_instanceでtagを指定した場合必須
tag_value string optional - インスタンス特定に利用するタグの値
※specify_instanceでtagを指定した場合必須
command string required - 実行するコマンド
例) whoami
comment string optional - コマンドに設定するコメント
document_name string required - コマンドの種類
Linux: AWS-RunShellScript
Windows: AWS-RunPowerShellScript
output_s3_bucket_name string optional - 実行結果を保存するS3のバケット名
output_s3_key_prefix string optional - 実行結果を保存するS3のプレフィックス
trace_status string optional true 実行コマンドの終了ステータスをジョブ完了の判定にするフラグ
"true" もしくは "false"
"true" にした場合のみ execution_timeout_seconds を設定できます。
timeout_seconds number optional - インスタンス接続のタイムアウト時間(秒)
(30-2592000)
execution_timeout_seconds number optional - コマンド実行のタイムアウト時間(秒)
(30-2592000)
trace_status が "true" の場合のみ指定可能

アクションのタイプがstart_instancesの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - 対象のEC2インスタンスが存在するAWSリージョン
specify_instance string required - 対象のEC2インスタンスの特定方法
インスタンスID: identifier
タグ: tag
instance_id string optional - 対象のEC2インスタンスID
※specify_instanceでidentifierを指定した場合必須
tag_key string optional - インスタンス特定に利用するタグのキー
※specify_instanceでtagを指定した場合必須
tag_value string optional - インスタンス特定に利用するタグの値
※specify_instanceでtagを指定した場合必須
trace_status string optional true インスタンスの起動完了をジョブ完了の判定にするフラグ
"true" もしくは "false"
status_checks_enable string optional false ステータスチェックを行うかどうか。 trace_statusで"true"を指定した場合のみ"true"を指定可能

アクションのタイプがstart_rds_clustersの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - 対象のDBクラスターが存在するAWSリージョン
specify_rds_cluster string required - 対象のDBクラスターの特定方法
DBクラスターID: identifier
タグ: tag
db_cluster_identifier string optional - 対象のDBクラスターID
※specify_rds_instanceでidentifierを指定した場合必須
tag_key string optional - DBクラスター特定に利用するタグのキー
※specify_rds_instanceでtagを指定した場合必須
tag_value string optional - DBクラスター特定に利用するタグの値
※specify_rds_instanceでtagを指定した場合必須
trace_status string optional true DBクラスターの起動完了をジョブ完了の判定にするフラグ
"true" もしくは "false"

アクションのタイプがstart_rds_instancesの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - 対象のDBインスタンスが存在するAWSリージョン
specify_rds_instance string required - 対象のDBインスタンスの特定方法
DBインスタンスID: identifier
タグ: tag
rds_instance_id string optional - 対象のDBインスタンスID
※specify_rds_instanceでidentifierを指定した場合必須
tag_key string optional - DBインスタンス特定に利用するタグのキー
※specify_rds_instanceでtagを指定した場合必須
tag_value string optional - DBインスタンス特定に利用するタグの値
※specify_rds_instanceでtagを指定した場合必須
trace_status string optional true DBインスタンスの起動完了をジョブ完了の判定にするフラグ
"true" もしくは "false"

アクションのタイプがstop_ecs_tasksの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - 対象のECSクラスターが存在するAWSリージョン
例) "ap-northeast-1"
ecs_cluster string required - 対象のECSクラスターの名前
例) "test-cluster"
specify_ecs_task string required - ECSタスクの特定方法
タスク定義のファミリーで特定する場合: "definition_family"
タスクに付けられたタグで特定する場合: "tag"
ecs_task_definition_family string optional - タスク定義のファミリー
例) "test-service"
※specify_ecs_taskで"definition_family"を指定した場合に必須
tag_key string optional - タスク特定に利用するタグのキー
※specify_ecs_taskで"tag"を指定した場合に必須
tag_value string optional - タスク特定に利用するタグの値
※specify_ecs_taskで"tag"を指定した場合に必須

アクションのタイプがstop_instancesの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - 対象のEC2インスタンスが存在するAWSリージョン
specify_instance string required - 対象のEC2インスタンスの特定方法
インスタンスID: identifier
タグ: tag
instance_id string optional - 対象のEC2インスタンスID
※specify_instanceでidentifierを指定した場合必須
tag_key string optional - インスタンス特定に利用するタグのキー
※specify_instanceでtagを指定した場合必須
tag_value string optional - インスタンス特定に利用するタグの値
※specify_instanceでtagを指定した場合必須
trace_status string optional true インスタンスの停止完了をジョブ完了の判定にするフラグ
"true" もしくは "false"

アクションのタイプがstop_rds_clustersの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - 対象のDBクラスターが存在するAWSリージョン
specify_rds_cluster string required - 対象のDBクラスターの特定方法
DBクラスターID: identifier
タグ: tag
db_cluster_identifier string optional - 対象のDBクラスターID
※specify_rds_instanceでidentifierを指定した場合必須
tag_key string optional - DBクラスター特定に利用するタグのキー
※specify_rds_instanceでtagを指定した場合必須
tag_value string optional - DBクラスター特定に利用するタグの値
※specify_rds_instanceでtagを指定した場合必須
trace_status string optional true DBクラスターの停止完了をジョブ完了の判定にするフラグ
"true" もしくは "false"

アクションのタイプがstop_rds_instancesの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - 対象のDBインスタンスが存在するAWSリージョン
specify_rds_instance string required - 対象のDBインスタンスの特定方法
DBインスタンスID: identifier
タグ: tag
rds_instance_id string optional - 対象のDBインスタンスID
※specify_rds_instanceでidentifierを指定した場合必須
tag_key string optional - DBインスタンス特定に利用するタグのキー
※specify_rds_instanceでtagを指定した場合必須
tag_value string optional - DBインスタンス特定に利用するタグの値
※specify_rds_instanceでtagを指定した場合必須
trace_status string optional true DBインスタンスの停止完了をジョブ完了の判定にするフラグ
"true" もしくは "false"

アクションのタイプがstart_workspacesの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - WorkSpaceを起動するAWSリージョン
tag_key string required - WorkSpace特定に利用するタグのキー
tag_value string required - WorkSpace特定に利用するタグの値

アクションのタイプがterminate_workspacesの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - WorkSpaceを削除するAWSリージョン
specify_workspace string required - 対象のWorkSpaceの特定方法
タグ: tag
tag_key string required - WorkSpace特定に利用するタグのキー
tag_value string required - WorkSpace特定に利用するタグの値
trace_status string optional true WorkSpaceの作成完了をジョブ完了の判定にするフラグ
"true" もしくは "false"

アクションのタイプがupdate_record_setの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
zone_name string required - リソースレコードセットを更新するホストゾーン
例) “test.local.”
record_set_name string required - 更新対象のリソースレコードセット
例) “aaa.test.local.”
record_set_type string required - リソースレコードタイプ
以下が指定可能
A
CNAME
record_set_value string required - リソースレコードセットの値

アクションのタイプがwindows_updateの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - コマンドを実行するAWSリージョン
specify_instance string required - 対象のEC2インスタンスの特定方法
インスタンスID: identifier
タグ: tag
instance_id string optional - 対象のEC2インスタンスID
※specify_instanceでidentifierを指定した場合必須
tag_key string optional - インスタンス特定に利用するタグのキー
※specify_instanceでtagを指定した場合必須
tag_value string optional - インスタンス特定に利用するタグの値
※specify_instanceでtagを指定した場合必須
comment string optional - コマンドに設定するコメント
document_name string required - AWS-InstallMissingWindowsUpdates固定
kb_article_ids array[string] optional - 除外するKBが含まれた配列
例) [“KB1111111”, “KB2222222”]
output_s3_bucket_name string optional - 実行結果を保存するS3のバケット名
output_s3_key_prefix string optional - 実行結果を保存するS3のプレフィックス
update_level string required - アップデートレベル
None, All, Important, Optionalから選択する
timeout_seconds number optional - タイムアウト時間(秒)
(30-2592000)

アクションのタイプがwindows_update_v2の場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
region string required - コマンドを実行するAWSリージョン
specify_instance string required - 対象のEC2インスタンスの特定方法
インスタンスID: identifier
タグ: tag
instance_id string optional - 対象のEC2インスタンスID
※specify_instanceでidentifierを指定した場合必須
tag_key string optional - インスタンス特定に利用するタグのキー
※specify_instanceでtagを指定した場合必須
tag_value string optional - インスタンス特定に利用するタグの値
※specify_instanceでtagを指定した場合必須
allow_reboot string required - Windows Updateの適用で発生する再起動を許容するか
true もしくは false
severity_levels array[string], null optional - 適用するWindows Updateの重要度
Critical, Important, Moderate, Low, Unspecifiedから選択する
例) ["Critical","Low"]
ジョブ作成時に省略すると「すべて適用」となる。ジョブ更新時に「すべて適用する」とするには、値として null を指定する必要がある。
output_s3_bucket_name string optional - 実行ログを保存するS3のバケット名
output_s3_key_prefix string optional - 実行ログを保存するS3のプレフィックス
trace_status string optional true Windows Update完了をジョブ完了の判定にするフラグ
"true" もしくは "false"

アクションのタイプがgoogle_compute_insert_machine_imageの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
generation number required - マシンイメージの世代管理を行う数(1〜100)。0は世代管理なし
例: 7
machine_image_basename string required - 作成するマシンイメージの名前。1〜42文字。使用可能な文字はGoogle Cloudの仕様に準ずる
例: "production-web-daily"
machine_image_description string optional "" 作成するマシンイメージに設定する説明。1,000文字まで。使用可能な文字はGoogle Cloudの仕様に準ずる
例: "本番環境Webサーバーの日時バックアップ"
machine_image_storage_location string required - マシンイメージの保存場所
例: "asia" や "asia-northeast1" など
project_id string required - 対象VMインスタンスが属するプロジェクトID
例: "gcp-project-name"
region string required - 対象VMインスタンスが存在するリージョン
例: "asia-northeast1"
specify_vm_instance string required - 対象VMインスタンスの指定方法
例: identifier (IDで指定) もしくは label (ラベルで指定)
vm_instance_id string optional - 対象VMインスタンスのID(名前ではない)。specify_vm_instanceがidentifierの場合に指定する
例: "1111111111111"
vm_instance_label_key string optional - 対象VMインスタンスのラベルのキー。specify_vm_instanceがlabelの場合に指定する
例: "env"
vm_instance_label_value string optional - 対象VMインスタンスのラベルの値。specify_vm_instanceがlabelの場合に指定する
例: "production"

アクションのタイプがgoogle_compute_start_vm_instancesの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
project_id string required - 対象VMインスタンスが属するプロジェクトID
例: "gcp-project-name"
region string required - 対象VMインスタンスが存在するリージョン
例: "asia-northeast1"
specify_vm_instance string required - 対象VMインスタンスの指定方法
例: identifier (IDで指定) もしくは label (ラベルで指定)
vm_instance_id string optional - 対象VMインスタンスのID(名前ではない)。specify_vm_instanceがidentifierの場合に指定する
例: "1111111111111"
vm_instance_label_key string optional - 対象VMインスタンスのラベルのキー。specify_vm_instanceがlabelの場合に指定する
例: "env"
vm_instance_label_value string optional - 対象VMインスタンスのラベルの値。specify_vm_instanceがlabelの場合に指定する
例: "production"

アクションのタイプがgoogle_compute_stop_vm_instancesの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
project_id string required - 対象VMインスタンスが属するプロジェクトID
例: "gcp-project-name"
region string required - 対象VMインスタンスが存在するリージョン
例: "asia-northeast1"
specify_vm_instance string required - 対象VMインスタンスの指定方法
例: identifier (IDで指定) もしくは label (ラベルで指定)
vm_instance_id string optional - 対象VMインスタンスのID(名前ではない)。specify_vm_instanceがidentifierの場合に指定する
例: "1111111111111"
vm_instance_label_key string optional - 対象VMインスタンスのラベルのキー。specify_vm_instanceがlabelの場合に指定する
例: "env"
vm_instance_label_value string optional - 対象VMインスタンスのラベルの値。specify_vm_instanceがlabelの場合に指定する
例: "production"

アクションのタイプがdelayの場合のaction_valueの設定値

名前 型 必須かどうか デフォルト値 説明
delay_minutes number required - 待機する時間 (1~60分)

Example URI

POST https://manager.cloudautomator.com/api/v1/jobs
Request  週次でAMIを作成するジョブの例
HideShow
Headers
Content-Type: application/json
Body
{
  "name": "毎週月曜の9時にAMIを作成",
  "group_id": "1",
  "aws_account_id": 1,
  "rule_type": "cron",
  "effective_date": "2016/10/01",
  "expiration_date": "2016/12/31",
  "rule_value": {
    "hour": 9,
    "minutes": 0,
    "national_holiday_schedule": "true",
    "schedule_type": "weekly",
    "weekly_schedule": [
      "monday"
    ],
    "dates_to_skip": [
      "2021-01-13"
    ]
  },
  "action_type": "create_image",
  "action_value": {
    "region": "ap-northeast-1",
    "instance_id": "i-00000001",
    "generation": "1",
    "image_name": "TestAMI",
    "trace_status": "true",
    "reboot_instance": "true",
    "specify_image_instance": "identifier",
    "add_same_tag_to_snapshot": "false",
    "recreate_image_if_ami_status_failed": "false"
  },
  "completed_post_process_id": [
    1
  ],
  "failed_post_process_id": [
    2
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "ジョブの名前"
    },
    "group_id": {
      "type": "string",
      "description": "作成するジョブを所属させるグループのID"
    },
    "aws_account_id": {
      "type": "number",
      "description": "ジョブの実行時に使うAWSアカウントのID"
    },
    "rule_type": {
      "type": "string",
      "description": "トリガーのタイプ"
    },
    "effective_date": {
      "type": "string",
      "description": "有効期間の開始日"
    },
    "expiration_date": {
      "type": "string",
      "description": "有効期間の終了日"
    },
    "rule_value": {
      "type": "object",
      "properties": {
        "hour": {
          "type": "number",
          "description": "時"
        },
        "minutes": {
          "type": "number",
          "description": "分"
        },
        "national_holiday_schedule": {
          "type": "string",
          "description": "ジョブの実行日と日本の祝日が重なっていた場合にジョブの実行をスキップするか否か"
        },
        "schedule_type": {
          "type": "string",
          "description": "one_time, weekly, monthly, monthly_day_of_week のいずれか"
        },
        "weekly_schedule": {
          "type": "array",
          "description": "曜日(sunday, monday, ...)の配列"
        },
        "dates_to_skip": {
          "type": "array",
          "description": "ジョブ実行をスキップする日付を示す YYYY-MM-DD 形式の配列"
        }
      },
      "required": [
        "hour",
        "minutes",
        "schedule_type",
        "weekly_schedule"
      ],
      "description": "トリガーの設定値"
    },
    "action_type": {
      "type": "string",
      "description": "アクションのタイプ"
    },
    "action_value": {
      "type": "object",
      "properties": {
        "region": {
          "type": "string"
        },
        "instance_id": {
          "type": "string"
        },
        "generation": {
          "type": "string"
        },
        "image_name": {
          "type": "string"
        },
        "trace_status": {
          "type": "string"
        },
        "reboot_instance": {
          "type": "string"
        },
        "specify_image_instance": {
          "type": "string"
        },
        "add_same_tag_to_snapshot": {
          "type": "string"
        },
        "recreate_image_if_ami_status_failed": {
          "type": "string"
        }
      },
      "required": [
        "trace_status"
      ],
      "description": "アクションの設定値"
    },
    "completed_post_process_id": {
      "type": "array",
      "description": "ジョブが成功した場合に実行する後処理IDの配列"
    },
    "failed_post_process_id": {
      "type": "array",
      "description": "ジョブが失敗した場合に実行する後処理IDの配列"
    }
  },
  "required": [
    "name",
    "group_id",
    "aws_account_id",
    "rule_type",
    "rule_value",
    "action_type",
    "action_value"
  ]
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": "1",
    "type": "trigger_jobs",
    "attributes": {
      "name": "毎週月曜の9時にAMIを作成",
      "aws_account_id": 1,
      "aws_account_ids": [
        "[1, 2, 3]"
      ],
      "google_cloud_account_id": "null",
      "provider_type": "aws",
      "group_id": 1,
      "for_workflow": false,
      "rule_type": "cron",
      "effective_date": "2016-10-01",
      "expiration_date": "2017-12-31",
      "rule_value": {
        "hour": 9,
        "minutes": 0,
        "national_holiday_schedule": "true",
        "schedule_type": "weekly",
        "time_zone": "Tokyo",
        "weekly_schedule": [
          "monday"
        ],
        "dates_to_skip": [
          "2021-01-13"
        ]
      },
      "action_type": "create_image",
      "action_value": {
        "region": "ap-northeast-1",
        "instance_id": "i-00000001",
        "generation": 1,
        "image_name": "TestAMI",
        "trace_status": "true",
        "reboot_instance": "true",
        "specify_image_instance": "identifier",
        "add_same_tag_to_snapshot": "false",
        "recreate_image_if_ami_status_failed": "false"
      },
      "active": true,
      "allow_runtime_action_values": false,
      "completed_post_process_id": [
        1
      ],
      "failed_post_process_id": [
        2
      ],
      "created_at": "2016-10-13 22:45:45 +0900",
      "updated_at": "2016-10-13 22:45:45 +0900"
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "ジョブID"
        },
        "type": {
          "type": "string",
          "description": "データ型"
        },
        "attributes": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "ジョブ名"
            },
            "aws_account_id": {
              "type": [
                "number",
                "null"
              ],
              "description": "AWSアカウントID (bulk_stop_instancesアクション以外の場合)"
            },
            "aws_account_ids": {
              "type": "array",
              "description": "AWSアカウントID (bulk_stop_instancesアクションの場合のみ)"
            },
            "google_cloud_account_id": {
              "type": [
                "string",
                "null"
              ],
              "description": "Google CloudアカウントID (bulk_stop_instancesアクション以外の場合)"
            },
            "provider_type": {
              "type": "string",
              "enum": [
                "aws",
                "google_cloud",
                "no"
              ],
              "description": "プロバイダの種類"
            },
            "group_id": {
              "type": "number",
              "description": "グループID"
            },
            "for_workflow": {
              "type": "boolean",
              "description": "ジョブワークフロー専用ジョブにするかどうか"
            },
            "rule_type": {
              "type": "string",
              "description": "トリガータイプ"
            },
            "effective_date": {
              "type": "string",
              "description": "有効期間の開始日"
            },
            "expiration_date": {
              "type": "string",
              "description": "有効期間の終了日"
            },
            "rule_value": {
              "type": "object",
              "properties": {
                "hour": {
                  "type": "number",
                  "description": "時"
                },
                "minutes": {
                  "type": "number",
                  "description": "分"
                },
                "national_holiday_schedule": {
                  "type": "string",
                  "description": "ジョブの実行日と日本の祝日が重なっていた場合に実行をスキップするか否か"
                },
                "schedule_type": {
                  "type": "string",
                  "description": "スケジュールタイプ"
                },
                "time_zone": {
                  "type": "string",
                  "description": "タイムゾーンを表す文字列"
                },
                "weekly_schedule": {
                  "type": "array"
                },
                "dates_to_skip": {
                  "type": "array"
                }
              }
            },
            "action_type": {
              "type": "string",
              "description": "アクションタイプ"
            },
            "action_value": {
              "type": "object",
              "properties": {
                "region": {
                  "type": "string"
                },
                "instance_id": {
                  "type": "string"
                },
                "generation": {
                  "type": "number"
                },
                "image_name": {
                  "type": "string"
                },
                "trace_status": {
                  "type": "string"
                },
                "reboot_instance": {
                  "type": "string"
                },
                "specify_image_instance": {
                  "type": "string"
                },
                "add_same_tag_to_snapshot": {
                  "type": "string"
                },
                "recreate_image_if_ami_status_failed": {
                  "type": "string"
                }
              }
            },
            "active": {
              "type": "boolean",
              "description": "ジョブがアクティブかどうか"
            },
            "allow_runtime_action_values": {
              "type": "boolean",
              "description": "アクションの設定値を実行時に指定するかどうか。ジョブが実行時の指定に対応していない場合はプロパティ自体が存在しません。"
            },
            "completed_post_process_id": {
              "type": "array",
              "description": "ジョブが成功した場合に実行する後処理IDの配列"
            },
            "failed_post_process_id": {
              "type": "array",
              "description": "ジョブが失敗した場合に実行する後処理IDの配列"
            },
            "created_at": {
              "type": "string",
              "description": "ジョブの作成日時"
            },
            "updated_at": {
              "type": "string",
              "description": "ジョブの更新日時"
            }
          }
        }
      },
      "description": "作成されたジョブ"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "source": {
        "pointer": "/data/attributes/name"
      },
      "detail": "を入力してください"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array"
    }
  }
}

Get Jobs
GET/jobs

複数のジョブを取得します。

Example URI

GET https://manager.cloudautomator.com/api/v1/jobs
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": "1",
      "type": "trigger_jobs",
      "attributes": {
        "name": "毎週月曜の9時にAMIを作成",
        "aws_account_id": 1,
        "aws_account_ids": [
          "[1, 2, 3]"
        ],
        "google_cloud_account_id": "null",
        "provider_type": "aws",
        "group_id": 1,
        "for_workflow": false,
        "rule_type": "cron",
        "effective_date": "2016-10-01",
        "expiration_date": "2017-12-31",
        "rule_value": {
          "hour": 9,
          "minutes": 0,
          "national_holiday_schedule": "true",
          "schedule_type": "weekly",
          "time_zone": "Tokyo",
          "weekly_schedule": [
            "monday"
          ],
          "dates_to_skip": [
            "2021-01-13"
          ]
        },
        "action_type": "create_image",
        "action_value": {
          "region": "ap-northeast-1",
          "instance_id": "i-00000001",
          "generation": 1,
          "image_name": "TestAMI",
          "trace_status": "true",
          "reboot_instance": "true",
          "specify_image_instance": "identifier",
          "add_same_tag_to_snapshot": "false",
          "recreate_image_if_ami_status_failed": "false"
        },
        "active": true,
        "allow_runtime_action_values": false,
        "completed_post_process_id": [
          1
        ],
        "failed_post_process_id": [
          2
        ],
        "created_at": "2016-10-13 22:45:45 +0900",
        "updated_at": "2016-10-13 22:45:45 +0900"
      }
    }
  ],
  "links": {
    "self": "https://manager.cloudautomator.com/api/v1/jobs?page%5Bnumber%5D=1&page%5Bsize%5D=5",
    "first": "https://manager.cloudautomator.com/api/v1/jobs?page%5Bnumber%5D=1&page%5Bsize%5D=5",
    "prev": "https://manager.cloudautomator.com/api/v1/jobs?page%5Bnumber%5D=1&page%5Bsize%5D=5",
    "next": "https://manager.cloudautomator.com/api/v1/jobs?page%5Bnumber%5D=2&page%5Bsize%5D=5",
    "last": "https://manager.cloudautomator.com/api/v1/jobs?page%5Bnumber%5D=3&page%5Bsize%5D=5"
  },
  "meta": {
    "total": 12
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "description": "ジョブの配列"
    },
    "links": {
      "type": "object",
      "properties": {
        "self": {
          "type": "string",
          "description": "現在のページを指すURL"
        },
        "first": {
          "type": "string",
          "description": "最初のページを指すURL"
        },
        "prev": {
          "type": [
            "string",
            "null"
          ],
          "description": "前のページを指すURL"
        },
        "next": {
          "type": [
            "string",
            "null"
          ],
          "description": "次のページを指すURL"
        },
        "last": {
          "type": "string",
          "description": "最後のページを指すURL"
        }
      },
      "description": "ページネーションリンク"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "ジョブの総数"
        }
      }
    }
  }
}

Get Job
GET/jobs/{id}

1件のジョブを取得します。

Example URI

GET https://manager.cloudautomator.com/api/v1/jobs/1
URI Parameters
HideShow
id
number (required) Example: 1

ジョブID

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": "1",
    "type": "trigger_jobs",
    "attributes": {
      "name": "毎週月曜の9時にAMIを作成",
      "aws_account_id": 1,
      "aws_account_ids": [
        "[1, 2, 3]"
      ],
      "google_cloud_account_id": "null",
      "provider_type": "aws",
      "group_id": 1,
      "for_workflow": false,
      "rule_type": "cron",
      "effective_date": "2016-10-01",
      "expiration_date": "2017-12-31",
      "rule_value": {
        "hour": 9,
        "minutes": 0,
        "national_holiday_schedule": "true",
        "schedule_type": "weekly",
        "time_zone": "Tokyo",
        "weekly_schedule": [
          "monday"
        ],
        "dates_to_skip": [
          "2021-01-13"
        ]
      },
      "action_type": "create_image",
      "action_value": {
        "region": "ap-northeast-1",
        "instance_id": "i-00000001",
        "generation": 1,
        "image_name": "TestAMI",
        "trace_status": "true",
        "reboot_instance": "true",
        "specify_image_instance": "identifier",
        "add_same_tag_to_snapshot": "false",
        "recreate_image_if_ami_status_failed": "false"
      },
      "active": true,
      "allow_runtime_action_values": false,
      "completed_post_process_id": [
        1
      ],
      "failed_post_process_id": [
        2
      ],
      "created_at": "2016-10-13 22:45:45 +0900",
      "updated_at": "2016-10-13 22:45:45 +0900"
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "ジョブID"
        },
        "type": {
          "type": "string",
          "description": "データ型"
        },
        "attributes": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "ジョブ名"
            },
            "aws_account_id": {
              "type": [
                "number",
                "null"
              ],
              "description": "AWSアカウントID (bulk_stop_instancesアクション以外の場合)"
            },
            "aws_account_ids": {
              "type": "array",
              "description": "AWSアカウントID (bulk_stop_instancesアクションの場合のみ)"
            },
            "google_cloud_account_id": {
              "type": [
                "string",
                "null"
              ],
              "description": "Google CloudアカウントID (bulk_stop_instancesアクション以外の場合)"
            },
            "provider_type": {
              "type": "string",
              "enum": [
                "aws",
                "google_cloud",
                "no"
              ],
              "description": "プロバイダの種類"
            },
            "group_id": {
              "type": "number",
              "description": "グループID"
            },
            "for_workflow": {
              "type": "boolean",
              "description": "ジョブワークフロー専用ジョブにするかどうか"
            },
            "rule_type": {
              "type": "string",
              "description": "トリガータイプ"
            },
            "effective_date": {
              "type": "string",
              "description": "有効期間の開始日"
            },
            "expiration_date": {
              "type": "string",
              "description": "有効期間の終了日"
            },
            "rule_value": {
              "type": "object",
              "properties": {
                "hour": {
                  "type": "number",
                  "description": "時"
                },
                "minutes": {
                  "type": "number",
                  "description": "分"
                },
                "national_holiday_schedule": {
                  "type": "string",
                  "description": "ジョブの実行日と日本の祝日が重なっていた場合に実行をスキップするか否か"
                },
                "schedule_type": {
                  "type": "string",
                  "description": "スケジュールタイプ"
                },
                "time_zone": {
                  "type": "string",
                  "description": "タイムゾーンを表す文字列"
                },
                "weekly_schedule": {
                  "type": "array"
                },
                "dates_to_skip": {
                  "type": "array"
                }
              }
            },
            "action_type": {
              "type": "string",
              "description": "アクションタイプ"
            },
            "action_value": {
              "type": "object",
              "properties": {
                "region": {
                  "type": "string"
                },
                "instance_id": {
                  "type": "string"
                },
                "generation": {
                  "type": "number"
                },
                "image_name": {
                  "type": "string"
                },
                "trace_status": {
                  "type": "string"
                },
                "reboot_instance": {
                  "type": "string"
                },
                "specify_image_instance": {
                  "type": "string"
                },
                "add_same_tag_to_snapshot": {
                  "type": "string"
                },
                "recreate_image_if_ami_status_failed": {
                  "type": "string"
                }
              }
            },
            "active": {
              "type": "boolean",
              "description": "ジョブがアクティブかどうか"
            },
            "allow_runtime_action_values": {
              "type": "boolean",
              "description": "アクションの設定値を実行時に指定するかどうか。ジョブが実行時の指定に対応していない場合はプロパティ自体が存在しません。"
            },
            "completed_post_process_id": {
              "type": "array",
              "description": "ジョブが成功した場合に実行する後処理IDの配列"
            },
            "failed_post_process_id": {
              "type": "array",
              "description": "ジョブが失敗した場合に実行する後処理IDの配列"
            },
            "created_at": {
              "type": "string",
              "description": "ジョブの作成日時"
            },
            "updated_at": {
              "type": "string",
              "description": "ジョブの更新日時"
            }
          }
        }
      },
      "description": "ジョブ"
    }
  }
}

Edit Job
PATCH/jobs/{id}

ジョブの情報を更新します。

リクエストボディに含めるパラメーター

名前 型 必須かどうか 説明
name string optional ジョブの名前
aws_account_id number optional ジョブの実行時に使うAWSアカウントのID。AWS用アクションの場合のみ必要
※AWSのアカウントIDではなくCloud Automator上のID
aws_account_ids array optional ジョブの実行時に使うAWSアカウントのIDの配列。
AWS用アクションのうち、action_typeがbulk_stop_instancesの場合に必要。
その場合、aws_account_idは指定不可。
google_cloud_account_id number optional ジョブの実行時に使うGoogle CloudアカウントのID。Google Cloud用アクションの場合のみ必要
※Google Cloud側のIDではなくCloud Automator上のID
rule_value object optional トリガーの設定値
action_value object optional アクションの設定値
effective_date string optional ジョブの有効期間の開始日
yyyy/mm/dd形式 (JSTとして解釈されます)
※rule_typeがcronかつschedule_typeがone_time以外の場合のみ指定
※rule_typeがcronかつschedule_typeがone_timeの場合にこのパラメータを指定すると422 Unprocessable Entityを返します
expiration_date string optional ジョブの有効期間の終了日
yyyy/mm/dd形式 (JSTとして解釈されます)
※rule_typeがcronかつschedule_typeがone_time以外の場合のみ指定可能
※rule_typeがcronかつschedule_typeがone_timeの場合にこのパラメータを指定すると422 Unprocessable Entityを返します
completed_post_process_id array[number] optional ジョブが成功した場合に実行する後処理IDが含まれる配列
空の配列を指定すると現在の設定が削除されます。
パラメーターを指定しない場合は現在の設定が維持されます。
例) [1, 2, 3, 4]
failed_post_process_id array[number] optional ジョブが失敗した場合に実行する後処理IDが含まれる配列
空の配列を指定すると現在の設定が削除されます。
パラメーターを指定しない場合は現在の設定が維持されます。
例) [1, 2, 3, 4]

トリガーのタイプ、アクションのタイプ、ジョブが所属するグループは変更することができません。

Example URI

PATCH https://manager.cloudautomator.com/api/v1/jobs/1
URI Parameters
HideShow
id
number (required) Example: 1

ジョブID

Request  サンプルリクエスト
HideShow
Headers
Content-Type: application/json
Body
{
  "effective_date": "2016/10/01",
  "expiration_date": "2016/12/31",
  "rule_value": {
    "weekly_schedule": [
      "sunday"
    ]
  },
  "completed_post_process_id": [
    3
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "effective_date": {
      "type": "string",
      "description": "有効期間の開始日"
    },
    "expiration_date": {
      "type": "string",
      "description": "有効期間の終了日"
    },
    "rule_value": {
      "type": "object",
      "properties": {
        "weekly_schedule": {
          "type": "array",
          "description": "ジョブの実行曜日"
        }
      }
    },
    "completed_post_process_id": {
      "type": "array",
      "description": "ジョブ成功時に実行する後処理ID"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": "1",
    "type": "trigger_jobs",
    "attributes": {
      "name": "毎週月曜の9時にAMIを作成",
      "aws_account_id": 1,
      "aws_account_ids": [
        "[1, 2, 3]"
      ],
      "google_cloud_account_id": "null",
      "provider_type": "aws",
      "group_id": 1,
      "for_workflow": false,
      "rule_type": "cron",
      "effective_date": "2016-10-01",
      "expiration_date": "2017-12-31",
      "rule_value": {
        "hour": 9,
        "minutes": 0,
        "national_holiday_schedule": "true",
        "schedule_type": "weekly",
        "time_zone": "Tokyo",
        "weekly_schedule": [
          "monday"
        ],
        "dates_to_skip": [
          "2021-01-13"
        ]
      },
      "action_type": "create_image",
      "action_value": {
        "region": "ap-northeast-1",
        "instance_id": "i-00000001",
        "generation": 1,
        "image_name": "TestAMI",
        "trace_status": "true",
        "reboot_instance": "true",
        "specify_image_instance": "identifier",
        "add_same_tag_to_snapshot": "false",
        "recreate_image_if_ami_status_failed": "false"
      },
      "active": true,
      "allow_runtime_action_values": false,
      "completed_post_process_id": [
        1
      ],
      "failed_post_process_id": [
        2
      ],
      "created_at": "2016-10-13 22:45:45 +0900",
      "updated_at": "2016-10-13 22:45:45 +0900"
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "ジョブID"
        },
        "type": {
          "type": "string",
          "description": "データ型"
        },
        "attributes": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "ジョブ名"
            },
            "aws_account_id": {
              "type": [
                "number",
                "null"
              ],
              "description": "AWSアカウントID (bulk_stop_instancesアクション以外の場合)"
            },
            "aws_account_ids": {
              "type": "array",
              "description": "AWSアカウントID (bulk_stop_instancesアクションの場合のみ)"
            },
            "google_cloud_account_id": {
              "type": [
                "string",
                "null"
              ],
              "description": "Google CloudアカウントID (bulk_stop_instancesアクション以外の場合)"
            },
            "provider_type": {
              "type": "string",
              "enum": [
                "aws",
                "google_cloud",
                "no"
              ],
              "description": "プロバイダの種類"
            },
            "group_id": {
              "type": "number",
              "description": "グループID"
            },
            "for_workflow": {
              "type": "boolean",
              "description": "ジョブワークフロー専用ジョブにするかどうか"
            },
            "rule_type": {
              "type": "string",
              "description": "トリガータイプ"
            },
            "effective_date": {
              "type": "string",
              "description": "有効期間の開始日"
            },
            "expiration_date": {
              "type": "string",
              "description": "有効期間の終了日"
            },
            "rule_value": {
              "type": "object",
              "properties": {
                "hour": {
                  "type": "number",
                  "description": "時"
                },
                "minutes": {
                  "type": "number",
                  "description": "分"
                },
                "national_holiday_schedule": {
                  "type": "string",
                  "description": "ジョブの実行日と日本の祝日が重なっていた場合に実行をスキップするか否か"
                },
                "schedule_type": {
                  "type": "string",
                  "description": "スケジュールタイプ"
                },
                "time_zone": {
                  "type": "string",
                  "description": "タイムゾーンを表す文字列"
                },
                "weekly_schedule": {
                  "type": "array"
                },
                "dates_to_skip": {
                  "type": "array"
                }
              }
            },
            "action_type": {
              "type": "string",
              "description": "アクションタイプ"
            },
            "action_value": {
              "type": "object",
              "properties": {
                "region": {
                  "type": "string"
                },
                "instance_id": {
                  "type": "string"
                },
                "generation": {
                  "type": "number"
                },
                "image_name": {
                  "type": "string"
                },
                "trace_status": {
                  "type": "string"
                },
                "reboot_instance": {
                  "type": "string"
                },
                "specify_image_instance": {
                  "type": "string"
                },
                "add_same_tag_to_snapshot": {
                  "type": "string"
                },
                "recreate_image_if_ami_status_failed": {
                  "type": "string"
                }
              }
            },
            "active": {
              "type": "boolean",
              "description": "ジョブがアクティブかどうか"
            },
            "allow_runtime_action_values": {
              "type": "boolean",
              "description": "アクションの設定値を実行時に指定するかどうか。ジョブが実行時の指定に対応していない場合はプロパティ自体が存在しません。"
            },
            "completed_post_process_id": {
              "type": "array",
              "description": "ジョブが成功した場合に実行する後処理IDの配列"
            },
            "failed_post_process_id": {
              "type": "array",
              "description": "ジョブが失敗した場合に実行する後処理IDの配列"
            },
            "created_at": {
              "type": "string",
              "description": "ジョブの作成日時"
            },
            "updated_at": {
              "type": "string",
              "description": "ジョブの更新日時"
            }
          }
        }
      },
      "description": "更新後のジョブ"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "source": {
        "pointer": "/data/attributes/name"
      },
      "detail": "を入力してください"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array"
    }
  }
}

Delete Job
DELETE/jobs/{id}

ジョブを削除します。

削除に成功した場合はステータスコード204 No Contentを返し、レスポンスボディは返しません。

Example URI

DELETE https://manager.cloudautomator.com/api/v1/jobs/1
URI Parameters
HideShow
id
number (required) Example: 1

ジョブID

Response  204
HideShow
Headers
Content-Type: application/json

ジョブの状態

Activate Job
POST/jobs/{id}/active

ジョブの状態をONに変更します。

現在のジョブの状態が既にONの場合は、何もせずに現在のジョブの状態が入ったレスポンスを返します。

Example URI

POST https://manager.cloudautomator.com/api/v1/jobs/1/active
URI Parameters
HideShow
id
number (required) Example: 1

ジョブID

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": "1",
    "type": "trigger_jobs",
    "attributes": {
      "active": true
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "ジョブID"
        },
        "type": {
          "type": "string",
          "description": "データ型"
        },
        "attributes": {
          "type": "object",
          "properties": {
            "active": {
              "type": "boolean",
              "description": "ジョブの状態"
            }
          }
        }
      },
      "description": "更新後のジョブの状態"
    }
  }
}

Deactivate Job
DELETE/jobs/{id}/active

ジョブの状態をOFFに変更します。

現在のジョブの状態が既にOFFの場合は、何もせずに現在のジョブの状態が入ったレスポンスを返します。

Example URI

DELETE https://manager.cloudautomator.com/api/v1/jobs/1/active
URI Parameters
HideShow
id
number (required) Example: 1

ジョブID

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": "1",
    "type": "trigger_jobs",
    "attributes": {
      "active": true
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "ジョブID"
        },
        "type": {
          "type": "string",
          "description": "データ型"
        },
        "attributes": {
          "type": "object",
          "properties": {
            "active": {
              "type": "boolean",
              "description": "ジョブの状態"
            }
          }
        }
      },
      "description": "更新後のジョブの状態"
    }
  }
}

ジョブログ

Get Logs
GET/logs

複数のジョブログを取得します。

Example URI

GET https://manager.cloudautomator.com/api/v1/logs
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": "1",
      "type": "trigger_job_logs",
      "attributes": {
        "name": "毎週月曜の9時にAMIを作成",
        "result": {
          "error_code": "ResourceNotFound",
          "error_message": "Instances not found"
        },
        "status": "failed",
        "aws_account_id": 1,
        "google_cloud_account_id": "null",
        "provider_type": "aws",
        "group_id": 1,
        "job_id": 1,
        "rule_type": "cron",
        "effective_date": "2016-10-01",
        "expiration_date": "2017-12-31",
        "rule_value": {
          "hour": 9,
          "minutes": 0,
          "schedule_type": "weekly",
          "time_zone": "Tokyo",
          "weekly_schedule": [
            "monday"
          ]
        },
        "action_type": "create_image",
        "action_value": {
          "region": "ap-northeast-1",
          "instance_id": "i-00000001",
          "generation": 1,
          "image_name": "TestAMI",
          "trace_status": true,
          "reboot_instance": true,
          "specify_image_instance": "identifier",
          "add_same_tag_to_snapshot": false,
          "recreate_image_if_ami_status_failed": false
        },
        "started_at": "2016-10-13 22:45:45 +0900",
        "finished_at": "2016-10-13 22:45:45 +0900",
        "allow_runtime_action_values": false,
        "created_at": "2016-10-13 22:45:45 +0900",
        "updated_at": "2016-10-13 22:45:45 +0900"
      }
    }
  ],
  "links": {
    "self": "https://manager.cloudautomator.com/api/v1/logs?page%5Bnumber%5D=1&page%5Bsize%5D=5",
    "first": "https://manager.cloudautomator.com/api/v1/logs?page%5Bnumber%5D=1&page%5Bsize%5D=5",
    "prev": "https://manager.cloudautomator.com/api/v1/logs?page%5Bnumber%5D=1&page%5Bsize%5D=5",
    "next": "https://manager.cloudautomator.com/api/v1/logs?page%5Bnumber%5D=2&page%5Bsize%5D=5",
    "last": "https://manager.cloudautomator.com/api/v1/logs?page%5Bnumber%5D=3&page%5Bsize%5D=5"
  },
  "meta": {
    "total": 12
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "description": "ジョブログの配列"
    },
    "links": {
      "type": "object",
      "properties": {
        "self": {
          "type": "string",
          "description": "現在のページを指すURL"
        },
        "first": {
          "type": "string",
          "description": "最初のページを指すURL"
        },
        "prev": {
          "type": [
            "string",
            "null"
          ],
          "description": "前のページを指すURL"
        },
        "next": {
          "type": [
            "string",
            "null"
          ],
          "description": "次のページを指すURL"
        },
        "last": {
          "type": "string",
          "description": "最後のページを指すURL"
        }
      },
      "description": "ページネーションリンク"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "ジョブログの総数"
        }
      }
    }
  }
}

Get Log
GET/logs/{id}

1件のジョブログを取得します。

Example URI

GET https://manager.cloudautomator.com/api/v1/logs/1
URI Parameters
HideShow
id
number (required) Example: 1

ジョブログ

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": "1",
    "type": "trigger_job_logs",
    "attributes": {
      "name": "毎週月曜の9時にAMIを作成",
      "result": {
        "error_code": "ResourceNotFound",
        "error_message": "Instances not found"
      },
      "status": "failed",
      "aws_account_id": 1,
      "google_cloud_account_id": "null",
      "provider_type": "aws",
      "group_id": 1,
      "job_id": 1,
      "rule_type": "cron",
      "effective_date": "2016-10-01",
      "expiration_date": "2017-12-31",
      "rule_value": {
        "hour": 9,
        "minutes": 0,
        "schedule_type": "weekly",
        "time_zone": "Tokyo",
        "weekly_schedule": [
          "monday"
        ]
      },
      "action_type": "create_image",
      "action_value": {
        "region": "ap-northeast-1",
        "instance_id": "i-00000001",
        "generation": 1,
        "image_name": "TestAMI",
        "trace_status": true,
        "reboot_instance": true,
        "specify_image_instance": "identifier",
        "add_same_tag_to_snapshot": false,
        "recreate_image_if_ami_status_failed": false
      },
      "started_at": "2016-10-13 22:45:45 +0900",
      "finished_at": "2016-10-13 22:45:45 +0900",
      "allow_runtime_action_values": false,
      "created_at": "2016-10-13 22:45:45 +0900",
      "updated_at": "2016-10-13 22:45:45 +0900"
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "ジョブログID"
        },
        "type": {
          "type": "string",
          "description": "データ型"
        },
        "attributes": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "ジョブ名"
            },
            "result": {
              "type": "object",
              "properties": {
                "error_code": {
                  "type": "string",
                  "description": "エラーコード"
                },
                "error_message": {
                  "type": "string",
                  "description": "エラーメッセージ"
                }
              }
            },
            "status": {
              "type": "string",
              "description": "ジョブステータス"
            },
            "aws_account_id": {
              "type": [
                "number",
                "null"
              ],
              "description": "AWSアカウントID"
            },
            "google_cloud_account_id": {
              "type": [
                "string",
                "null"
              ],
              "description": "Google CloudアカウントID"
            },
            "provider_type": {
              "type": "string",
              "enum": [
                "aws",
                "google_cloud",
                "no"
              ],
              "description": "プロバイダの種類"
            },
            "group_id": {
              "type": "number",
              "description": "グループID"
            },
            "job_id": {
              "type": "number",
              "description": "ジョブID"
            },
            "rule_type": {
              "type": "string",
              "description": "トリガータイプ"
            },
            "effective_date": {
              "type": "string",
              "description": "有効期間の開始日"
            },
            "expiration_date": {
              "type": "string",
              "description": "有効期間の終了日"
            },
            "rule_value": {
              "type": "object",
              "properties": {
                "hour": {
                  "type": "number",
                  "description": "時"
                },
                "minutes": {
                  "type": "number",
                  "description": "分"
                },
                "schedule_type": {
                  "type": "string",
                  "description": "スケジュールタイプ"
                },
                "time_zone": {
                  "type": "string",
                  "description": "タイムゾーンを表す文字列"
                },
                "weekly_schedule": {
                  "type": "array"
                }
              }
            },
            "action_type": {
              "type": "string",
              "description": "アクションタイプ"
            },
            "action_value": {
              "type": "object",
              "properties": {
                "region": {
                  "type": "string"
                },
                "instance_id": {
                  "type": "string"
                },
                "generation": {
                  "type": "number"
                },
                "image_name": {
                  "type": "string"
                },
                "trace_status": {
                  "type": "boolean"
                },
                "reboot_instance": {
                  "type": "boolean"
                },
                "specify_image_instance": {
                  "type": "string"
                },
                "add_same_tag_to_snapshot": {
                  "type": "boolean"
                },
                "recreate_image_if_ami_status_failed": {
                  "type": "boolean"
                }
              }
            },
            "started_at": {
              "type": "string",
              "description": "ジョブの実行開始日時"
            },
            "finished_at": {
              "type": "string",
              "description": "ジョブの終了日時"
            },
            "allow_runtime_action_values": {
              "type": "boolean",
              "description": "アクションの設定値を実行時に指定するかどうか。ジョブが実行時の指定に対応していない場合はプロパティ自体が存在しません。"
            },
            "created_at": {
              "type": "string",
              "description": "ジョブログの作成日時"
            },
            "updated_at": {
              "type": "string",
              "description": "ジョブログの更新日時"
            }
          }
        }
      },
      "description": "ジョブログ"
    }
  }
}

Get ResourceOperationResults
GET/logs/{id}/resource_operation_results

ログに紐づくリソース操作結果を返します。

Example URI

GET https://manager.cloudautomator.com/api/v1/logs/1/resource_operation_results
URI Parameters
HideShow
id
number (required) Example: 1

ジョブログID

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": "1",
    "type": "resource_operation_results",
    "attributes": {
      "message": "The command is pending",
      "result": "completed",
      "affected_resource_id": "ami-00000001",
      "target_resource_id": "i-00000001",
      "target_resource_name_tag": "sample-tag",
      "job_id": 1,
      "log_id": 1,
      "created_at": "2016-10-13 22:45:45 +0900",
      "updated_at": "2016-10-13 22:45:45 +0900"
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "ジョブログID"
        },
        "type": {
          "type": "string",
          "description": "データ型"
        },
        "attributes": {
          "type": "object",
          "properties": {
            "message": {
              "type": "string",
              "description": "リソースに対しての実行時の特記事項"
            },
            "result": {
              "type": "string",
              "description": "ジョブ実行結果(completed, failed, aborted, skipped)"
            },
            "affected_resource_id": {
              "type": "string",
              "description": "ジョブを実行して影響をうけたリソースID(作成したイメージID等)"
            },
            "target_resource_id": {
              "type": "string",
              "description": "ジョブの実行対象のリソースID"
            },
            "target_resource_name_tag": {
              "type": "string",
              "description": "ジョブ実行対象のNameタグの値"
            },
            "job_id": {
              "type": "number",
              "description": "ジョブID"
            },
            "log_id": {
              "type": "number",
              "description": "ログID"
            },
            "created_at": {
              "type": "string",
              "description": "リソース操作結果の作成日時"
            },
            "updated_at": {
              "type": "string",
              "description": "リソース操作結果の更新日時"
            }
          }
        }
      },
      "description": "リソース操作結果"
    }
  }
}

ジョブワークフロー

Create JobWorkflow
POST/job_workflows

新しいジョブワークフローを作成します。

リクエストボディに含めるパラメーター

名前 型 必須かどうか 説明
name string required ジョブワークフローの名前
group_id number required ジョブワークフローを所属させるグループのID
first_job_id number required 先頭ジョブID
following_job_ids array[number] required 後続ジョブIDの配列

Example URI

POST https://manager.cloudautomator.com/api/v1/job_workflows
Request  サンプルリクエスト
HideShow
Headers
Content-Type: application/json
Body
{
  "name": "ジョブワークフロー",
  "group_id": 1,
  "first_job_id": 1,
  "following_job_ids": [
    1,
    2,
    3
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "任意のジョブワークフロー名"
    },
    "group_id": {
      "type": "number",
      "description": "グループID"
    },
    "first_job_id": {
      "type": "number",
      "description": "先頭ジョブID"
    },
    "following_job_ids": {
      "type": "array",
      "description": "後続ジョブIDの配列"
    }
  },
  "required": [
    "name",
    "group_id",
    "first_job_id"
  ]
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": "1",
    "type": "job_workflows",
    "attributes": {
      "name": "ジョブワークフロー",
      "active": true,
      "group_id": 1,
      "first_job_id": 1,
      "following_job_ids": [
        1,
        2,
        3
      ],
      "created_at": "2016-10-13 22:45:45 +0900",
      "updated_at": "2016-10-13 22:45:45 +0900"
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "ジョブワークフローID"
        },
        "type": {
          "type": "string",
          "description": "データ型"
        },
        "attributes": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "ジョブワークフロー名"
            },
            "active": {
              "type": "boolean",
              "description": "ジョブワークフローの状態"
            },
            "group_id": {
              "type": "number",
              "description": "グループID"
            },
            "first_job_id": {
              "type": "number",
              "description": "先頭ジョブID"
            },
            "following_job_ids": {
              "type": "array",
              "description": "後続ジョブIDの配列"
            },
            "created_at": {
              "type": "string",
              "description": "ジョブワークフローの作成日時"
            },
            "updated_at": {
              "type": "string",
              "description": "ジョブワークフローの更新日時"
            }
          }
        }
      },
      "description": "作成されたジョブワークフロー"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "source": {
        "pointer": "/data/attributes/name"
      },
      "detail": "を入力してください"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array"
    }
  }
}

Get JobWorkflowes
GET/job_workflows

複数のジョブワークフローを取得します。

Example URI

GET https://manager.cloudautomator.com/api/v1/job_workflows
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": "1",
      "type": "job_workflows",
      "attributes": {
        "name": "ジョブワークフロー",
        "active": true,
        "group_id": 1,
        "first_job_id": 1,
        "following_job_ids": [
          1,
          2,
          3
        ],
        "created_at": "2016-10-13 22:45:45 +0900",
        "updated_at": "2016-10-13 22:45:45 +0900"
      }
    }
  ],
  "links": {
    "self": "https://manager.cloudautomator.com/api/v1/job_workflows?page%5Bnumber%5D=1&page%5Bsize%5D=5",
    "first": "https://manager.cloudautomator.com/api/v1/job_workflows?page%5Bnumber%5D=1&page%5Bsize%5D=5",
    "prev": "https://manager.cloudautomator.com/api/v1/job_workflows?page%5Bnumber%5D=1&page%5Bsize%5D=5",
    "next": "https://manager.cloudautomator.com/api/v1/job_workflows?page%5Bnumber%5D=2&page%5Bsize%5D=5",
    "last": "https://manager.cloudautomator.com/api/v1/job_workflows?page%5Bnumber%5D=3&page%5Bsize%5D=5"
  },
  "meta": {
    "total": 12
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "description": "ジョブワークフローの配列"
    },
    "links": {
      "type": "object",
      "properties": {
        "self": {
          "type": "string",
          "description": "現在のページを指すURL"
        },
        "first": {
          "type": "string",
          "description": "最初のページを指すURL"
        },
        "prev": {
          "type": [
            "string",
            "null"
          ],
          "description": "前のページを指すURL"
        },
        "next": {
          "type": [
            "string",
            "null"
          ],
          "description": "次のページを指すURL"
        },
        "last": {
          "type": "string",
          "description": "最後のページを指すURL"
        }
      },
      "description": "ページネーションリンク"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "ジョブワークフローの総数"
        }
      }
    }
  }
}

Get JobWorkflow
GET/job_workflows/{id}

1件のジョブワークフローを取得します。

Example URI

GET https://manager.cloudautomator.com/api/v1/job_workflows/1
URI Parameters
HideShow
id
number (required) Example: 1

ジョブワークフローID

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": "1",
    "type": "job_workflows",
    "attributes": {
      "name": "ジョブワークフロー",
      "active": true,
      "group_id": 1,
      "first_job_id": 1,
      "following_job_ids": [
        1,
        2,
        3
      ],
      "created_at": "2016-10-13 22:45:45 +0900",
      "updated_at": "2016-10-13 22:45:45 +0900"
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "ジョブワークフローID"
        },
        "type": {
          "type": "string",
          "description": "データ型"
        },
        "attributes": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "ジョブワークフロー名"
            },
            "active": {
              "type": "boolean",
              "description": "ジョブワークフローの状態"
            },
            "group_id": {
              "type": "number",
              "description": "グループID"
            },
            "first_job_id": {
              "type": "number",
              "description": "先頭ジョブID"
            },
            "following_job_ids": {
              "type": "array",
              "description": "後続ジョブIDの配列"
            },
            "created_at": {
              "type": "string",
              "description": "ジョブワークフローの作成日時"
            },
            "updated_at": {
              "type": "string",
              "description": "ジョブワークフローの更新日時"
            }
          }
        }
      },
      "description": "ジョブワークフロー"
    }
  }
}

Edit JobWorkflow
PATCH/job_workflows/{id}

ジョブワークフローの情報を更新します。

リクエストボディに含めるパラメーター

名前 型 必須かどうか 説明
name string optional ジョブワークフローの名前
active boolean optional ジョブワークフローの状態
first_job_id number optional 先頭ジョブID
following_job_ids array[number] optional 後続ジョブIDの配列

手動トリガー、HTTPトリガーが先頭ジョブのジョブワークフローの状態は更新できません。
ジョブワークフローが所属するグループは変更できません。

Example URI

PATCH https://manager.cloudautomator.com/api/v1/job_workflows/1
URI Parameters
HideShow
id
number (required) Example: 1

ジョブワークフローID

Request  サンプルリクエスト
HideShow
Headers
Content-Type: application/json
Body
{
  "parameters": {
    "name": "ジョブワークフロー",
    "active": true
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "parameters": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "active": {
          "type": "boolean"
        }
      }
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": "1",
    "type": "job_workflows",
    "attributes": {
      "name": "ジョブワークフロー",
      "active": true,
      "group_id": 1,
      "first_job_id": 1,
      "following_job_ids": [
        1,
        2,
        3
      ],
      "created_at": "2016-10-13 22:45:45 +0900",
      "updated_at": "2016-10-13 22:45:45 +0900"
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "ジョブワークフローID"
        },
        "type": {
          "type": "string",
          "description": "データ型"
        },
        "attributes": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "ジョブワークフロー名"
            },
            "active": {
              "type": "boolean",
              "description": "ジョブワークフローの状態"
            },
            "group_id": {
              "type": "number",
              "description": "グループID"
            },
            "first_job_id": {
              "type": "number",
              "description": "先頭ジョブID"
            },
            "following_job_ids": {
              "type": "array",
              "description": "後続ジョブIDの配列"
            },
            "created_at": {
              "type": "string",
              "description": "ジョブワークフローの作成日時"
            },
            "updated_at": {
              "type": "string",
              "description": "ジョブワークフローの更新日時"
            }
          }
        }
      },
      "description": "更新後のジョブワークフロー"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "source": {
        "pointer": "/data/attributes/name"
      },
      "detail": "を入力してください"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array"
    }
  }
}

Delete JobWorkflow
DELETE/job_workflows/{id}

ジョブワークフローを削除します。

削除に成功した場合はステータスコード204 No Contentを返し、レスポンスボディは返しません。

Example URI

DELETE https://manager.cloudautomator.com/api/v1/job_workflows/1
URI Parameters
HideShow
id
number (required) Example: 1

ジョブワークフローID

Response  204
HideShow
Headers
Content-Type: application/json

後処理

Create PostProcess
POST/post_processes

新しい後処理を作成します。

リクエストボディに含めるパラメーター

名前 型 必須かどうか 説明
name string required 後処理の名前
service string required 後処理で利用するサービスタイプ
parameters object required 後処理の設定値
group_id number optional 後処理を所属させるグループのID
グループを指定しない場合は共通後処理になります

サービスタイプとしてserviceに指定できるのは以下のいずれかです。

後処理で利用するサービスタイプ 説明 serviceの要否
email メール 必要
slack Slack 必要
sqs SQS 必要
webhook Webhook 必要

サービスタイプがemailの場合のparametersの設定値

名前 型 必須かどうか 説明
email_recipient string required メールアドレス
例)hoge@example.com

サービスタイプがslackの場合のparametersの設定値

名前 型 必須かどうか 説明
slack_channel_name string required Slackチャンネル名(#は含めない)
例) "general"
slack_language string required 通知内容の言語("ja"または"en")
slack_time_zone string required 通知内容のタイムゾーン("Tokyo"など)

サービスタイプがsqsの場合のparametersの設定値

名前 型 必須かどうか 説明
sqs_aws_account_id number required SQSのキューを検索する際に利用するAWSアカウントのID
※AWSのアカウントIDではなくCloud Automator上のID
sqs_queue string required SQSのキュー名
※標準キューのみ対応しております。 FIFOキューはご利用いただけません。
sqs_region string required SQSのキューが存在するリージョン名

サービスタイプがwebhookの場合のparametersの設定値

名前 型 必須かどうか 説明
webhook_authorization_header string required Authorizationヘッダの値
例) Bearer b30579a2659607322aa6f68eeecd793b
※Authorizationヘッダを利用しない場合でも空文字列を指定すること
webhook_url string required Webhook送信先となるURL
例) https://example.com/webhook

Example URI

POST https://manager.cloudautomator.com/api/v1/post_processes
Request  サンプルリクエスト
HideShow
Headers
Content-Type: application/json
Body
{
  "name": "成功時の通知",
  "service": "sqs",
  "group_id": 1,
  "parameters": {
    "sqs_aws_account_id": 1,
    "sqs_queue": "example-queue",
    "sqs_region": "ap-northeast-1"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "任意の後処理名"
    },
    "service": {
      "type": "string",
      "description": "後処理で利用するサービスタイプ"
    },
    "group_id": {
      "type": "number",
      "description": "グループID"
    },
    "parameters": {
      "type": "object",
      "properties": {
        "sqs_aws_account_id": {
          "type": "number",
          "description": "SQSのキューを検索する際に利用するAWSアカウントのID"
        },
        "sqs_queue": {
          "type": "string",
          "description": "SQSのキュー名"
        },
        "sqs_region": {
          "type": "string",
          "description": "SQSのキューが存在するリージョン名"
        }
      },
      "required": [
        "sqs_aws_account_id",
        "sqs_queue",
        "sqs_region"
      ],
      "description": "サービスの設定値"
    }
  },
  "required": [
    "name",
    "service",
    "parameters"
  ]
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": "'1'",
    "type": "post_processes",
    "attributes": {
      "name": "後処理",
      "service": "sqs",
      "group_id": 1,
      "shared_by_group": false,
      "parameters": {
        "sqs_aws_account_id": 1,
        "sqs_region": "ap-northeast-1",
        "sqs_queue": "sample"
      },
      "created_at": "2016-10-13 22:45:45 +0900",
      "updated_at": "2016-10-13 22:45:45 +0900"
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "後処理ID"
        },
        "type": {
          "type": "string",
          "description": "データ型"
        },
        "attributes": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "後処理名"
            },
            "service": {
              "type": "string",
              "description": "サービスタイプ"
            },
            "group_id": {
              "type": "number",
              "description": "グループID"
            },
            "shared_by_group": {
              "type": "boolean"
            },
            "parameters": {
              "type": "object",
              "properties": {
                "sqs_aws_account_id": {
                  "type": "number"
                },
                "sqs_region": {
                  "type": "string"
                },
                "sqs_queue": {
                  "type": "string"
                }
              }
            },
            "created_at": {
              "type": "string",
              "description": "後処理の作成日時"
            },
            "updated_at": {
              "type": "string",
              "description": "後処理の更新日時"
            }
          }
        }
      },
      "description": "作成された後処理"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "source": {
        "pointer": "/data/attributes/name"
      },
      "detail": "を入力してください"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array"
    }
  }
}

Get PostProcesses
GET/post_processes

複数の後処理を取得します。

Example URI

GET https://manager.cloudautomator.com/api/v1/post_processes
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": "'1'",
      "type": "post_processes",
      "attributes": {
        "name": "後処理",
        "service": "sqs",
        "group_id": 1,
        "shared_by_group": false,
        "parameters": {
          "sqs_aws_account_id": 1,
          "sqs_region": "ap-northeast-1",
          "sqs_queue": "sample"
        },
        "created_at": "2016-10-13 22:45:45 +0900",
        "updated_at": "2016-10-13 22:45:45 +0900"
      }
    }
  ],
  "links": {
    "self": "https://manager.cloudautomator.com/api/v1/post_processes?page%5Bnumber%5D=1&page%5Bsize%5D=5",
    "first": "https://manager.cloudautomator.com/api/v1/post_processes?page%5Bnumber%5D=1&page%5Bsize%5D=5",
    "prev": "https://manager.cloudautomator.com/api/v1/post_processes?page%5Bnumber%5D=1&page%5Bsize%5D=5",
    "next": "https://manager.cloudautomator.com/api/v1/post_processes?page%5Bnumber%5D=2&page%5Bsize%5D=5",
    "last": "https://manager.cloudautomator.com/api/v1/post_processes?page%5Bnumber%5D=3&page%5Bsize%5D=5"
  },
  "meta": {
    "total": 12
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "description": "後処理の配列"
    },
    "links": {
      "type": "object",
      "properties": {
        "self": {
          "type": "string",
          "description": "現在のページを指すURL"
        },
        "first": {
          "type": "string",
          "description": "最初のページを指すURL"
        },
        "prev": {
          "type": [
            "string",
            "null"
          ],
          "description": "前のページを指すURL"
        },
        "next": {
          "type": [
            "string",
            "null"
          ],
          "description": "次のページを指すURL"
        },
        "last": {
          "type": "string",
          "description": "最後のページを指すURL"
        }
      },
      "description": "ページネーションリンク"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "後処理の総数"
        }
      }
    }
  }
}

Get PostProcess
GET/post_processes/{id}

1件の後処理を取得します。

Example URI

GET https://manager.cloudautomator.com/api/v1/post_processes/1
URI Parameters
HideShow
id
number (required) Example: 1

後処理

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": "'1'",
    "type": "post_processes",
    "attributes": {
      "name": "後処理",
      "service": "sqs",
      "group_id": 1,
      "shared_by_group": false,
      "parameters": {
        "sqs_aws_account_id": 1,
        "sqs_region": "ap-northeast-1",
        "sqs_queue": "sample"
      },
      "created_at": "2016-10-13 22:45:45 +0900",
      "updated_at": "2016-10-13 22:45:45 +0900"
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "後処理ID"
        },
        "type": {
          "type": "string",
          "description": "データ型"
        },
        "attributes": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "後処理名"
            },
            "service": {
              "type": "string",
              "description": "サービスタイプ"
            },
            "group_id": {
              "type": "number",
              "description": "グループID"
            },
            "shared_by_group": {
              "type": "boolean"
            },
            "parameters": {
              "type": "object",
              "properties": {
                "sqs_aws_account_id": {
                  "type": "number"
                },
                "sqs_region": {
                  "type": "string"
                },
                "sqs_queue": {
                  "type": "string"
                }
              }
            },
            "created_at": {
              "type": "string",
              "description": "後処理の作成日時"
            },
            "updated_at": {
              "type": "string",
              "description": "後処理の更新日時"
            }
          }
        }
      },
      "description": "後処理"
    }
  }
}

Edit PostProcess
PATCH/post_processes/{id}

後処理の情報を更新します。

リクエストボディに含めるパラメーター

名前 型 必須かどうか 説明
name string optional 後処理の名前
service string optional 後処理で利用するサービスタイプ
parameters object optional 後処理の設定値

Example URI

PATCH https://manager.cloudautomator.com/api/v1/post_processes/1
URI Parameters
HideShow
id
number (required) Example: 1

後処理ID

Request  サンプルリクエスト
HideShow
Headers
Content-Type: application/json
Body
{
  "parameters": {
    "email_recipient": "fuga@example.com"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "parameters": {
      "type": "object",
      "properties": {
        "email_recipient": {
          "type": "string"
        }
      }
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": "'1'",
    "type": "post_processes",
    "attributes": {
      "name": "後処理",
      "service": "sqs",
      "group_id": 1,
      "shared_by_group": false,
      "parameters": {
        "sqs_aws_account_id": 1,
        "sqs_region": "ap-northeast-1",
        "sqs_queue": "sample"
      },
      "created_at": "2016-10-13 22:45:45 +0900",
      "updated_at": "2016-10-13 22:45:45 +0900"
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "後処理ID"
        },
        "type": {
          "type": "string",
          "description": "データ型"
        },
        "attributes": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "後処理名"
            },
            "service": {
              "type": "string",
              "description": "サービスタイプ"
            },
            "group_id": {
              "type": "number",
              "description": "グループID"
            },
            "shared_by_group": {
              "type": "boolean"
            },
            "parameters": {
              "type": "object",
              "properties": {
                "sqs_aws_account_id": {
                  "type": "number"
                },
                "sqs_region": {
                  "type": "string"
                },
                "sqs_queue": {
                  "type": "string"
                }
              }
            },
            "created_at": {
              "type": "string",
              "description": "後処理の作成日時"
            },
            "updated_at": {
              "type": "string",
              "description": "後処理の更新日時"
            }
          }
        }
      },
      "description": "更新後の後処理"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "source": {
        "pointer": "/data/attributes/name"
      },
      "detail": "を入力してください"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array"
    }
  }
}

Delete PostProcess
DELETE/post_processes/{id}

後処理を削除します。

削除に成功した場合はステータスコード204 No Contentを返し、レスポンスボディは返しません。

Example URI

DELETE https://manager.cloudautomator.com/api/v1/post_processes/1
URI Parameters
HideShow
id
number (required) Example: 1

後処理ID

Response  204
HideShow
Headers
Content-Type: application/json

カレンダー ※一部組織に限定して公開

※一部組織に限定して公開しています

Create Calendar
POST/calendars

新しいカレンダーを作成します。

リクエストボディに含めるパラメーター

名前 型 必須かどうか 説明
name string required カレンダーの名前
group_id number required カレンダーを所属させるグループのID
dates array[string] required カレンダーで管理する YYYY-MM-DD 形式の日付の配列
例) [“2020-01-01”, “2020-01-02”, “2020-01-03”]

Example URI

POST https://manager.cloudautomator.com/api/v1/calendars
Request  サンプルリクエスト
HideShow
Headers
Content-Type: application/json
Body
{
  "name": "成功時の通知",
  "group_id": 1,
  "dates": [
    "[\"2020-01-01\"]"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "任意のカレンダー名"
    },
    "group_id": {
      "type": "number",
      "description": "グループID"
    },
    "dates": {
      "type": "array",
      "description": "日付の配列"
    }
  },
  "required": [
    "name",
    "group_id",
    "dates"
  ]
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": "'1'",
    "type": "Calendar",
    "attributes": {
      "name": "カレンダー",
      "group_id": 1,
      "dates": [
        "[\"2020-01-01\"]"
      ]
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "カレンダーID"
        },
        "type": {
          "type": "string",
          "description": "データ型"
        },
        "attributes": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "カレンダー名"
            },
            "group_id": {
              "type": "number",
              "description": "グループID"
            },
            "dates": {
              "type": "array"
            }
          }
        }
      },
      "description": "作成されたカレンダー"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "source": {
        "pointer": "/data/attributes/name"
      },
      "detail": "を入力してください"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array"
    }
  }
}

Get Calendars
GET/calendars

複数のカレンダーを取得します。
クエリパラメータを指定することで、取得するカレンダーを絞り込んだりレスポンスの出力内容をフィルタリングすることができます。

指定可能なクエリパラメータ

名前 説明 指定例
name ラベル名 (完全一致) を指定します /calendars?name=ExampleLabel
date 日付リスト内の日付を指定します /calendars?date=2019-01-01
group_id グループIDを指定します /calendars?group_id=100
fields レスポンスに含めるフィールドを指定します /calendars?fields=name,group_id

Example URI

GET https://manager.cloudautomator.com/api/v1/calendars
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": "'1'",
      "type": "Calendar",
      "attributes": {
        "name": "カレンダー",
        "group_id": 1,
        "dates": [
          "[\"2020-01-01\"]"
        ]
      }
    }
  ],
  "links": {
    "self": "https://manager.cloudautomator.com/api/v1/calendars?page%5Bnumber%5D=1&page%5Bsize%5D=5",
    "first": "https://manager.cloudautomator.com/api/v1/calendars?page%5Bnumber%5D=1&page%5Bsize%5D=5",
    "prev": "https://manager.cloudautomator.com/api/v1/calendars?page%5Bnumber%5D=1&page%5Bsize%5D=5",
    "next": "https://manager.cloudautomator.com/api/v1/calendars?page%5Bnumber%5D=2&page%5Bsize%5D=5",
    "last": "https://manager.cloudautomator.com/api/v1/calendars?page%5Bnumber%5D=3&page%5Bsize%5D=5"
  },
  "meta": {
    "total": 12
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "description": "カレンダーの配列"
    },
    "links": {
      "type": "object",
      "properties": {
        "self": {
          "type": "string",
          "description": "現在のページを指すURL"
        },
        "first": {
          "type": "string",
          "description": "最初のページを指すURL"
        },
        "prev": {
          "type": [
            "string",
            "null"
          ],
          "description": "前のページを指すURL"
        },
        "next": {
          "type": [
            "string",
            "null"
          ],
          "description": "次のページを指すURL"
        },
        "last": {
          "type": "string",
          "description": "最後のページを指すURL"
        }
      },
      "description": "ページネーションリンク"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "カレンダーの総数"
        }
      }
    }
  }
}

Get Calendar
GET/calendars/{id}

1件のカレンダーを取得します。

Example URI

GET https://manager.cloudautomator.com/api/v1/calendars/1
URI Parameters
HideShow
id
number (required) Example: 1

カレンダーID

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": "'1'",
    "type": "Calendar",
    "attributes": {
      "name": "カレンダー",
      "group_id": 1,
      "dates": [
        "[\"2020-01-01\"]"
      ]
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "カレンダーID"
        },
        "type": {
          "type": "string",
          "description": "データ型"
        },
        "attributes": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "カレンダー名"
            },
            "group_id": {
              "type": "number",
              "description": "グループID"
            },
            "dates": {
              "type": "array"
            }
          }
        }
      },
      "description": "カレンダー"
    }
  }
}

Edit Calendar
PATCH/calendars/{id}

カレンダーの情報を更新します。

リクエストボディに含めるパラメーター

名前 型 必須かどうか 説明
name string optional カレンダーの名前
group_id number required カレンダーを所属させるグループのID
dates array[string] required カレンダーで管理する YYYY-MM-DD 形式の日付の配列
例) [“2020-01-01”, “2020-01-02”, “2020-01-03”]

Example URI

PATCH https://manager.cloudautomator.com/api/v1/calendars/1
URI Parameters
HideShow
id
number (required) Example: 1

カレンダーID

Request  サンプルリクエスト
HideShow
Headers
Content-Type: application/json
Body
{
  "dates": [
    "[\"2020-01-01\"]"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "dates": {
      "type": "array"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": "1",
    "type": "trigger_jobs",
    "attributes": {
      "name": "毎週月曜の9時にAMIを作成",
      "aws_account_id": 1,
      "aws_account_ids": [
        "[1, 2, 3]"
      ],
      "google_cloud_account_id": "null",
      "provider_type": "aws",
      "group_id": 1,
      "for_workflow": false,
      "rule_type": "cron",
      "effective_date": "2016-10-01",
      "expiration_date": "2017-12-31",
      "rule_value": {
        "hour": 9,
        "minutes": 0,
        "national_holiday_schedule": "true",
        "schedule_type": "weekly",
        "time_zone": "Tokyo",
        "weekly_schedule": [
          "monday"
        ],
        "dates_to_skip": [
          "2021-01-13"
        ]
      },
      "action_type": "create_image",
      "action_value": {
        "region": "ap-northeast-1",
        "instance_id": "i-00000001",
        "generation": 1,
        "image_name": "TestAMI",
        "trace_status": "true",
        "reboot_instance": "true",
        "specify_image_instance": "identifier",
        "add_same_tag_to_snapshot": "false",
        "recreate_image_if_ami_status_failed": "false"
      },
      "active": true,
      "allow_runtime_action_values": false,
      "completed_post_process_id": [
        1
      ],
      "failed_post_process_id": [
        2
      ],
      "created_at": "2016-10-13 22:45:45 +0900",
      "updated_at": "2016-10-13 22:45:45 +0900"
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "ジョブID"
        },
        "type": {
          "type": "string",
          "description": "データ型"
        },
        "attributes": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "ジョブ名"
            },
            "aws_account_id": {
              "type": [
                "number",
                "null"
              ],
              "description": "AWSアカウントID (bulk_stop_instancesアクション以外の場合)"
            },
            "aws_account_ids": {
              "type": "array",
              "description": "AWSアカウントID (bulk_stop_instancesアクションの場合のみ)"
            },
            "google_cloud_account_id": {
              "type": [
                "string",
                "null"
              ],
              "description": "Google CloudアカウントID (bulk_stop_instancesアクション以外の場合)"
            },
            "provider_type": {
              "type": "string",
              "enum": [
                "aws",
                "google_cloud",
                "no"
              ],
              "description": "プロバイダの種類"
            },
            "group_id": {
              "type": "number",
              "description": "グループID"
            },
            "for_workflow": {
              "type": "boolean",
              "description": "ジョブワークフロー専用ジョブにするかどうか"
            },
            "rule_type": {
              "type": "string",
              "description": "トリガータイプ"
            },
            "effective_date": {
              "type": "string",
              "description": "有効期間の開始日"
            },
            "expiration_date": {
              "type": "string",
              "description": "有効期間の終了日"
            },
            "rule_value": {
              "type": "object",
              "properties": {
                "hour": {
                  "type": "number",
                  "description": "時"
                },
                "minutes": {
                  "type": "number",
                  "description": "分"
                },
                "national_holiday_schedule": {
                  "type": "string",
                  "description": "ジョブの実行日と日本の祝日が重なっていた場合に実行をスキップするか否か"
                },
                "schedule_type": {
                  "type": "string",
                  "description": "スケジュールタイプ"
                },
                "time_zone": {
                  "type": "string",
                  "description": "タイムゾーンを表す文字列"
                },
                "weekly_schedule": {
                  "type": "array"
                },
                "dates_to_skip": {
                  "type": "array"
                }
              }
            },
            "action_type": {
              "type": "string",
              "description": "アクションタイプ"
            },
            "action_value": {
              "type": "object",
              "properties": {
                "region": {
                  "type": "string"
                },
                "instance_id": {
                  "type": "string"
                },
                "generation": {
                  "type": "number"
                },
                "image_name": {
                  "type": "string"
                },
                "trace_status": {
                  "type": "string"
                },
                "reboot_instance": {
                  "type": "string"
                },
                "specify_image_instance": {
                  "type": "string"
                },
                "add_same_tag_to_snapshot": {
                  "type": "string"
                },
                "recreate_image_if_ami_status_failed": {
                  "type": "string"
                }
              }
            },
            "active": {
              "type": "boolean",
              "description": "ジョブがアクティブかどうか"
            },
            "allow_runtime_action_values": {
              "type": "boolean",
              "description": "アクションの設定値を実行時に指定するかどうか。ジョブが実行時の指定に対応していない場合はプロパティ自体が存在しません。"
            },
            "completed_post_process_id": {
              "type": "array",
              "description": "ジョブが成功した場合に実行する後処理IDの配列"
            },
            "failed_post_process_id": {
              "type": "array",
              "description": "ジョブが失敗した場合に実行する後処理IDの配列"
            },
            "created_at": {
              "type": "string",
              "description": "ジョブの作成日時"
            },
            "updated_at": {
              "type": "string",
              "description": "ジョブの更新日時"
            }
          }
        }
      },
      "description": "更新後のカレンダー"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "source": {
        "pointer": "/data/attributes/name"
      },
      "detail": "を入力してください"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array"
    }
  }
}

Delete Calendar
DELETE/calendars/{id}

カレンダーを削除します。

削除に成功した場合はステータスコード204 No Contentを返し、レスポンスボディは返しません。

Example URI

DELETE https://manager.cloudautomator.com/api/v1/calendars/1
URI Parameters
HideShow
id
number (required) Example: 1

カレンダーID

Response  204
HideShow
Headers
Content-Type: application/json

Generated by aglio on 22 Feb 2024