add API reference documentation

add documentation for further publishing to OpenStack API Documentation

Change-Id: I5052c101db4763f77f186ee39bc4167409b72aa1
This commit is contained in:
tikitavi 2016-12-15 13:11:03 +03:00
parent e6594f491e
commit 4bbd243f47
5 changed files with 756 additions and 0 deletions

232
api-ref/source/conf.py Normal file
View File

@ -0,0 +1,232 @@
# -*- coding: utf-8 -*-
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
#
# nova documentation build configuration file, created by
# sphinx-quickstart on Sat May 1 15:17:47 2010.
#
# This file is execfile()d with the current directory set to
# its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import os
import subprocess
import sys
import warnings
import openstackdocstheme
extensions = [
'os_api_ref',
]
html_theme = 'openstackdocs'
html_theme_path = [openstackdocstheme.get_html_theme_path()]
html_theme_options = {
"sidebar_mode": "toc",
}
html_context = {'bug_project': 'ec2-api', 'bug_tag': 'api-ref'}
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.insert(0, os.path.abspath('../../'))
sys.path.insert(0, os.path.abspath('../'))
sys.path.insert(0, os.path.abspath('./'))
# -- General configuration ----------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#
# source_encoding = 'utf-8'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'EC2 API Reference'
copyright = u'OpenStack Foundation'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# from ec2-api.version import version_info
# The full version, including alpha/beta/rc tags.
# release = version_info.release_string()
# The short X.Y version.
# version = version_info.version_string()
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
# today = ''
# Else, today_fmt is used as the format for a strftime call.
# today_fmt = '%B %d, %Y'
# The reST default role (used for this markup: `text`) to use
# for all documents.
# default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
# add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
add_module_names = False
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# -- Options for man page output ----------------------------------------------
# Grouping the document tree for man pages.
# List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual'
# -- Options for HTML output --------------------------------------------------
# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
# html_theme_path = ["."]
# html_theme = '_theme'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
# html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
# html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
# html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
# html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
# html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
# html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
# html_last_updated_fmt = '%b %d, %Y'
git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local",
"-n1"]
try:
html_last_updated_fmt = subprocess.Popen(
git_cmd, stdout=subprocess.PIPE).communicate()[0].decode()
except Exception:
warnings.warn('Cannot get last updated time from git repository. '
'Not setting "html_last_updated_fmt".')
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
# html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
# html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
# html_additional_pages = {}
# If false, no module index is generated.
# html_use_modindex = True
# If false, no index is generated.
# html_use_index = True
# If true, the index is split into individual pages for each letter.
# html_split_index = False
# If true, links to the reST sources are added to the pages.
# html_show_sourcelink = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
# html_use_opensearch = ''
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
# html_file_suffix = ''
# Output file base name for HTML help builder.
htmlhelp_basename = 'ec2apidoc'
# -- Options for LaTeX output -------------------------------------------------
# The paper size ('letter' or 'a4').
# latex_paper_size = 'letter'
# The font size ('10pt', '11pt' or '12pt').
# latex_font_size = '10pt'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass
# [howto/manual]).
latex_documents = [
('index', 'Ec2api.tex', u'OpenStack EC2 API Documentation',
u'OpenStack Foundation', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
# latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
# latex_use_parts = False
# Additional stuff for the LaTeX preamble.
# latex_preamble = ''
# Documents to append as an appendix to all manuals.
# latex_appendices = []
# If false, no module index is generated.
# latex_use_modindex = True

13
api-ref/source/index.rst Normal file
View File

@ -0,0 +1,13 @@
:tocdepth: 2
========
EC2 API
========
Provides a standalone EC2 API service.
Amazon EC2 API Reference can be found `here
<http://docs.aws.amazon.com/AWSEC2/latest/APIReference/Welcome.html>`_.
.. include:: supported_features.inc

View File

@ -0,0 +1,503 @@
.. -*- rst -*-
Supported features and limitations
----------------------------------
General:
* DryRun option is not supported.
* Some exceptions are not exactly the same as reported by AWS.
+----------+------------------------------------------+-----------------+----------------------------------------+
| AWS | Command | Functionality | Limitations |
| Component| | group | |
+==========+==========================================+=================+========================================+
| | **bold** - supported, normal - supported | | |
| | with limitations, *italic* -not supported| | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *AcceptVpcPeeringConnection* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, VPC | **AllocateAddress** | addresses | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *AllocateHosts* | dedicated hosts | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *AssignIpv6Addresses* | network | not supported |
| | | interfaces | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | AssignPrivateIpAddresses | network | allowReassignment parameter |
| | | interfaces | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, VPC | **AssociateAddress** | addresses | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **AssociateDhcpOptions** | DHCP options | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **AssociateRouteTable** | routes | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *AssociateSubnetCidrBlock* | subnets | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *AssociateVpcCidrBlock* | VPC | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *AttachClassicLinkVpc* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **AttachInternetGateway** | internet | |
| | | gateways | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **AttachNetworkInterface** | network | |
| | | interfaces | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, EBS | **AttachVolume** | volumes | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **AttachVpnGateway** | VPN | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, VPC | AuthorizeSecurityGroupEgress | security groups | EC2 classic way to pass cidr, protocol,|
| | | | sourceGroup, ports parameters |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, VPC | AuthorizeSecurityGroupIngress | security groups | EC2 classic way to pass cidr, protocol,|
| | | | sourceGroup, ports parameters |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *BundleInstance* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CancelBundleTask* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CancelConversionTask* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CancelExportTask* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CancelImportTask* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CancelReservedInstancesListing* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CancelSpotFleetRequests* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CancelSpotInstanceRequests* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *ConfirmProductInstance* | product codes | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | *CopyImage* | image | not supported |
| | | provisioning | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | *CopySnapshot* | snapshots,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | CreateCustomerGateway | VPC gateways | BGP dynamic routing |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **CreateDhcpOptions** | DHCP options | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CreateEgressOnlyInternetGateway* | VPC gateways | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CreateFlowLogs* | infrastructural | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | CreateImage | images | blockDeviceMapping parameter |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CreateInstanceExportTask* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **CreateInternetGateway** | VPC gateways | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | **CreateKeyPair** | key pairs | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CreateNatGateway* | NAT gateways | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *CreateNetworkAcl* | ACL | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *CreateNetworkAclEntry* | ACL | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **CreateNetworkInterface** | network | |
| | | interfaces | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CreatePlacementGroup* | clusters | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CreateReservedInstancesListing* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | CreateRoute | routes | vpcPeeringConnection parameter |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **CreateRouteTable** | routes | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, VPC | **CreateSecurityGroup** | security groups | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | **CreateSnapshot** | snapshots | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CreateSpotDatafeedSubscription* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | CreateSubnet | subnets | availabilityZone parameter |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | **CreateTags** | tags | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | CreateVolume | volumes | iops, encrypted, kmsKeyId parameters |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **CreateVpc** | VPC | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *CreateVpcEndpoint* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *CreateVpcPeeringConnection* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | CreateVpnConnection | VPN | BGP dynamic routing |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **CreateVpnConnectionRoute** | VPN | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | CreateVpnGateway | VPN | BGP dynamic routing |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DeleteCustomerGateway** | VPC gateways | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DeleteDhcpOptions** | DHCP options | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DeleteEgressOnlyInternetGateway* | VPC gateways | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DeleteFlowLogs* | infrastructural | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DeleteInternetGateway** | VPC gateways | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | **DeleteKeyPair** | key pairs | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DeleteNatGateway* | NAT gateways | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DeleteNetworkAcl* | ACL | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DeleteNetworkAclEntry* | ACL | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DeleteNetworkInterface** | network | |
| | | interfaces | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | *DeletePlacementGroup* | clusters | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DeleteRoute** | routes | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DeleteRouteTable** | routes | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, VPC | **DeleteSecurityGroup** | security groups | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | **DeleteSnapshot** | snapshots | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DeleteSpotDatafeedSubscription* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DeleteSubnet** | subnets | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | **DeleteTags** | tags | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | **DeleteVolume** | volumes | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DeleteVpc** | VPC | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DeleteVpcEndpoints* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DeleteVpcPeeringConnection* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DeleteVpnConnection** | VPN | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DeleteVpnConnectionRoute** | VPN | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DeleteVpnGateway** | VPN | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | **DeregisterImage** | images | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | DescribeAccountAttributes | infrastructural | vpc-max-security-groups-per-interface, |
| | | | max-elastic-ips, |
| | | | vpc-max-elastic-ips attributes |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, VPC | **DescribeAddresses** | addresses | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | **DescribeAvailabilityZones** | availability | |
| | | zones | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeBundleTasks* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DescribeClassicLinkInstances* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeConversionTasks* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DescribeCustomerGateways** | gateways | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DescribeDhcpOptions** | DHCP options | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeEgressOnlyInternetGateways* | VPC gateways | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeExportTasks* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeFlowLogs* | infrastructural | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeHosts* | dedicated hosts | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeIdentityIdFormat* | resource IDs | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeIdFormat* | resource IDs | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | DescribeImageAttribute | images | productCodes, sriovNetSupport |
| | | | attributes |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | **DescribeImages** | images | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeImportImageTasks* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeImportSnapshotTasks* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | DescribeInstanceAttribute | instances | same limitations as for |
| | | | ModifyInstanceAttribute |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, | **DescribeInstances** | instances | |
| EBS, VPC | | | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeInstanceStatus* | monitoring | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DescribeInternetGateways** | gateways | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | **DescribeKeyPairs** | key pairs | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DescribeMovingAddresses* | infrastructural | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeNatGateways* | NAT gateways | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DescribeNetworkAcls* | ACL | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DescribeNetworkInterfaceAttribute** | network | |
| | | interfaces | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DescribeNetworkInterfaces** | network | |
| | | interfaces | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | *DescribePlacementGroups* | clusters | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DescribePrefixLists* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | DescribeRegions | availability | RegionNameparameter |
| | | zones | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeReservedInstances* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeReservedInstancesListings* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeReservedInstancesModifications* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeReservedInstancesOfferings* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DescribeRouteTables** | routes | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeScheduledInstanceAvailability* | scheduled | not supported |
| | | instances | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeScheduledInstances* | scheduled | not supported |
| | | instances | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeSecurityGroupReferences* | security groups | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, VPC | DescribeSecurityGroups | security groups | cidr, protocol, port, sourceGroup |
| | | | parameters |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | *DescribeSnapshotAttribute* | snapshots | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | **DescribeSnapshots** | snapshots | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeSpotDatafeedSubscription* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeSpotFleetInstances* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeSpotFleetRequestHistory* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeSpotFleetRequests* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeSpotInstanceRequests* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeSpotPriceHistory* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeStaleSecurityGroups* | security groups | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DescribeSubnets** | subnets | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | **DescribeTags** | tags | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | *DescribeVolumeAttribute* | volumes | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | **DescribeVolumes** | volumes | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeVolumeStatus* | monitoring | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DescribeVpcAttribute* | VPC | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DescribeVpcClassicLink* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeVpcClassicLinkDnsSupport* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DescribeVpcEndpoints* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DescribeVpcEndpointServices* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DescribeVpcPeeringConnections* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DescribeVpcs** | VPC | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DescribeVpnConnections** | VPN | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DescribeVpnGateways** | VPN | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DetachClassicLinkVpc* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DetachInternetGateway** | VPC | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DetachNetworkInterface** | network | |
| | | interfaces | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, EBS | DetachVolume | volumes | instance_id, device, force parameters |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DetachVpnGateway** | VPN | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DisableVgwRoutePropagation** | VPN | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DisableVpcClassicLink* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DisableVpcClassicLinkDnsSupport* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, VPC | **DisassociateAddress** | addresses | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DisassociateRouteTable** | routes | |
| | *DisassociateSubnetCidrBlock* | subnets | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DisassociateVpcCidrBlock* | VPC | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **EnableVgwRoutePropagation** | VPN | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | *EnableVolumeIO* | monitoring | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *EnableVpcClassicLink* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *EnableVpcClassicLinkDnsSupport* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | **GetConsoleOutput** | instances | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *GetConsoleScreenshot* | instances | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | **GetPasswordData** | instances | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *ImportImage* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *ImportInstance* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | **ImportKeyPair** | keypairs | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *ImportSnapshot* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *ImportVolume* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *ModifyHosts* | dedicated hosts | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *ModifyIdentityIdFormat* | resource IDs | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *ModifyIdFormat* | resource IDs | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | ModifyImageAttribute | images | productCodes attribute |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | ModifyInstanceAttribute | instances | only disableApiTermination, |
| | | | sourceDestCheck,instanceType supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *ModifyInstancePlacement* | dedicated hosts | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **ModifyNetworkInterfaceAttribute** | network | |
| | | interfaces | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *ModifyReservedInstances* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | *ModifySnapshotAttribute* | snapshots | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *ModifySpotFleetRequest* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *ModifySubnetAttribute* | subnets | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | *ModifyVolumeAttribute* | volumes | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *ModifyVpcAttribute* | VPC | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *ModifyVpcEndpoint* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *ModifyVpcPeeringConnectionOptions* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *MonitorInstances* | monitoring | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *MoveAddressToVpc* | infrastructural | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *PurchaseReservedInstancesOffering* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *PurchaseScheduledInstances* | scheduled | not supported |
| | | instances | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | **RebootInstances** | instances | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | RegisterImage | images | virtualizationType, sriovNetSupport |
| | | | parameters |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *RejectVpcPeeringConnection* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, VPC | **ReleaseAddress** | addresses | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *ReleaseHosts* | dedicated hosts | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *ReplaceNetworkAclAssociation* | ACL | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *ReplaceNetworkAclEntry* | ACL | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **ReplaceRoute** | routes | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **ReplaceRouteTableAssociation** | routes | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *ReportInstanceStatus* | monitoring | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *RequestSpotFleet* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *RequestSpotInstances* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | **ResetImageAttribute** | images | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | ResetInstanceAttribute | instances | same limitations as for |
| | | | ModifyInstanceAttribute |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **ResetNetworkInterfaceAttribute** | network | |
| | | interfaces | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | *ResetSnapshotAttribute* | snapshots | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *RestoreAddressToClassic* | infrastructural | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, VPC | RevokeSecurityGroupEgress | security groups | EC2 classic way to pass cidr, protocol,|
| | | | sourceGroup, ports parameters |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, VPC | RevokeSecurityGroupIngress | security groups | EC2 classic way to pass cidr, protocol,|
| | | | sourceGroup, ports parameters |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, | RunInstances | instances | placement, block_device_mapping partial|
| VPC, EBS | | | support, monitoring, |
| | | | iamInstanceProfile, ebsOptimized, |
| | | | shutdownInitiatedInstanceBehavior |
| | | | parameters |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *RunScheduledInstances* | scheduled | not supported |
| | | instances | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | **StartInstances** | instances | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | **StopInstances** | instances | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | **TerminateInstances** | instances | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *UnassignIpv6Addresses* | network | not supported |
| | | interfaces | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **UnassignPrivateIpAddresses** | network | |
| | | interfaces | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *UnmonitorInstances* | monitoring | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+

View File

@ -13,3 +13,4 @@ sphinx!=1.3b1,<1.4,>=1.2.1 # BSD
testrepository>=0.0.18 # Apache-2.0/BSD
testtools>=1.4.0 # MIT
openstackdocstheme>=1.5.0 # Apache-2.0
os-api-ref>=1.0.0 # Apache-2.0

View File

@ -56,3 +56,10 @@ import_exceptions = ec2api.i18n
[testenv:install-guide]
commands = sphinx-build -a -E -W -d install-guide/build/doctrees -b html install-guide/source install-guide/build/html
[testenv:api-ref]
# This environment is called from CI scripts to test and publish
# the API Ref to developer.openstack.org.
commands =
rm -rf api-ref/build
sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html