AWS API

zCompute provides compatibility with the following tables of APIs that list the required, optional, ignored and unsupported parameters.

Important

Although zCompute ignores the region parameter, a valid AWS region is a required parameter. Some tools can fail or return errors without the region parameter.

The following Terraform snippet demonstrates an example definition of a required valid AWS region that is ignored by zCompute:

provider "aws" {
    access_key = var.access_key
    secret_key = var.secret_key
    # shared_credentials = var.credentials_file
    version = "=3.0.0"
    endpoints {
        elb = "https://${var.zCompute_ip}/api/v2/aws/elb"
        ec2 = "https://${var.zCompute_ip}/api/v2/aws/ec2"
    }

    insecure                    = true
    skip_metadata_api_check     = true
    skip_credentials_validation = true
    skip_requesting_account_id  = true

    # Required valid AWS region, currently ignored by zCompute
    region = "us-east-2"
}

AWS EC2

AWS API Reference

Ignored Param

Optional Parameters

Required Parameters

Unsupported Params

AllocateAddress

[]

Address

[]

[]

AssociateAddress

[]

InstanceId NetworkInterfaceId PrivateIpAddress

AllocationId

[]

AssociateIamInstanceProfile

[]

[]

IamInstanceProfile InstanceId

[]

AuthorizeSecurityGroupIngress

[]

GroupId GroupName IpPermissions CidrIp FromPort IpProtocol ToPort SourceSecurityGroupName

[]

[]

CreateImage

[]

Description BlockDeviceMapping NoReboot

InstanceId Name

[]

CreateKeyPair

[]

[]

KeyName

[]

CreateSecurityGroup

[]

[]

GroupDescription GroupName VpcId

[]

CreateTags

[]

[]

ResourceId Tag

[]

DeleteKeyPair

[]

[]

KeyName

[]

DeleteSecurityGroup

[]

GroupId GroupName

[]

[]

DeleteTags

[]

[]

ResourceId Tag

[]

DeregisterImage

[]

[]

ImageId

[]

DescribeAccountAttributes

[]

AttributeName

[]

[]

DescribeAddresses

[]

AllocationId PublicIp Filter

[]

[]

DescribeAvailabilityZones

[]

[]

[]

[]

DescribeIamInstanceProfileAssociations

[]

AssociationIds

[]

[]

DescribeImageAttribute

[]

[]

ImageId Attribute

[]

DescribeImages

[]

ExecutableBy Filter ImageId Owner

[]

[]

DescribeInstanceAttribute

[]

[]

InstanceId Attribute

[]

DescribeInstanceCreditSpecifications

[]

[]

InstanceId

[]

DescribeInstances

[]

InstanceId Filter MaxResults NextToken

[]

[]

DescribeKeyPairs

[]

KeyName Filter

[]

[]

DescribeRegions

[]

[]

[]

[]

DescribeSecurityGroups

[]

GroupId GroupName Filter

[]

[]

DescribeSpotInstanceRequests

[]

[]

[]

[]

DescribeTags

[]

Filter MaxResults NextToken

[]

[]

DisassociateAddress

[]

[]

AssociationId

[]

DisassociateIamInstanceProfile

[]

[]

AssociationId

[]

GetConsoleOutput

[]

[]

InstanceId

[]

GetPasswordData

[]

[]

InstanceId

[]

ImportKeyPair

[]

[]

KeyName PublicKeyMaterial

[]

ModifyImageAttribute

[]

Attribute Description LaunchPermission OperationType ProductCode UserGroup UserId Value

ImageId

[]

ModifyInstanceAttribute

[]

Attribute Value InstanceType DisableApiTermination SourceDestCheck GroupId Kernel Ramdisk InstanceInitiatedShutdownBehavior RootDeviceName ProductCodes EbsOptimized SriovNetSupport EnaSupport UserData BlockDeviceMapping

InstanceId

[]

RebootInstances

[]

[]

InstanceId

[]

