@itentialopensource/adapter-aws_ec2

{ "$id": "schema.json", "type": "object", "schema": "http://json-schema.org/draft-07/schema#", "translate": true, "dynamicfields": true, "properties": { "ph_request_type": { "type": "string", "description": "type of request (internal to adapter)", "default": "describeImages", "enum": [ "describeImages", "describeImageAttribute", "describeImportImageTasks", "createImage", "copyImage", "registerImage", "deregisterImage", "modifyImageAttribute", "importImage", "resetImageAttribute", "describeFpgaImages", "describeFpgaImageAttribute", "createFpgaImage", "copyFpgaImage", "modifyFpgaImageAttribute", "resetFpgaImageAttribute", "deleteFpgaImage" ], "external_name": "ph_request_type" }, "imageId": { "description": "The ID of the AMI.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "ImageId" }, "dryRun": { "description": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "DryRun" }, "action": { "description": "", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "Action" }, "version": { "description": "", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "Version" }, "attribute": { "description": "The name of the attribute to modify. The valid values are description , launchPermission , and productCodes .", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "Attribute" }, "descriptionValue": { "description": "Describes a value for a resource attribute that is a String.\nThe attribute value. The value is case-sensitive.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "Description.Value" }, "launchPermissionAdd": { "description": "Describes a launch permission modification.\nThe AWS account ID to add to the list of launch permissions for the AMI.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "LaunchPermission.Add" }, "launchPermissionRemove": { "description": "Describes a launch permission modification.\nThe AWS account ID to remove from the list of launch permissions for the AMI.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "LaunchPermission.Remove" }, "operationType": { "description": "The operation type. This parameter can be used only when the Attribute parameter is launchPermission .", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "OperationType" }, "productCode": { "description": "The DevPay product codes. After you add a product code to an AMI, it can't be removed.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "ProductCode" }, "userGroup": { "description": "The user groups. This parameter can be used only when the Attribute parameter is launchPermission .", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "UserGroup" }, "userId": { "description": "The AWS account IDs. This parameter can be used only when the Attribute parameter is launchPermission .", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "UserId" }, "value": { "description": "The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description or productCodes .", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "Value" }, "imageLocation": { "description": "The full path to your AMI manifest in Amazon S3 storage.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "ImageLocation" }, "architecture": { "description": "The architecture of the AMI. Default: For Amazon EBS-backed AMIs, i386 . For instance store-backed AMIs, the architecture specified in the manifest file.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "Architecture" }, "blockDeviceMapping": { "description": "The block device mapping entries.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "BlockDeviceMapping" }, "description": { "description": "A description for your AMI.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "Description" }, "enaSupport": { "description": "Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI. This option is supported only for HVM AMIs. Specifying...(description truncated)", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "EnaSupport" }, "kernelId": { "description": "The ID of the kernel.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "KernelId" }, "name": { "description": "A name for your AMI. Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (), dashes (-), single quote...(description truncated)", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "Name" }, "billingProduct": { "description": "The billing product codes. Your account must be authorized to specify billing product codes. Otherwise, you can use the AWS Marketplace to bill for the use of an AMI.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "BillingProduct" }, "ramdiskId": { "description": "The ID of the RAM disk.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "RamdiskId" }, "rootDeviceName": { "description": "The device name of the root device volume (for example, devsda1 ).", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "RootDeviceName" }, "sriovNetSupport": { "description": "Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI. There is no w...(description truncated)", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "SriovNetSupport" }, "virtualizationType": { "description": "The type of virtualization ( hvm | paravirtual ). Default: paravirtual", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "VirtualizationType" }, "fpgaImageId": { "description": "The ID of the AFI.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "FpgaImageId" }, "executableBy": { "description": "Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "ExecutableBy" }, "owner": { "description": "Filters the images by the owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketpla...(description truncated)", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "Owner" }, "importTaskId": { "description": "A list of import image task IDs.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "ImportTaskId" }, "maxResults": { "description": "The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "MaxResults" }, "nextToken": { "description": "A token that indicates the next page of results.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "NextToken" }, "clientDataComment": { "description": "Describes the client-specific data.\nA user-defined comment about the disk upload.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "ClientData.Comment" }, "clientDataUploadEnd": { "description": "Describes the client-specific data.\nThe time that the disk upload ends.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "ClientData.UploadEnd" }, "clientDataUploadSize": { "description": "Describes the client-specific data.\nThe size of the uploaded disk image, in GiB.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "ClientData.UploadSize" }, "clientDataUploadStart": { "description": "Describes the client-specific data.\nThe time that the disk upload starts.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "ClientData.UploadStart" }, "clientToken": { "description": "The token to enable idempotency for VM import requests.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "ClientToken" }, "diskContainer": { "description": "Information about the disk containers.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "DiskContainer" }, "encrypted": { "description": "Specifies whether the destination AMI of the imported image should be encrypted. The default CMK for EBS is used unless you specify a non-default AWS Key Management Servi...(description truncated)", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "Encrypted" }, "hypervisor": { "description": "The target hypervisor platform. Valid values: xen", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "Hypervisor" }, "kmsKeyId": { "description": "An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted AMI. This parameter is only required if you want ...(description truncated)", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "KmsKeyId" }, "licenseType": { "description": "The license type to be used for the Amazon Machine Image (AMI) after importing. Note: You may only use BYOL if you have existing licenses with rights to use these l...(description truncated)", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "LicenseType" }, "platform": { "description": "The operating system of the virtual machine. Valid values: Windows | Linux", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "Platform" }, "roleName": { "description": "The name of the role to use when not using the default role, 'vmimport'.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "RoleName" }, "loadPermissionAdd": { "description": "Describes modifications to the load permissions of an Amazon FPGA image (AFI).\nThe load permissions to add.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "LoadPermission.Add" }, "loadPermissionRemove": { "description": "Describes modifications to the load permissions of an Amazon FPGA image (AFI).\nThe load permissions to remove.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "LoadPermission.Remove" }, "inputStorageLocationBucket": { "description": "Describes a storage location in Amazon S3.\nThe name of the S3 bucket.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "InputStorageLocation.Bucket" }, "inputStorageLocationKey": { "description": "Describes a storage location in Amazon S3.\nThe key.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "InputStorageLocation.Key" }, "logsStorageLocationBucket": { "description": "Describes a storage location in Amazon S3.\nThe name of the S3 bucket.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "LogsStorageLocation.Bucket" }, "logsStorageLocationKey": { "description": "Describes a storage location in Amazon S3.\nThe key.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "LogsStorageLocation.Key" }, "instanceId": { "description": "The ID of the instance.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "InstanceId" }, "noReboot": { "description": "By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the 'No Reboot' option is set, Amazon EC2 doesn't shut down the instanc...(description truncated)", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "NoReboot" }, "sourceFpgaImageId": { "description": "The ID of the source AFI.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "SourceFpgaImageId" }, "sourceRegion": { "description": "The Region that contains the source AFI.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "SourceRegion" }, "sourceImageId": { "description": "The ID of the AMI to copy.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "SourceImageId" }, "filter": { "description": "The filters. architecture - The image architecture ( i386 | x86_64 ). block-device-mapping.delete-on-termination - A Boolean value that indicates whe...(description truncated)", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "Filter" }, "filters": { "description": "Filter tasks using the task-state filter and one of the following values: active, completed, deleting, deleted.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "Filters" }, "bodyFormData": { "description": "", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "body" } }, "definitions": {} }