RegisterImage

[]

Architecture BillingProduct BlockDeviceMapping Description EnaSupport ImageLocation KernelId RamdiskId RootDeviceName SriovNetSupport VirtualizationType

Name

[]

ReleaseAddress

[]

[]

AllocationId

[]

ResetImageAttribute

[]

LaunchPermission

ImageId

[]

ResetInstanceAttribute

[]

[]

InstanceId Attribute

[]

RunInstances

[]

InstanceType KeyName NetworkInterface PrivateIpAddress SecurityGroup SecurityGroupId SubnetId TagSpecification UserData EbsOptimized BlockDeviceMapping DisableApiTermination Monitoring Placement IamInstanceProfile

MinCount MaxCount ImageId

[]

StartInstances

[]

[]

InstanceId

[]

StopInstances

[]

Force

InstanceId

[]

TerminateInstances

[]

[]

InstanceId

[]

AWS-Import/Export VMs

AWS API Reference

Ignored Param

Optional Parameters

Required Parameters

Unsupported Params

DescribeImportImageTasks

[]

Filters ImportTaskId MaxResults NextToken

[]

[]

ImportImage

[]

Architecture ClientData ClientToken Description DiskContainer Hypervisor LicenseType Platform RoleName

[]

[]

AWS-EC2-AutoScalingGroups

AWS API Reference

Ignored Param

Optional Parameters

Required Parameters

Unsupported Params

AttachInstances

[]

[]

AutoScalingGroupName InstanceIds

[]

AttachLoadBalancerTargetGroups

[]

[]

AutoScalingGroupName TargetGroupARNs

[]

CreateAutoScalingGroup

[]

AvailabilityZones DefaultCooldown DesiredCapacity HealthCheckGracePeriod HealthCheckType NewInstancesProtectedFromScaleIn ServiceLinkedRoleARN Tags TargetGroupARNs TerminationPolicies VPCZoneIdentifier

AutoScalingGroupName LaunchConfigurationName MaxSize MinSize

InstanceId LaunchTemplate LifecycleHookSpecificationList LoadBalancerNames PlacementGroup

CreateLaunchConfiguration

RamdiskId InstanceMonitoring EbsOptimized AssociatePublicIpAddress PlacementTenancy

KeyName InstanceType SecurityGroups UserData BlockDeviceMappings RamdiskId InstanceMonitoring EbsOptimized AssociatePublicIpAddress PlacementTenancy

LaunchConfigurationName ImageId

InstanceId ClassicLinkVPCId ClassicLinkVPCSecurityGroups IamInstanceProfile KernelId SpotPrice

CreateOrUpdateTags

[]

Tags

[]

[]

DeleteAutoScalingGroup

[]

ForceDelete

AutoScalingGroupName

[]

DeleteLaunchConfiguration

[]

[]

LaunchConfigurationName

[]

DeletePolicy

[]

[]

PolicyName AutoScalingGroupName

[]

DeleteScheduledAction

[]

[]

AutoScalingGroupName ScheduledActionName

[]

DeleteTags

[]

Tags

[]

[]

DescribeAutoScalingGroups

[]

AutoScalingGroupNames

[]

MaxRecords NextToken

DescribeLaunchConfigurations

[]

LaunchConfigurationNames

[]

[]

DescribePolicies

[]

AutoScalingGroupName PolicyNames PolicyTypes

[]

[]

DescribeScalingActivities

ActivityIds AutoScalingGroupName MaxRecords NextToken

ActivityIds AutoScalingGroupName MaxRecords NextToken

[]

[]

DescribeScheduledActions

[]

AutoScalingGroupName EndTime StartTime ScheduledActionNames

[]

MaxRecords NextToken

DescribeTags

[]

Filters

[]

MaxRecords NextToken

DetachInstances

[]

[]

AutoScalingGroupName InstanceIds ShouldDecrementDesiredCapacity

[]

DetachLoadBalancerTargetGroups

[]

[]

AutoScalingGroupName TargetGroupARNs

[]

EnterStandby

[]

[]

AutoScalingGroupName InstanceIds ShouldDecrementDesiredCapacity

[]

ExitStandby

[]

[]

AutoScalingGroupName InstanceIds

[]

PutScalingPolicy

[]

PolicyType EstimatedInstanceWarmup TargetTrackingConfiguration

PolicyName AutoScalingGroupName

AdjustmentType Cooldown MetricAggregationType MinAdjustmentMagnitude MinAdjustmentStep ScalingAdjustment StepAdjustments

PutScheduledUpdateGroupAction

Time

DesiredCapacity EndTime MaxSize MinSize Recurrence StartTime Time

AutoScalingGroupName ScheduledActionName

[]

UpdateAutoScalingGroup

[]

AvailabilityZones DefaultCooldown DesiredCapacity HealthCheckGracePeriod HealthCheckType LaunchConfigurationName MaxSize MinSize NewInstancesProtectedFromScaleIn ServiceLinkedRoleARN TerminationPolicies VPCZoneIdentifier

AutoScalingGroupName

LaunchTemplate PlacementGroup

AWS-EBS

AWS API Reference

Ignored Param

Optional Parameters

Required Parameters

Unsupported Params

AttachVolume

[]

[]

Device InstanceId VolumeId

[]

CreateSnapshot

[]

Description TagSpecification

VolumeId

[]

CreateVolume

[]

Size SnapshotId TagSpecification VolumeType

AvailabilityZone

[]

DeleteSnapshot

[]

[]

SnapshotId

[]

DeleteVolume

[]

[]

VolumeId

[]

DescribeSnapshots

[]

SnapshotId Owner Filter MaxResults

[]

[]

DescribeVolumes

[]

VolumeId Filter MaxResults

[]

[]

DetachVolume

[]

Device InstanceId Force

VolumeId

[]

ModifyVolume

[]

Iops Size VolumeType

VolumeId

[]

AWS-SNS

AWS API Reference

Ignored Param

Optional Parameters

Required Parameters

Unsupported Params

CreateTopic

[]

[]

Name

[]

DeleteTopic

[]

[]

TopicArn

[]

GetTopicAttributes

[]

[]

TopicArn

[]

ListSubscriptions

[]

NextToken

[]

[]

ListTagsForResource

[]

[]

ResourceArn

[]

ListTopics

[]

NextToken

[]

[]

Publish

[]

MessageAttributes MessageStructure PhoneNumber Subject TargetArn TopicArn

Message

[]

SetTopicAttributes

[]

[]

TopicArn

[]

Subscribe

[]

Attributes Endpoint Protocol ReturnSubscriptionArn

TopicArn Protocol

[]

Unsubscribe

[]

SubscriptionArn

[]

AWS-CloudWatch

AWS API Reference

Ignored Param

Optional Parameters

Required Parameters

Unsupported Params

DeleteAlarms

[]

[]

AlarmNames

[]

DescribeAlarmHistory

[]

AlarmName EndDate HistoryItemType MaxRecords NextToken StartDate

[]

[]

DescribeAlarms

[]

ActionPrefix AlarmNamePrefix AlarmNames MaxRecords NextToken StateValue

[]

[]

DisableAlarmActions

[]

[]

AlarmNames

[]

EnableAlarmActions

[]

[]

AlarmNames

[]

ListMetrics

[]

MetricName Namespace

[]

[]

ListTagsForResource

[]

[]

ResourceARN

[]

PutMetricAlarm

[]

ActionsEnabled AlarmActions AlarmDescription DatapointsToAlarm Dimensions EvaluateLowSampleCountPercentile ExtendedStatistic InsufficientDataActions OKActions Statistic TreatMissingData Unit

AlarmName ComparisonOperator EvaluationPeriods MetricName Namespace Period Threshold

[]

SetAlarmState

[]

StateReasonData

AlarmName StateReason StateValue

[]