From: Ricardo Wurmus Date: Fri, 28 Jun 2019 23:51:57 +0000 (+0200) Subject: Initial commit. X-Git-Url: https://git.elephly.net/?p=software%2Fguile-aws.git;a=commitdiff_plain;h=c9e1ea1d8cf2daab752b6073eeab5a328d7964ec Initial commit. --- c9e1ea1d8cf2daab752b6073eeab5a328d7964ec diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..bee3d6a --- /dev/null +++ b/.gitignore @@ -0,0 +1,11 @@ +Makefile +Makefile.in +autom4te.cache/ +build-aux/ +config.cache +config.log +config.status +configure +pre-inst-env +*.go +upstream-json-specs diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/Makefile.am b/Makefile.am new file mode 100644 index 0000000..a497b4d --- /dev/null +++ b/Makefile.am @@ -0,0 +1,41 @@ +GOBJECTS = $(GUILE_SOURCES:%.scm=%.go) $(JSON_SOURCES:.normal.json=.go) + +nobase_mod_DATA = $(SOURCES) $(NOCOMP_SOURCES) +nobase_go_DATA = $(GOBJECTS) + +# Make sure source files are installed first, so that the mtime of +# installed compiled files is greater than that of installed source +# files. See +# +# for details. +guile_install_go_files = install-nobase_goDATA +$(guile_install_go_files): install-nobase_modDATA + +CLEANFILES = $(GOBJECTS) +EXTRA_DIST = $(SOURCES) $(NOCOMP_SOURCES) +GUILE_WARNINGS = -Wunbound-variable -Warity-mismatch -Wformat +SUFFIXES = .scm .go +.scm.go: + $(AM_V_GEN)$(top_builddir)/pre-inst-env $(GUILE_TOOLS) compile $(GUILE_WARNINGS) -o "$@" "$<" + +moddir=$(prefix)/share/guile/site/$(GUILE_EFFECTIVE_VERSION) +godir=$(libdir)/guile/$(GUILE_EFFECTIVE_VERSION)/ccache + +GUILE_SOURCES = \ + aws/base.scm \ + aws/request.scm \ + aws/utils/json.scm \ + language/aws/spec.scm + +JSON_SOURCES = \ + aws/api/cloudfront-2019-03-26.normal.json \ + aws/api/ec2-2016-11-15.normal.json \ + aws/api/s3-2006-03-01.normal.json + +$(JSON_SOURCES:.normal.json=.go): %.go: %.normal.json aws/base.scm language/aws/spec.scm + $(AM_V_GEN)$(top_builddir)/pre-inst-env $(GUILE_TOOLS) \ + compile $(GUILE_WARNINGS) -O1 --from=aws \ + -o "$@" "$<" + + +SOURCES = $(GUILE_SOURCES) $(JSON_SOURCES) diff --git a/aws/api/README b/aws/api/README new file mode 100644 index 0000000..115e80b --- /dev/null +++ b/aws/api/README @@ -0,0 +1,4 @@ +These JSON files are unmodified copies taken from v2.484.0 of the AWS +SDK for JavaScript: https://github.com/aws/aws-sdk-js/tree/master/apis + +They are covered under the Apache 2.0 license. diff --git a/aws/api/cloudfront-2019-03-26.normal.json b/aws/api/cloudfront-2019-03-26.normal.json new file mode 100644 index 0000000..ab547c7 --- /dev/null +++ b/aws/api/cloudfront-2019-03-26.normal.json @@ -0,0 +1,5679 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2019-03-26", + "endpointPrefix": "cloudfront", + "globalEndpoint": "cloudfront.amazonaws.com", + "protocol": "rest-xml", + "serviceAbbreviation": "CloudFront", + "serviceFullName": "Amazon CloudFront", + "serviceId": "CloudFront", + "signatureVersion": "v4", + "uid": "cloudfront-2019-03-26" + }, + "operations": { + "CreateCloudFrontOriginAccessIdentity": { + "name": "CreateCloudFrontOriginAccessIdentity2019_03_26", + "http": { + "method": "POST", + "requestUri": "/2019-03-26/origin-access-identity/cloudfront", + "responseCode": 201 + }, + "input": { + "shape": "CreateCloudFrontOriginAccessIdentityRequest" + }, + "output": { + "shape": "CreateCloudFrontOriginAccessIdentityResult" + }, + "errors": [ + { + "shape": "CloudFrontOriginAccessIdentityAlreadyExists" + }, + { + "shape": "MissingBody" + }, + { + "shape": "TooManyCloudFrontOriginAccessIdentities" + }, + { + "shape": "InvalidArgument" + }, + { + "shape": "InconsistentQuantities" + } + ], + "documentation": "

Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "CreateDistribution": { + "name": "CreateDistribution2019_03_26", + "http": { + "method": "POST", + "requestUri": "/2019-03-26/distribution", + "responseCode": 201 + }, + "input": { + "shape": "CreateDistributionRequest" + }, + "output": { + "shape": "CreateDistributionResult" + }, + "errors": [ + { + "shape": "CNAMEAlreadyExists" + }, + { + "shape": "DistributionAlreadyExists" + }, + { + "shape": "InvalidOrigin" + }, + { + "shape": "InvalidOriginAccessIdentity" + }, + { + "shape": "AccessDenied" + }, + { + "shape": "TooManyTrustedSigners" + }, + { + "shape": "TrustedSignerDoesNotExist" + }, + { + "shape": "InvalidViewerCertificate" + }, + { + "shape": "InvalidMinimumProtocolVersion" + }, + { + "shape": "MissingBody" + }, + { + "shape": "TooManyDistributionCNAMEs" + }, + { + "shape": "TooManyDistributions" + }, + { + "shape": "InvalidDefaultRootObject" + }, + { + "shape": "InvalidRelativePath" + }, + { + "shape": "InvalidErrorCode" + }, + { + "shape": "InvalidResponseCode" + }, + { + "shape": "InvalidArgument" + }, + { + "shape": "InvalidRequiredProtocol" + }, + { + "shape": "NoSuchOrigin" + }, + { + "shape": "TooManyOrigins" + }, + { + "shape": "TooManyOriginGroupsPerDistribution" + }, + { + "shape": "TooManyCacheBehaviors" + }, + { + "shape": "TooManyCookieNamesInWhiteList" + }, + { + "shape": "InvalidForwardCookies" + }, + { + "shape": "TooManyHeadersInForwardedValues" + }, + { + "shape": "InvalidHeadersForS3Origin" + }, + { + "shape": "InconsistentQuantities" + }, + { + "shape": "TooManyCertificates" + }, + { + "shape": "InvalidLocationCode" + }, + { + "shape": "InvalidGeoRestrictionParameter" + }, + { + "shape": "InvalidProtocolSettings" + }, + { + "shape": "InvalidTTLOrder" + }, + { + "shape": "InvalidWebACLId" + }, + { + "shape": "TooManyOriginCustomHeaders" + }, + { + "shape": "TooManyQueryStringParameters" + }, + { + "shape": "InvalidQueryStringParameters" + }, + { + "shape": "TooManyDistributionsWithLambdaAssociations" + }, + { + "shape": "TooManyLambdaFunctionAssociations" + }, + { + "shape": "InvalidLambdaFunctionAssociation" + }, + { + "shape": "InvalidOriginReadTimeout" + }, + { + "shape": "InvalidOriginKeepaliveTimeout" + }, + { + "shape": "NoSuchFieldLevelEncryptionConfig" + }, + { + "shape": "IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior" + }, + { + "shape": "TooManyDistributionsAssociatedToFieldLevelEncryptionConfig" + } + ], + "documentation": "

Creates a new web distribution. You create a CloudFront distribution to tell CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery. Send a POST request to the /CloudFront API version/distribution/distribution ID resource.

When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using UpdateDistribution, follow the steps included in the documentation to get the current configuration and then make your updates. This helps to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide.

" + }, + "CreateDistributionWithTags": { + "name": "CreateDistributionWithTags2019_03_26", + "http": { + "method": "POST", + "requestUri": "/2019-03-26/distribution?WithTags", + "responseCode": 201 + }, + "input": { + "shape": "CreateDistributionWithTagsRequest" + }, + "output": { + "shape": "CreateDistributionWithTagsResult" + }, + "errors": [ + { + "shape": "CNAMEAlreadyExists" + }, + { + "shape": "DistributionAlreadyExists" + }, + { + "shape": "InvalidOrigin" + }, + { + "shape": "InvalidOriginAccessIdentity" + }, + { + "shape": "AccessDenied" + }, + { + "shape": "TooManyTrustedSigners" + }, + { + "shape": "TrustedSignerDoesNotExist" + }, + { + "shape": "InvalidViewerCertificate" + }, + { + "shape": "InvalidMinimumProtocolVersion" + }, + { + "shape": "MissingBody" + }, + { + "shape": "TooManyDistributionCNAMEs" + }, + { + "shape": "TooManyDistributions" + }, + { + "shape": "InvalidDefaultRootObject" + }, + { + "shape": "InvalidRelativePath" + }, + { + "shape": "InvalidErrorCode" + }, + { + "shape": "InvalidResponseCode" + }, + { + "shape": "InvalidArgument" + }, + { + "shape": "InvalidRequiredProtocol" + }, + { + "shape": "NoSuchOrigin" + }, + { + "shape": "TooManyOrigins" + }, + { + "shape": "TooManyOriginGroupsPerDistribution" + }, + { + "shape": "TooManyCacheBehaviors" + }, + { + "shape": "TooManyCookieNamesInWhiteList" + }, + { + "shape": "InvalidForwardCookies" + }, + { + "shape": "TooManyHeadersInForwardedValues" + }, + { + "shape": "InvalidHeadersForS3Origin" + }, + { + "shape": "InconsistentQuantities" + }, + { + "shape": "TooManyCertificates" + }, + { + "shape": "InvalidLocationCode" + }, + { + "shape": "InvalidGeoRestrictionParameter" + }, + { + "shape": "InvalidProtocolSettings" + }, + { + "shape": "InvalidTTLOrder" + }, + { + "shape": "InvalidWebACLId" + }, + { + "shape": "TooManyOriginCustomHeaders" + }, + { + "shape": "InvalidTagging" + }, + { + "shape": "TooManyQueryStringParameters" + }, + { + "shape": "InvalidQueryStringParameters" + }, + { + "shape": "TooManyDistributionsWithLambdaAssociations" + }, + { + "shape": "TooManyLambdaFunctionAssociations" + }, + { + "shape": "InvalidLambdaFunctionAssociation" + }, + { + "shape": "InvalidOriginReadTimeout" + }, + { + "shape": "InvalidOriginKeepaliveTimeout" + }, + { + "shape": "NoSuchFieldLevelEncryptionConfig" + }, + { + "shape": "IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior" + }, + { + "shape": "TooManyDistributionsAssociatedToFieldLevelEncryptionConfig" + } + ], + "documentation": "

Create a new distribution with tags.

" + }, + "CreateFieldLevelEncryptionConfig": { + "name": "CreateFieldLevelEncryptionConfig2019_03_26", + "http": { + "method": "POST", + "requestUri": "/2019-03-26/field-level-encryption", + "responseCode": 201 + }, + "input": { + "shape": "CreateFieldLevelEncryptionConfigRequest" + }, + "output": { + "shape": "CreateFieldLevelEncryptionConfigResult" + }, + "errors": [ + { + "shape": "InconsistentQuantities" + }, + { + "shape": "InvalidArgument" + }, + { + "shape": "NoSuchFieldLevelEncryptionProfile" + }, + { + "shape": "FieldLevelEncryptionConfigAlreadyExists" + }, + { + "shape": "TooManyFieldLevelEncryptionConfigs" + }, + { + "shape": "TooManyFieldLevelEncryptionQueryArgProfiles" + }, + { + "shape": "TooManyFieldLevelEncryptionContentTypeProfiles" + }, + { + "shape": "QueryArgProfileEmpty" + } + ], + "documentation": "

Create a new field-level encryption configuration.

" + }, + "CreateFieldLevelEncryptionProfile": { + "name": "CreateFieldLevelEncryptionProfile2019_03_26", + "http": { + "method": "POST", + "requestUri": "/2019-03-26/field-level-encryption-profile", + "responseCode": 201 + }, + "input": { + "shape": "CreateFieldLevelEncryptionProfileRequest" + }, + "output": { + "shape": "CreateFieldLevelEncryptionProfileResult" + }, + "errors": [ + { + "shape": "InconsistentQuantities" + }, + { + "shape": "InvalidArgument" + }, + { + "shape": "NoSuchPublicKey" + }, + { + "shape": "FieldLevelEncryptionProfileAlreadyExists" + }, + { + "shape": "FieldLevelEncryptionProfileSizeExceeded" + }, + { + "shape": "TooManyFieldLevelEncryptionProfiles" + }, + { + "shape": "TooManyFieldLevelEncryptionEncryptionEntities" + }, + { + "shape": "TooManyFieldLevelEncryptionFieldPatterns" + } + ], + "documentation": "

Create a field-level encryption profile.

" + }, + "CreateInvalidation": { + "name": "CreateInvalidation2019_03_26", + "http": { + "method": "POST", + "requestUri": "/2019-03-26/distribution/{DistributionId}/invalidation", + "responseCode": 201 + }, + "input": { + "shape": "CreateInvalidationRequest" + }, + "output": { + "shape": "CreateInvalidationResult" + }, + "errors": [ + { + "shape": "AccessDenied" + }, + { + "shape": "MissingBody" + }, + { + "shape": "InvalidArgument" + }, + { + "shape": "NoSuchDistribution" + }, + { + "shape": "BatchTooLarge" + }, + { + "shape": "TooManyInvalidationsInProgress" + }, + { + "shape": "InconsistentQuantities" + } + ], + "documentation": "

Create a new invalidation.

" + }, + "CreatePublicKey": { + "name": "CreatePublicKey2019_03_26", + "http": { + "method": "POST", + "requestUri": "/2019-03-26/public-key", + "responseCode": 201 + }, + "input": { + "shape": "CreatePublicKeyRequest" + }, + "output": { + "shape": "CreatePublicKeyResult" + }, + "errors": [ + { + "shape": "PublicKeyAlreadyExists" + }, + { + "shape": "InvalidArgument" + }, + { + "shape": "TooManyPublicKeys" + } + ], + "documentation": "

Add a new public key to CloudFront to use, for example, for field-level encryption. You can add a maximum of 10 public keys with one AWS account.

" + }, + "CreateStreamingDistribution": { + "name": "CreateStreamingDistribution2019_03_26", + "http": { + "method": "POST", + "requestUri": "/2019-03-26/streaming-distribution", + "responseCode": 201 + }, + "input": { + "shape": "CreateStreamingDistributionRequest" + }, + "output": { + "shape": "CreateStreamingDistributionResult" + }, + "errors": [ + { + "shape": "CNAMEAlreadyExists" + }, + { + "shape": "StreamingDistributionAlreadyExists" + }, + { + "shape": "InvalidOrigin" + }, + { + "shape": "InvalidOriginAccessIdentity" + }, + { + "shape": "AccessDenied" + }, + { + "shape": "TooManyTrustedSigners" + }, + { + "shape": "TrustedSignerDoesNotExist" + }, + { + "shape": "MissingBody" + }, + { + "shape": "TooManyStreamingDistributionCNAMEs" + }, + { + "shape": "TooManyStreamingDistributions" + }, + { + "shape": "InvalidArgument" + }, + { + "shape": "InconsistentQuantities" + } + ], + "documentation": "

Creates a new RTMP distribution. An RTMP distribution is similar to a web distribution, but an RTMP distribution streams media files using the Adobe Real-Time Messaging Protocol (RTMP) instead of serving files using HTTP.

To create a new distribution, submit a POST request to the CloudFront API version/distribution resource. The request body must include a document with a StreamingDistributionConfig element. The response echoes the StreamingDistributionConfig element and returns other information about the RTMP distribution.

To get the status of your request, use the GET StreamingDistribution API action. When the value of Enabled is true and the value of Status is Deployed, your distribution is ready. A distribution usually deploys in less than 15 minutes.

For more information about web distributions, see Working with RTMP Distributions in the Amazon CloudFront Developer Guide.

Beginning with the 2012-05-05 version of the CloudFront API, we made substantial changes to the format of the XML document that you include in the request body when you create or update a web distribution or an RTMP distribution, and when you invalidate objects. With previous versions of the API, we discovered that it was too easy to accidentally delete one or more values for an element that accepts multiple values, for example, CNAMEs and trusted signers. Our changes for the 2012-05-05 release are intended to prevent these accidental deletions and to notify you when there's a mismatch between the number of values you say you're specifying in the Quantity element and the number of values specified.

" + }, + "CreateStreamingDistributionWithTags": { + "name": "CreateStreamingDistributionWithTags2019_03_26", + "http": { + "method": "POST", + "requestUri": "/2019-03-26/streaming-distribution?WithTags", + "responseCode": 201 + }, + "input": { + "shape": "CreateStreamingDistributionWithTagsRequest" + }, + "output": { + "shape": "CreateStreamingDistributionWithTagsResult" + }, + "errors": [ + { + "shape": "CNAMEAlreadyExists" + }, + { + "shape": "StreamingDistributionAlreadyExists" + }, + { + "shape": "InvalidOrigin" + }, + { + "shape": "InvalidOriginAccessIdentity" + }, + { + "shape": "AccessDenied" + }, + { + "shape": "TooManyTrustedSigners" + }, + { + "shape": "TrustedSignerDoesNotExist" + }, + { + "shape": "MissingBody" + }, + { + "shape": "TooManyStreamingDistributionCNAMEs" + }, + { + "shape": "TooManyStreamingDistributions" + }, + { + "shape": "InvalidArgument" + }, + { + "shape": "InconsistentQuantities" + }, + { + "shape": "InvalidTagging" + } + ], + "documentation": "

Create a new streaming distribution with tags.

" + }, + "DeleteCloudFrontOriginAccessIdentity": { + "name": "DeleteCloudFrontOriginAccessIdentity2019_03_26", + "http": { + "method": "DELETE", + "requestUri": "/2019-03-26/origin-access-identity/cloudfront/{Id}", + "responseCode": 204 + }, + "input": { + "shape": "DeleteCloudFrontOriginAccessIdentityRequest" + }, + "errors": [ + { + "shape": "AccessDenied" + }, + { + "shape": "InvalidIfMatchVersion" + }, + { + "shape": "NoSuchCloudFrontOriginAccessIdentity" + }, + { + "shape": "PreconditionFailed" + }, + { + "shape": "CloudFrontOriginAccessIdentityInUse" + } + ], + "documentation": "

Delete an origin access identity.

" + }, + "DeleteDistribution": { + "name": "DeleteDistribution2019_03_26", + "http": { + "method": "DELETE", + "requestUri": "/2019-03-26/distribution/{Id}", + "responseCode": 204 + }, + "input": { + "shape": "DeleteDistributionRequest" + }, + "errors": [ + { + "shape": "AccessDenied" + }, + { + "shape": "DistributionNotDisabled" + }, + { + "shape": "InvalidIfMatchVersion" + }, + { + "shape": "NoSuchDistribution" + }, + { + "shape": "PreconditionFailed" + } + ], + "documentation": "

Delete a distribution.

" + }, + "DeleteFieldLevelEncryptionConfig": { + "name": "DeleteFieldLevelEncryptionConfig2019_03_26", + "http": { + "method": "DELETE", + "requestUri": "/2019-03-26/field-level-encryption/{Id}", + "responseCode": 204 + }, + "input": { + "shape": "DeleteFieldLevelEncryptionConfigRequest" + }, + "errors": [ + { + "shape": "AccessDenied" + }, + { + "shape": "InvalidIfMatchVersion" + }, + { + "shape": "NoSuchFieldLevelEncryptionConfig" + }, + { + "shape": "PreconditionFailed" + }, + { + "shape": "FieldLevelEncryptionConfigInUse" + } + ], + "documentation": "

Remove a field-level encryption configuration.

" + }, + "DeleteFieldLevelEncryptionProfile": { + "name": "DeleteFieldLevelEncryptionProfile2019_03_26", + "http": { + "method": "DELETE", + "requestUri": "/2019-03-26/field-level-encryption-profile/{Id}", + "responseCode": 204 + }, + "input": { + "shape": "DeleteFieldLevelEncryptionProfileRequest" + }, + "errors": [ + { + "shape": "AccessDenied" + }, + { + "shape": "InvalidIfMatchVersion" + }, + { + "shape": "NoSuchFieldLevelEncryptionProfile" + }, + { + "shape": "PreconditionFailed" + }, + { + "shape": "FieldLevelEncryptionProfileInUse" + } + ], + "documentation": "

Remove a field-level encryption profile.

" + }, + "DeletePublicKey": { + "name": "DeletePublicKey2019_03_26", + "http": { + "method": "DELETE", + "requestUri": "/2019-03-26/public-key/{Id}", + "responseCode": 204 + }, + "input": { + "shape": "DeletePublicKeyRequest" + }, + "errors": [ + { + "shape": "AccessDenied" + }, + { + "shape": "PublicKeyInUse" + }, + { + "shape": "InvalidIfMatchVersion" + }, + { + "shape": "NoSuchPublicKey" + }, + { + "shape": "PreconditionFailed" + } + ], + "documentation": "

Remove a public key you previously added to CloudFront.

" + }, + "DeleteStreamingDistribution": { + "name": "DeleteStreamingDistribution2019_03_26", + "http": { + "method": "DELETE", + "requestUri": "/2019-03-26/streaming-distribution/{Id}", + "responseCode": 204 + }, + "input": { + "shape": "DeleteStreamingDistributionRequest" + }, + "errors": [ + { + "shape": "AccessDenied" + }, + { + "shape": "StreamingDistributionNotDisabled" + }, + { + "shape": "InvalidIfMatchVersion" + }, + { + "shape": "NoSuchStreamingDistribution" + }, + { + "shape": "PreconditionFailed" + } + ], + "documentation": "

Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps.

To delete an RTMP distribution using the CloudFront API:

  1. Disable the RTMP distribution.

  2. Submit a GET Streaming Distribution Config request to get the current configuration and the Etag header for the distribution.

  3. Update the XML document that was returned in the response to your GET Streaming Distribution Config request to change the value of Enabled to false.

  4. Submit a PUT Streaming Distribution Config request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Then set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2.

  5. Review the response to the PUT Streaming Distribution Config request to confirm that the distribution was successfully disabled.

  6. Submit a GET Streaming Distribution Config request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.

  7. Submit a DELETE Streaming Distribution request. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2.

  8. Review the response to your DELETE Streaming Distribution request to confirm that the distribution was successfully deleted.

For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.

" + }, + "GetCloudFrontOriginAccessIdentity": { + "name": "GetCloudFrontOriginAccessIdentity2019_03_26", + "http": { + "method": "GET", + "requestUri": "/2019-03-26/origin-access-identity/cloudfront/{Id}" + }, + "input": { + "shape": "GetCloudFrontOriginAccessIdentityRequest" + }, + "output": { + "shape": "GetCloudFrontOriginAccessIdentityResult" + }, + "errors": [ + { + "shape": "NoSuchCloudFrontOriginAccessIdentity" + }, + { + "shape": "AccessDenied" + } + ], + "documentation": "

Get the information about an origin access identity.

" + }, + "GetCloudFrontOriginAccessIdentityConfig": { + "name": "GetCloudFrontOriginAccessIdentityConfig2019_03_26", + "http": { + "method": "GET", + "requestUri": "/2019-03-26/origin-access-identity/cloudfront/{Id}/config" + }, + "input": { + "shape": "GetCloudFrontOriginAccessIdentityConfigRequest" + }, + "output": { + "shape": "GetCloudFrontOriginAccessIdentityConfigResult" + }, + "errors": [ + { + "shape": "NoSuchCloudFrontOriginAccessIdentity" + }, + { + "shape": "AccessDenied" + } + ], + "documentation": "

Get the configuration information about an origin access identity.

" + }, + "GetDistribution": { + "name": "GetDistribution2019_03_26", + "http": { + "method": "GET", + "requestUri": "/2019-03-26/distribution/{Id}" + }, + "input": { + "shape": "GetDistributionRequest" + }, + "output": { + "shape": "GetDistributionResult" + }, + "errors": [ + { + "shape": "NoSuchDistribution" + }, + { + "shape": "AccessDenied" + } + ], + "documentation": "

Get the information about a distribution.

" + }, + "GetDistributionConfig": { + "name": "GetDistributionConfig2019_03_26", + "http": { + "method": "GET", + "requestUri": "/2019-03-26/distribution/{Id}/config" + }, + "input": { + "shape": "GetDistributionConfigRequest" + }, + "output": { + "shape": "GetDistributionConfigResult" + }, + "errors": [ + { + "shape": "NoSuchDistribution" + }, + { + "shape": "AccessDenied" + } + ], + "documentation": "

Get the configuration information about a distribution.

" + }, + "GetFieldLevelEncryption": { + "name": "GetFieldLevelEncryption2019_03_26", + "http": { + "method": "GET", + "requestUri": "/2019-03-26/field-level-encryption/{Id}" + }, + "input": { + "shape": "GetFieldLevelEncryptionRequest" + }, + "output": { + "shape": "GetFieldLevelEncryptionResult" + }, + "errors": [ + { + "shape": "AccessDenied" + }, + { + "shape": "NoSuchFieldLevelEncryptionConfig" + } + ], + "documentation": "

Get the field-level encryption configuration information.

" + }, + "GetFieldLevelEncryptionConfig": { + "name": "GetFieldLevelEncryptionConfig2019_03_26", + "http": { + "method": "GET", + "requestUri": "/2019-03-26/field-level-encryption/{Id}/config" + }, + "input": { + "shape": "GetFieldLevelEncryptionConfigRequest" + }, + "output": { + "shape": "GetFieldLevelEncryptionConfigResult" + }, + "errors": [ + { + "shape": "AccessDenied" + }, + { + "shape": "NoSuchFieldLevelEncryptionConfig" + } + ], + "documentation": "

Get the field-level encryption configuration information.

" + }, + "GetFieldLevelEncryptionProfile": { + "name": "GetFieldLevelEncryptionProfile2019_03_26", + "http": { + "method": "GET", + "requestUri": "/2019-03-26/field-level-encryption-profile/{Id}" + }, + "input": { + "shape": "GetFieldLevelEncryptionProfileRequest" + }, + "output": { + "shape": "GetFieldLevelEncryptionProfileResult" + }, + "errors": [ + { + "shape": "AccessDenied" + }, + { + "shape": "NoSuchFieldLevelEncryptionProfile" + } + ], + "documentation": "

Get the field-level encryption profile information.

" + }, + "GetFieldLevelEncryptionProfileConfig": { + "name": "GetFieldLevelEncryptionProfileConfig2019_03_26", + "http": { + "method": "GET", + "requestUri": "/2019-03-26/field-level-encryption-profile/{Id}/config" + }, + "input": { + "shape": "GetFieldLevelEncryptionProfileConfigRequest" + }, + "output": { + "shape": "GetFieldLevelEncryptionProfileConfigResult" + }, + "errors": [ + { + "shape": "AccessDenied" + }, + { + "shape": "NoSuchFieldLevelEncryptionProfile" + } + ], + "documentation": "

Get the field-level encryption profile configuration information.

" + }, + "GetInvalidation": { + "name": "GetInvalidation2019_03_26", + "http": { + "method": "GET", + "requestUri": "/2019-03-26/distribution/{DistributionId}/invalidation/{Id}" + }, + "input": { + "shape": "GetInvalidationRequest" + }, + "output": { + "shape": "GetInvalidationResult" + }, + "errors": [ + { + "shape": "NoSuchInvalidation" + }, + { + "shape": "NoSuchDistribution" + }, + { + "shape": "AccessDenied" + } + ], + "documentation": "

Get the information about an invalidation.

" + }, + "GetPublicKey": { + "name": "GetPublicKey2019_03_26", + "http": { + "method": "GET", + "requestUri": "/2019-03-26/public-key/{Id}" + }, + "input": { + "shape": "GetPublicKeyRequest" + }, + "output": { + "shape": "GetPublicKeyResult" + }, + "errors": [ + { + "shape": "AccessDenied" + }, + { + "shape": "NoSuchPublicKey" + } + ], + "documentation": "

Get the public key information.

" + }, + "GetPublicKeyConfig": { + "name": "GetPublicKeyConfig2019_03_26", + "http": { + "method": "GET", + "requestUri": "/2019-03-26/public-key/{Id}/config" + }, + "input": { + "shape": "GetPublicKeyConfigRequest" + }, + "output": { + "shape": "GetPublicKeyConfigResult" + }, + "errors": [ + { + "shape": "AccessDenied" + }, + { + "shape": "NoSuchPublicKey" + } + ], + "documentation": "

Return public key configuration informaation

" + }, + "GetStreamingDistribution": { + "name": "GetStreamingDistribution2019_03_26", + "http": { + "method": "GET", + "requestUri": "/2019-03-26/streaming-distribution/{Id}" + }, + "input": { + "shape": "GetStreamingDistributionRequest" + }, + "output": { + "shape": "GetStreamingDistributionResult" + }, + "errors": [ + { + "shape": "NoSuchStreamingDistribution" + }, + { + "shape": "AccessDenied" + } + ], + "documentation": "

Gets information about a specified RTMP distribution, including the distribution configuration.

" + }, + "GetStreamingDistributionConfig": { + "name": "GetStreamingDistributionConfig2019_03_26", + "http": { + "method": "GET", + "requestUri": "/2019-03-26/streaming-distribution/{Id}/config" + }, + "input": { + "shape": "GetStreamingDistributionConfigRequest" + }, + "output": { + "shape": "GetStreamingDistributionConfigResult" + }, + "errors": [ + { + "shape": "NoSuchStreamingDistribution" + }, + { + "shape": "AccessDenied" + } + ], + "documentation": "

Get the configuration information about a streaming distribution.

" + }, + "ListCloudFrontOriginAccessIdentities": { + "name": "ListCloudFrontOriginAccessIdentities2019_03_26", + "http": { + "method": "GET", + "requestUri": "/2019-03-26/origin-access-identity/cloudfront" + }, + "input": { + "shape": "ListCloudFrontOriginAccessIdentitiesRequest" + }, + "output": { + "shape": "ListCloudFrontOriginAccessIdentitiesResult" + }, + "errors": [ + { + "shape": "InvalidArgument" + } + ], + "documentation": "

Lists origin access identities.

" + }, + "ListDistributions": { + "name": "ListDistributions2019_03_26", + "http": { + "method": "GET", + "requestUri": "/2019-03-26/distribution" + }, + "input": { + "shape": "ListDistributionsRequest" + }, + "output": { + "shape": "ListDistributionsResult" + }, + "errors": [ + { + "shape": "InvalidArgument" + } + ], + "documentation": "

List CloudFront distributions.

" + }, + "ListDistributionsByWebACLId": { + "name": "ListDistributionsByWebACLId2019_03_26", + "http": { + "method": "GET", + "requestUri": "/2019-03-26/distributionsByWebACLId/{WebACLId}" + }, + "input": { + "shape": "ListDistributionsByWebACLIdRequest" + }, + "output": { + "shape": "ListDistributionsByWebACLIdResult" + }, + "errors": [ + { + "shape": "InvalidArgument" + }, + { + "shape": "InvalidWebACLId" + } + ], + "documentation": "

List the distributions that are associated with a specified AWS WAF web ACL.

" + }, + "ListFieldLevelEncryptionConfigs": { + "name": "ListFieldLevelEncryptionConfigs2019_03_26", + "http": { + "method": "GET", + "requestUri": "/2019-03-26/field-level-encryption" + }, + "input": { + "shape": "ListFieldLevelEncryptionConfigsRequest" + }, + "output": { + "shape": "ListFieldLevelEncryptionConfigsResult" + }, + "errors": [ + { + "shape": "InvalidArgument" + } + ], + "documentation": "

List all field-level encryption configurations that have been created in CloudFront for this account.

" + }, + "ListFieldLevelEncryptionProfiles": { + "name": "ListFieldLevelEncryptionProfiles2019_03_26", + "http": { + "method": "GET", + "requestUri": "/2019-03-26/field-level-encryption-profile" + }, + "input": { + "shape": "ListFieldLevelEncryptionProfilesRequest" + }, + "output": { + "shape": "ListFieldLevelEncryptionProfilesResult" + }, + "errors": [ + { + "shape": "InvalidArgument" + } + ], + "documentation": "

Request a list of field-level encryption profiles that have been created in CloudFront for this account.

" + }, + "ListInvalidations": { + "name": "ListInvalidations2019_03_26", + "http": { + "method": "GET", + "requestUri": "/2019-03-26/distribution/{DistributionId}/invalidation" + }, + "input": { + "shape": "ListInvalidationsRequest" + }, + "output": { + "shape": "ListInvalidationsResult" + }, + "errors": [ + { + "shape": "InvalidArgument" + }, + { + "shape": "NoSuchDistribution" + }, + { + "shape": "AccessDenied" + } + ], + "documentation": "

Lists invalidation batches.

" + }, + "ListPublicKeys": { + "name": "ListPublicKeys2019_03_26", + "http": { + "method": "GET", + "requestUri": "/2019-03-26/public-key" + }, + "input": { + "shape": "ListPublicKeysRequest" + }, + "output": { + "shape": "ListPublicKeysResult" + }, + "errors": [ + { + "shape": "InvalidArgument" + } + ], + "documentation": "

List all public keys that have been added to CloudFront for this account.

" + }, + "ListStreamingDistributions": { + "name": "ListStreamingDistributions2019_03_26", + "http": { + "method": "GET", + "requestUri": "/2019-03-26/streaming-distribution" + }, + "input": { + "shape": "ListStreamingDistributionsRequest" + }, + "output": { + "shape": "ListStreamingDistributionsResult" + }, + "errors": [ + { + "shape": "InvalidArgument" + } + ], + "documentation": "

List streaming distributions.

" + }, + "ListTagsForResource": { + "name": "ListTagsForResource2019_03_26", + "http": { + "method": "GET", + "requestUri": "/2019-03-26/tagging" + }, + "input": { + "shape": "ListTagsForResourceRequest" + }, + "output": { + "shape": "ListTagsForResourceResult" + }, + "errors": [ + { + "shape": "AccessDenied" + }, + { + "shape": "InvalidArgument" + }, + { + "shape": "InvalidTagging" + }, + { + "shape": "NoSuchResource" + } + ], + "documentation": "

List tags for a CloudFront resource.

" + }, + "TagResource": { + "name": "TagResource2019_03_26", + "http": { + "method": "POST", + "requestUri": "/2019-03-26/tagging?Operation=Tag", + "responseCode": 204 + }, + "input": { + "shape": "TagResourceRequest" + }, + "errors": [ + { + "shape": "AccessDenied" + }, + { + "shape": "InvalidArgument" + }, + { + "shape": "InvalidTagging" + }, + { + "shape": "NoSuchResource" + } + ], + "documentation": "

Add tags to a CloudFront resource.

" + }, + "UntagResource": { + "name": "UntagResource2019_03_26", + "http": { + "method": "POST", + "requestUri": "/2019-03-26/tagging?Operation=Untag", + "responseCode": 204 + }, + "input": { + "shape": "UntagResourceRequest" + }, + "errors": [ + { + "shape": "AccessDenied" + }, + { + "shape": "InvalidArgument" + }, + { + "shape": "InvalidTagging" + }, + { + "shape": "NoSuchResource" + } + ], + "documentation": "

Remove tags from a CloudFront resource.

" + }, + "UpdateCloudFrontOriginAccessIdentity": { + "name": "UpdateCloudFrontOriginAccessIdentity2019_03_26", + "http": { + "method": "PUT", + "requestUri": "/2019-03-26/origin-access-identity/cloudfront/{Id}/config" + }, + "input": { + "shape": "UpdateCloudFrontOriginAccessIdentityRequest" + }, + "output": { + "shape": "UpdateCloudFrontOriginAccessIdentityResult" + }, + "errors": [ + { + "shape": "AccessDenied" + }, + { + "shape": "IllegalUpdate" + }, + { + "shape": "InvalidIfMatchVersion" + }, + { + "shape": "MissingBody" + }, + { + "shape": "NoSuchCloudFrontOriginAccessIdentity" + }, + { + "shape": "PreconditionFailed" + }, + { + "shape": "InvalidArgument" + }, + { + "shape": "InconsistentQuantities" + } + ], + "documentation": "

Update an origin access identity.

" + }, + "UpdateDistribution": { + "name": "UpdateDistribution2019_03_26", + "http": { + "method": "PUT", + "requestUri": "/2019-03-26/distribution/{Id}/config" + }, + "input": { + "shape": "UpdateDistributionRequest" + }, + "output": { + "shape": "UpdateDistributionResult" + }, + "errors": [ + { + "shape": "AccessDenied" + }, + { + "shape": "CNAMEAlreadyExists" + }, + { + "shape": "IllegalUpdate" + }, + { + "shape": "InvalidIfMatchVersion" + }, + { + "shape": "MissingBody" + }, + { + "shape": "NoSuchDistribution" + }, + { + "shape": "PreconditionFailed" + }, + { + "shape": "TooManyDistributionCNAMEs" + }, + { + "shape": "InvalidDefaultRootObject" + }, + { + "shape": "InvalidRelativePath" + }, + { + "shape": "InvalidErrorCode" + }, + { + "shape": "InvalidResponseCode" + }, + { + "shape": "InvalidArgument" + }, + { + "shape": "InvalidOriginAccessIdentity" + }, + { + "shape": "TooManyTrustedSigners" + }, + { + "shape": "TrustedSignerDoesNotExist" + }, + { + "shape": "InvalidViewerCertificate" + }, + { + "shape": "InvalidMinimumProtocolVersion" + }, + { + "shape": "InvalidRequiredProtocol" + }, + { + "shape": "NoSuchOrigin" + }, + { + "shape": "TooManyOrigins" + }, + { + "shape": "TooManyOriginGroupsPerDistribution" + }, + { + "shape": "TooManyCacheBehaviors" + }, + { + "shape": "TooManyCookieNamesInWhiteList" + }, + { + "shape": "InvalidForwardCookies" + }, + { + "shape": "TooManyHeadersInForwardedValues" + }, + { + "shape": "InvalidHeadersForS3Origin" + }, + { + "shape": "InconsistentQuantities" + }, + { + "shape": "TooManyCertificates" + }, + { + "shape": "InvalidLocationCode" + }, + { + "shape": "InvalidGeoRestrictionParameter" + }, + { + "shape": "InvalidTTLOrder" + }, + { + "shape": "InvalidWebACLId" + }, + { + "shape": "TooManyOriginCustomHeaders" + }, + { + "shape": "TooManyQueryStringParameters" + }, + { + "shape": "InvalidQueryStringParameters" + }, + { + "shape": "TooManyDistributionsWithLambdaAssociations" + }, + { + "shape": "TooManyLambdaFunctionAssociations" + }, + { + "shape": "InvalidLambdaFunctionAssociation" + }, + { + "shape": "InvalidOriginReadTimeout" + }, + { + "shape": "InvalidOriginKeepaliveTimeout" + }, + { + "shape": "NoSuchFieldLevelEncryptionConfig" + }, + { + "shape": "IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior" + }, + { + "shape": "TooManyDistributionsAssociatedToFieldLevelEncryptionConfig" + } + ], + "documentation": "

Updates the configuration for a web distribution.

When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using this API action, follow the steps here to get the current configuration and then make your updates, to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide.

The update process includes getting the current distribution configuration, updating the XML document that is returned to make your changes, and then submitting an UpdateDistribution request to make the updates.

For information about updating a distribution using the CloudFront console instead, see Creating a Distribution in the Amazon CloudFront Developer Guide.

To update a web distribution using the CloudFront API

  1. Submit a GetDistributionConfig request to get the current configuration and an Etag header for the distribution.

    If you update the distribution again, you must get a new Etag header.

  2. Update the XML document that was returned in the response to your GetDistributionConfig request to include your changes.

    When you edit the XML file, be aware of the following:

    • You must strip out the ETag parameter that is returned.

    • Additional fields are required when you update a distribution. There may be fields included in the XML file for features that you haven't configured for your distribution. This is expected and required to successfully update the distribution.

    • You can't change the value of CallerReference. If you try to change this value, CloudFront returns an IllegalUpdate error.

    • The new configuration replaces the existing configuration; the values that you specify in an UpdateDistribution request are not merged into your existing configuration. When you add, delete, or replace values in an element that allows multiple values (for example, CNAME), you must specify all of the values that you want to appear in the updated distribution. In addition, you must update the corresponding Quantity element.

  3. Submit an UpdateDistribution request to update the configuration for your distribution:

    • In the request body, include the XML document that you updated in Step 2. The request body must include an XML document with a DistributionConfig element.

    • Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GetDistributionConfig request in Step 1.

  4. Review the response to the UpdateDistribution request to confirm that the configuration was successfully updated.

  5. Optional: Submit a GetDistribution request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.

" + }, + "UpdateFieldLevelEncryptionConfig": { + "name": "UpdateFieldLevelEncryptionConfig2019_03_26", + "http": { + "method": "PUT", + "requestUri": "/2019-03-26/field-level-encryption/{Id}/config" + }, + "input": { + "shape": "UpdateFieldLevelEncryptionConfigRequest" + }, + "output": { + "shape": "UpdateFieldLevelEncryptionConfigResult" + }, + "errors": [ + { + "shape": "AccessDenied" + }, + { + "shape": "IllegalUpdate" + }, + { + "shape": "InconsistentQuantities" + }, + { + "shape": "InvalidArgument" + }, + { + "shape": "InvalidIfMatchVersion" + }, + { + "shape": "NoSuchFieldLevelEncryptionProfile" + }, + { + "shape": "NoSuchFieldLevelEncryptionConfig" + }, + { + "shape": "PreconditionFailed" + }, + { + "shape": "TooManyFieldLevelEncryptionQueryArgProfiles" + }, + { + "shape": "TooManyFieldLevelEncryptionContentTypeProfiles" + }, + { + "shape": "QueryArgProfileEmpty" + } + ], + "documentation": "

Update a field-level encryption configuration.

" + }, + "UpdateFieldLevelEncryptionProfile": { + "name": "UpdateFieldLevelEncryptionProfile2019_03_26", + "http": { + "method": "PUT", + "requestUri": "/2019-03-26/field-level-encryption-profile/{Id}/config" + }, + "input": { + "shape": "UpdateFieldLevelEncryptionProfileRequest" + }, + "output": { + "shape": "UpdateFieldLevelEncryptionProfileResult" + }, + "errors": [ + { + "shape": "AccessDenied" + }, + { + "shape": "FieldLevelEncryptionProfileAlreadyExists" + }, + { + "shape": "IllegalUpdate" + }, + { + "shape": "InconsistentQuantities" + }, + { + "shape": "InvalidArgument" + }, + { + "shape": "InvalidIfMatchVersion" + }, + { + "shape": "NoSuchPublicKey" + }, + { + "shape": "NoSuchFieldLevelEncryptionProfile" + }, + { + "shape": "PreconditionFailed" + }, + { + "shape": "FieldLevelEncryptionProfileSizeExceeded" + }, + { + "shape": "TooManyFieldLevelEncryptionEncryptionEntities" + }, + { + "shape": "TooManyFieldLevelEncryptionFieldPatterns" + } + ], + "documentation": "

Update a field-level encryption profile.

" + }, + "UpdatePublicKey": { + "name": "UpdatePublicKey2019_03_26", + "http": { + "method": "PUT", + "requestUri": "/2019-03-26/public-key/{Id}/config" + }, + "input": { + "shape": "UpdatePublicKeyRequest" + }, + "output": { + "shape": "UpdatePublicKeyResult" + }, + "errors": [ + { + "shape": "AccessDenied" + }, + { + "shape": "CannotChangeImmutablePublicKeyFields" + }, + { + "shape": "InvalidArgument" + }, + { + "shape": "InvalidIfMatchVersion" + }, + { + "shape": "IllegalUpdate" + }, + { + "shape": "NoSuchPublicKey" + }, + { + "shape": "PreconditionFailed" + } + ], + "documentation": "

Update public key information. Note that the only value you can change is the comment.

" + }, + "UpdateStreamingDistribution": { + "name": "UpdateStreamingDistribution2019_03_26", + "http": { + "method": "PUT", + "requestUri": "/2019-03-26/streaming-distribution/{Id}/config" + }, + "input": { + "shape": "UpdateStreamingDistributionRequest" + }, + "output": { + "shape": "UpdateStreamingDistributionResult" + }, + "errors": [ + { + "shape": "AccessDenied" + }, + { + "shape": "CNAMEAlreadyExists" + }, + { + "shape": "IllegalUpdate" + }, + { + "shape": "InvalidIfMatchVersion" + }, + { + "shape": "MissingBody" + }, + { + "shape": "NoSuchStreamingDistribution" + }, + { + "shape": "PreconditionFailed" + }, + { + "shape": "TooManyStreamingDistributionCNAMEs" + }, + { + "shape": "InvalidArgument" + }, + { + "shape": "InvalidOriginAccessIdentity" + }, + { + "shape": "TooManyTrustedSigners" + }, + { + "shape": "TrustedSignerDoesNotExist" + }, + { + "shape": "InconsistentQuantities" + } + ], + "documentation": "

Update a streaming distribution.

" + } + }, + "shapes": { + "ActiveTrustedSigners": { + "type": "structure", + "required": [ + "Enabled", + "Quantity" + ], + "members": { + "Enabled": { + "shape": "boolean", + "documentation": "

Enabled is true if any of the AWS accounts listed in the TrustedSigners complex type for this distribution have active CloudFront key pairs. If not, Enabled is false.

" + }, + "Quantity": { + "shape": "integer", + "documentation": "

The number of trusted signers specified in the TrustedSigners complex type.

" + }, + "Items": { + "shape": "SignerList", + "documentation": "

A complex type that contains one Signer complex type for each trusted signer that is specified in the TrustedSigners complex type.

" + } + }, + "documentation": "

A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content.

The Signer complex type lists the AWS account number of the trusted signer or self if the signer is the AWS account that created the distribution. The Signer element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create signed URLs.

For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "AliasICPRecordal": { + "type": "structure", + "members": { + "CNAME": { + "shape": "string", + "documentation": "

A domain name associated with a distribution.

" + }, + "ICPRecordalStatus": { + "shape": "ICPRecordalStatus", + "documentation": "

The Internet Content Provider (ICP) recordal status for a CNAME. The ICPRecordalStatus is set to APPROVED for all CNAMEs (aliases) in regions outside of China.

The status values returned are the following:

  • APPROVED indicates that the associated CNAME has a valid ICP recordal number. Multiple CNAMEs can be associated with a distribution, and CNAMEs can correspond to different ICP recordals. To be marked as APPROVED, that is, valid to use with China region, a CNAME must have one ICP recordal number associated with it.

  • SUSPENDED indicates that the associated CNAME does not have a valid ICP recordal number.

  • PENDING indicates that at least one CNAME associated with the distribution does not have a valid ICP recordal number.

" + } + }, + "documentation": "

AWS services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions. The status is returned in the CloudFront response; you can't configure it yourself.

For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with AWS services in China.

" + }, + "AliasICPRecordals": { + "type": "list", + "member": { + "shape": "AliasICPRecordal", + "locationName": "AliasICPRecordal" + } + }, + "AliasList": { + "type": "list", + "member": { + "shape": "string", + "locationName": "CNAME" + } + }, + "Aliases": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "shape": "integer", + "documentation": "

The number of CNAME aliases, if any, that you want to associate with this distribution.

" + }, + "Items": { + "shape": "AliasList", + "documentation": "

A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.

" + } + }, + "documentation": "

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

" + }, + "AllowedMethods": { + "type": "structure", + "required": [ + "Quantity", + "Items" + ], + "members": { + "Quantity": { + "shape": "integer", + "documentation": "

The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD, and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests).

" + }, + "Items": { + "shape": "MethodsList", + "documentation": "

A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.

" + }, + "CachedMethods": { + "shape": "CachedMethods" + } + }, + "documentation": "

A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:

  • CloudFront forwards only GET and HEAD requests.

  • CloudFront forwards only GET, HEAD, and OPTIONS requests.

  • CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests.

If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.

" + }, + "AwsAccountNumberList": { + "type": "list", + "member": { + "shape": "string", + "locationName": "AwsAccountNumber" + } + }, + "CacheBehavior": { + "type": "structure", + "required": [ + "PathPattern", + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members": { + "PathPattern": { + "shape": "string", + "documentation": "

The pattern (for example, images/*.jpg) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.

You can optionally include a slash (/) at the beginning of the path pattern. For example, /images/*.jpg. CloudFront behavior is the same with or without the leading /.

The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.

For more information, see Path Pattern in the Amazon CloudFront Developer Guide.

" + }, + "TargetOriginId": { + "shape": "string", + "documentation": "

The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior in your distribution.

" + }, + "ForwardedValues": { + "shape": "ForwardedValues", + "documentation": "

A complex type that specifies how CloudFront handles query strings and cookies.

" + }, + "TrustedSigners": { + "shape": "TrustedSigners", + "documentation": "

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

" + }, + "ViewerProtocolPolicy": { + "shape": "ViewerProtocolPolicy", + "documentation": "

The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options:

  • allow-all: Viewers can use HTTP or HTTPS.

  • redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.

  • https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).

For more information about requiring the HTTPS protocol, see Using an HTTPS Connection to Access Your Objects in the Amazon CloudFront Developer Guide.

The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "MinTTL": { + "shape": "long", + "documentation": "

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

" + }, + "AllowedMethods": { + "shape": "AllowedMethods" + }, + "SmoothStreaming": { + "shape": "boolean", + "documentation": "

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

" + }, + "DefaultTTL": { + "shape": "long", + "documentation": "

The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "MaxTTL": { + "shape": "long", + "documentation": "

The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "Compress": { + "shape": "boolean", + "documentation": "

Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

" + }, + "LambdaFunctionAssociations": { + "shape": "LambdaFunctionAssociations", + "documentation": "

A complex type that contains zero or more Lambda function associations for a cache behavior.

" + }, + "FieldLevelEncryptionId": { + "shape": "string", + "documentation": "

The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for a cache behavior or for the default cache behavior in your distribution.

" + } + }, + "documentation": "

A complex type that describes how CloudFront processes requests.

You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin is never used.

For the current limit on the number of cache behaviors that you can add to a distribution, see Amazon CloudFront Limits in the AWS General Reference.

If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error.

To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element.

To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution.

For more information about cache behaviors, see Cache Behaviors in the Amazon CloudFront Developer Guide.

" + }, + "CacheBehaviorList": { + "type": "list", + "member": { + "shape": "CacheBehavior", + "locationName": "CacheBehavior" + } + }, + "CacheBehaviors": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "shape": "integer", + "documentation": "

The number of cache behaviors for this distribution.

" + }, + "Items": { + "shape": "CacheBehaviorList", + "documentation": "

Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items.

" + } + }, + "documentation": "

A complex type that contains zero or more CacheBehavior elements.

" + }, + "CachedMethods": { + "type": "structure", + "required": [ + "Quantity", + "Items" + ], + "members": { + "Quantity": { + "shape": "integer", + "documentation": "

The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests).

" + }, + "Items": { + "shape": "MethodsList", + "documentation": "

A complex type that contains the HTTP methods that you want CloudFront to cache responses to.

" + } + }, + "documentation": "

A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:

  • CloudFront caches responses to GET and HEAD requests.

  • CloudFront caches responses to GET, HEAD, and OPTIONS requests.

If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.

" + }, + "CertificateSource": { + "type": "string", + "enum": [ + "cloudfront", + "iam", + "acm" + ] + }, + "CloudFrontOriginAccessIdentity": { + "type": "structure", + "required": [ + "Id", + "S3CanonicalUserId" + ], + "members": { + "Id": { + "shape": "string", + "documentation": "

The ID for the origin access identity, for example, E74FTE3AJFJ256A.

" + }, + "S3CanonicalUserId": { + "shape": "string", + "documentation": "

The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3.

" + }, + "CloudFrontOriginAccessIdentityConfig": { + "shape": "CloudFrontOriginAccessIdentityConfig", + "documentation": "

The current configuration information for the identity.

" + } + }, + "documentation": "

CloudFront origin access identity.

" + }, + "CloudFrontOriginAccessIdentityConfig": { + "type": "structure", + "required": [ + "CallerReference", + "Comment" + ], + "members": { + "CallerReference": { + "shape": "string", + "documentation": "

A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.

If the value of CallerReference is new (regardless of the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created.

If the CallerReference is a value already sent in a previous identity request, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request.

If the CallerReference is a value you already sent in a previous request to create an identity, but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.

" + }, + "Comment": { + "shape": "string", + "documentation": "

Any comments you want to include about the origin access identity.

" + } + }, + "documentation": "

Origin access identity configuration. Send a GET request to the /CloudFront API version/CloudFront/identity ID/config resource.

" + }, + "CloudFrontOriginAccessIdentityList": { + "type": "structure", + "required": [ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members": { + "Marker": { + "shape": "string", + "documentation": "

Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).

" + }, + "NextMarker": { + "shape": "string", + "documentation": "

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your origin access identities where they left off.

" + }, + "MaxItems": { + "shape": "integer", + "documentation": "

The maximum number of origin access identities you want in the response body.

" + }, + "IsTruncated": { + "shape": "boolean", + "documentation": "

A flag that indicates whether more origin access identities remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more items in the list.

" + }, + "Quantity": { + "shape": "integer", + "documentation": "

The number of CloudFront origin access identities that were created by the current AWS account.

" + }, + "Items": { + "shape": "CloudFrontOriginAccessIdentitySummaryList", + "documentation": "

A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account.

" + } + }, + "documentation": "

Lists the origin access identities for CloudFront.Send a GET request to the /CloudFront API version/origin-access-identity/cloudfront resource. The response includes a CloudFrontOriginAccessIdentityList element with zero or more CloudFrontOriginAccessIdentitySummary child elements. By default, your entire list of origin access identities is returned in one single page. If the list is long, you can paginate it using the MaxItems and Marker parameters.

" + }, + "CloudFrontOriginAccessIdentitySummary": { + "type": "structure", + "required": [ + "Id", + "S3CanonicalUserId", + "Comment" + ], + "members": { + "Id": { + "shape": "string", + "documentation": "

The ID for the origin access identity. For example: E74FTE3AJFJ256A.

" + }, + "S3CanonicalUserId": { + "shape": "string", + "documentation": "

The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3.

" + }, + "Comment": { + "shape": "string", + "documentation": "

The comment for this origin access identity, as originally specified when created.

" + } + }, + "documentation": "

Summary of the information about a CloudFront origin access identity.

" + }, + "CloudFrontOriginAccessIdentitySummaryList": { + "type": "list", + "member": { + "shape": "CloudFrontOriginAccessIdentitySummary", + "locationName": "CloudFrontOriginAccessIdentitySummary" + } + }, + "CommentType": { + "type": "string", + "sensitive": true + }, + "ContentTypeProfile": { + "type": "structure", + "required": [ + "Format", + "ContentType" + ], + "members": { + "Format": { + "shape": "Format", + "documentation": "

The format for a field-level encryption content type-profile mapping.

" + }, + "ProfileId": { + "shape": "string", + "documentation": "

The profile ID for a field-level encryption content type-profile mapping.

" + }, + "ContentType": { + "shape": "string", + "documentation": "

The content type for a field-level encryption content type-profile mapping.

" + } + }, + "documentation": "

A field-level encryption content type profile.

" + }, + "ContentTypeProfileConfig": { + "type": "structure", + "required": [ + "ForwardWhenContentTypeIsUnknown" + ], + "members": { + "ForwardWhenContentTypeIsUnknown": { + "shape": "boolean", + "documentation": "

The setting in a field-level encryption content type-profile mapping that specifies what to do when an unknown content type is provided for the profile. If true, content is forwarded without being encrypted when the content type is unknown. If false (the default), an error is returned when the content type is unknown.

" + }, + "ContentTypeProfiles": { + "shape": "ContentTypeProfiles", + "documentation": "

The configuration for a field-level encryption content type-profile.

" + } + }, + "documentation": "

The configuration for a field-level encryption content type-profile mapping.

" + }, + "ContentTypeProfileList": { + "type": "list", + "member": { + "shape": "ContentTypeProfile", + "locationName": "ContentTypeProfile" + } + }, + "ContentTypeProfiles": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "shape": "integer", + "documentation": "

The number of field-level encryption content type-profile mappings.

" + }, + "Items": { + "shape": "ContentTypeProfileList", + "documentation": "

Items in a field-level encryption content type-profile mapping.

" + } + }, + "documentation": "

Field-level encryption content type-profile.

" + }, + "CookieNameList": { + "type": "list", + "member": { + "shape": "string", + "locationName": "Name" + } + }, + "CookieNames": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "shape": "integer", + "documentation": "

The number of different cookies that you want CloudFront to forward to the origin for this cache behavior.

" + }, + "Items": { + "shape": "CookieNameList", + "documentation": "

A complex type that contains one Name element for each cookie that you want CloudFront to forward to the origin for this cache behavior.

" + } + }, + "documentation": "

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide.

" + }, + "CookiePreference": { + "type": "structure", + "required": [ + "Forward" + ], + "members": { + "Forward": { + "shape": "ItemSelection", + "documentation": "

Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.

Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.

" + }, + "WhitelistedNames": { + "shape": "CookieNames", + "documentation": "

Required if you specify whitelist for the value of Forward:. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.

If you specify all or none for the value of Forward, omit WhitelistedNames. If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.

For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the AWS General Reference.

" + } + }, + "documentation": "

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see Caching Content Based on Cookies in the Amazon CloudFront Developer Guide.

" + }, + "CreateCloudFrontOriginAccessIdentityRequest": { + "type": "structure", + "required": [ + "CloudFrontOriginAccessIdentityConfig" + ], + "members": { + "CloudFrontOriginAccessIdentityConfig": { + "shape": "CloudFrontOriginAccessIdentityConfig", + "documentation": "

The current configuration information for the identity.

", + "locationName": "CloudFrontOriginAccessIdentityConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2019-03-26/" + } + } + }, + "documentation": "

The request to create a new origin access identity (OAI). An origin access identity is a special CloudFront user that you can associate with Amazon S3 origins, so that you can secure all or just some of your Amazon S3 content. For more information, see Restricting Access to Amazon S3 Content by Using an Origin Access Identity in the Amazon CloudFront Developer Guide.

", + "payload": "CloudFrontOriginAccessIdentityConfig" + }, + "CreateCloudFrontOriginAccessIdentityResult": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentity": { + "shape": "CloudFrontOriginAccessIdentity", + "documentation": "

The origin access identity's information.

" + }, + "Location": { + "shape": "string", + "documentation": "

The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A.

", + "location": "header", + "locationName": "Location" + }, + "ETag": { + "shape": "string", + "documentation": "

The current version of the origin access identity created.

", + "location": "header", + "locationName": "ETag" + } + }, + "documentation": "

The returned result of the corresponding request.

", + "payload": "CloudFrontOriginAccessIdentity" + }, + "CreateDistributionRequest": { + "type": "structure", + "required": [ + "DistributionConfig" + ], + "members": { + "DistributionConfig": { + "shape": "DistributionConfig", + "documentation": "

The distribution's configuration information.

", + "locationName": "DistributionConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2019-03-26/" + } + } + }, + "documentation": "

The request to create a new distribution.

", + "payload": "DistributionConfig" + }, + "CreateDistributionResult": { + "type": "structure", + "members": { + "Distribution": { + "shape": "Distribution", + "documentation": "

The distribution's information.

" + }, + "Location": { + "shape": "string", + "documentation": "

The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.

", + "location": "header", + "locationName": "Location" + }, + "ETag": { + "shape": "string", + "documentation": "

The current version of the distribution created.

", + "location": "header", + "locationName": "ETag" + } + }, + "documentation": "

The returned result of the corresponding request.

", + "payload": "Distribution" + }, + "CreateDistributionWithTagsRequest": { + "type": "structure", + "required": [ + "DistributionConfigWithTags" + ], + "members": { + "DistributionConfigWithTags": { + "shape": "DistributionConfigWithTags", + "documentation": "

The distribution's configuration information.

", + "locationName": "DistributionConfigWithTags", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2019-03-26/" + } + } + }, + "documentation": "

The request to create a new distribution with tags.

", + "payload": "DistributionConfigWithTags" + }, + "CreateDistributionWithTagsResult": { + "type": "structure", + "members": { + "Distribution": { + "shape": "Distribution", + "documentation": "

The distribution's information.

" + }, + "Location": { + "shape": "string", + "documentation": "

The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.

", + "location": "header", + "locationName": "Location" + }, + "ETag": { + "shape": "string", + "documentation": "

The current version of the distribution created.

", + "location": "header", + "locationName": "ETag" + } + }, + "documentation": "

The returned result of the corresponding request.

", + "payload": "Distribution" + }, + "CreateFieldLevelEncryptionConfigRequest": { + "type": "structure", + "required": [ + "FieldLevelEncryptionConfig" + ], + "members": { + "FieldLevelEncryptionConfig": { + "shape": "FieldLevelEncryptionConfig", + "documentation": "

The request to create a new field-level encryption configuration.

", + "locationName": "FieldLevelEncryptionConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2019-03-26/" + } + } + }, + "payload": "FieldLevelEncryptionConfig" + }, + "CreateFieldLevelEncryptionConfigResult": { + "type": "structure", + "members": { + "FieldLevelEncryption": { + "shape": "FieldLevelEncryption", + "documentation": "

Returned when you create a new field-level encryption configuration.

" + }, + "Location": { + "shape": "string", + "documentation": "

The fully qualified URI of the new configuration resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/field-level-encryption-config/EDFDVBD632BHDS5.

", + "location": "header", + "locationName": "Location" + }, + "ETag": { + "shape": "string", + "documentation": "

The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.

", + "location": "header", + "locationName": "ETag" + } + }, + "payload": "FieldLevelEncryption" + }, + "CreateFieldLevelEncryptionProfileRequest": { + "type": "structure", + "required": [ + "FieldLevelEncryptionProfileConfig" + ], + "members": { + "FieldLevelEncryptionProfileConfig": { + "shape": "FieldLevelEncryptionProfileConfig", + "documentation": "

The request to create a field-level encryption profile.

", + "locationName": "FieldLevelEncryptionProfileConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2019-03-26/" + } + } + }, + "payload": "FieldLevelEncryptionProfileConfig" + }, + "CreateFieldLevelEncryptionProfileResult": { + "type": "structure", + "members": { + "FieldLevelEncryptionProfile": { + "shape": "FieldLevelEncryptionProfile", + "documentation": "

Returned when you create a new field-level encryption profile.

" + }, + "Location": { + "shape": "string", + "documentation": "

The fully qualified URI of the new profile resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/field-level-encryption-profile/EDFDVBD632BHDS5.

", + "location": "header", + "locationName": "Location" + }, + "ETag": { + "shape": "string", + "documentation": "

The current version of the field level encryption profile. For example: E2QWRUHAPOMQZL.

", + "location": "header", + "locationName": "ETag" + } + }, + "payload": "FieldLevelEncryptionProfile" + }, + "CreateInvalidationRequest": { + "type": "structure", + "required": [ + "DistributionId", + "InvalidationBatch" + ], + "members": { + "DistributionId": { + "shape": "string", + "documentation": "

The distribution's id.

", + "location": "uri", + "locationName": "DistributionId" + }, + "InvalidationBatch": { + "shape": "InvalidationBatch", + "documentation": "

The batch information for the invalidation.

", + "locationName": "InvalidationBatch", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2019-03-26/" + } + } + }, + "documentation": "

The request to create an invalidation.

", + "payload": "InvalidationBatch" + }, + "CreateInvalidationResult": { + "type": "structure", + "members": { + "Location": { + "shape": "string", + "documentation": "

The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID.

", + "location": "header", + "locationName": "Location" + }, + "Invalidation": { + "shape": "Invalidation", + "documentation": "

The invalidation's information.

" + } + }, + "documentation": "

The returned result of the corresponding request.

", + "payload": "Invalidation" + }, + "CreatePublicKeyRequest": { + "type": "structure", + "required": [ + "PublicKeyConfig" + ], + "members": { + "PublicKeyConfig": { + "shape": "PublicKeyConfig", + "documentation": "

The request to add a public key to CloudFront.

", + "locationName": "PublicKeyConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2019-03-26/" + } + } + }, + "payload": "PublicKeyConfig" + }, + "CreatePublicKeyResult": { + "type": "structure", + "members": { + "PublicKey": { + "shape": "PublicKey", + "documentation": "

Returned when you add a public key.

" + }, + "Location": { + "shape": "string", + "documentation": "

The fully qualified URI of the new public key resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/cloudfront-public-key/EDFDVBD632BHDS5.

", + "location": "header", + "locationName": "Location" + }, + "ETag": { + "shape": "string", + "documentation": "

The current version of the public key. For example: E2QWRUHAPOMQZL.

", + "location": "header", + "locationName": "ETag" + } + }, + "payload": "PublicKey" + }, + "CreateStreamingDistributionRequest": { + "type": "structure", + "required": [ + "StreamingDistributionConfig" + ], + "members": { + "StreamingDistributionConfig": { + "shape": "StreamingDistributionConfig", + "documentation": "

The streaming distribution's configuration information.

", + "locationName": "StreamingDistributionConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2019-03-26/" + } + } + }, + "documentation": "

The request to create a new streaming distribution.

", + "payload": "StreamingDistributionConfig" + }, + "CreateStreamingDistributionResult": { + "type": "structure", + "members": { + "StreamingDistribution": { + "shape": "StreamingDistribution", + "documentation": "

The streaming distribution's information.

" + }, + "Location": { + "shape": "string", + "documentation": "

The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.

", + "location": "header", + "locationName": "Location" + }, + "ETag": { + "shape": "string", + "documentation": "

The current version of the streaming distribution created.

", + "location": "header", + "locationName": "ETag" + } + }, + "documentation": "

The returned result of the corresponding request.

", + "payload": "StreamingDistribution" + }, + "CreateStreamingDistributionWithTagsRequest": { + "type": "structure", + "required": [ + "StreamingDistributionConfigWithTags" + ], + "members": { + "StreamingDistributionConfigWithTags": { + "shape": "StreamingDistributionConfigWithTags", + "documentation": "

The streaming distribution's configuration information.

", + "locationName": "StreamingDistributionConfigWithTags", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2019-03-26/" + } + } + }, + "documentation": "

The request to create a new streaming distribution with tags.

", + "payload": "StreamingDistributionConfigWithTags" + }, + "CreateStreamingDistributionWithTagsResult": { + "type": "structure", + "members": { + "StreamingDistribution": { + "shape": "StreamingDistribution", + "documentation": "

The streaming distribution's information.

" + }, + "Location": { + "shape": "string", + "documentation": "

The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.

", + "location": "header", + "locationName": "Location" + }, + "ETag": { + "shape": "string", + "documentation": "

The current version of the distribution created.

", + "location": "header", + "locationName": "ETag" + } + }, + "documentation": "

The returned result of the corresponding request.

", + "payload": "StreamingDistribution" + }, + "CustomErrorResponse": { + "type": "structure", + "required": [ + "ErrorCode" + ], + "members": { + "ErrorCode": { + "shape": "integer", + "documentation": "

The HTTP status code for which you want to specify a custom error page and/or a caching duration.

" + }, + "ResponsePagePath": { + "shape": "string", + "documentation": "

The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ErrorCode, for example, /4xx-errors/403-forbidden.html. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:

  • The value of PathPattern matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named /4xx-errors. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, /4xx-errors/*.

  • The value of TargetOriginId specifies the value of the ID element for the origin that contains your custom error pages.

If you specify a value for ResponsePagePath, you must also specify a value for ResponseCode. If you don't want to specify a value, include an empty element, <ResponsePagePath>, in the XML document.

We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.

" + }, + "ResponseCode": { + "shape": "string", + "documentation": "

The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:

  • Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute 200, the response typically won't be intercepted.

  • If you don't care about distinguishing among different client errors or server errors, you can specify 400 or 500 as the ResponseCode for all 4xx or 5xx errors.

  • You might want to return a 200 status code (OK) and static website so your customers don't know that your website is down.

If you specify a value for ResponseCode, you must also specify a value for ResponsePagePath. If you don't want to specify a value, include an empty element, <ResponseCode>, in the XML document.

" + }, + "ErrorCachingMinTTL": { + "shape": "long", + "documentation": "

The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ErrorCode. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.

If you don't want to specify a value, include an empty element, <ErrorCachingMinTTL>, in the XML document.

For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" + } + }, + "documentation": "

A complex type that controls:

  • Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.

  • How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" + }, + "CustomErrorResponseList": { + "type": "list", + "member": { + "shape": "CustomErrorResponse", + "locationName": "CustomErrorResponse" + } + }, + "CustomErrorResponses": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "shape": "integer", + "documentation": "

The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If Quantity is 0, you can omit Items.

" + }, + "Items": { + "shape": "CustomErrorResponseList", + "documentation": "

A complex type that contains a CustomErrorResponse element for each HTTP status code for which you want to specify a custom error page and/or a caching duration.

" + } + }, + "documentation": "

A complex type that controls:

  • Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.

  • How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" + }, + "CustomHeaders": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "shape": "integer", + "documentation": "

The number of custom headers, if any, for this distribution.

" + }, + "Items": { + "shape": "OriginCustomHeadersList", + "documentation": "

Optional: A list that contains one OriginCustomHeader element for each custom header that you want CloudFront to forward to the origin. If Quantity is 0, omit Items.

" + } + }, + "documentation": "

A complex type that contains the list of Custom Headers for each origin.

" + }, + "CustomOriginConfig": { + "type": "structure", + "required": [ + "HTTPPort", + "HTTPSPort", + "OriginProtocolPolicy" + ], + "members": { + "HTTPPort": { + "shape": "integer", + "documentation": "

The HTTP port the custom origin listens on.

" + }, + "HTTPSPort": { + "shape": "integer", + "documentation": "

The HTTPS port the custom origin listens on.

" + }, + "OriginProtocolPolicy": { + "shape": "OriginProtocolPolicy", + "documentation": "

The origin protocol policy to apply to your origin.

" + }, + "OriginSslProtocols": { + "shape": "OriginSslProtocols", + "documentation": "

The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS.

" + }, + "OriginReadTimeout": { + "shape": "integer", + "documentation": "

You can create a custom origin read timeout. All timeout units are in seconds. The default origin read timeout is 30 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 4 seconds; the maximum is 60 seconds.

If you need to increase the maximum time limit, contact the AWS Support Center.

" + }, + "OriginKeepaliveTimeout": { + "shape": "integer", + "documentation": "

You can create a custom keep-alive timeout. All timeout units are in seconds. The default keep-alive timeout is 5 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 1 second; the maximum is 60 seconds.

If you need to increase the maximum time limit, contact the AWS Support Center.

" + } + }, + "documentation": "

A custom origin or an Amazon S3 bucket configured as a website endpoint.

" + }, + "DefaultCacheBehavior": { + "type": "structure", + "required": [ + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members": { + "TargetOriginId": { + "shape": "string", + "documentation": "

The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior in your distribution.

" + }, + "ForwardedValues": { + "shape": "ForwardedValues", + "documentation": "

A complex type that specifies how CloudFront handles query strings and cookies.

" + }, + "TrustedSigners": { + "shape": "TrustedSigners", + "documentation": "

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

" + }, + "ViewerProtocolPolicy": { + "shape": "ViewerProtocolPolicy", + "documentation": "

The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options:

  • allow-all: Viewers can use HTTP or HTTPS.

  • redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.

  • https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).

For more information about requiring the HTTPS protocol, see Using an HTTPS Connection to Access Your Objects in the Amazon CloudFront Developer Guide.

The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "MinTTL": { + "shape": "long", + "documentation": "

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

" + }, + "AllowedMethods": { + "shape": "AllowedMethods" + }, + "SmoothStreaming": { + "shape": "boolean", + "documentation": "

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

" + }, + "DefaultTTL": { + "shape": "long", + "documentation": "

The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "MaxTTL": { + "shape": "long", + "documentation": "

The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "Compress": { + "shape": "boolean", + "documentation": "

Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

" + }, + "LambdaFunctionAssociations": { + "shape": "LambdaFunctionAssociations", + "documentation": "

A complex type that contains zero or more Lambda function associations for a cache behavior.

" + }, + "FieldLevelEncryptionId": { + "shape": "string", + "documentation": "

The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for a cache behavior or for the default cache behavior in your distribution.

" + } + }, + "documentation": "

A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

" + }, + "DeleteCloudFrontOriginAccessIdentityRequest": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "shape": "string", + "documentation": "

The origin access identity's ID.

", + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "shape": "string", + "documentation": "

The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL.

", + "location": "header", + "locationName": "If-Match" + } + }, + "documentation": "

Deletes a origin access identity.

" + }, + "DeleteDistributionRequest": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "shape": "string", + "documentation": "

The distribution ID.

", + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "shape": "string", + "documentation": "

The value of the ETag header that you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.

", + "location": "header", + "locationName": "If-Match" + } + }, + "documentation": "

This action deletes a web distribution. To delete a web distribution using the CloudFront API, perform the following steps.

To delete a web distribution using the CloudFront API:

  1. Disable the web distribution

  2. Submit a GET Distribution Config request to get the current configuration and the Etag header for the distribution.

  3. Update the XML document that was returned in the response to your GET Distribution Config request to change the value of Enabled to false.

  4. Submit a PUT Distribution Config request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Distribution Config request in Step 2.

  5. Review the response to the PUT Distribution Config request to confirm that the distribution was successfully disabled.

  6. Submit a GET Distribution request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.

  7. Submit a DELETE Distribution request. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Distribution Config request in Step 6.

  8. Review the response to your DELETE Distribution request to confirm that the distribution was successfully deleted.

For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.

" + }, + "DeleteFieldLevelEncryptionConfigRequest": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "shape": "string", + "documentation": "

The ID of the configuration you want to delete from CloudFront.

", + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "shape": "string", + "documentation": "

The value of the ETag header that you received when retrieving the configuration identity to delete. For example: E2QWRUHAPOMQZL.

", + "location": "header", + "locationName": "If-Match" + } + } + }, + "DeleteFieldLevelEncryptionProfileRequest": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "shape": "string", + "documentation": "

Request the ID of the profile you want to delete from CloudFront.

", + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "shape": "string", + "documentation": "

The value of the ETag header that you received when retrieving the profile to delete. For example: E2QWRUHAPOMQZL.

", + "location": "header", + "locationName": "If-Match" + } + } + }, + "DeletePublicKeyRequest": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "shape": "string", + "documentation": "

The ID of the public key you want to remove from CloudFront.

", + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "shape": "string", + "documentation": "

The value of the ETag header that you received when retrieving the public key identity to delete. For example: E2QWRUHAPOMQZL.

", + "location": "header", + "locationName": "If-Match" + } + } + }, + "DeleteStreamingDistributionRequest": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "shape": "string", + "documentation": "

The distribution ID.

", + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "shape": "string", + "documentation": "

The value of the ETag header that you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL.

", + "location": "header", + "locationName": "If-Match" + } + }, + "documentation": "

The request to delete a streaming distribution.

" + }, + "Distribution": { + "type": "structure", + "required": [ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "InProgressInvalidationBatches", + "DomainName", + "ActiveTrustedSigners", + "DistributionConfig" + ], + "members": { + "Id": { + "shape": "string", + "documentation": "

The identifier for the distribution. For example: EDFDVBD632BHDS5.

" + }, + "ARN": { + "shape": "string", + "documentation": "

The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

" + }, + "Status": { + "shape": "string", + "documentation": "

This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated to all CloudFront edge locations.

" + }, + "LastModifiedTime": { + "shape": "timestamp", + "documentation": "

The date and time the distribution was last modified.

" + }, + "InProgressInvalidationBatches": { + "shape": "integer", + "documentation": "

The number of invalidation batches currently in progress.

" + }, + "DomainName": { + "shape": "string", + "documentation": "

The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net.

" + }, + "ActiveTrustedSigners": { + "shape": "ActiveTrustedSigners", + "documentation": "

CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs.

" + }, + "DistributionConfig": { + "shape": "DistributionConfig", + "documentation": "

The current configuration information for the distribution. Send a GET request to the /CloudFront API version/distribution ID/config resource.

" + }, + "AliasICPRecordals": { + "shape": "AliasICPRecordals", + "documentation": "

AWS services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions.

For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with AWS services in China.

" + } + }, + "documentation": "

A distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery.

" + }, + "DistributionConfig": { + "type": "structure", + "required": [ + "CallerReference", + "Origins", + "DefaultCacheBehavior", + "Comment", + "Enabled" + ], + "members": { + "CallerReference": { + "shape": "string", + "documentation": "

A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.

If the value of CallerReference is new (regardless of the content of the DistributionConfig object), CloudFront creates a new distribution.

If CallerReference is a value that you already sent in a previous request to create a distribution, CloudFront returns a DistributionAlreadyExists error.

" + }, + "Aliases": { + "shape": "Aliases", + "documentation": "

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

" + }, + "DefaultRootObject": { + "shape": "string", + "documentation": "

The object that you want CloudFront to request from your origin (for example, index.html) when a viewer requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/product-description.html). Specifying a default root object avoids exposing the contents of your distribution.

Specify only the object name, for example, index.html. Don't add a / before the object name.

If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element.

To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element.

To replace the default root object, update the distribution configuration and specify the new object.

For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide.

" + }, + "Origins": { + "shape": "Origins", + "documentation": "

A complex type that contains information about origins for this distribution.

" + }, + "OriginGroups": { + "shape": "OriginGroups", + "documentation": "

A complex type that contains information about origin groups for this distribution.

" + }, + "DefaultCacheBehavior": { + "shape": "DefaultCacheBehavior", + "documentation": "

A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

" + }, + "CacheBehaviors": { + "shape": "CacheBehaviors", + "documentation": "

A complex type that contains zero or more CacheBehavior elements.

" + }, + "CustomErrorResponses": { + "shape": "CustomErrorResponses", + "documentation": "

A complex type that controls the following:

  • Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.

  • How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" + }, + "Comment": { + "shape": "CommentType", + "documentation": "

Any comments you want to include about the distribution.

If you don't want to specify a comment, include an empty Comment element.

To delete an existing comment, update the distribution configuration and include an empty Comment element.

To add or change a comment, update the distribution configuration and specify the new comment.

" + }, + "Logging": { + "shape": "LoggingConfig", + "documentation": "

A complex type that controls whether access logs are written for the distribution.

For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide.

" + }, + "PriceClass": { + "shape": "PriceClass", + "documentation": "

The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify PriceClass_All, CloudFront responds to requests for your objects from all CloudFront edge locations.

If you specify a price class other than PriceClass_All, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.

For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing. For price class information, scroll down to see the table at the bottom of the page.

" + }, + "Enabled": { + "shape": "boolean", + "documentation": "

From this field, you can enable or disable the selected distribution.

" + }, + "ViewerCertificate": { + "shape": "ViewerCertificate", + "documentation": "

A complex type that specifies whether you want viewers to use HTTP or HTTPS to request your objects, whether you're using an alternate domain name with HTTPS, and if so, if you're using AWS Certificate Manager (ACM) or a third-party certificate authority.

" + }, + "Restrictions": { + "shape": "Restrictions", + "documentation": "

A complex type that identifies ways in which you want to restrict distribution of your content.

" + }, + "WebACLId": { + "shape": "string", + "documentation": "

A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution.

AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about AWS WAF, see the AWS WAF Developer Guide.

" + }, + "HttpVersion": { + "shape": "HttpVersion", + "documentation": "

(Optional) Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 automatically use an earlier HTTP version.

For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support Server Name Identification (SNI).

In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve performance by optimizing for HTTP/2. For more information, do an Internet search for \"http/2 optimization.\"

" + }, + "IsIPV6Enabled": { + "shape": "boolean", + "documentation": "

If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify true. If you specify false, CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.

In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the IpAddress parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide.

If you're using an Amazon Route 53 alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:

  • You enable IPv6 for the distribution

  • You're using alternate domain names in the URLs for your objects

For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Amazon Route 53 Developer Guide.

If you created a CNAME resource record set, either with Amazon Route 53 or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.

" + } + }, + "documentation": "

A distribution configuration.

" + }, + "DistributionConfigWithTags": { + "type": "structure", + "required": [ + "DistributionConfig", + "Tags" + ], + "members": { + "DistributionConfig": { + "shape": "DistributionConfig", + "documentation": "

A distribution configuration.

" + }, + "Tags": { + "shape": "Tags", + "documentation": "

A complex type that contains zero or more Tag elements.

" + } + }, + "documentation": "

A distribution Configuration and a list of tags to be associated with the distribution.

" + }, + "DistributionList": { + "type": "structure", + "required": [ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members": { + "Marker": { + "shape": "string", + "documentation": "

The value you provided for the Marker request parameter.

" + }, + "NextMarker": { + "shape": "string", + "documentation": "

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your distributions where they left off.

" + }, + "MaxItems": { + "shape": "integer", + "documentation": "

The value you provided for the MaxItems request parameter.

" + }, + "IsTruncated": { + "shape": "boolean", + "documentation": "

A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list.

" + }, + "Quantity": { + "shape": "integer", + "documentation": "

The number of distributions that were created by the current AWS account.

" + }, + "Items": { + "shape": "DistributionSummaryList", + "documentation": "

A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account.

" + } + }, + "documentation": "

A distribution list.

" + }, + "DistributionSummary": { + "type": "structure", + "required": [ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "DomainName", + "Aliases", + "Origins", + "DefaultCacheBehavior", + "CacheBehaviors", + "CustomErrorResponses", + "Comment", + "PriceClass", + "Enabled", + "ViewerCertificate", + "Restrictions", + "WebACLId", + "HttpVersion", + "IsIPV6Enabled" + ], + "members": { + "Id": { + "shape": "string", + "documentation": "

The identifier for the distribution. For example: EDFDVBD632BHDS5.

" + }, + "ARN": { + "shape": "string", + "documentation": "

The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

" + }, + "Status": { + "shape": "string", + "documentation": "

The current status of the distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations.

" + }, + "LastModifiedTime": { + "shape": "timestamp", + "documentation": "

The date and time the distribution was last modified.

" + }, + "DomainName": { + "shape": "string", + "documentation": "

The domain name that corresponds to the distribution, for example, d111111abcdef8.cloudfront.net.

" + }, + "Aliases": { + "shape": "Aliases", + "documentation": "

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

" + }, + "Origins": { + "shape": "Origins", + "documentation": "

A complex type that contains information about origins for this distribution.

" + }, + "OriginGroups": { + "shape": "OriginGroups", + "documentation": "

A complex type that contains information about origin groups for this distribution.

" + }, + "DefaultCacheBehavior": { + "shape": "DefaultCacheBehavior", + "documentation": "

A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

" + }, + "CacheBehaviors": { + "shape": "CacheBehaviors", + "documentation": "

A complex type that contains zero or more CacheBehavior elements.

" + }, + "CustomErrorResponses": { + "shape": "CustomErrorResponses", + "documentation": "

A complex type that contains zero or more CustomErrorResponses elements.

" + }, + "Comment": { + "shape": "string", + "documentation": "

The comment originally specified when this distribution was created.

" + }, + "PriceClass": { + "shape": "PriceClass", + "documentation": "

A complex type that contains information about price class for this streaming distribution.

" + }, + "Enabled": { + "shape": "boolean", + "documentation": "

Whether the distribution is enabled to accept user requests for content.

" + }, + "ViewerCertificate": { + "shape": "ViewerCertificate", + "documentation": "

A complex type that specifies whether you want viewers to use HTTP or HTTPS to request your objects, whether you're using an alternate domain name with HTTPS, and if so, if you're using AWS Certificate Manager (ACM) or a third-party certificate authority.

" + }, + "Restrictions": { + "shape": "Restrictions", + "documentation": "

A complex type that identifies ways in which you want to restrict distribution of your content.

" + }, + "WebACLId": { + "shape": "string", + "documentation": "

The Web ACL Id (if any) associated with the distribution.

" + }, + "HttpVersion": { + "shape": "HttpVersion", + "documentation": "

Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 will automatically use an earlier version.

" + }, + "IsIPV6Enabled": { + "shape": "boolean", + "documentation": "

Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.

" + }, + "AliasICPRecordals": { + "shape": "AliasICPRecordals", + "documentation": "

AWS services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions.

For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with AWS services in China.

" + } + }, + "documentation": "

A summary of the information about a CloudFront distribution.

" + }, + "DistributionSummaryList": { + "type": "list", + "member": { + "shape": "DistributionSummary", + "locationName": "DistributionSummary" + } + }, + "EncryptionEntities": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "shape": "integer", + "documentation": "

Number of field pattern items in a field-level encryption content type-profile mapping.

" + }, + "Items": { + "shape": "EncryptionEntityList", + "documentation": "

An array of field patterns in a field-level encryption content type-profile mapping.

" + } + }, + "documentation": "

Complex data type for field-level encryption profiles that includes all of the encryption entities.

" + }, + "EncryptionEntity": { + "type": "structure", + "required": [ + "PublicKeyId", + "ProviderId", + "FieldPatterns" + ], + "members": { + "PublicKeyId": { + "shape": "string", + "documentation": "

The public key associated with a set of field-level encryption patterns, to be used when encrypting the fields that match the patterns.

" + }, + "ProviderId": { + "shape": "string", + "documentation": "

The provider associated with the public key being used for encryption. This value must also be provided with the private key for applications to be able to decrypt data.

" + }, + "FieldPatterns": { + "shape": "FieldPatterns", + "documentation": "

Field patterns in a field-level encryption content type profile specify the fields that you want to be encrypted. You can provide the full field name, or any beginning characters followed by a wildcard (*). You can't overlap field patterns. For example, you can't have both ABC* and AB*. Note that field patterns are case-sensitive.

" + } + }, + "documentation": "

Complex data type for field-level encryption profiles that includes the encryption key and field pattern specifications.

" + }, + "EncryptionEntityList": { + "type": "list", + "member": { + "shape": "EncryptionEntity", + "locationName": "EncryptionEntity" + } + }, + "EventType": { + "type": "string", + "enum": [ + "viewer-request", + "viewer-response", + "origin-request", + "origin-response" + ] + }, + "FieldLevelEncryption": { + "type": "structure", + "required": [ + "Id", + "LastModifiedTime", + "FieldLevelEncryptionConfig" + ], + "members": { + "Id": { + "shape": "string", + "documentation": "

The configuration ID for a field-level encryption configuration which includes a set of profiles that specify certain selected data fields to be encrypted by specific public keys.

" + }, + "LastModifiedTime": { + "shape": "timestamp", + "documentation": "

The last time the field-level encryption configuration was changed.

" + }, + "FieldLevelEncryptionConfig": { + "shape": "FieldLevelEncryptionConfig", + "documentation": "

A complex data type that includes the profile configurations specified for field-level encryption.

" + } + }, + "documentation": "

A complex data type that includes the profile configurations and other options specified for field-level encryption.

" + }, + "FieldLevelEncryptionConfig": { + "type": "structure", + "required": [ + "CallerReference" + ], + "members": { + "CallerReference": { + "shape": "string", + "documentation": "

A unique number that ensures the request can't be replayed.

" + }, + "Comment": { + "shape": "string", + "documentation": "

An optional comment about the configuration.

" + }, + "QueryArgProfileConfig": { + "shape": "QueryArgProfileConfig", + "documentation": "

A complex data type that specifies when to forward content if a profile isn't found and the profile that can be provided as a query argument in a request.

" + }, + "ContentTypeProfileConfig": { + "shape": "ContentTypeProfileConfig", + "documentation": "

A complex data type that specifies when to forward content if a content type isn't recognized and profiles to use as by default in a request if a query argument doesn't specify a profile to use.

" + } + }, + "documentation": "

A complex data type that includes the profile configurations specified for field-level encryption.

" + }, + "FieldLevelEncryptionList": { + "type": "structure", + "required": [ + "MaxItems", + "Quantity" + ], + "members": { + "NextMarker": { + "shape": "string", + "documentation": "

If there are more elements to be listed, this element is present and contains the value that you can use for the Marker request parameter to continue listing your configurations where you left off.

" + }, + "MaxItems": { + "shape": "integer", + "documentation": "

The maximum number of elements you want in the response body.

" + }, + "Quantity": { + "shape": "integer", + "documentation": "

The number of field-level encryption items.

" + }, + "Items": { + "shape": "FieldLevelEncryptionSummaryList", + "documentation": "

An array of field-level encryption items.

" + } + }, + "documentation": "

List of field-level encrpytion configurations.

" + }, + "FieldLevelEncryptionProfile": { + "type": "structure", + "required": [ + "Id", + "LastModifiedTime", + "FieldLevelEncryptionProfileConfig" + ], + "members": { + "Id": { + "shape": "string", + "documentation": "

The ID for a field-level encryption profile configuration which includes a set of profiles that specify certain selected data fields to be encrypted by specific public keys.

" + }, + "LastModifiedTime": { + "shape": "timestamp", + "documentation": "

The last time the field-level encryption profile was updated.

" + }, + "FieldLevelEncryptionProfileConfig": { + "shape": "FieldLevelEncryptionProfileConfig", + "documentation": "

A complex data type that includes the profile name and the encryption entities for the field-level encryption profile.

" + } + }, + "documentation": "

A complex data type for field-level encryption profiles.

" + }, + "FieldLevelEncryptionProfileConfig": { + "type": "structure", + "required": [ + "Name", + "CallerReference", + "EncryptionEntities" + ], + "members": { + "Name": { + "shape": "string", + "documentation": "

Profile name for the field-level encryption profile.

" + }, + "CallerReference": { + "shape": "string", + "documentation": "

A unique number that ensures that the request can't be replayed.

" + }, + "Comment": { + "shape": "string", + "documentation": "

An optional comment for the field-level encryption profile.

" + }, + "EncryptionEntities": { + "shape": "EncryptionEntities", + "documentation": "

A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and field patterns for specifying which fields to encrypt with this key.

" + } + }, + "documentation": "

A complex data type of profiles for the field-level encryption.

" + }, + "FieldLevelEncryptionProfileList": { + "type": "structure", + "required": [ + "MaxItems", + "Quantity" + ], + "members": { + "NextMarker": { + "shape": "string", + "documentation": "

If there are more elements to be listed, this element is present and contains the value that you can use for the Marker request parameter to continue listing your profiles where you left off.

" + }, + "MaxItems": { + "shape": "integer", + "documentation": "

The maximum number of field-level encryption profiles you want in the response body.

" + }, + "Quantity": { + "shape": "integer", + "documentation": "

The number of field-level encryption profiles.

" + }, + "Items": { + "shape": "FieldLevelEncryptionProfileSummaryList", + "documentation": "

The field-level encryption profile items.

" + } + }, + "documentation": "

List of field-level encryption profiles.

" + }, + "FieldLevelEncryptionProfileSummary": { + "type": "structure", + "required": [ + "Id", + "LastModifiedTime", + "Name", + "EncryptionEntities" + ], + "members": { + "Id": { + "shape": "string", + "documentation": "

ID for the field-level encryption profile summary.

" + }, + "LastModifiedTime": { + "shape": "timestamp", + "documentation": "

The time when the the field-level encryption profile summary was last updated.

" + }, + "Name": { + "shape": "string", + "documentation": "

Name for the field-level encryption profile summary.

" + }, + "EncryptionEntities": { + "shape": "EncryptionEntities", + "documentation": "

A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and field patterns for specifying which fields to encrypt with this key.

" + }, + "Comment": { + "shape": "string", + "documentation": "

An optional comment for the field-level encryption profile summary.

" + } + }, + "documentation": "

The field-level encryption profile summary.

" + }, + "FieldLevelEncryptionProfileSummaryList": { + "type": "list", + "member": { + "shape": "FieldLevelEncryptionProfileSummary", + "locationName": "FieldLevelEncryptionProfileSummary" + } + }, + "FieldLevelEncryptionSummary": { + "type": "structure", + "required": [ + "Id", + "LastModifiedTime" + ], + "members": { + "Id": { + "shape": "string", + "documentation": "

The unique ID of a field-level encryption item.

" + }, + "LastModifiedTime": { + "shape": "timestamp", + "documentation": "

The last time that the summary of field-level encryption items was modified.

" + }, + "Comment": { + "shape": "string", + "documentation": "

An optional comment about the field-level encryption item.

" + }, + "QueryArgProfileConfig": { + "shape": "QueryArgProfileConfig", + "documentation": "

A summary of a query argument-profile mapping.

" + }, + "ContentTypeProfileConfig": { + "shape": "ContentTypeProfileConfig", + "documentation": "

A summary of a content type-profile mapping.

" + } + }, + "documentation": "

A summary of a field-level encryption item.

" + }, + "FieldLevelEncryptionSummaryList": { + "type": "list", + "member": { + "shape": "FieldLevelEncryptionSummary", + "locationName": "FieldLevelEncryptionSummary" + } + }, + "FieldPatternList": { + "type": "list", + "member": { + "shape": "string", + "locationName": "FieldPattern" + } + }, + "FieldPatterns": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "shape": "integer", + "documentation": "

The number of field-level encryption field patterns.

" + }, + "Items": { + "shape": "FieldPatternList", + "documentation": "

An array of the field-level encryption field patterns.

" + } + }, + "documentation": "

A complex data type that includes the field patterns to match for field-level encryption.

" + }, + "Format": { + "type": "string", + "enum": [ + "URLEncoded" + ] + }, + "ForwardedValues": { + "type": "structure", + "required": [ + "QueryString", + "Cookies" + ], + "members": { + "QueryString": { + "shape": "boolean", + "documentation": "

Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys, if any:

If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.

If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.

If you specify false for QueryString, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.

For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide.

" + }, + "Cookies": { + "shape": "CookiePreference", + "documentation": "

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.

" + }, + "Headers": { + "shape": "Headers", + "documentation": "

A complex type that specifies the Headers, if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.

For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide.

" + }, + "QueryStringCacheKeys": { + "shape": "QueryStringCacheKeys", + "documentation": "

A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.

" + } + }, + "documentation": "

A complex type that specifies how CloudFront handles query strings and cookies.

" + }, + "GeoRestriction": { + "type": "structure", + "required": [ + "RestrictionType", + "Quantity" + ], + "members": { + "RestrictionType": { + "shape": "GeoRestrictionType", + "documentation": "

The method that you want to use to restrict distribution of your content by country:

  • none: No geo restriction is enabled, meaning access to content is not restricted by client geo location.

  • blacklist: The Location elements specify the countries in which you don't want CloudFront to distribute your content.

  • whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.

" + }, + "Quantity": { + "shape": "integer", + "documentation": "

When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items.

" + }, + "Items": { + "shape": "LocationList", + "documentation": "

A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist).

The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country.

CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.

" + } + }, + "documentation": "

A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.

" + }, + "GeoRestrictionType": { + "type": "string", + "enum": [ + "blacklist", + "whitelist", + "none" + ] + }, + "GetCloudFrontOriginAccessIdentityConfigRequest": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "shape": "string", + "documentation": "

The identity's ID.

", + "location": "uri", + "locationName": "Id" + } + }, + "documentation": "

The origin access identity's configuration information. For more information, see CloudFrontOriginAccessIdentityConfig.

" + }, + "GetCloudFrontOriginAccessIdentityConfigResult": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentityConfig": { + "shape": "CloudFrontOriginAccessIdentityConfig", + "documentation": "

The origin access identity's configuration information.

" + }, + "ETag": { + "shape": "string", + "documentation": "

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location": "header", + "locationName": "ETag" + } + }, + "documentation": "

The returned result of the corresponding request.

", + "payload": "CloudFrontOriginAccessIdentityConfig" + }, + "GetCloudFrontOriginAccessIdentityRequest": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "shape": "string", + "documentation": "

The identity's ID.

", + "location": "uri", + "locationName": "Id" + } + }, + "documentation": "

The request to get an origin access identity's information.

" + }, + "GetCloudFrontOriginAccessIdentityResult": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentity": { + "shape": "CloudFrontOriginAccessIdentity", + "documentation": "

The origin access identity's information.

" + }, + "ETag": { + "shape": "string", + "documentation": "

The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL.

", + "location": "header", + "locationName": "ETag" + } + }, + "documentation": "

The returned result of the corresponding request.

", + "payload": "CloudFrontOriginAccessIdentity" + }, + "GetDistributionConfigRequest": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "shape": "string", + "documentation": "

The distribution's ID. If the ID is empty, an empty distribution configuration is returned.

", + "location": "uri", + "locationName": "Id" + } + }, + "documentation": "

The request to get a distribution configuration.

" + }, + "GetDistributionConfigResult": { + "type": "structure", + "members": { + "DistributionConfig": { + "shape": "DistributionConfig", + "documentation": "

The distribution's configuration information.

" + }, + "ETag": { + "shape": "string", + "documentation": "

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location": "header", + "locationName": "ETag" + } + }, + "documentation": "

The returned result of the corresponding request.

", + "payload": "DistributionConfig" + }, + "GetDistributionRequest": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "shape": "string", + "documentation": "

The distribution's ID. If the ID is empty, an empty distribution configuration is returned.

", + "location": "uri", + "locationName": "Id" + } + }, + "documentation": "

The request to get a distribution's information.

" + }, + "GetDistributionResult": { + "type": "structure", + "members": { + "Distribution": { + "shape": "Distribution", + "documentation": "

The distribution's information.

" + }, + "ETag": { + "shape": "string", + "documentation": "

The current version of the distribution's information. For example: E2QWRUHAPOMQZL.

", + "location": "header", + "locationName": "ETag" + } + }, + "documentation": "

The returned result of the corresponding request.

", + "payload": "Distribution" + }, + "GetFieldLevelEncryptionConfigRequest": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "shape": "string", + "documentation": "

Request the ID for the field-level encryption configuration information.

", + "location": "uri", + "locationName": "Id" + } + } + }, + "GetFieldLevelEncryptionConfigResult": { + "type": "structure", + "members": { + "FieldLevelEncryptionConfig": { + "shape": "FieldLevelEncryptionConfig", + "documentation": "

Return the field-level encryption configuration information.

" + }, + "ETag": { + "shape": "string", + "documentation": "

The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.

", + "location": "header", + "locationName": "ETag" + } + }, + "payload": "FieldLevelEncryptionConfig" + }, + "GetFieldLevelEncryptionProfileConfigRequest": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "shape": "string", + "documentation": "

Get the ID for the field-level encryption profile configuration information.

", + "location": "uri", + "locationName": "Id" + } + } + }, + "GetFieldLevelEncryptionProfileConfigResult": { + "type": "structure", + "members": { + "FieldLevelEncryptionProfileConfig": { + "shape": "FieldLevelEncryptionProfileConfig", + "documentation": "

Return the field-level encryption profile configuration information.

" + }, + "ETag": { + "shape": "string", + "documentation": "

The current version of the field-level encryption profile configuration result. For example: E2QWRUHAPOMQZL.

", + "location": "header", + "locationName": "ETag" + } + }, + "payload": "FieldLevelEncryptionProfileConfig" + }, + "GetFieldLevelEncryptionProfileRequest": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "shape": "string", + "documentation": "

Get the ID for the field-level encryption profile information.

", + "location": "uri", + "locationName": "Id" + } + } + }, + "GetFieldLevelEncryptionProfileResult": { + "type": "structure", + "members": { + "FieldLevelEncryptionProfile": { + "shape": "FieldLevelEncryptionProfile", + "documentation": "

Return the field-level encryption profile information.

" + }, + "ETag": { + "shape": "string", + "documentation": "

The current version of the field level encryption profile. For example: E2QWRUHAPOMQZL.

", + "location": "header", + "locationName": "ETag" + } + }, + "payload": "FieldLevelEncryptionProfile" + }, + "GetFieldLevelEncryptionRequest": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "shape": "string", + "documentation": "

Request the ID for the field-level encryption configuration information.

", + "location": "uri", + "locationName": "Id" + } + } + }, + "GetFieldLevelEncryptionResult": { + "type": "structure", + "members": { + "FieldLevelEncryption": { + "shape": "FieldLevelEncryption", + "documentation": "

Return the field-level encryption configuration information.

" + }, + "ETag": { + "shape": "string", + "documentation": "

The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.

", + "location": "header", + "locationName": "ETag" + } + }, + "payload": "FieldLevelEncryption" + }, + "GetInvalidationRequest": { + "type": "structure", + "required": [ + "DistributionId", + "Id" + ], + "members": { + "DistributionId": { + "shape": "string", + "documentation": "

The distribution's ID.

", + "location": "uri", + "locationName": "DistributionId" + }, + "Id": { + "shape": "string", + "documentation": "

The identifier for the invalidation request, for example, IDFDVBD632BHDS5.

", + "location": "uri", + "locationName": "Id" + } + }, + "documentation": "

The request to get an invalidation's information.

" + }, + "GetInvalidationResult": { + "type": "structure", + "members": { + "Invalidation": { + "shape": "Invalidation", + "documentation": "

The invalidation's information. For more information, see Invalidation Complex Type.

" + } + }, + "documentation": "

The returned result of the corresponding request.

", + "payload": "Invalidation" + }, + "GetPublicKeyConfigRequest": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "shape": "string", + "documentation": "

Request the ID for the public key configuration.

", + "location": "uri", + "locationName": "Id" + } + } + }, + "GetPublicKeyConfigResult": { + "type": "structure", + "members": { + "PublicKeyConfig": { + "shape": "PublicKeyConfig", + "documentation": "

Return the result for the public key configuration.

" + }, + "ETag": { + "shape": "string", + "documentation": "

The current version of the public key configuration. For example: E2QWRUHAPOMQZL.

", + "location": "header", + "locationName": "ETag" + } + }, + "payload": "PublicKeyConfig" + }, + "GetPublicKeyRequest": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "shape": "string", + "documentation": "

Request the ID for the public key.

", + "location": "uri", + "locationName": "Id" + } + } + }, + "GetPublicKeyResult": { + "type": "structure", + "members": { + "PublicKey": { + "shape": "PublicKey", + "documentation": "

Return the public key.

" + }, + "ETag": { + "shape": "string", + "documentation": "

The current version of the public key. For example: E2QWRUHAPOMQZL.

", + "location": "header", + "locationName": "ETag" + } + }, + "payload": "PublicKey" + }, + "GetStreamingDistributionConfigRequest": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "shape": "string", + "documentation": "

The streaming distribution's ID.

", + "location": "uri", + "locationName": "Id" + } + }, + "documentation": "

To request to get a streaming distribution configuration.

" + }, + "GetStreamingDistributionConfigResult": { + "type": "structure", + "members": { + "StreamingDistributionConfig": { + "shape": "StreamingDistributionConfig", + "documentation": "

The streaming distribution's configuration information.

" + }, + "ETag": { + "shape": "string", + "documentation": "

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location": "header", + "locationName": "ETag" + } + }, + "documentation": "

The returned result of the corresponding request.

", + "payload": "StreamingDistributionConfig" + }, + "GetStreamingDistributionRequest": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "shape": "string", + "documentation": "

The streaming distribution's ID.

", + "location": "uri", + "locationName": "Id" + } + }, + "documentation": "

The request to get a streaming distribution's information.

" + }, + "GetStreamingDistributionResult": { + "type": "structure", + "members": { + "StreamingDistribution": { + "shape": "StreamingDistribution", + "documentation": "

The streaming distribution's information.

" + }, + "ETag": { + "shape": "string", + "documentation": "

The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL.

", + "location": "header", + "locationName": "ETag" + } + }, + "documentation": "

The returned result of the corresponding request.

", + "payload": "StreamingDistribution" + }, + "HeaderList": { + "type": "list", + "member": { + "shape": "string", + "locationName": "Name" + } + }, + "Headers": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "shape": "integer", + "documentation": "

The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:

  • Forward all headers to your origin: Specify 1 for Quantity and * for Name.

    CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin.

  • Forward a whitelist of headers you specify: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in Name elements. CloudFront caches your objects based on the values in the specified headers.

  • Forward only the default headers: Specify 0 for Quantity and omit Items. In this configuration, CloudFront doesn't cache based on the values in the request headers.

Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:

" + }, + "Items": { + "shape": "HeaderList", + "documentation": "

A list that contains one Name element for each header that you want CloudFront to use for caching in this cache behavior. If Quantity is 0, omit Items.

" + } + }, + "documentation": "

A complex type that specifies the request headers, if any, that you want CloudFront to base caching on for this cache behavior.

For the headers that you specify, CloudFront caches separate versions of a specified object based on the header values in viewer requests. For example, suppose viewer requests for logo.jpg contain a custom product header that has a value of either acme or apex, and you configure CloudFront to cache your content based on values in the product header. CloudFront forwards the product header to the origin and caches the response from the origin once for each header value. For more information about caching based on header values, see How CloudFront Forwards and Caches Headers in the Amazon CloudFront Developer Guide.

" + }, + "HttpVersion": { + "type": "string", + "enum": [ + "http1.1", + "http2" + ] + }, + "ICPRecordalStatus": { + "type": "string", + "enum": [ + "APPROVED", + "SUSPENDED", + "PENDING" + ] + }, + "Invalidation": { + "type": "structure", + "required": [ + "Id", + "Status", + "CreateTime", + "InvalidationBatch" + ], + "members": { + "Id": { + "shape": "string", + "documentation": "

The identifier for the invalidation request. For example: IDFDVBD632BHDS5.

" + }, + "Status": { + "shape": "string", + "documentation": "

The status of the invalidation request. When the invalidation batch is finished, the status is Completed.

" + }, + "CreateTime": { + "shape": "timestamp", + "documentation": "

The date and time the invalidation request was first made.

" + }, + "InvalidationBatch": { + "shape": "InvalidationBatch", + "documentation": "

The current invalidation information for the batch request.

" + } + }, + "documentation": "

An invalidation.

" + }, + "InvalidationBatch": { + "type": "structure", + "required": [ + "Paths", + "CallerReference" + ], + "members": { + "Paths": { + "shape": "Paths", + "documentation": "

A complex type that contains information about the objects that you want to invalidate. For more information, see Specifying the Objects to Invalidate in the Amazon CloudFront Developer Guide.

" + }, + "CallerReference": { + "shape": "string", + "documentation": "

A value that you specify to uniquely identify an invalidation request. CloudFront uses the value to prevent you from accidentally resubmitting an identical request. Whenever you create a new invalidation request, you must specify a new value for CallerReference and change other values in the request as applicable. One way to ensure that the value of CallerReference is unique is to use a timestamp, for example, 20120301090000.

If you make a second invalidation request with the same value for CallerReference, and if the rest of the request is the same, CloudFront doesn't create a new invalidation request. Instead, CloudFront returns information about the invalidation request that you previously created with the same CallerReference.

If CallerReference is a value you already sent in a previous invalidation batch request but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error.

" + } + }, + "documentation": "

An invalidation batch.

" + }, + "InvalidationList": { + "type": "structure", + "required": [ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members": { + "Marker": { + "shape": "string", + "documentation": "

The value that you provided for the Marker request parameter.

" + }, + "NextMarker": { + "shape": "string", + "documentation": "

If IsTruncated is true, this element is present and contains the value that you can use for the Marker request parameter to continue listing your invalidation batches where they left off.

" + }, + "MaxItems": { + "shape": "integer", + "documentation": "

The value that you provided for the MaxItems request parameter.

" + }, + "IsTruncated": { + "shape": "boolean", + "documentation": "

A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more invalidation batches in the list.

" + }, + "Quantity": { + "shape": "integer", + "documentation": "

The number of invalidation batches that were created by the current AWS account.

" + }, + "Items": { + "shape": "InvalidationSummaryList", + "documentation": "

A complex type that contains one InvalidationSummary element for each invalidation batch created by the current AWS account.

" + } + }, + "documentation": "

The InvalidationList complex type describes the list of invalidation objects. For more information about invalidation, see Invalidating Objects (Web Distributions Only) in the Amazon CloudFront Developer Guide.

" + }, + "InvalidationSummary": { + "type": "structure", + "required": [ + "Id", + "CreateTime", + "Status" + ], + "members": { + "Id": { + "shape": "string", + "documentation": "

The unique ID for an invalidation request.

" + }, + "CreateTime": { + "shape": "timestamp", + "documentation": "

The time that an invalidation request was created.

" + }, + "Status": { + "shape": "string", + "documentation": "

The status of an invalidation request.

" + } + }, + "documentation": "

A summary of an invalidation request.

" + }, + "InvalidationSummaryList": { + "type": "list", + "member": { + "shape": "InvalidationSummary", + "locationName": "InvalidationSummary" + } + }, + "ItemSelection": { + "type": "string", + "enum": [ + "none", + "whitelist", + "all" + ] + }, + "KeyPairIdList": { + "type": "list", + "member": { + "shape": "string", + "locationName": "KeyPairId" + } + }, + "KeyPairIds": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "shape": "integer", + "documentation": "

The number of active CloudFront key pairs for AwsAccountNumber.

For more information, see ActiveTrustedSigners.

" + }, + "Items": { + "shape": "KeyPairIdList", + "documentation": "

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

For more information, see ActiveTrustedSigners.

" + } + }, + "documentation": "

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

For more information, see ActiveTrustedSigners.

" + }, + "LambdaFunctionARN": { + "type": "string" + }, + "LambdaFunctionAssociation": { + "type": "structure", + "required": [ + "LambdaFunctionARN", + "EventType" + ], + "members": { + "LambdaFunctionARN": { + "shape": "LambdaFunctionARN", + "documentation": "

The ARN of the Lambda function. You must specify the ARN of a function version; you can't specify a Lambda alias or $LATEST.

" + }, + "EventType": { + "shape": "EventType", + "documentation": "

Specifies the event type that triggers a Lambda function invocation. You can specify the following values:

  • viewer-request: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.

  • origin-request: The function executes only when CloudFront forwards a request to your origin. When the requested object is in the edge cache, the function doesn't execute.

  • origin-response: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.

  • viewer-response: The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache.

    If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.

" + }, + "IncludeBody": { + "shape": "boolean", + "documentation": "

A flag that allows a Lambda function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.

" + } + }, + "documentation": "

A complex type that contains a Lambda function association.

" + }, + "LambdaFunctionAssociationList": { + "type": "list", + "member": { + "shape": "LambdaFunctionAssociation", + "locationName": "LambdaFunctionAssociation" + } + }, + "LambdaFunctionAssociations": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "shape": "integer", + "documentation": "

The number of Lambda function associations for this cache behavior.

" + }, + "Items": { + "shape": "LambdaFunctionAssociationList", + "documentation": "

Optional: A complex type that contains LambdaFunctionAssociation items for this cache behavior. If Quantity is 0, you can omit Items.

" + } + }, + "documentation": "

A complex type that specifies a list of Lambda functions associations for a cache behavior.

If you want to invoke one or more Lambda functions triggered by requests that match the PathPattern of the cache behavior, specify the applicable values for Quantity and Items. Note that there can be up to 4 LambdaFunctionAssociation items in this list (one for each possible value of EventType) and each EventType can be associated with the Lambda function only once.

If you don't want to invoke any Lambda functions for the requests that match PathPattern, specify 0 for Quantity and omit Items.

" + }, + "ListCloudFrontOriginAccessIdentitiesRequest": { + "type": "structure", + "members": { + "Marker": { + "shape": "string", + "documentation": "

Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).

", + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "shape": "string", + "documentation": "

The maximum number of origin access identities you want in the response body.

", + "location": "querystring", + "locationName": "MaxItems" + } + }, + "documentation": "

The request to list origin access identities.

" + }, + "ListCloudFrontOriginAccessIdentitiesResult": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentityList": { + "shape": "CloudFrontOriginAccessIdentityList", + "documentation": "

The CloudFrontOriginAccessIdentityList type.

" + } + }, + "documentation": "

The returned result of the corresponding request.

", + "payload": "CloudFrontOriginAccessIdentityList" + }, + "ListDistributionsByWebACLIdRequest": { + "type": "structure", + "required": [ + "WebACLId" + ], + "members": { + "Marker": { + "shape": "string", + "documentation": "

Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)

", + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "shape": "string", + "documentation": "

The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.

", + "location": "querystring", + "locationName": "MaxItems" + }, + "WebACLId": { + "shape": "string", + "documentation": "

The ID of the AWS WAF web ACL that you want to list the associated distributions. If you specify \"null\" for the ID, the request returns a list of the distributions that aren't associated with a web ACL.

", + "location": "uri", + "locationName": "WebACLId" + } + }, + "documentation": "

The request to list distributions that are associated with a specified AWS WAF web ACL.

" + }, + "ListDistributionsByWebACLIdResult": { + "type": "structure", + "members": { + "DistributionList": { + "shape": "DistributionList", + "documentation": "

The DistributionList type.

" + } + }, + "documentation": "

The response to a request to list the distributions that are associated with a specified AWS WAF web ACL.

", + "payload": "DistributionList" + }, + "ListDistributionsRequest": { + "type": "structure", + "members": { + "Marker": { + "shape": "string", + "documentation": "

Use this when paginating results to indicate where to begin in your list of distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page).

", + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "shape": "string", + "documentation": "

The maximum number of distributions you want in the response body.

", + "location": "querystring", + "locationName": "MaxItems" + } + }, + "documentation": "

The request to list your distributions.

" + }, + "ListDistributionsResult": { + "type": "structure", + "members": { + "DistributionList": { + "shape": "DistributionList", + "documentation": "

The DistributionList type.

" + } + }, + "documentation": "

The returned result of the corresponding request.

", + "payload": "DistributionList" + }, + "ListFieldLevelEncryptionConfigsRequest": { + "type": "structure", + "members": { + "Marker": { + "shape": "string", + "documentation": "

Use this when paginating results to indicate where to begin in your list of configurations. The results include configurations in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last configuration on that page).

", + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "shape": "string", + "documentation": "

The maximum number of field-level encryption configurations you want in the response body.

", + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "ListFieldLevelEncryptionConfigsResult": { + "type": "structure", + "members": { + "FieldLevelEncryptionList": { + "shape": "FieldLevelEncryptionList", + "documentation": "

Returns a list of all field-level encryption configurations that have been created in CloudFront for this account.

" + } + }, + "payload": "FieldLevelEncryptionList" + }, + "ListFieldLevelEncryptionProfilesRequest": { + "type": "structure", + "members": { + "Marker": { + "shape": "string", + "documentation": "

Use this when paginating results to indicate where to begin in your list of profiles. The results include profiles in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last profile on that page).

", + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "shape": "string", + "documentation": "

The maximum number of field-level encryption profiles you want in the response body.

", + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "ListFieldLevelEncryptionProfilesResult": { + "type": "structure", + "members": { + "FieldLevelEncryptionProfileList": { + "shape": "FieldLevelEncryptionProfileList", + "documentation": "

Returns a list of the field-level encryption profiles that have been created in CloudFront for this account.

" + } + }, + "payload": "FieldLevelEncryptionProfileList" + }, + "ListInvalidationsRequest": { + "type": "structure", + "required": [ + "DistributionId" + ], + "members": { + "DistributionId": { + "shape": "string", + "documentation": "

The distribution's ID.

", + "location": "uri", + "locationName": "DistributionId" + }, + "Marker": { + "shape": "string", + "documentation": "

Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page.

", + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "shape": "string", + "documentation": "

The maximum number of invalidation batches that you want in the response body.

", + "location": "querystring", + "locationName": "MaxItems" + } + }, + "documentation": "

The request to list invalidations.

" + }, + "ListInvalidationsResult": { + "type": "structure", + "members": { + "InvalidationList": { + "shape": "InvalidationList", + "documentation": "

Information about invalidation batches.

" + } + }, + "documentation": "

The returned result of the corresponding request.

", + "payload": "InvalidationList" + }, + "ListPublicKeysRequest": { + "type": "structure", + "members": { + "Marker": { + "shape": "string", + "documentation": "

Use this when paginating results to indicate where to begin in your list of public keys. The results include public keys in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last public key on that page).

", + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "shape": "string", + "documentation": "

The maximum number of public keys you want in the response body.

", + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "ListPublicKeysResult": { + "type": "structure", + "members": { + "PublicKeyList": { + "shape": "PublicKeyList", + "documentation": "

Returns a list of all public keys that have been added to CloudFront for this account.

" + } + }, + "payload": "PublicKeyList" + }, + "ListStreamingDistributionsRequest": { + "type": "structure", + "members": { + "Marker": { + "shape": "string", + "documentation": "

The value that you provided for the Marker request parameter.

", + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "shape": "string", + "documentation": "

The value that you provided for the MaxItems request parameter.

", + "location": "querystring", + "locationName": "MaxItems" + } + }, + "documentation": "

The request to list your streaming distributions.

" + }, + "ListStreamingDistributionsResult": { + "type": "structure", + "members": { + "StreamingDistributionList": { + "shape": "StreamingDistributionList", + "documentation": "

The StreamingDistributionList type.

" + } + }, + "documentation": "

The returned result of the corresponding request.

", + "payload": "StreamingDistributionList" + }, + "ListTagsForResourceRequest": { + "type": "structure", + "required": [ + "Resource" + ], + "members": { + "Resource": { + "shape": "ResourceARN", + "documentation": "

An ARN of a CloudFront resource.

", + "location": "querystring", + "locationName": "Resource" + } + }, + "documentation": "

The request to list tags for a CloudFront resource.

" + }, + "ListTagsForResourceResult": { + "type": "structure", + "required": [ + "Tags" + ], + "members": { + "Tags": { + "shape": "Tags", + "documentation": "

A complex type that contains zero or more Tag elements.

" + } + }, + "documentation": "

The returned result of the corresponding request.

", + "payload": "Tags" + }, + "LocationList": { + "type": "list", + "member": { + "shape": "string", + "locationName": "Location" + } + }, + "LoggingConfig": { + "type": "structure", + "required": [ + "Enabled", + "IncludeCookies", + "Bucket", + "Prefix" + ], + "members": { + "Enabled": { + "shape": "boolean", + "documentation": "

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix, and IncludeCookies, the values are automatically deleted.

" + }, + "IncludeCookies": { + "shape": "boolean", + "documentation": "

Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies.

" + }, + "Bucket": { + "shape": "string", + "documentation": "

The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.

" + }, + "Prefix": { + "shape": "string", + "documentation": "

An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.

" + } + }, + "documentation": "

A complex type that controls whether access logs are written for the distribution.

" + }, + "Method": { + "type": "string", + "enum": [ + "GET", + "HEAD", + "POST", + "PUT", + "PATCH", + "OPTIONS", + "DELETE" + ] + }, + "MethodsList": { + "type": "list", + "member": { + "shape": "Method", + "locationName": "Method" + } + }, + "MinimumProtocolVersion": { + "type": "string", + "enum": [ + "SSLv3", + "TLSv1", + "TLSv1_2016", + "TLSv1.1_2016", + "TLSv1.2_2018" + ] + }, + "Origin": { + "type": "structure", + "required": [ + "Id", + "DomainName" + ], + "members": { + "Id": { + "shape": "string", + "documentation": "

A unique identifier for the origin or origin group. The value of Id must be unique within the distribution.

When you specify the value of TargetOriginId for the default cache behavior or for another cache behavior, you indicate the origin to which you want the cache behavior to route requests by specifying the value of the Id element for that origin. When a request matches the path pattern for that cache behavior, CloudFront routes the request to the specified origin. For more information, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.

" + }, + "DomainName": { + "shape": "string", + "documentation": "

Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. If you set up your bucket to be configured as a website endpoint, enter the Amazon S3 static website hosting endpoint for the bucket.

For more information about specifying this value for different types of origins, see Origin Domain Name in the Amazon CloudFront Developer Guide.

Constraints for Amazon S3 origins:

  • If you configured Amazon S3 Transfer Acceleration for your bucket, don't specify the s3-accelerate endpoint for DomainName.

  • The bucket name must be between 3 and 63 characters long (inclusive).

  • The bucket name must contain only lowercase characters, numbers, periods, underscores, and dashes.

  • The bucket name must not contain adjacent periods.

Custom Origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com.

Constraints for custom origins:

  • DomainName must be a valid DNS name that contains only a-z, A-Z, 0-9, dot (.), hyphen (-), or underscore (_) characters.

  • The name cannot exceed 128 characters.

" + }, + "OriginPath": { + "shape": "string", + "documentation": "

An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the OriginPath element, specify the directory name, beginning with a /. CloudFront appends the directory name to the value of DomainName, for example, example.com/production. Do not include a / at the end of the directory name.

For example, suppose you've specified the following values for your distribution:

  • DomainName: An Amazon S3 bucket named myawsbucket.

  • OriginPath: /production

  • CNAME: example.com

When a user enters example.com/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/index.html.

When a user enters example.com/acme/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/acme/index.html.

" + }, + "CustomHeaders": { + "shape": "CustomHeaders", + "documentation": "

A complex type that contains names and values for the custom headers that you want.

" + }, + "S3OriginConfig": { + "shape": "S3OriginConfig", + "documentation": "

A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead.

" + }, + "CustomOriginConfig": { + "shape": "CustomOriginConfig", + "documentation": "

A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead.

" + } + }, + "documentation": "

A complex type that describes the Amazon S3 bucket, HTTP server (for example, a web server), Amazon MediaStore, or other server from which CloudFront gets your files. This can also be an origin group, if you've created an origin group. You must specify at least one origin or origin group.

For the current limit on the number of origins or origin groups that you can specify for a distribution, see Amazon CloudFront Limits in the AWS General Reference.

" + }, + "OriginCustomHeader": { + "type": "structure", + "required": [ + "HeaderName", + "HeaderValue" + ], + "members": { + "HeaderName": { + "shape": "string", + "documentation": "

The name of a header that you want CloudFront to forward to your origin. For more information, see Forwarding Custom Headers to Your Origin (Web Distributions Only) in the Amazon CloudFront Developer Guide.

" + }, + "HeaderValue": { + "shape": "string", + "documentation": "

The value for the header that you specified in the HeaderName field.

" + } + }, + "documentation": "

A complex type that contains HeaderName and HeaderValue elements, if any, for this distribution.

" + }, + "OriginCustomHeadersList": { + "type": "list", + "member": { + "shape": "OriginCustomHeader", + "locationName": "OriginCustomHeader" + } + }, + "OriginGroup": { + "type": "structure", + "required": [ + "Id", + "FailoverCriteria", + "Members" + ], + "members": { + "Id": { + "shape": "string", + "documentation": "

The origin group's ID.

" + }, + "FailoverCriteria": { + "shape": "OriginGroupFailoverCriteria", + "documentation": "

A complex type that contains information about the failover criteria for an origin group.

" + }, + "Members": { + "shape": "OriginGroupMembers", + "documentation": "

A complex type that contains information about the origins in an origin group.

" + } + }, + "documentation": "

An origin group includes two origins (a primary origin and a second origin to failover to) and a failover criteria that you specify. You create an origin group to support origin failover in CloudFront. When you create or update a distribution, you can specifiy the origin group instead of a single origin, and CloudFront will failover from the primary origin to the second origin under the failover conditions that you've chosen.

" + }, + "OriginGroupFailoverCriteria": { + "type": "structure", + "required": [ + "StatusCodes" + ], + "members": { + "StatusCodes": { + "shape": "StatusCodes", + "documentation": "

The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.

" + } + }, + "documentation": "

A complex data type that includes information about the failover criteria for an origin group, including the status codes for which CloudFront will failover from the primary origin to the second origin.

" + }, + "OriginGroupList": { + "type": "list", + "member": { + "shape": "OriginGroup", + "locationName": "OriginGroup" + }, + "documentation": "

List of origin groups for a distribution.

" + }, + "OriginGroupMember": { + "type": "structure", + "required": [ + "OriginId" + ], + "members": { + "OriginId": { + "shape": "string", + "documentation": "

The ID for an origin in an origin group.

" + } + }, + "documentation": "

An origin in an origin group.

" + }, + "OriginGroupMemberList": { + "type": "list", + "member": { + "shape": "OriginGroupMember", + "locationName": "OriginGroupMember" + }, + "documentation": "

List of origins in an origin group.

", + "max": 2, + "min": 2 + }, + "OriginGroupMembers": { + "type": "structure", + "required": [ + "Quantity", + "Items" + ], + "members": { + "Quantity": { + "shape": "integer", + "documentation": "

The number of origins in an origin group.

" + }, + "Items": { + "shape": "OriginGroupMemberList", + "documentation": "

Items (origins) in an origin group.

" + } + }, + "documentation": "

A complex data type for the origins included in an origin group.

" + }, + "OriginGroups": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "shape": "integer", + "documentation": "

The number of origin groups.

" + }, + "Items": { + "shape": "OriginGroupList", + "documentation": "

The items (origin groups) in a distribution.

" + } + }, + "documentation": "

A complex data type for the origin groups specified for a distribution.

" + }, + "OriginList": { + "type": "list", + "member": { + "shape": "Origin", + "locationName": "Origin" + }, + "min": 1 + }, + "OriginProtocolPolicy": { + "type": "string", + "enum": [ + "http-only", + "match-viewer", + "https-only" + ] + }, + "OriginSslProtocols": { + "type": "structure", + "required": [ + "Quantity", + "Items" + ], + "members": { + "Quantity": { + "shape": "integer", + "documentation": "

The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.

" + }, + "Items": { + "shape": "SslProtocolsList", + "documentation": "

A list that contains allowed SSL/TLS protocols for this distribution.

" + } + }, + "documentation": "

A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin.

" + }, + "Origins": { + "type": "structure", + "required": [ + "Quantity", + "Items" + ], + "members": { + "Quantity": { + "shape": "integer", + "documentation": "

The number of origins or origin groups for this distribution.

" + }, + "Items": { + "shape": "OriginList", + "documentation": "

A complex type that contains origins or origin groups for this distribution.

" + } + }, + "documentation": "

A complex type that contains information about origins and origin groups for this distribution.

" + }, + "PathList": { + "type": "list", + "member": { + "shape": "string", + "locationName": "Path" + } + }, + "Paths": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "shape": "integer", + "documentation": "

The number of invalidation paths specified for the objects that you want to invalidate.

" + }, + "Items": { + "shape": "PathList", + "documentation": "

A complex type that contains a list of the paths that you want to invalidate.

" + } + }, + "documentation": "

A complex type that contains information about the objects that you want to invalidate. For more information, see Specifying the Objects to Invalidate in the Amazon CloudFront Developer Guide.

" + }, + "PriceClass": { + "type": "string", + "enum": [ + "PriceClass_100", + "PriceClass_200", + "PriceClass_All" + ] + }, + "PublicKey": { + "type": "structure", + "required": [ + "Id", + "CreatedTime", + "PublicKeyConfig" + ], + "members": { + "Id": { + "shape": "string", + "documentation": "

A unique ID assigned to a public key you've added to CloudFront.

" + }, + "CreatedTime": { + "shape": "timestamp", + "documentation": "

A time you added a public key to CloudFront.

" + }, + "PublicKeyConfig": { + "shape": "PublicKeyConfig", + "documentation": "

A complex data type for a public key you add to CloudFront to use with features like field-level encryption.

" + } + }, + "documentation": "

A complex data type of public keys you add to CloudFront to use with features like field-level encryption.

" + }, + "PublicKeyConfig": { + "type": "structure", + "required": [ + "CallerReference", + "Name", + "EncodedKey" + ], + "members": { + "CallerReference": { + "shape": "string", + "documentation": "

A unique number that ensures that the request can't be replayed.

" + }, + "Name": { + "shape": "string", + "documentation": "

The name for a public key you add to CloudFront to use with features like field-level encryption.

" + }, + "EncodedKey": { + "shape": "string", + "documentation": "

The encoded public key that you want to add to CloudFront to use with features like field-level encryption.

" + }, + "Comment": { + "shape": "string", + "documentation": "

An optional comment about a public key.

" + } + }, + "documentation": "

Information about a public key you add to CloudFront to use with features like field-level encryption.

" + }, + "PublicKeyList": { + "type": "structure", + "required": [ + "MaxItems", + "Quantity" + ], + "members": { + "NextMarker": { + "shape": "string", + "documentation": "

If there are more elements to be listed, this element is present and contains the value that you can use for the Marker request parameter to continue listing your public keys where you left off.

" + }, + "MaxItems": { + "shape": "integer", + "documentation": "

The maximum number of public keys you want in the response body.

" + }, + "Quantity": { + "shape": "integer", + "documentation": "

The number of public keys you added to CloudFront to use with features like field-level encryption.

" + }, + "Items": { + "shape": "PublicKeySummaryList", + "documentation": "

An array of information about a public key you add to CloudFront to use with features like field-level encryption.

" + } + }, + "documentation": "

A list of public keys you've added to CloudFront to use with features like field-level encryption.

" + }, + "PublicKeySummary": { + "type": "structure", + "required": [ + "Id", + "Name", + "CreatedTime", + "EncodedKey" + ], + "members": { + "Id": { + "shape": "string", + "documentation": "

ID for public key information summary.

" + }, + "Name": { + "shape": "string", + "documentation": "

Name for public key information summary.

" + }, + "CreatedTime": { + "shape": "timestamp", + "documentation": "

Creation time for public key information summary.

" + }, + "EncodedKey": { + "shape": "string", + "documentation": "

Encoded key for public key information summary.

" + }, + "Comment": { + "shape": "string", + "documentation": "

Comment for public key information summary.

" + } + }, + "documentation": "

A complex data type for public key information.

" + }, + "PublicKeySummaryList": { + "type": "list", + "member": { + "shape": "PublicKeySummary", + "locationName": "PublicKeySummary" + } + }, + "QueryArgProfile": { + "type": "structure", + "required": [ + "QueryArg", + "ProfileId" + ], + "members": { + "QueryArg": { + "shape": "string", + "documentation": "

Query argument for field-level encryption query argument-profile mapping.

" + }, + "ProfileId": { + "shape": "string", + "documentation": "

ID of profile to use for field-level encryption query argument-profile mapping

" + } + }, + "documentation": "

Query argument-profile mapping for field-level encryption.

" + }, + "QueryArgProfileConfig": { + "type": "structure", + "required": [ + "ForwardWhenQueryArgProfileIsUnknown" + ], + "members": { + "ForwardWhenQueryArgProfileIsUnknown": { + "shape": "boolean", + "documentation": "

Flag to set if you want a request to be forwarded to the origin even if the profile specified by the field-level encryption query argument, fle-profile, is unknown.

" + }, + "QueryArgProfiles": { + "shape": "QueryArgProfiles", + "documentation": "

Profiles specified for query argument-profile mapping for field-level encryption.

" + } + }, + "documentation": "

Configuration for query argument-profile mapping for field-level encryption.

" + }, + "QueryArgProfileList": { + "type": "list", + "member": { + "shape": "QueryArgProfile", + "locationName": "QueryArgProfile" + } + }, + "QueryArgProfiles": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "shape": "integer", + "documentation": "

Number of profiles for query argument-profile mapping for field-level encryption.

" + }, + "Items": { + "shape": "QueryArgProfileList", + "documentation": "

Number of items for query argument-profile mapping for field-level encryption.

" + } + }, + "documentation": "

Query argument-profile mapping for field-level encryption.

" + }, + "QueryStringCacheKeys": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "shape": "integer", + "documentation": "

The number of whitelisted query string parameters for a cache behavior.

" + }, + "Items": { + "shape": "QueryStringCacheKeysList", + "documentation": "

A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items.

" + } + }, + "documentation": "

A complex type that contains information about the query string parameters that you want CloudFront to use for caching for a cache behavior.

" + }, + "QueryStringCacheKeysList": { + "type": "list", + "member": { + "shape": "string", + "locationName": "Name" + } + }, + "ResourceARN": { + "type": "string", + "pattern": "arn:aws(-cn)?:cloudfront::[0-9]+:.*" + }, + "Restrictions": { + "type": "structure", + "required": [ + "GeoRestriction" + ], + "members": { + "GeoRestriction": { + "shape": "GeoRestriction", + "documentation": "

A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.

" + } + }, + "documentation": "

A complex type that identifies ways in which you want to restrict distribution of your content.

" + }, + "S3Origin": { + "type": "structure", + "required": [ + "DomainName", + "OriginAccessIdentity" + ], + "members": { + "DomainName": { + "shape": "string", + "documentation": "

The DNS name of the Amazon S3 origin.

" + }, + "OriginAccessIdentity": { + "shape": "string", + "documentation": "

The CloudFront origin access identity to associate with the distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an Amazon S3 bucket through CloudFront.

If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in the Amazon CloudFront Developer Guide.

" + } + }, + "documentation": "

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

" + }, + "S3OriginConfig": { + "type": "structure", + "required": [ + "OriginAccessIdentity" + ], + "members": { + "OriginAccessIdentity": { + "shape": "string", + "documentation": "

The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:

origin-access-identity/cloudfront/ID-of-origin-access-identity

where ID-of-origin-access-identity is the value that CloudFront returned in the ID element when you created the origin access identity.

If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + } + }, + "documentation": "

A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead.

" + }, + "SSLSupportMethod": { + "type": "string", + "enum": [ + "sni-only", + "vip" + ] + }, + "Signer": { + "type": "structure", + "members": { + "AwsAccountNumber": { + "shape": "string", + "documentation": "

An AWS account that is included in the TrustedSigners complex type for this distribution. Valid values include:

  • self, which is the AWS account used to create the distribution.

  • An AWS account number.

" + }, + "KeyPairIds": { + "shape": "KeyPairIds", + "documentation": "

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

" + } + }, + "documentation": "

A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any.

" + }, + "SignerList": { + "type": "list", + "member": { + "shape": "Signer", + "locationName": "Signer" + } + }, + "SslProtocol": { + "type": "string", + "enum": [ + "SSLv3", + "TLSv1", + "TLSv1.1", + "TLSv1.2" + ] + }, + "SslProtocolsList": { + "type": "list", + "member": { + "shape": "SslProtocol", + "locationName": "SslProtocol" + } + }, + "StatusCodeList": { + "type": "list", + "member": { + "shape": "integer", + "locationName": "StatusCode" + }, + "documentation": "

List of status codes for origin failover.

", + "min": 1 + }, + "StatusCodes": { + "type": "structure", + "required": [ + "Quantity", + "Items" + ], + "members": { + "Quantity": { + "shape": "integer", + "documentation": "

The number of status codes.

" + }, + "Items": { + "shape": "StatusCodeList", + "documentation": "

The items (status codes) for an origin group.

" + } + }, + "documentation": "

A complex data type for the status codes that you specify that, when returned by a primary origin, trigger CloudFront to failover to a second origin.

" + }, + "StreamingDistribution": { + "type": "structure", + "required": [ + "Id", + "ARN", + "Status", + "DomainName", + "ActiveTrustedSigners", + "StreamingDistributionConfig" + ], + "members": { + "Id": { + "shape": "string", + "documentation": "

The identifier for the RTMP distribution. For example: EGTXBD79EXAMPLE.

" + }, + "ARN": { + "shape": "string", + "documentation": "

The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

" + }, + "Status": { + "shape": "string", + "documentation": "

The current status of the RTMP distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations.

" + }, + "LastModifiedTime": { + "shape": "timestamp", + "documentation": "

The date and time that the distribution was last modified.

" + }, + "DomainName": { + "shape": "string", + "documentation": "

The domain name that corresponds to the streaming distribution, for example, s5c39gqb8ow64r.cloudfront.net.

" + }, + "ActiveTrustedSigners": { + "shape": "ActiveTrustedSigners", + "documentation": "

A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content.

The Signer complex type lists the AWS account number of the trusted signer or self if the signer is the AWS account that created the distribution. The Signer element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create signed URLs.

For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "StreamingDistributionConfig": { + "shape": "StreamingDistributionConfig", + "documentation": "

The current configuration information for the RTMP distribution.

" + } + }, + "documentation": "

A streaming distribution tells CloudFront where you want RTMP content to be delivered from, and the details about how to track and manage content delivery.

" + }, + "StreamingDistributionConfig": { + "type": "structure", + "required": [ + "CallerReference", + "S3Origin", + "Comment", + "TrustedSigners", + "Enabled" + ], + "members": { + "CallerReference": { + "shape": "string", + "documentation": "

A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.

If the value of CallerReference is new (regardless of the content of the StreamingDistributionConfig object), CloudFront creates a new distribution.

If CallerReference is a value that you already sent in a previous request to create a distribution, CloudFront returns a DistributionAlreadyExists error.

" + }, + "S3Origin": { + "shape": "S3Origin", + "documentation": "

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

" + }, + "Aliases": { + "shape": "Aliases", + "documentation": "

A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.

" + }, + "Comment": { + "shape": "string", + "documentation": "

Any comments you want to include about the streaming distribution.

" + }, + "Logging": { + "shape": "StreamingLoggingConfig", + "documentation": "

A complex type that controls whether access logs are written for the streaming distribution.

" + }, + "TrustedSigners": { + "shape": "TrustedSigners", + "documentation": "

A complex type that specifies any AWS accounts that you want to permit to create signed URLs for private content. If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element. For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "PriceClass": { + "shape": "PriceClass", + "documentation": "

A complex type that contains information about price class for this streaming distribution.

" + }, + "Enabled": { + "shape": "boolean", + "documentation": "

Whether the streaming distribution is enabled to accept user requests for content.

" + } + }, + "documentation": "

The RTMP distribution's configuration information.

" + }, + "StreamingDistributionConfigWithTags": { + "type": "structure", + "required": [ + "StreamingDistributionConfig", + "Tags" + ], + "members": { + "StreamingDistributionConfig": { + "shape": "StreamingDistributionConfig", + "documentation": "

A streaming distribution Configuration.

" + }, + "Tags": { + "shape": "Tags", + "documentation": "

A complex type that contains zero or more Tag elements.

" + } + }, + "documentation": "

A streaming distribution Configuration and a list of tags to be associated with the streaming distribution.

" + }, + "StreamingDistributionList": { + "type": "structure", + "required": [ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members": { + "Marker": { + "shape": "string", + "documentation": "

The value you provided for the Marker request parameter.

" + }, + "NextMarker": { + "shape": "string", + "documentation": "

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your RTMP distributions where they left off.

" + }, + "MaxItems": { + "shape": "integer", + "documentation": "

The value you provided for the MaxItems request parameter.

" + }, + "IsTruncated": { + "shape": "boolean", + "documentation": "

A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list.

" + }, + "Quantity": { + "shape": "integer", + "documentation": "

The number of streaming distributions that were created by the current AWS account.

" + }, + "Items": { + "shape": "StreamingDistributionSummaryList", + "documentation": "

A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account.

" + } + }, + "documentation": "

A streaming distribution list.

" + }, + "StreamingDistributionSummary": { + "type": "structure", + "required": [ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "DomainName", + "S3Origin", + "Aliases", + "TrustedSigners", + "Comment", + "PriceClass", + "Enabled" + ], + "members": { + "Id": { + "shape": "string", + "documentation": "

The identifier for the distribution, for example, EDFDVBD632BHDS5.

" + }, + "ARN": { + "shape": "string", + "documentation": "

The ARN (Amazon Resource Name) for the streaming distribution. For example: arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

" + }, + "Status": { + "shape": "string", + "documentation": "

Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.

" + }, + "LastModifiedTime": { + "shape": "timestamp", + "documentation": "

The date and time the distribution was last modified.

" + }, + "DomainName": { + "shape": "string", + "documentation": "

The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net.

" + }, + "S3Origin": { + "shape": "S3Origin", + "documentation": "

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

" + }, + "Aliases": { + "shape": "Aliases", + "documentation": "

A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.

" + }, + "TrustedSigners": { + "shape": "TrustedSigners", + "documentation": "

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items.If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "Comment": { + "shape": "string", + "documentation": "

The comment originally specified when this distribution was created.

" + }, + "PriceClass": { + "shape": "PriceClass", + "documentation": "

A complex type that contains information about price class for this streaming distribution.

" + }, + "Enabled": { + "shape": "boolean", + "documentation": "

Whether the distribution is enabled to accept end user requests for content.

" + } + }, + "documentation": "

A summary of the information for a CloudFront streaming distribution.

" + }, + "StreamingDistributionSummaryList": { + "type": "list", + "member": { + "shape": "StreamingDistributionSummary", + "locationName": "StreamingDistributionSummary" + } + }, + "StreamingLoggingConfig": { + "type": "structure", + "required": [ + "Enabled", + "Bucket", + "Prefix" + ], + "members": { + "Enabled": { + "shape": "boolean", + "documentation": "

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted.

" + }, + "Bucket": { + "shape": "string", + "documentation": "

The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.

" + }, + "Prefix": { + "shape": "string", + "documentation": "

An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.

" + } + }, + "documentation": "

A complex type that controls whether access logs are written for this streaming distribution.

" + }, + "Tag": { + "type": "structure", + "required": [ + "Key" + ], + "members": { + "Key": { + "shape": "TagKey", + "documentation": "

A string that contains Tag key.

The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

" + }, + "Value": { + "shape": "TagValue", + "documentation": "

A string that contains an optional Tag value.

The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

" + } + }, + "documentation": "

A complex type that contains Tag key and Tag value.

" + }, + "TagKey": { + "type": "string", + "documentation": "

A string that contains Tag key.

The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

", + "max": 128, + "min": 1, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagKeyList": { + "type": "list", + "member": { + "shape": "TagKey", + "locationName": "Key" + } + }, + "TagKeys": { + "type": "structure", + "members": { + "Items": { + "shape": "TagKeyList", + "documentation": "

A complex type that contains Tag key elements.

" + } + }, + "documentation": "

A complex type that contains zero or more Tag elements.

" + }, + "TagList": { + "type": "list", + "member": { + "shape": "Tag", + "locationName": "Tag" + } + }, + "TagResourceRequest": { + "type": "structure", + "required": [ + "Resource", + "Tags" + ], + "members": { + "Resource": { + "shape": "ResourceARN", + "documentation": "

An ARN of a CloudFront resource.

", + "location": "querystring", + "locationName": "Resource" + }, + "Tags": { + "shape": "Tags", + "documentation": "

A complex type that contains zero or more Tag elements.

", + "locationName": "Tags", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2019-03-26/" + } + } + }, + "documentation": "

The request to add tags to a CloudFront resource.

", + "payload": "Tags" + }, + "TagValue": { + "type": "string", + "max": 256, + "min": 0, + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "Tags": { + "type": "structure", + "members": { + "Items": { + "shape": "TagList", + "documentation": "

A complex type that contains Tag elements.

" + } + }, + "documentation": "

A complex type that contains zero or more Tag elements.

" + }, + "TrustedSigners": { + "type": "structure", + "required": [ + "Enabled", + "Quantity" + ], + "members": { + "Enabled": { + "shape": "boolean", + "documentation": "

Specifies whether you want to require viewers to use signed URLs to access the files specified by PathPattern and TargetOriginId.

" + }, + "Quantity": { + "shape": "integer", + "documentation": "

The number of trusted signers for this cache behavior.

" + }, + "Items": { + "shape": "AwsAccountNumberList", + "documentation": "

Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items.

" + } + }, + "documentation": "

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

For more information about updating the distribution configuration, see DistributionConfig in the Amazon CloudFront API Reference.

" + }, + "UntagResourceRequest": { + "type": "structure", + "required": [ + "Resource", + "TagKeys" + ], + "members": { + "Resource": { + "shape": "ResourceARN", + "documentation": "

An ARN of a CloudFront resource.

", + "location": "querystring", + "locationName": "Resource" + }, + "TagKeys": { + "shape": "TagKeys", + "documentation": "

A complex type that contains zero or more Tag key elements.

", + "locationName": "TagKeys", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2019-03-26/" + } + } + }, + "documentation": "

The request to remove tags from a CloudFront resource.

", + "payload": "TagKeys" + }, + "UpdateCloudFrontOriginAccessIdentityRequest": { + "type": "structure", + "required": [ + "CloudFrontOriginAccessIdentityConfig", + "Id" + ], + "members": { + "CloudFrontOriginAccessIdentityConfig": { + "shape": "CloudFrontOriginAccessIdentityConfig", + "documentation": "

The identity's configuration information.

", + "locationName": "CloudFrontOriginAccessIdentityConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2019-03-26/" + } + }, + "Id": { + "shape": "string", + "documentation": "

The identity's id.

", + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "shape": "string", + "documentation": "

The value of the ETag header that you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL.

", + "location": "header", + "locationName": "If-Match" + } + }, + "documentation": "

The request to update an origin access identity.

", + "payload": "CloudFrontOriginAccessIdentityConfig" + }, + "UpdateCloudFrontOriginAccessIdentityResult": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentity": { + "shape": "CloudFrontOriginAccessIdentity", + "documentation": "

The origin access identity's information.

" + }, + "ETag": { + "shape": "string", + "documentation": "

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location": "header", + "locationName": "ETag" + } + }, + "documentation": "

The returned result of the corresponding request.

", + "payload": "CloudFrontOriginAccessIdentity" + }, + "UpdateDistributionRequest": { + "type": "structure", + "required": [ + "DistributionConfig", + "Id" + ], + "members": { + "DistributionConfig": { + "shape": "DistributionConfig", + "documentation": "

The distribution's configuration information.

", + "locationName": "DistributionConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2019-03-26/" + } + }, + "Id": { + "shape": "string", + "documentation": "

The distribution's id.

", + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "shape": "string", + "documentation": "

The value of the ETag header that you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.

", + "location": "header", + "locationName": "If-Match" + } + }, + "documentation": "

The request to update a distribution.

", + "payload": "DistributionConfig" + }, + "UpdateDistributionResult": { + "type": "structure", + "members": { + "Distribution": { + "shape": "Distribution", + "documentation": "

The distribution's information.

" + }, + "ETag": { + "shape": "string", + "documentation": "

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location": "header", + "locationName": "ETag" + } + }, + "documentation": "

The returned result of the corresponding request.

", + "payload": "Distribution" + }, + "UpdateFieldLevelEncryptionConfigRequest": { + "type": "structure", + "required": [ + "FieldLevelEncryptionConfig", + "Id" + ], + "members": { + "FieldLevelEncryptionConfig": { + "shape": "FieldLevelEncryptionConfig", + "documentation": "

Request to update a field-level encryption configuration.

", + "locationName": "FieldLevelEncryptionConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2019-03-26/" + } + }, + "Id": { + "shape": "string", + "documentation": "

The ID of the configuration you want to update.

", + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "shape": "string", + "documentation": "

The value of the ETag header that you received when retrieving the configuration identity to update. For example: E2QWRUHAPOMQZL.

", + "location": "header", + "locationName": "If-Match" + } + }, + "payload": "FieldLevelEncryptionConfig" + }, + "UpdateFieldLevelEncryptionConfigResult": { + "type": "structure", + "members": { + "FieldLevelEncryption": { + "shape": "FieldLevelEncryption", + "documentation": "

Return the results of updating the configuration.

" + }, + "ETag": { + "shape": "string", + "documentation": "

The value of the ETag header that you received when updating the configuration. For example: E2QWRUHAPOMQZL.

", + "location": "header", + "locationName": "ETag" + } + }, + "payload": "FieldLevelEncryption" + }, + "UpdateFieldLevelEncryptionProfileRequest": { + "type": "structure", + "required": [ + "FieldLevelEncryptionProfileConfig", + "Id" + ], + "members": { + "FieldLevelEncryptionProfileConfig": { + "shape": "FieldLevelEncryptionProfileConfig", + "documentation": "

Request to update a field-level encryption profile.

", + "locationName": "FieldLevelEncryptionProfileConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2019-03-26/" + } + }, + "Id": { + "shape": "string", + "documentation": "

The ID of the field-level encryption profile request.

", + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "shape": "string", + "documentation": "

The value of the ETag header that you received when retrieving the profile identity to update. For example: E2QWRUHAPOMQZL.

", + "location": "header", + "locationName": "If-Match" + } + }, + "payload": "FieldLevelEncryptionProfileConfig" + }, + "UpdateFieldLevelEncryptionProfileResult": { + "type": "structure", + "members": { + "FieldLevelEncryptionProfile": { + "shape": "FieldLevelEncryptionProfile", + "documentation": "

Return the results of updating the profile.

" + }, + "ETag": { + "shape": "string", + "documentation": "

The result of the field-level encryption profile request.

", + "location": "header", + "locationName": "ETag" + } + }, + "payload": "FieldLevelEncryptionProfile" + }, + "UpdatePublicKeyRequest": { + "type": "structure", + "required": [ + "PublicKeyConfig", + "Id" + ], + "members": { + "PublicKeyConfig": { + "shape": "PublicKeyConfig", + "documentation": "

Request to update public key information.

", + "locationName": "PublicKeyConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2019-03-26/" + } + }, + "Id": { + "shape": "string", + "documentation": "

ID of the public key to be updated.

", + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "shape": "string", + "documentation": "

The value of the ETag header that you received when retrieving the public key to update. For example: E2QWRUHAPOMQZL.

", + "location": "header", + "locationName": "If-Match" + } + }, + "payload": "PublicKeyConfig" + }, + "UpdatePublicKeyResult": { + "type": "structure", + "members": { + "PublicKey": { + "shape": "PublicKey", + "documentation": "

Return the results of updating the public key.

" + }, + "ETag": { + "shape": "string", + "documentation": "

The current version of the update public key result. For example: E2QWRUHAPOMQZL.

", + "location": "header", + "locationName": "ETag" + } + }, + "payload": "PublicKey" + }, + "UpdateStreamingDistributionRequest": { + "type": "structure", + "required": [ + "StreamingDistributionConfig", + "Id" + ], + "members": { + "StreamingDistributionConfig": { + "shape": "StreamingDistributionConfig", + "documentation": "

The streaming distribution's configuration information.

", + "locationName": "StreamingDistributionConfig", + "xmlNamespace": { + "uri": "http://cloudfront.amazonaws.com/doc/2019-03-26/" + } + }, + "Id": { + "shape": "string", + "documentation": "

The streaming distribution's id.

", + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "shape": "string", + "documentation": "

The value of the ETag header that you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL.

", + "location": "header", + "locationName": "If-Match" + } + }, + "documentation": "

The request to update a streaming distribution.

", + "payload": "StreamingDistributionConfig" + }, + "UpdateStreamingDistributionResult": { + "type": "structure", + "members": { + "StreamingDistribution": { + "shape": "StreamingDistribution", + "documentation": "

The streaming distribution's information.

" + }, + "ETag": { + "shape": "string", + "documentation": "

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location": "header", + "locationName": "ETag" + } + }, + "documentation": "

The returned result of the corresponding request.

", + "payload": "StreamingDistribution" + }, + "ViewerCertificate": { + "type": "structure", + "members": { + "CloudFrontDefaultCertificate": { + "shape": "boolean", + "documentation": "

If you're using the CloudFront domain name for your distribution, such as d111111abcdef8.cloudfront.net, specify the following value:

  • <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>

" + }, + "IAMCertificateId": { + "shape": "string", + "documentation": "

If you want viewers to use HTTPS to request your objects and you're using an alternate domain name, you must choose the type of certificate that you want to use. Specify the following value if you purchased your certificate from a third-party certificate authority:

  • <IAMCertificateId>IAM certificate ID<IAMCertificateId> where IAM certificate ID is the ID that IAM returned when you added the certificate to the IAM certificate store.

If you specify IAMCertificateId, you must also specify a value for SSLSupportMethod.

" + }, + "ACMCertificateArn": { + "shape": "string", + "documentation": "

If you want viewers to use HTTPS to request your objects and you're using an alternate domain name, you must choose the type of certificate that you want to use. Specify the following value if ACM provided your certificate:

  • <ACMCertificateArn>ARN for ACM SSL/TLS certificate<ACMCertificateArn> where ARN for ACM SSL/TLS certificate is the ARN for the ACM SSL/TLS certificate that you want to use for this distribution.

If you specify ACMCertificateArn, you must also specify a value for SSLSupportMethod.

" + }, + "SSLSupportMethod": { + "shape": "SSLSupportMethod", + "documentation": "

If you specify a value for ACMCertificateArn or for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for browsers and clients released after 2010 or one that works for all clients.

  • sni-only: CloudFront can respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but there are a few that don't. For a current list of the browsers that support SNI, see the Wikipedia entry Server Name Indication. To learn about options to explore if you have users with browsers that don't include SNI support, see Choosing How CloudFront Serves HTTPS Requests in the Amazon CloudFront Developer Guide.

  • vip: CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, there are additional monthly charges. For details, including specific pricing information, see Custom SSL options for Amazon CloudFront on the AWS marketing site.

Don't specify a value for SSLSupportMethod if you specified <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>.

For more information, see Choosing How CloudFront Serves HTTPS Requests in the Amazon CloudFront Developer Guide.

" + }, + "MinimumProtocolVersion": { + "shape": "MinimumProtocolVersion", + "documentation": "

Specify the security policy that you want CloudFront to use for HTTPS connections. A security policy determines two settings:

  • The minimum SSL/TLS protocol that CloudFront uses to communicate with viewers

  • The cipher that CloudFront uses to encrypt the content that it returns to viewers

On the CloudFront console, this setting is called Security policy.

We recommend that you specify TLSv1.1_2016 unless your users are using browsers or devices that do not support TLSv1.1 or later.

When both of the following are true, you must specify TLSv1 or later for the security policy:

  • You're using a custom certificate: you specified a value for ACMCertificateArn or for IAMCertificateId

  • You're using SNI: you specified sni-only for SSLSupportMethod

If you specify true for CloudFrontDefaultCertificate, CloudFront automatically sets the security policy to TLSv1 regardless of the value that you specify for MinimumProtocolVersion.

For information about the relationship between the security policy that you choose and the protocols and ciphers that CloudFront uses to communicate with viewers, see Supported SSL/TLS Protocols and Ciphers for Communication Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "Certificate": { + "shape": "string", + "documentation": "

This field is no longer used. Use one of the following fields instead:

", + "deprecated": true + }, + "CertificateSource": { + "shape": "CertificateSource", + "documentation": "

This field is no longer used. Use one of the following fields instead:

", + "deprecated": true + } + }, + "documentation": "

A complex type that specifies the following:

  • Whether you want viewers to use HTTP or HTTPS to request your objects.

  • If you want viewers to use HTTPS, whether you're using an alternate domain name such as example.com or the CloudFront domain name for your distribution, such as d111111abcdef8.cloudfront.net.

  • If you're using an alternate domain name, whether AWS Certificate Manager (ACM) provided the certificate, or you purchased a certificate from a third-party certificate authority and imported it into ACM or uploaded it to the IAM certificate store.

Specify only one of the following values:

For more information, see Using Alternate Domain Names and HTTPS in the Amazon CloudFront Developer Guide.

" + }, + "ViewerProtocolPolicy": { + "type": "string", + "enum": [ + "allow-all", + "https-only", + "redirect-to-https" + ] + }, + "boolean": { + "type": "boolean" + }, + "integer": { + "type": "integer" + }, + "long": { + "type": "long" + }, + "string": { + "type": "string" + }, + "timestamp": { + "type": "timestamp" + } + }, + "documentation": "Amazon CloudFront

This is the Amazon CloudFront API Reference. This guide is for developers who need detailed information about CloudFront API actions, data types, and errors. For detailed information about CloudFront features, see the Amazon CloudFront Developer Guide.

" +} \ No newline at end of file diff --git a/aws/api/ec2-2016-11-15.normal.json b/aws/api/ec2-2016-11-15.normal.json new file mode 100644 index 0000000..cc0d566 --- /dev/null +++ b/aws/api/ec2-2016-11-15.normal.json @@ -0,0 +1,32928 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2016-11-15", + "endpointPrefix": "ec2", + "protocol": "ec2", + "serviceAbbreviation": "Amazon EC2", + "serviceFullName": "Amazon Elastic Compute Cloud", + "serviceId": "EC2", + "signatureVersion": "v4", + "uid": "ec2-2016-11-15", + "xmlNamespace": "http://ec2.amazonaws.com/doc/2016-11-15" + }, + "operations": { + "AcceptReservedInstancesExchangeQuote": { + "name": "AcceptReservedInstancesExchangeQuote", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "AcceptReservedInstancesExchangeQuoteRequest" + }, + "output": { + "shape": "AcceptReservedInstancesExchangeQuoteResult" + }, + "documentation": "

Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.

" + }, + "AcceptTransitGatewayVpcAttachment": { + "name": "AcceptTransitGatewayVpcAttachment", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "AcceptTransitGatewayVpcAttachmentRequest" + }, + "output": { + "shape": "AcceptTransitGatewayVpcAttachmentResult" + }, + "documentation": "

Accepts a request to attach a VPC to a transit gateway.

The VPC attachment must be in the pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use RejectTransitGatewayVpcAttachment to reject a VPC attachment request.

" + }, + "AcceptVpcEndpointConnections": { + "name": "AcceptVpcEndpointConnections", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "AcceptVpcEndpointConnectionsRequest" + }, + "output": { + "shape": "AcceptVpcEndpointConnectionsResult" + }, + "documentation": "

Accepts one or more interface VPC endpoint connection requests to your VPC endpoint service.

" + }, + "AcceptVpcPeeringConnection": { + "name": "AcceptVpcPeeringConnection", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "AcceptVpcPeeringConnectionRequest" + }, + "output": { + "shape": "AcceptVpcPeeringConnectionResult" + }, + "documentation": "

Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use DescribeVpcPeeringConnections to view your outstanding VPC peering connection requests.

For an inter-Region VPC peering connection request, you must accept the VPC peering connection in the Region of the accepter VPC.

" + }, + "AdvertiseByoipCidr": { + "name": "AdvertiseByoipCidr", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "AdvertiseByoipCidrRequest" + }, + "output": { + "shape": "AdvertiseByoipCidrResult" + }, + "documentation": "

Advertises an IPv4 address range that is provisioned for use with your AWS resources through bring your own IP addresses (BYOIP).

You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.

We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise it from AWS. To minimize down time, you can configure your AWS resources to use an address from a BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current location and start advertising it through AWS.

It can take a few minutes before traffic to the specified addresses starts routing to AWS because of BGP propagation delays.

To stop advertising the BYOIP CIDR, use WithdrawByoipCidr.

" + }, + "AllocateAddress": { + "name": "AllocateAddress", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "AllocateAddressRequest" + }, + "output": { + "shape": "AllocateAddressResult" + }, + "documentation": "

Allocates an Elastic IP address to your AWS account. After you allocate the Elastic IP address you can associate it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address pool and can be allocated to a different AWS account.

You can allocate an Elastic IP address from an address pool owned by AWS or from an address pool created from a public IPv4 address range that you have brought to AWS for use with your AWS resources using bring your own IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.

[EC2-VPC] If you release an Elastic IP address, you might be able to recover it. You cannot recover an Elastic IP address that you released after it is allocated to another AWS account. You cannot recover an Elastic IP address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation.

An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate 5 Elastic IP addresses for EC2-Classic per Region and 5 Elastic IP addresses for EC2-VPC per Region.

For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

" + }, + "AllocateHosts": { + "name": "AllocateHosts", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "AllocateHostsRequest" + }, + "output": { + "shape": "AllocateHostsResult" + }, + "documentation": "

Allocates a Dedicated Host to your account. At a minimum, specify the instance size type, Availability Zone, and quantity of hosts to allocate.

" + }, + "ApplySecurityGroupsToClientVpnTargetNetwork": { + "name": "ApplySecurityGroupsToClientVpnTargetNetwork", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ApplySecurityGroupsToClientVpnTargetNetworkRequest" + }, + "output": { + "shape": "ApplySecurityGroupsToClientVpnTargetNetworkResult" + }, + "documentation": "

Applies a security group to the association between the target network and the Client VPN endpoint. This action replaces the existing security groups with the specified security groups.

" + }, + "AssignIpv6Addresses": { + "name": "AssignIpv6Addresses", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "AssignIpv6AddressesRequest" + }, + "output": { + "shape": "AssignIpv6AddressesResult" + }, + "documentation": "

Assigns one or more IPv6 addresses to the specified network interface. You can specify one or more specific IPv6 addresses, or you can specify the number of IPv6 addresses to be automatically assigned from within the subnet's IPv6 CIDR block range. You can assign as many IPv6 addresses to a network interface as you can assign private IPv4 addresses, and the limit varies per instance type. For information, see IP Addresses Per Network Interface Per Instance Type in the Amazon Elastic Compute Cloud User Guide.

" + }, + "AssignPrivateIpAddresses": { + "name": "AssignPrivateIpAddresses", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "AssignPrivateIpAddressesRequest" + }, + "documentation": "

Assigns one or more secondary private IP addresses to the specified network interface.

You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

When you move a secondary private IP address to another network interface, any Elastic IP address that is associated with the IP address is also moved.

Remapping an IP address is an asynchronous operation. When you move an IP address from one network interface to another, check network/interfaces/macs/mac/local-ipv4s in the instance metadata to confirm that the remapping is complete.

" + }, + "AssociateAddress": { + "name": "AssociateAddress", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "AssociateAddressRequest" + }, + "output": { + "shape": "AssociateAddressResult" + }, + "documentation": "

Associates an Elastic IP address with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account.

[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. You cannot associate an Elastic IP address with an instance or network interface that has an existing Elastic IP address.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing.

" + }, + "AssociateClientVpnTargetNetwork": { + "name": "AssociateClientVpnTargetNetwork", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "AssociateClientVpnTargetNetworkRequest" + }, + "output": { + "shape": "AssociateClientVpnTargetNetworkResult" + }, + "documentation": "

Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy.

" + }, + "AssociateDhcpOptions": { + "name": "AssociateDhcpOptions", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "AssociateDhcpOptionsRequest" + }, + "documentation": "

Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.

After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.

For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" + }, + "AssociateIamInstanceProfile": { + "name": "AssociateIamInstanceProfile", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "AssociateIamInstanceProfileRequest" + }, + "output": { + "shape": "AssociateIamInstanceProfileResult" + }, + "documentation": "

Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance.

" + }, + "AssociateRouteTable": { + "name": "AssociateRouteTable", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "AssociateRouteTableRequest" + }, + "output": { + "shape": "AssociateRouteTableResult" + }, + "documentation": "

Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table from the subnet later. A route table can be associated with multiple subnets.

For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "AssociateSubnetCidrBlock": { + "name": "AssociateSubnetCidrBlock", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "AssociateSubnetCidrBlockRequest" + }, + "output": { + "shape": "AssociateSubnetCidrBlockResult" + }, + "documentation": "

Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR block with your subnet. An IPv6 CIDR block must have a prefix length of /64.

" + }, + "AssociateTransitGatewayRouteTable": { + "name": "AssociateTransitGatewayRouteTable", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "AssociateTransitGatewayRouteTableRequest" + }, + "output": { + "shape": "AssociateTransitGatewayRouteTableResult" + }, + "documentation": "

Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.

" + }, + "AssociateVpcCidrBlock": { + "name": "AssociateVpcCidrBlock", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "AssociateVpcCidrBlockRequest" + }, + "output": { + "shape": "AssociateVpcCidrBlockResult" + }, + "documentation": "

Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block, or you can associate an Amazon-provided IPv6 CIDR block. The IPv6 CIDR block size is fixed at /56.

For more information about associating CIDR blocks with your VPC and applicable restrictions, see VPC and Subnet Sizing in the Amazon Virtual Private Cloud User Guide.

" + }, + "AttachClassicLinkVpc": { + "name": "AttachClassicLinkVpc", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "AttachClassicLinkVpcRequest" + }, + "output": { + "shape": "AttachClassicLinkVpcResult" + }, + "documentation": "

Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the running state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it.

After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.

Linking your instance to a VPC is sometimes referred to as attaching your instance.

" + }, + "AttachInternetGateway": { + "name": "AttachInternetGateway", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "AttachInternetGatewayRequest" + }, + "documentation": "

Attaches an internet gateway to a VPC, enabling connectivity between the internet and the VPC. For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.

" + }, + "AttachNetworkInterface": { + "name": "AttachNetworkInterface", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "AttachNetworkInterfaceRequest" + }, + "output": { + "shape": "AttachNetworkInterfaceResult" + }, + "documentation": "

Attaches a network interface to an instance.

" + }, + "AttachVolume": { + "name": "AttachVolume", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "AttachVolumeRequest" + }, + "output": { + "shape": "VolumeAttachment" + }, + "documentation": "

Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.

Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

After you attach an EBS volume, you must make it available. For more information, see Making an EBS Volume Available For Use.

If a volume has an AWS Marketplace product code:

  • The volume can be attached only to a stopped instance.

  • AWS Marketplace product codes are copied from the volume to the instance.

  • You must be subscribed to the product.

  • The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance.

For more information, see Attaching Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" + }, + "AttachVpnGateway": { + "name": "AttachVpnGateway", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "AttachVpnGatewayRequest" + }, + "output": { + "shape": "AttachVpnGatewayResult" + }, + "documentation": "

Attaches a virtual private gateway to a VPC. You can attach one virtual private gateway to one VPC at a time.

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

" + }, + "AuthorizeClientVpnIngress": { + "name": "AuthorizeClientVpnIngress", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "AuthorizeClientVpnIngressRequest" + }, + "output": { + "shape": "AuthorizeClientVpnIngressResult" + }, + "documentation": "

Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in AWS or on-premises networks.

" + }, + "AuthorizeSecurityGroupEgress": { + "name": "AuthorizeSecurityGroupEgress", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "AuthorizeSecurityGroupEgressRequest" + }, + "documentation": "

[VPC only] Adds the specified egress rules to a security group for use with a VPC.

An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR address ranges, or to the instances associated with the specified destination security groups.

You specify a protocol for each rule (for example, TCP). For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.

Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.

For more information about VPC security group limits, see Amazon VPC Limits.

" + }, + "AuthorizeSecurityGroupIngress": { + "name": "AuthorizeSecurityGroupIngress", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "AuthorizeSecurityGroupIngressRequest" + }, + "documentation": "

Adds the specified ingress rules to a security group.

An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR address ranges, or from the instances associated with the specified destination security groups.

You specify a protocol for each rule (for example, TCP). For TCP and UDP, you must also specify the destination port or port range. For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. You can use -1 to mean all types or all codes.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

For more information about VPC security group limits, see Amazon VPC Limits.

" + }, + "BundleInstance": { + "name": "BundleInstance", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "BundleInstanceRequest" + }, + "output": { + "shape": "BundleInstanceResult" + }, + "documentation": "

Bundles an Amazon instance store-backed Windows instance.

During bundling, only the root device volume (C:\\) is bundled. Data on other instance store volumes is not preserved.

This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.

" + }, + "CancelBundleTask": { + "name": "CancelBundleTask", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CancelBundleTaskRequest" + }, + "output": { + "shape": "CancelBundleTaskResult" + }, + "documentation": "

Cancels a bundling operation for an instance store-backed Windows instance.

" + }, + "CancelCapacityReservation": { + "name": "CancelCapacityReservation", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CancelCapacityReservationRequest" + }, + "output": { + "shape": "CancelCapacityReservationResult" + }, + "documentation": "

Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation's state to cancelled.

Instances running in the reserved capacity continue running until you stop them. Stopped instances that target the Capacity Reservation can no longer launch. Modify these instances to either target a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation that has matching attributes and sufficient capacity.

" + }, + "CancelConversionTask": { + "name": "CancelConversionTask", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CancelConversionRequest" + }, + "documentation": "

Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.

For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.

" + }, + "CancelExportTask": { + "name": "CancelExportTask", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CancelExportTaskRequest" + }, + "documentation": "

Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.

" + }, + "CancelImportTask": { + "name": "CancelImportTask", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CancelImportTaskRequest" + }, + "output": { + "shape": "CancelImportTaskResult" + }, + "documentation": "

Cancels an in-process import virtual machine or import snapshot task.

" + }, + "CancelReservedInstancesListing": { + "name": "CancelReservedInstancesListing", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CancelReservedInstancesListingRequest" + }, + "output": { + "shape": "CancelReservedInstancesListingResult" + }, + "documentation": "

Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CancelSpotFleetRequests": { + "name": "CancelSpotFleetRequests", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CancelSpotFleetRequestsRequest" + }, + "output": { + "shape": "CancelSpotFleetRequestsResponse" + }, + "documentation": "

Cancels the specified Spot Fleet requests.

After you cancel a Spot Fleet request, the Spot Fleet launches no new Spot Instances. You must specify whether the Spot Fleet should also terminate its Spot Instances. If you terminate the instances, the Spot Fleet request enters the cancelled_terminating state. Otherwise, the Spot Fleet request enters the cancelled_running state and the instances continue to run until they are interrupted or you terminate them manually.

" + }, + "CancelSpotInstanceRequests": { + "name": "CancelSpotInstanceRequests", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CancelSpotInstanceRequestsRequest" + }, + "output": { + "shape": "CancelSpotInstanceRequestsResult" + }, + "documentation": "

Cancels one or more Spot Instance requests.

Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.

" + }, + "ConfirmProductInstance": { + "name": "ConfirmProductInstance", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ConfirmProductInstanceRequest" + }, + "output": { + "shape": "ConfirmProductInstanceResult" + }, + "documentation": "

Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner must verify whether another user's instance is eligible for support.

" + }, + "CopyFpgaImage": { + "name": "CopyFpgaImage", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CopyFpgaImageRequest" + }, + "output": { + "shape": "CopyFpgaImageResult" + }, + "documentation": "

Copies the specified Amazon FPGA Image (AFI) to the current Region.

" + }, + "CopyImage": { + "name": "CopyImage", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CopyImageRequest" + }, + "output": { + "shape": "CopyImageResult" + }, + "documentation": "

Initiates the copy of an AMI from the specified source Region to the current Region. You specify the destination Region by using its endpoint when making the request.

Copies of encrypted backing snapshots for the AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, unless you set Encrypted during the copy operation. You cannot create an unencrypted copy of an encrypted backing snapshot.

For more information about the prerequisites and limits when copying an AMI, see Copying an AMI in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CopySnapshot": { + "name": "CopySnapshot", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CopySnapshotRequest" + }, + "output": { + "shape": "CopySnapshotResult" + }, + "documentation": "

Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy the snapshot within the same Region or from one Region to another. You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).

Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless you enable encryption for the snapshot copy operation. By default, encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK); however, you can specify a different CMK.

To copy an encrypted snapshot that has been shared from another account, you must have permissions for the CMK used to encrypt the snapshot.

Snapshots created by copying another snapshot have an arbitrary volume ID that should not be used for any purpose.

For more information, see Copying an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateCapacityReservation": { + "name": "CreateCapacityReservation", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateCapacityReservationRequest" + }, + "output": { + "shape": "CreateCapacityReservationResult" + }, + "documentation": "

Creates a new Capacity Reservation with the specified attributes.

Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This gives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. By creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. For more information, see Capacity Reservations in the Amazon Elastic Compute Cloud User Guide.

Your request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to fulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try again at a later time, try in a different Availability Zone, or request a smaller capacity reservation. If your application is flexible across instance types and sizes, try to create a Capacity Reservation with different instance attributes.

Your request could also fail if the requested quantity exceeds your On-Demand Instance limit for the selected instance type. If your request fails due to limit constraints, increase your On-Demand Instance limit for the required instance type and try again. For more information about increasing your instance limits, see Amazon EC2 Service Limits in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateClientVpnEndpoint": { + "name": "CreateClientVpnEndpoint", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateClientVpnEndpointRequest" + }, + "output": { + "shape": "CreateClientVpnEndpointResult" + }, + "documentation": "

Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated.

" + }, + "CreateClientVpnRoute": { + "name": "CreateClientVpnRoute", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateClientVpnRouteRequest" + }, + "output": { + "shape": "CreateClientVpnRouteResult" + }, + "documentation": "

Adds a route to a network to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks.

" + }, + "CreateCustomerGateway": { + "name": "CreateCustomerGateway", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateCustomerGatewayRequest" + }, + "output": { + "shape": "CreateCustomerGatewayResult" + }, + "documentation": "

Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and may be behind a device performing network address translation (NAT).

For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range).

Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in the us-east-1 Region, and 9059, which is reserved in the eu-west-1 Region.

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

You cannot create more than one customer gateway with the same VPN type, IP address, and BGP ASN parameter values. If you run an identical request more than one time, the first request creates the customer gateway, and subsequent requests return information about the existing customer gateway. The subsequent requests do not create new customer gateway resources.

" + }, + "CreateDefaultSubnet": { + "name": "CreateDefaultSubnet", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateDefaultSubnetRequest" + }, + "output": { + "shape": "CreateDefaultSubnetResult" + }, + "documentation": "

Creates a default subnet with a size /20 IPv4 CIDR block in the specified Availability Zone in your default VPC. You can have only one default subnet per Availability Zone. For more information, see Creating a Default Subnet in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateDefaultVpc": { + "name": "CreateDefaultVpc", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateDefaultVpcRequest" + }, + "output": { + "shape": "CreateDefaultVpcResult" + }, + "documentation": "

Creates a default VPC with a size /16 IPv4 CIDR block and a default subnet in each Availability Zone. For more information about the components of a default VPC, see Default VPC and Default Subnets in the Amazon Virtual Private Cloud User Guide. You cannot specify the components of the default VPC yourself.

If you deleted your previous default VPC, you can create a default VPC. You cannot have more than one default VPC per Region.

If your account supports EC2-Classic, you cannot use this action to create a default VPC in a Region that supports EC2-Classic. If you want a default VPC in a Region that supports EC2-Classic, see \"I really want a default VPC for my existing EC2 account. Is that possible?\" in the Default VPCs FAQ.

" + }, + "CreateDhcpOptions": { + "name": "CreateDhcpOptions", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateDhcpOptionsRequest" + }, + "output": { + "shape": "CreateDhcpOptionsResult" + }, + "documentation": "

Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.

  • domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas. ITo have your instance to receive a custom DNS hostname as specified in domain-name, you must set domain-name-servers to a custom DNS server.

  • domain-name - If you're using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you're using AmazonProvidedDNS in another Region, specify region.compute.internal (for example, ap-northeast-1.compute.internal). Otherwise, specify a domain name (for example, MyCompany.com). This value is used to complete unqualified DNS hostnames. Important: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.

  • ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.

  • netbios-name-servers - The IP addresses of up to four NetBIOS name servers.

  • netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132.

Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateEgressOnlyInternetGateway": { + "name": "CreateEgressOnlyInternetGateway", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateEgressOnlyInternetGatewayRequest" + }, + "output": { + "shape": "CreateEgressOnlyInternetGatewayResult" + }, + "documentation": "

[IPv6 only] Creates an egress-only internet gateway for your VPC. An egress-only internet gateway is used to enable outbound communication over IPv6 from instances in your VPC to the internet, and prevents hosts outside of your VPC from initiating an IPv6 connection with your instance.

" + }, + "CreateFleet": { + "name": "CreateFleet", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateFleetRequest" + }, + "output": { + "shape": "CreateFleetResult" + }, + "documentation": "

Launches an EC2 Fleet.

You can create a single EC2 Fleet that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.

For more information, see Launching an EC2 Fleet in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateFlowLogs": { + "name": "CreateFlowLogs", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateFlowLogsRequest" + }, + "output": { + "shape": "CreateFlowLogsResult" + }, + "documentation": "

Creates one or more flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC.

Flow log data for a monitored network interface is recorded as flow log records, which are log events consisting of fields that describe the traffic flow. For more information, see Flow Log Records in the Amazon Virtual Private Cloud User Guide.

When publishing to CloudWatch Logs, flow log records are published to a log group, and each network interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all of the monitored network interfaces are published to a single log file object that is stored in the specified bucket.

For more information, see VPC Flow Logs in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateFpgaImage": { + "name": "CreateFpgaImage", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateFpgaImageRequest" + }, + "output": { + "shape": "CreateFpgaImageResult" + }, + "documentation": "

Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).

The create operation is asynchronous. To verify that the AFI is ready for use, check the output logs.

An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated instances. For more information, see the AWS FPGA Hardware Development Kit.

" + }, + "CreateImage": { + "name": "CreateImage", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateImageRequest" + }, + "output": { + "shape": "CreateImageResult" + }, + "documentation": "

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.

If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.

For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateInstanceExportTask": { + "name": "CreateInstanceExportTask", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateInstanceExportTaskRequest" + }, + "output": { + "shape": "CreateInstanceExportTaskResult" + }, + "documentation": "

Exports a running or stopped instance to an S3 bucket.

For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting an Instance as a VM Using VM Import/Export in the VM Import/Export User Guide.

" + }, + "CreateInternetGateway": { + "name": "CreateInternetGateway", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateInternetGatewayRequest" + }, + "output": { + "shape": "CreateInternetGatewayResult" + }, + "documentation": "

Creates an internet gateway for use with a VPC. After creating the internet gateway, you attach it to a VPC using AttachInternetGateway.

For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateKeyPair": { + "name": "CreateKeyPair", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateKeyPairRequest" + }, + "output": { + "shape": "KeyPair" + }, + "documentation": "

Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#1 private key. If a key with the specified name already exists, Amazon EC2 returns an error.

You can have up to five thousand key pairs per Region.

The key pair returned to you is available only in the Region in which you create it. If you prefer, you can create your own key pair using a third-party tool and upload it to any Region using ImportKeyPair.

For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateLaunchTemplate": { + "name": "CreateLaunchTemplate", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateLaunchTemplateRequest" + }, + "output": { + "shape": "CreateLaunchTemplateResult" + }, + "documentation": "

Creates a launch template. A launch template contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify a launch template instead of providing the launch parameters in the request.

" + }, + "CreateLaunchTemplateVersion": { + "name": "CreateLaunchTemplateVersion", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateLaunchTemplateVersionRequest" + }, + "output": { + "shape": "CreateLaunchTemplateVersionResult" + }, + "documentation": "

Creates a new version for a launch template. You can specify an existing version of launch template from which to base the new version.

Launch template versions are numbered in the order in which they are created. You cannot specify, change, or replace the numbering of launch template versions.

" + }, + "CreateNatGateway": { + "name": "CreateNatGateway", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateNatGatewayRequest" + }, + "output": { + "shape": "CreateNatGatewayResult" + }, + "documentation": "

Creates a NAT gateway in the specified public subnet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. Internet-bound traffic from a private subnet can be routed to the NAT gateway, therefore enabling instances in the private subnet to connect to the internet. For more information, see NAT Gateways in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateNetworkAcl": { + "name": "CreateNetworkAcl", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateNetworkAclRequest" + }, + "output": { + "shape": "CreateNetworkAclResult" + }, + "documentation": "

Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.

For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateNetworkAclEntry": { + "name": "CreateNetworkAclEntry", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateNetworkAclEntryRequest" + }, + "documentation": "

Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.

We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.

After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateNetworkInterface": { + "name": "CreateNetworkInterface", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateNetworkInterfaceRequest" + }, + "output": { + "shape": "CreateNetworkInterfaceResult" + }, + "documentation": "

Creates a network interface in the specified subnet.

For more information about network interfaces, see Elastic Network Interfaces in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateNetworkInterfacePermission": { + "name": "CreateNetworkInterfacePermission", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateNetworkInterfacePermissionRequest" + }, + "output": { + "shape": "CreateNetworkInterfacePermissionResult" + }, + "documentation": "

Grants an AWS-authorized account permission to attach the specified network interface to an instance in their account.

You can grant permission to a single AWS account only, and only one account at a time.

" + }, + "CreatePlacementGroup": { + "name": "CreatePlacementGroup", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreatePlacementGroupRequest" + }, + "documentation": "

Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group.

A cluster placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A spread placement group places instances on distinct hardware. A partition placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition.

For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateReservedInstancesListing": { + "name": "CreateReservedInstancesListing", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateReservedInstancesListingRequest" + }, + "output": { + "shape": "CreateReservedInstancesListingResult" + }, + "documentation": "

Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your Standard Reserved Instances, you can use the DescribeReservedInstances operation.

Only Standard Reserved Instances can be sold in the Reserved Instance Marketplace. Convertible Reserved Instances cannot be sold.

The Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price to receive for them. Your Standard Reserved Instance listings then become available for purchase. To view the details of your Standard Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateRoute": { + "name": "CreateRoute", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateRouteRequest" + }, + "output": { + "shape": "CreateRouteResult" + }, + "documentation": "

Creates a route in a route table within a VPC.

You must specify one of the following targets: internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, or egress-only internet gateway.

When determining how to route traffic, we use the route with the most specific match. For example, traffic is destined for the IPv4 address 192.0.2.3, and the route table includes the following two IPv4 routes:

  • 192.0.2.0/24 (goes to some target A)

  • 192.0.2.0/28 (goes to some target B)

Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateRouteTable": { + "name": "CreateRouteTable", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateRouteTableRequest" + }, + "output": { + "shape": "CreateRouteTableResult" + }, + "documentation": "

Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.

For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateSecurityGroup": { + "name": "CreateSecurityGroup", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateSecurityGroupRequest" + }, + "output": { + "shape": "CreateSecurityGroupResult" + }, + "documentation": "

Creates a security group.

A security group acts as a virtual firewall for your instance to control inbound and outbound traffic. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.

You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.

You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress.

For more information about VPC security group limits, see Amazon VPC Limits.

" + }, + "CreateSnapshot": { + "name": "CreateSnapshot", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateSnapshotRequest" + }, + "output": { + "shape": "Snapshot" + }, + "documentation": "

Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.

When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot.

You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your EBS volume at the time the snapshot command is issued; this may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending.

To create a snapshot for EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.

Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.

You can tag your snapshots during creation. For more information, see Tagging Your Amazon EC2 Resources in the Amazon Elastic Compute Cloud User Guide.

For more information, see Amazon Elastic Block Store and Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateSnapshots": { + "name": "CreateSnapshots", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateSnapshotsRequest" + }, + "output": { + "shape": "CreateSnapshotsResult" + }, + "documentation": "

Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3. Volumes are chosen by specifying an instance. Any attached volumes will produce one snapshot each that is crash-consistent across the instance. Boot volumes can be excluded by changing the paramaters.

" + }, + "CreateSpotDatafeedSubscription": { + "name": "CreateSpotDatafeedSubscription", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateSpotDatafeedSubscriptionRequest" + }, + "output": { + "shape": "CreateSpotDatafeedSubscriptionResult" + }, + "documentation": "

Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per AWS account. For more information, see Spot Instance Data Feed in the Amazon EC2 User Guide for Linux Instances.

" + }, + "CreateSubnet": { + "name": "CreateSubnet", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateSubnetRequest" + }, + "output": { + "shape": "CreateSubnetResult" + }, + "documentation": "

Creates a subnet in an existing VPC.

When you create each subnet, you provide the VPC ID and IPv4 CIDR block for the subnet. After you create a subnet, you can't change its CIDR block. The size of the subnet's IPv4 CIDR block can be the same as a VPC's IPv4 CIDR block, or a subset of a VPC's IPv4 CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest IPv4 subnet (and VPC) you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses).

If you've associated an IPv6 CIDR block with your VPC, you can create a subnet with an IPv6 CIDR block that uses a /64 prefix length.

AWS reserves both the first four and the last IPv4 address in each subnet's CIDR block. They're not available for use.

If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.

If you launch an instance in a VPC using an Amazon EBS-backed AMI, the IP address doesn't change if you stop and restart the instance (unlike a similar instance launched outside a VPC, which gets a new IP address when restarted). It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateTags": { + "name": "CreateTags", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateTagsRequest" + }, + "documentation": "

Adds or overwrites the specified tags for the specified Amazon EC2 resource or resources. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide. For more information about creating IAM policies that control users' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateTrafficMirrorFilter": { + "name": "CreateTrafficMirrorFilter", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateTrafficMirrorFilterRequest" + }, + "output": { + "shape": "CreateTrafficMirrorFilterResult" + }, + "documentation": "

Creates a Traffic Mirror filter.

A Traffic Mirror filter is a set of rules that defines the traffic to mirror.

By default, no traffic is mirrored. To mirror traffic, use CreateTrafficMirrorFilterRule to add Traffic Mirror rules to the filter. The rules you add define what traffic gets mirrored. You can also use ModifyTrafficMirrorFilterNetworkServices to mirror supported network services.

" + }, + "CreateTrafficMirrorFilterRule": { + "name": "CreateTrafficMirrorFilterRule", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateTrafficMirrorFilterRuleRequest" + }, + "output": { + "shape": "CreateTrafficMirrorFilterRuleResult" + }, + "documentation": "

Creates a Traffic Mirror rule.

A Traffic Mirror rule defines the Traffic Mirror source traffic to mirror.

You need the Traffic Mirror filter ID when you create the rule.

" + }, + "CreateTrafficMirrorSession": { + "name": "CreateTrafficMirrorSession", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateTrafficMirrorSessionRequest" + }, + "output": { + "shape": "CreateTrafficMirrorSessionResult" + }, + "documentation": "

Creates a Traffic Mirror session.

A Traffic Mirror session actively copies packets from a Traffic Mirror source to a Traffic Mirror target. Create a filter, and then assign it to the session to define a subset of the traffic to mirror, for example all TCP traffic.

The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in a different VPC connected via VPC peering or a transit gateway.

By default, no traffic is mirrored. Use CreateTrafficMirrorFilter to create filter rules that specify the traffic to mirror.

" + }, + "CreateTrafficMirrorTarget": { + "name": "CreateTrafficMirrorTarget", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateTrafficMirrorTargetRequest" + }, + "output": { + "shape": "CreateTrafficMirrorTargetResult" + }, + "documentation": "

Creates a target for your Traffic Mirror session.

A Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in different VPCs connected via VPC peering or a transit gateway.

A Traffic Mirror target can be a network interface, or a Network Load Balancer.

To use the target in a Traffic Mirror session, use CreateTrafficMirrorSession.

" + }, + "CreateTransitGateway": { + "name": "CreateTransitGateway", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateTransitGatewayRequest" + }, + "output": { + "shape": "CreateTransitGatewayResult" + }, + "documentation": "

Creates a transit gateway.

You can use a transit gateway to interconnect your virtual private clouds (VPC) and on-premises networks. After the transit gateway enters the available state, you can attach your VPCs and VPN connections to the transit gateway.

To attach your VPCs, use CreateTransitGatewayVpcAttachment.

To attach a VPN connection, use CreateCustomerGateway to create a customer gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to CreateVpnConnection.

When you create a transit gateway, we create a default transit gateway route table and use it as the default association route table and the default propagation route table. You can use CreateTransitGatewayRouteTable to create additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. You can use EnableTransitGatewayRouteTablePropagation to propagate routes from a resource attachment to a transit gateway route table. If you disable automatic associations, you can use AssociateTransitGatewayRouteTable to associate a resource attachment with a transit gateway route table.

" + }, + "CreateTransitGatewayRoute": { + "name": "CreateTransitGatewayRoute", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateTransitGatewayRouteRequest" + }, + "output": { + "shape": "CreateTransitGatewayRouteResult" + }, + "documentation": "

Creates a static route for the specified transit gateway route table.

" + }, + "CreateTransitGatewayRouteTable": { + "name": "CreateTransitGatewayRouteTable", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateTransitGatewayRouteTableRequest" + }, + "output": { + "shape": "CreateTransitGatewayRouteTableResult" + }, + "documentation": "

Creates a route table for the specified transit gateway.

" + }, + "CreateTransitGatewayVpcAttachment": { + "name": "CreateTransitGatewayVpcAttachment", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateTransitGatewayVpcAttachmentRequest" + }, + "output": { + "shape": "CreateTransitGatewayVpcAttachmentResult" + }, + "documentation": "

Attaches the specified VPC to the specified transit gateway.

If you attach a VPC with a CIDR range that overlaps the CIDR range of a VPC that is already attached, the new VPC CIDR range is not propagated to the default propagation route table.

To send VPC traffic to an attached transit gateway, add a route to the VPC route table using CreateRoute.

" + }, + "CreateVolume": { + "name": "CreateVolume", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateVolumeRequest" + }, + "output": { + "shape": "Volume" + }, + "documentation": "

Creates an EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the regional endpoint that you send the HTTP request to. For more information see Regions and Endpoints.

You can create a new empty volume or restore a volume from an EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume.

You can create encrypted volumes. Encrypted volumes must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

You can tag your volumes during creation. For more information, see Tagging Your Amazon EC2 Resources in the Amazon Elastic Compute Cloud User Guide.

For more information, see Creating an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateVpc": { + "name": "CreateVpc", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateVpcRequest" + }, + "output": { + "shape": "CreateVpcResult" + }, + "documentation": "

Creates a VPC with the specified IPv4 CIDR block. The smallest VPC you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses). For more information about how large to make your VPC, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

You can optionally request an Amazon-provided IPv6 CIDR block for the VPC. The IPv6 CIDR block uses a /56 prefix length, and is allocated from Amazon's pool of IPv6 addresses. You cannot choose the IPv6 range for your VPC.

By default, each instance you launch in the VPC has the default DHCP options, which include only a default DNS server that we provide (AmazonProvidedDNS). For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

You can specify the instance tenancy value for the VPC when you create it. You can't change this value for the VPC after you create it. For more information, see Dedicated Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateVpcEndpoint": { + "name": "CreateVpcEndpoint", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateVpcEndpointRequest" + }, + "output": { + "shape": "CreateVpcEndpointResult" + }, + "documentation": "

Creates a VPC endpoint for a specified service. An endpoint enables you to create a private connection between your VPC and the service. The service may be provided by AWS, an AWS Marketplace partner, or another AWS account. For more information, see VPC Endpoints in the Amazon Virtual Private Cloud User Guide.

A gateway endpoint serves as a target for a route in your route table for traffic destined for the AWS service. You can specify an endpoint policy to attach to the endpoint that will control access to the service from your VPC. You can also specify the VPC route tables that use the endpoint.

An interface endpoint is a network interface in your subnet that serves as an endpoint for communicating with the specified service. You can specify the subnets in which to create an endpoint, and the security groups to associate with the endpoint network interface.

Use DescribeVpcEndpointServices to get a list of supported services.

" + }, + "CreateVpcEndpointConnectionNotification": { + "name": "CreateVpcEndpointConnectionNotification", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateVpcEndpointConnectionNotificationRequest" + }, + "output": { + "shape": "CreateVpcEndpointConnectionNotificationResult" + }, + "documentation": "

Creates a connection notification for a specified VPC endpoint or VPC endpoint service. A connection notification notifies you of specific endpoint events. You must create an SNS topic to receive notifications. For more information, see Create a Topic in the Amazon Simple Notification Service Developer Guide.

You can create a connection notification for interface endpoints only.

" + }, + "CreateVpcEndpointServiceConfiguration": { + "name": "CreateVpcEndpointServiceConfiguration", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateVpcEndpointServiceConfigurationRequest" + }, + "output": { + "shape": "CreateVpcEndpointServiceConfigurationResult" + }, + "documentation": "

Creates a VPC endpoint service configuration to which service consumers (AWS accounts, IAM users, and IAM roles) can connect. Service consumers can create an interface VPC endpoint to connect to your service.

To create an endpoint service configuration, you must first create a Network Load Balancer for your service. For more information, see VPC Endpoint Services in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateVpcPeeringConnection": { + "name": "CreateVpcPeeringConnection", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateVpcPeeringConnectionRequest" + }, + "output": { + "shape": "CreateVpcPeeringConnectionResult" + }, + "documentation": "

Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection. The accepter VPC can belong to another AWS account and can be in a different Region to the requester VPC. The requester VPC and accepter VPC cannot have overlapping CIDR blocks.

Limitations and rules apply to a VPC peering connection. For more information, see the limitations section in the VPC Peering Guide.

The owner of the accepter VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.

If you create a VPC peering connection request between VPCs with overlapping CIDR blocks, the VPC peering connection has a status of failed.

" + }, + "CreateVpnConnection": { + "name": "CreateVpnConnection", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateVpnConnectionRequest" + }, + "output": { + "shape": "CreateVpnConnectionResult" + }, + "documentation": "

Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The supported connection types is ipsec.1.

The response includes information that you need to give to your network administrator to configure your customer gateway.

We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway.

If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

" + }, + "CreateVpnConnectionRoute": { + "name": "CreateVpnConnectionRoute", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateVpnConnectionRouteRequest" + }, + "documentation": "

Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

" + }, + "CreateVpnGateway": { + "name": "CreateVpnGateway", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateVpnGatewayRequest" + }, + "output": { + "shape": "CreateVpnGatewayResult" + }, + "documentation": "

Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

" + }, + "DeleteClientVpnEndpoint": { + "name": "DeleteClientVpnEndpoint", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteClientVpnEndpointRequest" + }, + "output": { + "shape": "DeleteClientVpnEndpointResult" + }, + "documentation": "

Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint.

" + }, + "DeleteClientVpnRoute": { + "name": "DeleteClientVpnRoute", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteClientVpnRouteRequest" + }, + "output": { + "shape": "DeleteClientVpnRouteResult" + }, + "documentation": "

Deletes a route from a Client VPN endpoint. You can only delete routes that you manually added using the CreateClientVpnRoute action. You cannot delete routes that were automatically added when associating a subnet. To remove routes that have been automatically added, disassociate the target subnet from the Client VPN endpoint.

" + }, + "DeleteCustomerGateway": { + "name": "DeleteCustomerGateway", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteCustomerGatewayRequest" + }, + "documentation": "

Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.

" + }, + "DeleteDhcpOptions": { + "name": "DeleteDhcpOptions", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteDhcpOptionsRequest" + }, + "documentation": "

Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.

" + }, + "DeleteEgressOnlyInternetGateway": { + "name": "DeleteEgressOnlyInternetGateway", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteEgressOnlyInternetGatewayRequest" + }, + "output": { + "shape": "DeleteEgressOnlyInternetGatewayResult" + }, + "documentation": "

Deletes an egress-only internet gateway.

" + }, + "DeleteFleets": { + "name": "DeleteFleets", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteFleetsRequest" + }, + "output": { + "shape": "DeleteFleetsResult" + }, + "documentation": "

Deletes the specified EC2 Fleet.

After you delete an EC2 Fleet, it launches no new instances. You must specify whether an EC2 Fleet should also terminate its instances. If you terminate the instances, the EC2 Fleet enters the deleted_terminating state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances continue to run until they are interrupted or you terminate them manually.

" + }, + "DeleteFlowLogs": { + "name": "DeleteFlowLogs", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteFlowLogsRequest" + }, + "output": { + "shape": "DeleteFlowLogsResult" + }, + "documentation": "

Deletes one or more flow logs.

" + }, + "DeleteFpgaImage": { + "name": "DeleteFpgaImage", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteFpgaImageRequest" + }, + "output": { + "shape": "DeleteFpgaImageResult" + }, + "documentation": "

Deletes the specified Amazon FPGA Image (AFI).

" + }, + "DeleteInternetGateway": { + "name": "DeleteInternetGateway", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteInternetGatewayRequest" + }, + "documentation": "

Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it.

" + }, + "DeleteKeyPair": { + "name": "DeleteKeyPair", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteKeyPairRequest" + }, + "documentation": "

Deletes the specified key pair, by removing the public key from Amazon EC2.

" + }, + "DeleteLaunchTemplate": { + "name": "DeleteLaunchTemplate", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteLaunchTemplateRequest" + }, + "output": { + "shape": "DeleteLaunchTemplateResult" + }, + "documentation": "

Deletes a launch template. Deleting a launch template deletes all of its versions.

" + }, + "DeleteLaunchTemplateVersions": { + "name": "DeleteLaunchTemplateVersions", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteLaunchTemplateVersionsRequest" + }, + "output": { + "shape": "DeleteLaunchTemplateVersionsResult" + }, + "documentation": "

Deletes one or more versions of a launch template. You cannot delete the default version of a launch template; you must first assign a different version as the default. If the default version is the only version for the launch template, you must delete the entire launch template using DeleteLaunchTemplate.

" + }, + "DeleteNatGateway": { + "name": "DeleteNatGateway", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteNatGatewayRequest" + }, + "output": { + "shape": "DeleteNatGatewayResult" + }, + "documentation": "

Deletes the specified NAT gateway. Deleting a NAT gateway disassociates its Elastic IP address, but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway routes in your route tables.

" + }, + "DeleteNetworkAcl": { + "name": "DeleteNetworkAcl", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteNetworkAclRequest" + }, + "documentation": "

Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.

" + }, + "DeleteNetworkAclEntry": { + "name": "DeleteNetworkAclEntry", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteNetworkAclEntryRequest" + }, + "documentation": "

Deletes the specified ingress or egress entry (rule) from the specified network ACL.

" + }, + "DeleteNetworkInterface": { + "name": "DeleteNetworkInterface", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteNetworkInterfaceRequest" + }, + "documentation": "

Deletes the specified network interface. You must detach the network interface before you can delete it.

" + }, + "DeleteNetworkInterfacePermission": { + "name": "DeleteNetworkInterfacePermission", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteNetworkInterfacePermissionRequest" + }, + "output": { + "shape": "DeleteNetworkInterfacePermissionResult" + }, + "documentation": "

Deletes a permission for a network interface. By default, you cannot delete the permission if the account for which you're removing the permission has attached the network interface to an instance. However, you can force delete the permission, regardless of any attachment.

" + }, + "DeletePlacementGroup": { + "name": "DeletePlacementGroup", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeletePlacementGroupRequest" + }, + "documentation": "

Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DeleteRoute": { + "name": "DeleteRoute", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteRouteRequest" + }, + "documentation": "

Deletes the specified route from the specified route table.

" + }, + "DeleteRouteTable": { + "name": "DeleteRouteTable", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteRouteTableRequest" + }, + "documentation": "

Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.

" + }, + "DeleteSecurityGroup": { + "name": "DeleteSecurityGroup", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteSecurityGroupRequest" + }, + "documentation": "

Deletes a security group.

If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC.

" + }, + "DeleteSnapshot": { + "name": "DeleteSnapshot", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteSnapshotRequest" + }, + "documentation": "

Deletes the specified snapshot.

When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.

You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.

For more information, see Deleting an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DeleteSpotDatafeedSubscription": { + "name": "DeleteSpotDatafeedSubscription", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteSpotDatafeedSubscriptionRequest" + }, + "documentation": "

Deletes the data feed for Spot Instances.

" + }, + "DeleteSubnet": { + "name": "DeleteSubnet", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteSubnetRequest" + }, + "documentation": "

Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.

" + }, + "DeleteTags": { + "name": "DeleteTags", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteTagsRequest" + }, + "documentation": "

Deletes the specified set of tags from the specified set of resources.

To list the current tags, use DescribeTags. For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DeleteTrafficMirrorFilter": { + "name": "DeleteTrafficMirrorFilter", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteTrafficMirrorFilterRequest" + }, + "output": { + "shape": "DeleteTrafficMirrorFilterResult" + }, + "documentation": "

Deletes the specified Traffic Mirror filter.

You cannot delete a Traffic Mirror filter that is in use by a Traffic Mirror session.

" + }, + "DeleteTrafficMirrorFilterRule": { + "name": "DeleteTrafficMirrorFilterRule", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteTrafficMirrorFilterRuleRequest" + }, + "output": { + "shape": "DeleteTrafficMirrorFilterRuleResult" + }, + "documentation": "

Deletes the specified Traffic Mirror rule.

" + }, + "DeleteTrafficMirrorSession": { + "name": "DeleteTrafficMirrorSession", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteTrafficMirrorSessionRequest" + }, + "output": { + "shape": "DeleteTrafficMirrorSessionResult" + }, + "documentation": "

Deletes the specified Traffic Mirror session.

" + }, + "DeleteTrafficMirrorTarget": { + "name": "DeleteTrafficMirrorTarget", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteTrafficMirrorTargetRequest" + }, + "output": { + "shape": "DeleteTrafficMirrorTargetResult" + }, + "documentation": "

Deletes the specified Traffic Mirror target.

You cannot delete a Traffic Mirror target that is in use by a Traffic Mirror session.

" + }, + "DeleteTransitGateway": { + "name": "DeleteTransitGateway", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteTransitGatewayRequest" + }, + "output": { + "shape": "DeleteTransitGatewayResult" + }, + "documentation": "

Deletes the specified transit gateway.

" + }, + "DeleteTransitGatewayRoute": { + "name": "DeleteTransitGatewayRoute", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteTransitGatewayRouteRequest" + }, + "output": { + "shape": "DeleteTransitGatewayRouteResult" + }, + "documentation": "

Deletes the specified route from the specified transit gateway route table.

" + }, + "DeleteTransitGatewayRouteTable": { + "name": "DeleteTransitGatewayRouteTable", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteTransitGatewayRouteTableRequest" + }, + "output": { + "shape": "DeleteTransitGatewayRouteTableResult" + }, + "documentation": "

Deletes the specified transit gateway route table. You must disassociate the route table from any transit gateway route tables before you can delete it.

" + }, + "DeleteTransitGatewayVpcAttachment": { + "name": "DeleteTransitGatewayVpcAttachment", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteTransitGatewayVpcAttachmentRequest" + }, + "output": { + "shape": "DeleteTransitGatewayVpcAttachmentResult" + }, + "documentation": "

Deletes the specified VPC attachment.

" + }, + "DeleteVolume": { + "name": "DeleteVolume", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteVolumeRequest" + }, + "documentation": "

Deletes the specified EBS volume. The volume must be in the available state (not attached to an instance).

The volume can remain in the deleting state for several minutes.

For more information, see Deleting an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DeleteVpc": { + "name": "DeleteVpc", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteVpcRequest" + }, + "documentation": "

Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.

" + }, + "DeleteVpcEndpointConnectionNotifications": { + "name": "DeleteVpcEndpointConnectionNotifications", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteVpcEndpointConnectionNotificationsRequest" + }, + "output": { + "shape": "DeleteVpcEndpointConnectionNotificationsResult" + }, + "documentation": "

Deletes one or more VPC endpoint connection notifications.

" + }, + "DeleteVpcEndpointServiceConfigurations": { + "name": "DeleteVpcEndpointServiceConfigurations", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteVpcEndpointServiceConfigurationsRequest" + }, + "output": { + "shape": "DeleteVpcEndpointServiceConfigurationsResult" + }, + "documentation": "

Deletes one or more VPC endpoint service configurations in your account. Before you delete the endpoint service configuration, you must reject any Available or PendingAcceptance interface endpoint connections that are attached to the service.

" + }, + "DeleteVpcEndpoints": { + "name": "DeleteVpcEndpoints", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteVpcEndpointsRequest" + }, + "output": { + "shape": "DeleteVpcEndpointsResult" + }, + "documentation": "

Deletes one or more specified VPC endpoints. Deleting a gateway endpoint also deletes the endpoint routes in the route tables that were associated with the endpoint. Deleting an interface endpoint deletes the endpoint network interfaces.

" + }, + "DeleteVpcPeeringConnection": { + "name": "DeleteVpcPeeringConnection", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteVpcPeeringConnectionRequest" + }, + "output": { + "shape": "DeleteVpcPeeringConnectionResult" + }, + "documentation": "

Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the accepter VPC can delete the VPC peering connection if it's in the active state. The owner of the requester VPC can delete a VPC peering connection in the pending-acceptance state. You cannot delete a VPC peering connection that's in the failed state.

" + }, + "DeleteVpnConnection": { + "name": "DeleteVpnConnection", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteVpnConnectionRequest" + }, + "documentation": "

Deletes the specified VPN connection.

If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway using the new configuration information returned with the new VPN connection ID.

" + }, + "DeleteVpnConnectionRoute": { + "name": "DeleteVpnConnectionRoute", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteVpnConnectionRouteRequest" + }, + "documentation": "

Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

" + }, + "DeleteVpnGateway": { + "name": "DeleteVpnGateway", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteVpnGatewayRequest" + }, + "documentation": "

Deletes the specified virtual private gateway. We recommend that before you delete a virtual private gateway, you detach it from the VPC and delete the VPN connection. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network.

" + }, + "DeprovisionByoipCidr": { + "name": "DeprovisionByoipCidr", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeprovisionByoipCidrRequest" + }, + "output": { + "shape": "DeprovisionByoipCidrResult" + }, + "documentation": "

Releases the specified address range that you provisioned for use with your AWS resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.

Before you can release an address range, you must stop advertising it using WithdrawByoipCidr and you must not have any IP addresses allocated from its address range.

" + }, + "DeregisterImage": { + "name": "DeregisterImage", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeregisterImageRequest" + }, + "documentation": "

Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances; however, it doesn't affect any instances that you've already launched from the AMI. You'll continue to incur usage costs for those instances until you terminate them.

When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was created for the root volume of the instance during the AMI creation process. When you deregister an instance store-backed AMI, it doesn't affect the files that you uploaded to Amazon S3 when you created the AMI.

" + }, + "DescribeAccountAttributes": { + "name": "DescribeAccountAttributes", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeAccountAttributesRequest" + }, + "output": { + "shape": "DescribeAccountAttributesResult" + }, + "documentation": "

Describes attributes of your AWS account. The following are the supported account attributes:

  • supported-platforms: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC.

  • default-vpc: The ID of the default VPC for your account, or none.

  • max-instances: The maximum number of On-Demand Instances that you can run.

  • vpc-max-security-groups-per-interface: The maximum number of security groups that you can assign to a network interface.

  • max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic.

  • vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC.

" + }, + "DescribeAddresses": { + "name": "DescribeAddresses", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeAddressesRequest" + }, + "output": { + "shape": "DescribeAddressesResult" + }, + "documentation": "

Describes the specified Elastic IP addresses or all of your Elastic IP addresses.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeAggregateIdFormat": { + "name": "DescribeAggregateIdFormat", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeAggregateIdFormatRequest" + }, + "output": { + "shape": "DescribeAggregateIdFormatResult" + }, + "documentation": "

Describes the longer ID format settings for all resource types in a specific Region. This request is useful for performing a quick audit to determine whether a specific Region is fully opted in for longer IDs (17-character IDs).

This request only returns information about resource types that support longer IDs.

The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

" + }, + "DescribeAvailabilityZones": { + "name": "DescribeAvailabilityZones", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeAvailabilityZonesRequest" + }, + "output": { + "shape": "DescribeAvailabilityZonesResult" + }, + "documentation": "

Describes the Availability Zones that are available to you. The results include zones only for the Region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone.

For more information, see Regions and Availability Zones in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeBundleTasks": { + "name": "DescribeBundleTasks", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeBundleTasksRequest" + }, + "output": { + "shape": "DescribeBundleTasksResult" + }, + "documentation": "

Describes the specified bundle tasks or all of your bundle tasks.

Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task.

" + }, + "DescribeByoipCidrs": { + "name": "DescribeByoipCidrs", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeByoipCidrsRequest" + }, + "output": { + "shape": "DescribeByoipCidrsResult" + }, + "documentation": "

Describes the IP address ranges that were specified in calls to ProvisionByoipCidr.

To describe the address pools that were created when you provisioned the address ranges, use DescribePublicIpv4Pools.

" + }, + "DescribeCapacityReservations": { + "name": "DescribeCapacityReservations", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeCapacityReservationsRequest" + }, + "output": { + "shape": "DescribeCapacityReservationsResult" + }, + "documentation": "

Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the AWS Region that you're currently using.

" + }, + "DescribeClassicLinkInstances": { + "name": "DescribeClassicLinkInstances", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeClassicLinkInstancesRequest" + }, + "output": { + "shape": "DescribeClassicLinkInstancesResult" + }, + "documentation": "

Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink. You cannot use this request to return information about other instances.

" + }, + "DescribeClientVpnAuthorizationRules": { + "name": "DescribeClientVpnAuthorizationRules", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeClientVpnAuthorizationRulesRequest" + }, + "output": { + "shape": "DescribeClientVpnAuthorizationRulesResult" + }, + "documentation": "

Describes the authorization rules for a specified Client VPN endpoint.

" + }, + "DescribeClientVpnConnections": { + "name": "DescribeClientVpnConnections", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeClientVpnConnectionsRequest" + }, + "output": { + "shape": "DescribeClientVpnConnectionsResult" + }, + "documentation": "

Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint.

" + }, + "DescribeClientVpnEndpoints": { + "name": "DescribeClientVpnEndpoints", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeClientVpnEndpointsRequest" + }, + "output": { + "shape": "DescribeClientVpnEndpointsResult" + }, + "documentation": "

Describes one or more Client VPN endpoints in the account.

" + }, + "DescribeClientVpnRoutes": { + "name": "DescribeClientVpnRoutes", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeClientVpnRoutesRequest" + }, + "output": { + "shape": "DescribeClientVpnRoutesResult" + }, + "documentation": "

Describes the routes for the specified Client VPN endpoint.

" + }, + "DescribeClientVpnTargetNetworks": { + "name": "DescribeClientVpnTargetNetworks", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeClientVpnTargetNetworksRequest" + }, + "output": { + "shape": "DescribeClientVpnTargetNetworksResult" + }, + "documentation": "

Describes the target networks associated with the specified Client VPN endpoint.

" + }, + "DescribeConversionTasks": { + "name": "DescribeConversionTasks", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeConversionTasksRequest" + }, + "output": { + "shape": "DescribeConversionTasksResult" + }, + "documentation": "

Describes the specified conversion tasks or all your conversion tasks. For more information, see the VM Import/Export User Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

" + }, + "DescribeCustomerGateways": { + "name": "DescribeCustomerGateways", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeCustomerGatewaysRequest" + }, + "output": { + "shape": "DescribeCustomerGatewaysResult" + }, + "documentation": "

Describes one or more of your VPN customer gateways.

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

" + }, + "DescribeDhcpOptions": { + "name": "DescribeDhcpOptions", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeDhcpOptionsRequest" + }, + "output": { + "shape": "DescribeDhcpOptionsResult" + }, + "documentation": "

Describes one or more of your DHCP options sets.

For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeEgressOnlyInternetGateways": { + "name": "DescribeEgressOnlyInternetGateways", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeEgressOnlyInternetGatewaysRequest" + }, + "output": { + "shape": "DescribeEgressOnlyInternetGatewaysResult" + }, + "documentation": "

Describes one or more of your egress-only internet gateways.

" + }, + "DescribeElasticGpus": { + "name": "DescribeElasticGpus", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeElasticGpusRequest" + }, + "output": { + "shape": "DescribeElasticGpusResult" + }, + "documentation": "

Describes the Elastic Graphics accelerator associated with your instances. For more information about Elastic Graphics, see Amazon Elastic Graphics.

" + }, + "DescribeExportTasks": { + "name": "DescribeExportTasks", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeExportTasksRequest" + }, + "output": { + "shape": "DescribeExportTasksResult" + }, + "documentation": "

Describes the specified export tasks or all your export tasks.

" + }, + "DescribeFleetHistory": { + "name": "DescribeFleetHistory", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeFleetHistoryRequest" + }, + "output": { + "shape": "DescribeFleetHistoryResult" + }, + "documentation": "

Describes the events for the specified EC2 Fleet during the specified time.

" + }, + "DescribeFleetInstances": { + "name": "DescribeFleetInstances", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeFleetInstancesRequest" + }, + "output": { + "shape": "DescribeFleetInstancesResult" + }, + "documentation": "

Describes the running instances for the specified EC2 Fleet.

" + }, + "DescribeFleets": { + "name": "DescribeFleets", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeFleetsRequest" + }, + "output": { + "shape": "DescribeFleetsResult" + }, + "documentation": "

Describes the specified EC2 Fleets or all your EC2 Fleets.

" + }, + "DescribeFlowLogs": { + "name": "DescribeFlowLogs", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeFlowLogsRequest" + }, + "output": { + "shape": "DescribeFlowLogsResult" + }, + "documentation": "

Describes one or more flow logs. To view the information in your flow logs (the log streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs API.

" + }, + "DescribeFpgaImageAttribute": { + "name": "DescribeFpgaImageAttribute", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeFpgaImageAttributeRequest" + }, + "output": { + "shape": "DescribeFpgaImageAttributeResult" + }, + "documentation": "

Describes the specified attribute of the specified Amazon FPGA Image (AFI).

" + }, + "DescribeFpgaImages": { + "name": "DescribeFpgaImages", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeFpgaImagesRequest" + }, + "output": { + "shape": "DescribeFpgaImagesResult" + }, + "documentation": "

Describes the Amazon FPGA Images (AFIs) available to you. These include public AFIs, private AFIs that you own, and AFIs owned by other AWS accounts for which you have load permissions.

" + }, + "DescribeHostReservationOfferings": { + "name": "DescribeHostReservationOfferings", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeHostReservationOfferingsRequest" + }, + "output": { + "shape": "DescribeHostReservationOfferingsResult" + }, + "documentation": "

Describes the Dedicated Host reservations that are available to purchase.

The results describe all the Dedicated Host reservation offerings, including offerings that may not match the instance family and Region of your Dedicated Hosts. When purchasing an offering, ensure that the instance family and Region of the offering matches that of the Dedicated Hosts with which it is to be associated. For more information about supported instance types, see Dedicated Hosts Overview in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeHostReservations": { + "name": "DescribeHostReservations", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeHostReservationsRequest" + }, + "output": { + "shape": "DescribeHostReservationsResult" + }, + "documentation": "

Describes reservations that are associated with Dedicated Hosts in your account.

" + }, + "DescribeHosts": { + "name": "DescribeHosts", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeHostsRequest" + }, + "output": { + "shape": "DescribeHostsResult" + }, + "documentation": "

Describes the specified Dedicated Hosts or all your Dedicated Hosts.

The results describe only the Dedicated Hosts in the Region you're currently using. All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have recently been released are listed with the state released.

" + }, + "DescribeIamInstanceProfileAssociations": { + "name": "DescribeIamInstanceProfileAssociations", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeIamInstanceProfileAssociationsRequest" + }, + "output": { + "shape": "DescribeIamInstanceProfileAssociationsResult" + }, + "documentation": "

Describes your IAM instance profile associations.

" + }, + "DescribeIdFormat": { + "name": "DescribeIdFormat", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeIdFormatRequest" + }, + "output": { + "shape": "DescribeIdFormatResult" + }, + "documentation": "

Describes the ID format settings for your resources on a per-Region basis, for example, to view which resource types are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types.

The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

These settings apply to the IAM user who makes the request; they do not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user, unless they explicitly override the settings by running the ModifyIdFormat command. Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.

" + }, + "DescribeIdentityIdFormat": { + "name": "DescribeIdentityIdFormat", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeIdentityIdFormatRequest" + }, + "output": { + "shape": "DescribeIdentityIdFormatResult" + }, + "documentation": "

Describes the ID format settings for resources for the specified IAM user, IAM role, or root user. For example, you can view the resource types that are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

These settings apply to the principal specified in the request. They do not apply to the principal that makes the request.

" + }, + "DescribeImageAttribute": { + "name": "DescribeImageAttribute", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeImageAttributeRequest" + }, + "output": { + "shape": "ImageAttribute" + }, + "documentation": "

Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.

" + }, + "DescribeImages": { + "name": "DescribeImages", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeImagesRequest" + }, + "output": { + "shape": "DescribeImagesResult" + }, + "documentation": "

Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.

The images available to you include public images, private images that you own, and private images owned by other AWS accounts for which you have explicit launch permissions.

Recently deregistered images appear in the returned results for a short interval and then return empty results. After all instances that reference a deregistered AMI are terminated, specifying the ID of the image results in an error indicating that the AMI ID cannot be found.

" + }, + "DescribeImportImageTasks": { + "name": "DescribeImportImageTasks", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeImportImageTasksRequest" + }, + "output": { + "shape": "DescribeImportImageTasksResult" + }, + "documentation": "

Displays details about an import virtual machine or import snapshot tasks that are already created.

" + }, + "DescribeImportSnapshotTasks": { + "name": "DescribeImportSnapshotTasks", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeImportSnapshotTasksRequest" + }, + "output": { + "shape": "DescribeImportSnapshotTasksResult" + }, + "documentation": "

Describes your import snapshot tasks.

" + }, + "DescribeInstanceAttribute": { + "name": "DescribeInstanceAttribute", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeInstanceAttributeRequest" + }, + "output": { + "shape": "InstanceAttribute" + }, + "documentation": "

Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport

" + }, + "DescribeInstanceCreditSpecifications": { + "name": "DescribeInstanceCreditSpecifications", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeInstanceCreditSpecificationsRequest" + }, + "output": { + "shape": "DescribeInstanceCreditSpecificationsResult" + }, + "documentation": "

Describes the credit option for CPU usage of the specified T2 or T3 instances. The credit options are standard and unlimited.

If you do not specify an instance ID, Amazon EC2 returns T2 and T3 instances with the unlimited credit option, as well as instances that were previously configured as T2 or T3 with the unlimited credit option. For example, if you resize a T2 instance, while it is configured as unlimited, to an M4 instance, Amazon EC2 returns the M4 instance.

If you specify one or more instance IDs, Amazon EC2 returns the credit option (standard or unlimited) of those instances. If you specify an instance ID that is not valid, such as an instance that is not a T2 or T3 instance, an error is returned.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

If an Availability Zone is experiencing a service disruption and you specify instance IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs in an unaffected zone, the call works normally.

For more information, see Burstable Performance Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeInstanceStatus": { + "name": "DescribeInstanceStatus", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeInstanceStatusRequest" + }, + "output": { + "shape": "DescribeInstanceStatusResult" + }, + "documentation": "

Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances.

Instance status includes the following components:

  • Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status Checks for Your Instances and Troubleshooting Instances with Failed Status Checks in the Amazon Elastic Compute Cloud User Guide.

  • Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled Events for Your Instances in the Amazon Elastic Compute Cloud User Guide.

  • Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeInstances": { + "name": "DescribeInstances", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeInstancesRequest" + }, + "output": { + "shape": "DescribeInstancesResult" + }, + "documentation": "

Describes the specified instances or all of your instances.

If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.

" + }, + "DescribeInternetGateways": { + "name": "DescribeInternetGateways", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeInternetGatewaysRequest" + }, + "output": { + "shape": "DescribeInternetGatewaysResult" + }, + "documentation": "

Describes one or more of your internet gateways.

" + }, + "DescribeKeyPairs": { + "name": "DescribeKeyPairs", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeKeyPairsRequest" + }, + "output": { + "shape": "DescribeKeyPairsResult" + }, + "documentation": "

Describes the specified key pairs or all of your key pairs.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeLaunchTemplateVersions": { + "name": "DescribeLaunchTemplateVersions", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeLaunchTemplateVersionsRequest" + }, + "output": { + "shape": "DescribeLaunchTemplateVersionsResult" + }, + "documentation": "

Describes one or more versions of a specified launch template. You can describe all versions, individual versions, or a range of versions.

" + }, + "DescribeLaunchTemplates": { + "name": "DescribeLaunchTemplates", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeLaunchTemplatesRequest" + }, + "output": { + "shape": "DescribeLaunchTemplatesResult" + }, + "documentation": "

Describes one or more launch templates.

" + }, + "DescribeMovingAddresses": { + "name": "DescribeMovingAddresses", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeMovingAddressesRequest" + }, + "output": { + "shape": "DescribeMovingAddressesResult" + }, + "documentation": "

Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account.

" + }, + "DescribeNatGateways": { + "name": "DescribeNatGateways", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeNatGatewaysRequest" + }, + "output": { + "shape": "DescribeNatGatewaysResult" + }, + "documentation": "

Describes one or more of your NAT gateways.

" + }, + "DescribeNetworkAcls": { + "name": "DescribeNetworkAcls", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeNetworkAclsRequest" + }, + "output": { + "shape": "DescribeNetworkAclsResult" + }, + "documentation": "

Describes one or more of your network ACLs.

For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeNetworkInterfaceAttribute": { + "name": "DescribeNetworkInterfaceAttribute", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeNetworkInterfaceAttributeRequest" + }, + "output": { + "shape": "DescribeNetworkInterfaceAttributeResult" + }, + "documentation": "

Describes a network interface attribute. You can specify only one attribute at a time.

" + }, + "DescribeNetworkInterfacePermissions": { + "name": "DescribeNetworkInterfacePermissions", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeNetworkInterfacePermissionsRequest" + }, + "output": { + "shape": "DescribeNetworkInterfacePermissionsResult" + }, + "documentation": "

Describes the permissions for your network interfaces.

" + }, + "DescribeNetworkInterfaces": { + "name": "DescribeNetworkInterfaces", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeNetworkInterfacesRequest" + }, + "output": { + "shape": "DescribeNetworkInterfacesResult" + }, + "documentation": "

Describes one or more of your network interfaces.

" + }, + "DescribePlacementGroups": { + "name": "DescribePlacementGroups", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribePlacementGroupsRequest" + }, + "output": { + "shape": "DescribePlacementGroupsResult" + }, + "documentation": "

Describes the specified placement groups or all of your placement groups. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribePrefixLists": { + "name": "DescribePrefixLists", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribePrefixListsRequest" + }, + "output": { + "shape": "DescribePrefixListsResult" + }, + "documentation": "

Describes available AWS services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service. A prefix list ID is required for creating an outbound security group rule that allows traffic from a VPC to access an AWS service through a gateway VPC endpoint. Currently, the services that support this action are Amazon S3 and Amazon DynamoDB.

" + }, + "DescribePrincipalIdFormat": { + "name": "DescribePrincipalIdFormat", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribePrincipalIdFormatRequest" + }, + "output": { + "shape": "DescribePrincipalIdFormatResult" + }, + "documentation": "

Describes the ID format settings for the root user and all IAM roles and IAM users that have explicitly specified a longer ID (17-character ID) preference.

By default, all IAM roles and IAM users default to the same ID settings as the root user, unless they explicitly override the settings. This request is useful for identifying those IAM users and IAM roles that have overridden the default ID settings.

The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

" + }, + "DescribePublicIpv4Pools": { + "name": "DescribePublicIpv4Pools", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribePublicIpv4PoolsRequest" + }, + "output": { + "shape": "DescribePublicIpv4PoolsResult" + }, + "documentation": "

Describes the specified IPv4 address pools.

" + }, + "DescribeRegions": { + "name": "DescribeRegions", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeRegionsRequest" + }, + "output": { + "shape": "DescribeRegionsResult" + }, + "documentation": "

Describes the Regions that are currently available to you. The API returns a list of all the Regions, including Regions that are disabled for your account. For information about enabling Regions for your account, see Enabling and Disabling Regions in the AWS Billing and Cost Management User Guide.

For a list of the Regions supported by Amazon EC2, see Regions and Endpoints.

" + }, + "DescribeReservedInstances": { + "name": "DescribeReservedInstances", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeReservedInstancesRequest" + }, + "output": { + "shape": "DescribeReservedInstancesResult" + }, + "documentation": "

Describes one or more of the Reserved Instances that you purchased.

For more information about Reserved Instances, see Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeReservedInstancesListings": { + "name": "DescribeReservedInstancesListings", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeReservedInstancesListingsRequest" + }, + "output": { + "shape": "DescribeReservedInstancesListingsResult" + }, + "documentation": "

Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.

As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeReservedInstancesModifications": { + "name": "DescribeReservedInstancesModifications", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeReservedInstancesModificationsRequest" + }, + "output": { + "shape": "DescribeReservedInstancesModificationsResult" + }, + "documentation": "

Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeReservedInstancesOfferings": { + "name": "DescribeReservedInstancesOfferings", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeReservedInstancesOfferingsRequest" + }, + "output": { + "shape": "DescribeReservedInstancesOfferingsResult" + }, + "documentation": "

Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.

If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeRouteTables": { + "name": "DescribeRouteTables", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeRouteTablesRequest" + }, + "output": { + "shape": "DescribeRouteTablesResult" + }, + "documentation": "

Describes one or more of your route tables.

Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.

For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeScheduledInstanceAvailability": { + "name": "DescribeScheduledInstanceAvailability", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeScheduledInstanceAvailabilityRequest" + }, + "output": { + "shape": "DescribeScheduledInstanceAvailabilityResult" + }, + "documentation": "

Finds available schedules that meet the specified criteria.

You can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.

After you find a schedule that meets your needs, call PurchaseScheduledInstances to purchase Scheduled Instances with that schedule.

" + }, + "DescribeScheduledInstances": { + "name": "DescribeScheduledInstances", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeScheduledInstancesRequest" + }, + "output": { + "shape": "DescribeScheduledInstancesResult" + }, + "documentation": "

Describes the specified Scheduled Instances or all your Scheduled Instances.

" + }, + "DescribeSecurityGroupReferences": { + "name": "DescribeSecurityGroupReferences", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeSecurityGroupReferencesRequest" + }, + "output": { + "shape": "DescribeSecurityGroupReferencesResult" + }, + "documentation": "

[VPC only] Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you've specified in this request.

" + }, + "DescribeSecurityGroups": { + "name": "DescribeSecurityGroups", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeSecurityGroupsRequest" + }, + "output": { + "shape": "DescribeSecurityGroupsResult" + }, + "documentation": "

Describes the specified security groups or all of your security groups.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeSnapshotAttribute": { + "name": "DescribeSnapshotAttribute", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeSnapshotAttributeRequest" + }, + "output": { + "shape": "DescribeSnapshotAttributeResult" + }, + "documentation": "

Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.

For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeSnapshots": { + "name": "DescribeSnapshots", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeSnapshotsRequest" + }, + "output": { + "shape": "DescribeSnapshotsResult" + }, + "documentation": "

Describes the specified EBS snapshots available to you or all of the EBS snapshots available to you.

The snapshots available to you include public snapshots, private snapshots that you own, and private snapshots owned by other AWS accounts for which you have explicit create volume permissions.

The create volume permissions fall into the following categories:

  • public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All AWS accounts have create volume permissions for these snapshots.

  • explicit: The owner of the snapshot granted create volume permissions to a specific AWS account.

  • implicit: An AWS account has implicit create volume permissions for all snapshots it owns.

The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.

If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.

If you specify one or more snapshot owners using the OwnerIds option, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.

If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.

If you are describing a long list of snapshots, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSnapshots request to retrieve the remaining results.

For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeSpotDatafeedSubscription": { + "name": "DescribeSpotDatafeedSubscription", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeSpotDatafeedSubscriptionRequest" + }, + "output": { + "shape": "DescribeSpotDatafeedSubscriptionResult" + }, + "documentation": "

Describes the data feed for Spot Instances. For more information, see Spot Instance Data Feed in the Amazon EC2 User Guide for Linux Instances.

" + }, + "DescribeSpotFleetInstances": { + "name": "DescribeSpotFleetInstances", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeSpotFleetInstancesRequest" + }, + "output": { + "shape": "DescribeSpotFleetInstancesResponse" + }, + "documentation": "

Describes the running instances for the specified Spot Fleet.

" + }, + "DescribeSpotFleetRequestHistory": { + "name": "DescribeSpotFleetRequestHistory", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeSpotFleetRequestHistoryRequest" + }, + "output": { + "shape": "DescribeSpotFleetRequestHistoryResponse" + }, + "documentation": "

Describes the events for the specified Spot Fleet request during the specified time.

Spot Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. Spot Fleet events are available for 48 hours.

" + }, + "DescribeSpotFleetRequests": { + "name": "DescribeSpotFleetRequests", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeSpotFleetRequestsRequest" + }, + "output": { + "shape": "DescribeSpotFleetRequestsResponse" + }, + "documentation": "

Describes your Spot Fleet requests.

Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.

" + }, + "DescribeSpotInstanceRequests": { + "name": "DescribeSpotInstanceRequests", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeSpotInstanceRequestsRequest" + }, + "output": { + "shape": "DescribeSpotInstanceRequestsResult" + }, + "documentation": "

Describes the specified Spot Instance requests.

You can use DescribeSpotInstanceRequests to find a running Spot Instance by examining the response. If the status of the Spot Instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot.

We recommend that you set MaxResults to a value between 5 and 1000 to limit the number of results returned. This paginates the output, which makes the list more manageable and returns the results faster. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSpotInstanceRequests request to retrieve the remaining results.

Spot Instance requests are deleted four hours after they are canceled and their instances are terminated.

" + }, + "DescribeSpotPriceHistory": { + "name": "DescribeSpotPriceHistory", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeSpotPriceHistoryRequest" + }, + "output": { + "shape": "DescribeSpotPriceHistoryResult" + }, + "documentation": "

Describes the Spot price history. For more information, see Spot Instance Pricing History in the Amazon EC2 User Guide for Linux Instances.

When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed.

" + }, + "DescribeStaleSecurityGroups": { + "name": "DescribeStaleSecurityGroups", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeStaleSecurityGroupsRequest" + }, + "output": { + "shape": "DescribeStaleSecurityGroupsResult" + }, + "documentation": "

[VPC only] Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in a peer VPC, or a security group in a peer VPC for which the VPC peering connection has been deleted.

" + }, + "DescribeSubnets": { + "name": "DescribeSubnets", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeSubnetsRequest" + }, + "output": { + "shape": "DescribeSubnetsResult" + }, + "documentation": "

Describes one or more of your subnets.

For more information, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeTags": { + "name": "DescribeTags", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeTagsRequest" + }, + "output": { + "shape": "DescribeTagsResult" + }, + "documentation": "

Describes the specified tags for your EC2 resources.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeTrafficMirrorFilters": { + "name": "DescribeTrafficMirrorFilters", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeTrafficMirrorFiltersRequest" + }, + "output": { + "shape": "DescribeTrafficMirrorFiltersResult" + }, + "documentation": "

Describes one or more Traffic Mirror filters.

" + }, + "DescribeTrafficMirrorSessions": { + "name": "DescribeTrafficMirrorSessions", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeTrafficMirrorSessionsRequest" + }, + "output": { + "shape": "DescribeTrafficMirrorSessionsResult" + }, + "documentation": "

Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.

" + }, + "DescribeTrafficMirrorTargets": { + "name": "DescribeTrafficMirrorTargets", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeTrafficMirrorTargetsRequest" + }, + "output": { + "shape": "DescribeTrafficMirrorTargetsResult" + }, + "documentation": "

Information about one or more Traffic Mirror targets.

" + }, + "DescribeTransitGatewayAttachments": { + "name": "DescribeTransitGatewayAttachments", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeTransitGatewayAttachmentsRequest" + }, + "output": { + "shape": "DescribeTransitGatewayAttachmentsResult" + }, + "documentation": "

Describes one or more attachments between resources and transit gateways. By default, all attachments are described. Alternatively, you can filter the results by attachment ID, attachment state, resource ID, or resource owner.

" + }, + "DescribeTransitGatewayRouteTables": { + "name": "DescribeTransitGatewayRouteTables", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeTransitGatewayRouteTablesRequest" + }, + "output": { + "shape": "DescribeTransitGatewayRouteTablesResult" + }, + "documentation": "

Describes one or more transit gateway route tables. By default, all transit gateway route tables are described. Alternatively, you can filter the results.

" + }, + "DescribeTransitGatewayVpcAttachments": { + "name": "DescribeTransitGatewayVpcAttachments", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeTransitGatewayVpcAttachmentsRequest" + }, + "output": { + "shape": "DescribeTransitGatewayVpcAttachmentsResult" + }, + "documentation": "

Describes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results.

" + }, + "DescribeTransitGateways": { + "name": "DescribeTransitGateways", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeTransitGatewaysRequest" + }, + "output": { + "shape": "DescribeTransitGatewaysResult" + }, + "documentation": "

Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results.

" + }, + "DescribeVolumeAttribute": { + "name": "DescribeVolumeAttribute", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeVolumeAttributeRequest" + }, + "output": { + "shape": "DescribeVolumeAttributeResult" + }, + "documentation": "

Describes the specified attribute of the specified volume. You can specify only one attribute at a time.

For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeVolumeStatus": { + "name": "DescribeVolumeStatus", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeVolumeStatusRequest" + }, + "output": { + "shape": "DescribeVolumeStatusResult" + }, + "documentation": "

Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.

The DescribeVolumeStatus operation provides the following information about the specified volumes:

Status: Reflects the current status of the volume. The possible values are ok, impaired , warning, or insufficient-data. If all checks pass, the overall status of the volume is ok. If the check fails, the overall status is impaired. If the status is insufficient-data, then the checks may still be taking place on your volume at the time. We recommend that you retry the request. For more information about volume status, see Monitoring the Status of Your Volumes in the Amazon Elastic Compute Cloud User Guide.

Events: Reflect the cause of a volume status and may require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and may have inconsistent data.

Actions: Reflect the actions you may have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency, then the action shows enable-volume-io. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.

Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the error state (for example, when a volume is incapable of accepting I/O.)

" + }, + "DescribeVolumes": { + "name": "DescribeVolumes", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeVolumesRequest" + }, + "output": { + "shape": "DescribeVolumesResult" + }, + "documentation": "

Describes the specified EBS volumes or all of your EBS volumes.

If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results.

For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeVolumesModifications": { + "name": "DescribeVolumesModifications", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeVolumesModificationsRequest" + }, + "output": { + "shape": "DescribeVolumesModificationsResult" + }, + "documentation": "

Reports the current modification status of EBS volumes.

Current-generation EBS volumes support modification of attributes including type, size, and (for io1 volumes) IOPS provisioning while either attached to or detached from an instance. Following an action from the API or the console to modify a volume, the status of the modification may be modifying, optimizing, completed, or failed. If a volume has never been modified, then certain elements of the returned VolumeModification objects are null.

You can also use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. For more information, see Monitoring Volume Modifications\" in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeVpcAttribute": { + "name": "DescribeVpcAttribute", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeVpcAttributeRequest" + }, + "output": { + "shape": "DescribeVpcAttributeResult" + }, + "documentation": "

Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.

" + }, + "DescribeVpcClassicLink": { + "name": "DescribeVpcClassicLink", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeVpcClassicLinkRequest" + }, + "output": { + "shape": "DescribeVpcClassicLinkResult" + }, + "documentation": "

Describes the ClassicLink status of one or more VPCs.

" + }, + "DescribeVpcClassicLinkDnsSupport": { + "name": "DescribeVpcClassicLinkDnsSupport", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeVpcClassicLinkDnsSupportRequest" + }, + "output": { + "shape": "DescribeVpcClassicLinkDnsSupportResult" + }, + "documentation": "

Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeVpcEndpointConnectionNotifications": { + "name": "DescribeVpcEndpointConnectionNotifications", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeVpcEndpointConnectionNotificationsRequest" + }, + "output": { + "shape": "DescribeVpcEndpointConnectionNotificationsResult" + }, + "documentation": "

Describes the connection notifications for VPC endpoints and VPC endpoint services.

" + }, + "DescribeVpcEndpointConnections": { + "name": "DescribeVpcEndpointConnections", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeVpcEndpointConnectionsRequest" + }, + "output": { + "shape": "DescribeVpcEndpointConnectionsResult" + }, + "documentation": "

Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.

" + }, + "DescribeVpcEndpointServiceConfigurations": { + "name": "DescribeVpcEndpointServiceConfigurations", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeVpcEndpointServiceConfigurationsRequest" + }, + "output": { + "shape": "DescribeVpcEndpointServiceConfigurationsResult" + }, + "documentation": "

Describes the VPC endpoint service configurations in your account (your services).

" + }, + "DescribeVpcEndpointServicePermissions": { + "name": "DescribeVpcEndpointServicePermissions", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeVpcEndpointServicePermissionsRequest" + }, + "output": { + "shape": "DescribeVpcEndpointServicePermissionsResult" + }, + "documentation": "

Describes the principals (service consumers) that are permitted to discover your VPC endpoint service.

" + }, + "DescribeVpcEndpointServices": { + "name": "DescribeVpcEndpointServices", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeVpcEndpointServicesRequest" + }, + "output": { + "shape": "DescribeVpcEndpointServicesResult" + }, + "documentation": "

Describes available services to which you can create a VPC endpoint.

" + }, + "DescribeVpcEndpoints": { + "name": "DescribeVpcEndpoints", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeVpcEndpointsRequest" + }, + "output": { + "shape": "DescribeVpcEndpointsResult" + }, + "documentation": "

Describes one or more of your VPC endpoints.

" + }, + "DescribeVpcPeeringConnections": { + "name": "DescribeVpcPeeringConnections", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeVpcPeeringConnectionsRequest" + }, + "output": { + "shape": "DescribeVpcPeeringConnectionsResult" + }, + "documentation": "

Describes one or more of your VPC peering connections.

" + }, + "DescribeVpcs": { + "name": "DescribeVpcs", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeVpcsRequest" + }, + "output": { + "shape": "DescribeVpcsResult" + }, + "documentation": "

Describes one or more of your VPCs.

" + }, + "DescribeVpnConnections": { + "name": "DescribeVpnConnections", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeVpnConnectionsRequest" + }, + "output": { + "shape": "DescribeVpnConnectionsResult" + }, + "documentation": "

Describes one or more of your VPN connections.

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

" + }, + "DescribeVpnGateways": { + "name": "DescribeVpnGateways", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeVpnGatewaysRequest" + }, + "output": { + "shape": "DescribeVpnGatewaysResult" + }, + "documentation": "

Describes one or more of your virtual private gateways.

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

" + }, + "DetachClassicLinkVpc": { + "name": "DetachClassicLinkVpc", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DetachClassicLinkVpcRequest" + }, + "output": { + "shape": "DetachClassicLinkVpcResult" + }, + "documentation": "

Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped.

" + }, + "DetachInternetGateway": { + "name": "DetachInternetGateway", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DetachInternetGatewayRequest" + }, + "documentation": "

Detaches an internet gateway from a VPC, disabling connectivity between the internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses or public IPv4 addresses.

" + }, + "DetachNetworkInterface": { + "name": "DetachNetworkInterface", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DetachNetworkInterfaceRequest" + }, + "documentation": "

Detaches a network interface from an instance.

" + }, + "DetachVolume": { + "name": "DetachVolume", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DetachVolumeRequest" + }, + "output": { + "shape": "VolumeAttachment" + }, + "documentation": "

Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so can result in the volume becoming stuck in the busy state while detaching. If this happens, detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot the instance, or all three. If an EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first.

When a volume with an AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance.

For more information, see Detaching an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DetachVpnGateway": { + "name": "DetachVpnGateway", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DetachVpnGatewayRequest" + }, + "documentation": "

Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described).

You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC to the virtual private gateway.

" + }, + "DisableEbsEncryptionByDefault": { + "name": "DisableEbsEncryptionByDefault", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DisableEbsEncryptionByDefaultRequest" + }, + "output": { + "shape": "DisableEbsEncryptionByDefaultResult" + }, + "documentation": "

Disables EBS encryption by default for your account in the current Region.

After you disable encryption by default, you can still create encrypted volumes by enabling encryption when you create each volume.

Disabling encryption by default does not change the encryption status of your existing volumes.

For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DisableTransitGatewayRouteTablePropagation": { + "name": "DisableTransitGatewayRouteTablePropagation", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DisableTransitGatewayRouteTablePropagationRequest" + }, + "output": { + "shape": "DisableTransitGatewayRouteTablePropagationResult" + }, + "documentation": "

Disables the specified resource attachment from propagating routes to the specified propagation route table.

" + }, + "DisableVgwRoutePropagation": { + "name": "DisableVgwRoutePropagation", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DisableVgwRoutePropagationRequest" + }, + "documentation": "

Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.

" + }, + "DisableVpcClassicLink": { + "name": "DisableVpcClassicLink", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DisableVpcClassicLinkRequest" + }, + "output": { + "shape": "DisableVpcClassicLinkResult" + }, + "documentation": "

Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.

" + }, + "DisableVpcClassicLinkDnsSupport": { + "name": "DisableVpcClassicLinkDnsSupport", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DisableVpcClassicLinkDnsSupportRequest" + }, + "output": { + "shape": "DisableVpcClassicLinkDnsSupportResult" + }, + "documentation": "

Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to public IP addresses when addressed between a linked EC2-Classic instance and instances in the VPC to which it's linked. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DisassociateAddress": { + "name": "DisassociateAddress", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DisassociateAddressRequest" + }, + "documentation": "

Disassociates an Elastic IP address from the instance or network interface it's associated with.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

" + }, + "DisassociateClientVpnTargetNetwork": { + "name": "DisassociateClientVpnTargetNetwork", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DisassociateClientVpnTargetNetworkRequest" + }, + "output": { + "shape": "DisassociateClientVpnTargetNetworkResult" + }, + "documentation": "

Disassociates a target network from the specified Client VPN endpoint. When you disassociate the last target network from a Client VPN, the following happens:

  • The route that was automatically added for the VPC is deleted

  • All active client connections are terminated

  • New client connections are disallowed

  • The Client VPN endpoint's status changes to pending-associate

" + }, + "DisassociateIamInstanceProfile": { + "name": "DisassociateIamInstanceProfile", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DisassociateIamInstanceProfileRequest" + }, + "output": { + "shape": "DisassociateIamInstanceProfileResult" + }, + "documentation": "

Disassociates an IAM instance profile from a running or stopped instance.

Use DescribeIamInstanceProfileAssociations to get the association ID.

" + }, + "DisassociateRouteTable": { + "name": "DisassociateRouteTable", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DisassociateRouteTableRequest" + }, + "documentation": "

Disassociates a subnet from a route table.

After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "DisassociateSubnetCidrBlock": { + "name": "DisassociateSubnetCidrBlock", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DisassociateSubnetCidrBlockRequest" + }, + "output": { + "shape": "DisassociateSubnetCidrBlockResult" + }, + "documentation": "

Disassociates a CIDR block from a subnet. Currently, you can disassociate an IPv6 CIDR block only. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it.

" + }, + "DisassociateTransitGatewayRouteTable": { + "name": "DisassociateTransitGatewayRouteTable", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DisassociateTransitGatewayRouteTableRequest" + }, + "output": { + "shape": "DisassociateTransitGatewayRouteTableResult" + }, + "documentation": "

Disassociates a resource attachment from a transit gateway route table.

" + }, + "DisassociateVpcCidrBlock": { + "name": "DisassociateVpcCidrBlock", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DisassociateVpcCidrBlockRequest" + }, + "output": { + "shape": "DisassociateVpcCidrBlockResult" + }, + "documentation": "

Disassociates a CIDR block from a VPC. To disassociate the CIDR block, you must specify its association ID. You can get the association ID by using DescribeVpcs. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it.

You cannot disassociate the CIDR block with which you originally created the VPC (the primary CIDR block).

" + }, + "EnableEbsEncryptionByDefault": { + "name": "EnableEbsEncryptionByDefault", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "EnableEbsEncryptionByDefaultRequest" + }, + "output": { + "shape": "EnableEbsEncryptionByDefaultResult" + }, + "documentation": "

Enables EBS encryption by default for your account in the current Region.

After you enable encryption by default, the EBS volumes that you create are are always encrypted, either using the default CMK or the CMK that you specified when you created each volume. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

You can specify the default CMK for encryption by default using ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId.

Enabling encryption by default has no effect on the encryption status of your existing volumes.

After you enable encryption by default, you can no longer launch instances using instance types that do not support encryption. For more information, see Supported Instance Types.

" + }, + "EnableTransitGatewayRouteTablePropagation": { + "name": "EnableTransitGatewayRouteTablePropagation", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "EnableTransitGatewayRouteTablePropagationRequest" + }, + "output": { + "shape": "EnableTransitGatewayRouteTablePropagationResult" + }, + "documentation": "

Enables the specified attachment to propagate routes to the specified propagation route table.

" + }, + "EnableVgwRoutePropagation": { + "name": "EnableVgwRoutePropagation", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "EnableVgwRoutePropagationRequest" + }, + "documentation": "

Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.

" + }, + "EnableVolumeIO": { + "name": "EnableVolumeIO", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "EnableVolumeIORequest" + }, + "documentation": "

Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.

" + }, + "EnableVpcClassicLink": { + "name": "EnableVpcClassicLink", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "EnableVpcClassicLinkRequest" + }, + "output": { + "shape": "EnableVpcClassicLinkResult" + }, + "documentation": "

Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC route tables have existing routes for address ranges within the 10.0.0.0/8 IP address range, excluding local routes for VPCs in the 10.0.0.0/16 and 10.1.0.0/16 IP address ranges. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" + }, + "EnableVpcClassicLinkDnsSupport": { + "name": "EnableVpcClassicLinkDnsSupport", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "EnableVpcClassicLinkDnsSupportRequest" + }, + "output": { + "shape": "EnableVpcClassicLinkDnsSupportResult" + }, + "documentation": "

Enables a VPC to support DNS hostname resolution for ClassicLink. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ExportClientVpnClientCertificateRevocationList": { + "name": "ExportClientVpnClientCertificateRevocationList", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ExportClientVpnClientCertificateRevocationListRequest" + }, + "output": { + "shape": "ExportClientVpnClientCertificateRevocationListResult" + }, + "documentation": "

Downloads the client certificate revocation list for the specified Client VPN endpoint.

" + }, + "ExportClientVpnClientConfiguration": { + "name": "ExportClientVpnClientConfiguration", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ExportClientVpnClientConfigurationRequest" + }, + "output": { + "shape": "ExportClientVpnClientConfigurationResult" + }, + "documentation": "

Downloads the contents of the Client VPN endpoint configuration file for the specified Client VPN endpoint. The Client VPN endpoint configuration file includes the Client VPN endpoint and certificate information clients need to establish a connection with the Client VPN endpoint.

" + }, + "ExportTransitGatewayRoutes": { + "name": "ExportTransitGatewayRoutes", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ExportTransitGatewayRoutesRequest" + }, + "output": { + "shape": "ExportTransitGatewayRoutesResult" + }, + "documentation": "

Exports routes from the specified transit gateway route table to the specified S3 bucket. By default, all routes are exported. Alternatively, you can filter by CIDR range.

" + }, + "GetConsoleOutput": { + "name": "GetConsoleOutput", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "GetConsoleOutputRequest" + }, + "output": { + "shape": "GetConsoleOutputResult" + }, + "documentation": "

Gets the console output for the specified instance. For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. For Windows instances, the instance console output includes the last three system event log errors.

By default, the console output returns buffered information that was posted shortly after an instance transition state (start, stop, reboot, or terminate). This information is available for at least one hour after the most recent post. Only the most recent 64 KB of console output is available.

You can optionally retrieve the latest serial console output at any time during the instance lifecycle. This option is supported on instance types that use the Nitro hypervisor.

For more information, see Instance Console Output in the Amazon Elastic Compute Cloud User Guide.

" + }, + "GetConsoleScreenshot": { + "name": "GetConsoleScreenshot", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "GetConsoleScreenshotRequest" + }, + "output": { + "shape": "GetConsoleScreenshotResult" + }, + "documentation": "

Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.

The returned content is Base64-encoded.

" + }, + "GetEbsDefaultKmsKeyId": { + "name": "GetEbsDefaultKmsKeyId", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "GetEbsDefaultKmsKeyIdRequest" + }, + "output": { + "shape": "GetEbsDefaultKmsKeyIdResult" + }, + "documentation": "

Describes the default customer master key (CMK) for EBS encryption by default for your account in this Region. You can change the default CMK for encryption by default using ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId.

For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

" + }, + "GetEbsEncryptionByDefault": { + "name": "GetEbsEncryptionByDefault", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "GetEbsEncryptionByDefaultRequest" + }, + "output": { + "shape": "GetEbsEncryptionByDefaultResult" + }, + "documentation": "

Describes whether EBS encryption by default is enabled for your account in the current Region.

For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

" + }, + "GetHostReservationPurchasePreview": { + "name": "GetHostReservationPurchasePreview", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "GetHostReservationPurchasePreviewRequest" + }, + "output": { + "shape": "GetHostReservationPurchasePreviewResult" + }, + "documentation": "

Preview a reservation purchase with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation.

This is a preview of the PurchaseHostReservation action and does not result in the offering being purchased.

" + }, + "GetLaunchTemplateData": { + "name": "GetLaunchTemplateData", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "GetLaunchTemplateDataRequest" + }, + "output": { + "shape": "GetLaunchTemplateDataResult" + }, + "documentation": "

Retrieves the configuration data of the specified instance. You can use this data to create a launch template.

" + }, + "GetPasswordData": { + "name": "GetPasswordData", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "GetPasswordDataRequest" + }, + "output": { + "shape": "GetPasswordDataResult" + }, + "documentation": "

Retrieves the encrypted administrator password for a running Windows instance.

The Windows password is generated at boot by the EC2Config service or EC2Launch scripts (Windows Server 2016 and later). This usually only happens the first time an instance is launched. For more information, see EC2Config and EC2Launch in the Amazon Elastic Compute Cloud User Guide.

For the EC2Config service, the password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling.

The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.

When you launch an instance, password generation and encryption may take a few minutes. If you try to retrieve the password before it's available, the output returns an empty string. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.

" + }, + "GetReservedInstancesExchangeQuote": { + "name": "GetReservedInstancesExchangeQuote", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "GetReservedInstancesExchangeQuoteRequest" + }, + "output": { + "shape": "GetReservedInstancesExchangeQuoteResult" + }, + "documentation": "

Returns a quote and exchange information for exchanging one or more specified Convertible Reserved Instances for a new Convertible Reserved Instance. If the exchange cannot be performed, the reason is returned in the response. Use AcceptReservedInstancesExchangeQuote to perform the exchange.

" + }, + "GetTransitGatewayAttachmentPropagations": { + "name": "GetTransitGatewayAttachmentPropagations", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "GetTransitGatewayAttachmentPropagationsRequest" + }, + "output": { + "shape": "GetTransitGatewayAttachmentPropagationsResult" + }, + "documentation": "

Lists the route tables to which the specified resource attachment propagates routes.

" + }, + "GetTransitGatewayRouteTableAssociations": { + "name": "GetTransitGatewayRouteTableAssociations", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "GetTransitGatewayRouteTableAssociationsRequest" + }, + "output": { + "shape": "GetTransitGatewayRouteTableAssociationsResult" + }, + "documentation": "

Gets information about the associations for the specified transit gateway route table.

" + }, + "GetTransitGatewayRouteTablePropagations": { + "name": "GetTransitGatewayRouteTablePropagations", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "GetTransitGatewayRouteTablePropagationsRequest" + }, + "output": { + "shape": "GetTransitGatewayRouteTablePropagationsResult" + }, + "documentation": "

Gets information about the route table propagations for the specified transit gateway route table.

" + }, + "ImportClientVpnClientCertificateRevocationList": { + "name": "ImportClientVpnClientCertificateRevocationList", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ImportClientVpnClientCertificateRevocationListRequest" + }, + "output": { + "shape": "ImportClientVpnClientCertificateRevocationListResult" + }, + "documentation": "

Uploads a client certificate revocation list to the specified Client VPN endpoint. Uploading a client certificate revocation list overwrites the existing client certificate revocation list.

Uploading a client certificate revocation list resets existing client connections.

" + }, + "ImportImage": { + "name": "ImportImage", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ImportImageRequest" + }, + "output": { + "shape": "ImportImageResult" + }, + "documentation": "

Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI). For more information, see Importing a VM as an Image Using VM Import/Export in the VM Import/Export User Guide.

" + }, + "ImportInstance": { + "name": "ImportInstance", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ImportInstanceRequest" + }, + "output": { + "shape": "ImportInstanceResult" + }, + "documentation": "

Creates an import instance task using metadata from the specified disk image. ImportInstance only supports single-volume VMs. To import multi-volume VMs, use ImportImage. For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.

For information about the import manifest referenced by this API action, see VM Import Manifest.

" + }, + "ImportKeyPair": { + "name": "ImportKeyPair", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ImportKeyPairRequest" + }, + "output": { + "shape": "ImportKeyPairResult" + }, + "documentation": "

Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. The private key is never transferred between you and AWS.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ImportSnapshot": { + "name": "ImportSnapshot", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ImportSnapshotRequest" + }, + "output": { + "shape": "ImportSnapshotResult" + }, + "documentation": "

Imports a disk into an EBS snapshot.

" + }, + "ImportVolume": { + "name": "ImportVolume", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ImportVolumeRequest" + }, + "output": { + "shape": "ImportVolumeResult" + }, + "documentation": "

Creates an import volume task using metadata from the specified disk image.For more information, see Importing Disks to Amazon EBS.

For information about the import manifest referenced by this API action, see VM Import Manifest.

" + }, + "ModifyCapacityReservation": { + "name": "ModifyCapacityReservation", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ModifyCapacityReservationRequest" + }, + "output": { + "shape": "ModifyCapacityReservationResult" + }, + "documentation": "

Modifies a Capacity Reservation's capacity and the conditions under which it is to be released. You cannot change a Capacity Reservation's instance type, EBS optimization, instance store settings, platform, Availability Zone, or instance eligibility. If you need to modify any of these attributes, we recommend that you cancel the Capacity Reservation, and then create a new one with the required attributes.

" + }, + "ModifyClientVpnEndpoint": { + "name": "ModifyClientVpnEndpoint", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ModifyClientVpnEndpointRequest" + }, + "output": { + "shape": "ModifyClientVpnEndpointResult" + }, + "documentation": "

Modifies the specified Client VPN endpoint. You can only modify an endpoint's server certificate information, client connection logging information, DNS server, and description. Modifying the DNS server resets existing client connections.

" + }, + "ModifyEbsDefaultKmsKeyId": { + "name": "ModifyEbsDefaultKmsKeyId", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ModifyEbsDefaultKmsKeyIdRequest" + }, + "output": { + "shape": "ModifyEbsDefaultKmsKeyIdResult" + }, + "documentation": "

Changes the default customer master key (CMK) for EBS encryption by default for your account in this Region.

AWS creates a unique AWS managed CMK in each Region for use with encryption by default. If you change the default CMK to a customer managed CMK, it is used instead of the AWS managed CMK. To reset the default CMK to the AWS managed CMK for EBS, use ResetEbsDefaultKmsKeyId.

If you delete or disable the customer managed CMK that you specified for use with encryption by default, your instances will fail to launch.

For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ModifyFleet": { + "name": "ModifyFleet", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ModifyFleetRequest" + }, + "output": { + "shape": "ModifyFleetResult" + }, + "documentation": "

Modifies the specified EC2 Fleet.

While the EC2 Fleet is being modified, it is in the modifying state.

" + }, + "ModifyFpgaImageAttribute": { + "name": "ModifyFpgaImageAttribute", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ModifyFpgaImageAttributeRequest" + }, + "output": { + "shape": "ModifyFpgaImageAttributeResult" + }, + "documentation": "

Modifies the specified attribute of the specified Amazon FPGA Image (AFI).

" + }, + "ModifyHosts": { + "name": "ModifyHosts", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ModifyHostsRequest" + }, + "output": { + "shape": "ModifyHostsResult" + }, + "documentation": "

Modify the auto-placement setting of a Dedicated Host. When auto-placement is enabled, any instances that you launch with a tenancy of host but without a specific host ID are placed onto any available Dedicated Host in your account that has auto-placement enabled. When auto-placement is disabled, you need to provide a host ID to have the instance launch onto a specific host. If no host ID is provided, the instance is launched onto a suitable host with auto-placement enabled.

" + }, + "ModifyIdFormat": { + "name": "ModifyIdFormat", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ModifyIdFormatRequest" + }, + "documentation": "

Modifies the ID format for the specified resource on a per-Region basis. You can specify that resources should receive longer IDs (17-character IDs) when they are created.

This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

This setting applies to the IAM user who makes the request; it does not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user. If you're using this action as the root user, then these settings apply to the entire account, unless an IAM user explicitly overrides these settings for themselves. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.

" + }, + "ModifyIdentityIdFormat": { + "name": "ModifyIdentityIdFormat", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ModifyIdentityIdFormatRequest" + }, + "documentation": "

Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user for an account; or all IAM users, IAM roles, and the root user for an account. You can specify that resources should receive longer IDs (17-character IDs) when they are created.

This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

This setting applies to the principal specified in the request; it does not apply to the principal that makes the request.

Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.

" + }, + "ModifyImageAttribute": { + "name": "ModifyImageAttribute", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ModifyImageAttributeRequest" + }, + "documentation": "

Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. You can use the Attribute parameter to specify the attribute or one of the following parameters: Description, LaunchPermission, or ProductCode.

AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public.

To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance and create an AMI from the instance.

" + }, + "ModifyInstanceAttribute": { + "name": "ModifyInstanceAttribute", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ModifyInstanceAttributeRequest" + }, + "documentation": "

Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.

Note: Using this action to change the security groups associated with an elastic network interface (ENI) attached to an instance in a VPC can result in an error if the instance has more than one ENI. To change the security groups associated with an ENI attached to an instance that has multiple ENIs, we recommend that you use the ModifyNetworkInterfaceAttribute action.

To modify some attributes, the instance must be stopped. For more information, see Modifying Attributes of a Stopped Instance in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ModifyInstanceCapacityReservationAttributes": { + "name": "ModifyInstanceCapacityReservationAttributes", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ModifyInstanceCapacityReservationAttributesRequest" + }, + "output": { + "shape": "ModifyInstanceCapacityReservationAttributesResult" + }, + "documentation": "

Modifies the Capacity Reservation settings for a stopped instance. Use this action to configure an instance to target a specific Capacity Reservation, run in any open Capacity Reservation with matching attributes, or run On-Demand Instance capacity.

" + }, + "ModifyInstanceCreditSpecification": { + "name": "ModifyInstanceCreditSpecification", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ModifyInstanceCreditSpecificationRequest" + }, + "output": { + "shape": "ModifyInstanceCreditSpecificationResult" + }, + "documentation": "

Modifies the credit option for CPU usage on a running or stopped T2 or T3 instance. The credit options are standard and unlimited.

For more information, see Burstable Performance Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ModifyInstanceEventStartTime": { + "name": "ModifyInstanceEventStartTime", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ModifyInstanceEventStartTimeRequest" + }, + "output": { + "shape": "ModifyInstanceEventStartTimeResult" + }, + "documentation": "

Modifies the start time for a scheduled Amazon EC2 instance event.

" + }, + "ModifyInstancePlacement": { + "name": "ModifyInstancePlacement", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ModifyInstancePlacementRequest" + }, + "output": { + "shape": "ModifyInstancePlacementResult" + }, + "documentation": "

Modifies the placement attributes for a specified instance. You can do the following:

  • Modify the affinity between an instance and a Dedicated Host. When affinity is set to host and the instance is not associated with a specific Dedicated Host, the next time the instance is launched, it is automatically associated with the host on which it lands. If the instance is restarted or rebooted, this relationship persists.

  • Change the Dedicated Host with which an instance is associated.

  • Change the instance tenancy of an instance from host to dedicated, or from dedicated to host.

  • Move an instance to or from a placement group.

At least one attribute for affinity, host ID, tenancy, or placement group name must be specified in the request. Affinity and tenancy can be modified in the same request.

To modify the host ID, tenancy, placement group, or partition for an instance, the instance must be in the stopped state.

" + }, + "ModifyLaunchTemplate": { + "name": "ModifyLaunchTemplate", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ModifyLaunchTemplateRequest" + }, + "output": { + "shape": "ModifyLaunchTemplateResult" + }, + "documentation": "

Modifies a launch template. You can specify which version of the launch template to set as the default version. When launching an instance, the default version applies when a launch template version is not specified.

" + }, + "ModifyNetworkInterfaceAttribute": { + "name": "ModifyNetworkInterfaceAttribute", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ModifyNetworkInterfaceAttributeRequest" + }, + "documentation": "

Modifies the specified network interface attribute. You can specify only one attribute at a time. You can use this action to attach and detach security groups from an existing EC2 instance.

" + }, + "ModifyReservedInstances": { + "name": "ModifyReservedInstances", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ModifyReservedInstancesRequest" + }, + "output": { + "shape": "ModifyReservedInstancesResult" + }, + "documentation": "

Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ModifySnapshotAttribute": { + "name": "ModifySnapshotAttribute", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ModifySnapshotAttributeRequest" + }, + "documentation": "

Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single operation. If you need to both add and remove account IDs for a snapshot, you must use multiple operations.

Encrypted snapshots and snapshots with AWS Marketplace product codes cannot be made public. Snapshots encrypted with your default CMK cannot be shared with other accounts.

For more information about modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ModifySpotFleetRequest": { + "name": "ModifySpotFleetRequest", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ModifySpotFleetRequestRequest" + }, + "output": { + "shape": "ModifySpotFleetRequestResponse" + }, + "documentation": "

Modifies the specified Spot Fleet request.

You can only modify a Spot Fleet request of type maintain.

While the Spot Fleet request is being modified, it is in the modifying state.

To scale up your Spot Fleet, increase its target capacity. The Spot Fleet launches the additional Spot Instances according to the allocation strategy for the Spot Fleet request. If the allocation strategy is lowestPrice, the Spot Fleet launches instances using the Spot pool with the lowest price. If the allocation strategy is diversified, the Spot Fleet distributes the instances across the Spot pools.

To scale down your Spot Fleet, decrease its target capacity. First, the Spot Fleet cancels any open requests that exceed the new target capacity. You can request that the Spot Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is lowestPrice, the Spot Fleet terminates the instances with the highest price per unit. If the allocation strategy is diversified, the Spot Fleet terminates instances across the Spot pools. Alternatively, you can request that the Spot Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.

If you are finished with your Spot Fleet for now, but will use it again later, you can set the target capacity to 0.

" + }, + "ModifySubnetAttribute": { + "name": "ModifySubnetAttribute", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ModifySubnetAttributeRequest" + }, + "documentation": "

Modifies a subnet attribute. You can only modify one attribute at a time.

" + }, + "ModifyTrafficMirrorFilterNetworkServices": { + "name": "ModifyTrafficMirrorFilterNetworkServices", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ModifyTrafficMirrorFilterNetworkServicesRequest" + }, + "output": { + "shape": "ModifyTrafficMirrorFilterNetworkServicesResult" + }, + "documentation": "

Allows or restricts mirroring network services.

By default, Amazon DNS network services are not eligible for Traffic Mirror. Use AddNetworkServices to add network services to a Traffic Mirror filter. When a network service is added to the Traffic Mirror filter, all traffic related to that network service will be mirrored. When you no longer want to mirror network services, use RemoveNetworkServices to remove the network services from the Traffic Mirror filter.

FFor information about filter rule properties, see Network Services in the Traffic Mirroring User Guide .

" + }, + "ModifyTrafficMirrorFilterRule": { + "name": "ModifyTrafficMirrorFilterRule", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ModifyTrafficMirrorFilterRuleRequest" + }, + "output": { + "shape": "ModifyTrafficMirrorFilterRuleResult" + }, + "documentation": "

Modifies the specified Traffic Mirror rule.

DestinationCidrBlock and SourceCidrBlock must both be an IPv4 range or an IPv6 range.

" + }, + "ModifyTrafficMirrorSession": { + "name": "ModifyTrafficMirrorSession", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ModifyTrafficMirrorSessionRequest" + }, + "output": { + "shape": "ModifyTrafficMirrorSessionResult" + }, + "documentation": "

Modifies a Traffic Mirror session.

" + }, + "ModifyTransitGatewayVpcAttachment": { + "name": "ModifyTransitGatewayVpcAttachment", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ModifyTransitGatewayVpcAttachmentRequest" + }, + "output": { + "shape": "ModifyTransitGatewayVpcAttachmentResult" + }, + "documentation": "

Modifies the specified VPC attachment.

" + }, + "ModifyVolume": { + "name": "ModifyVolume", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ModifyVolumeRequest" + }, + "output": { + "shape": "ModifyVolumeResult" + }, + "documentation": "

You can modify several parameters of an existing EBS volume, including volume size, volume type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance type, you may be able to apply these changes without stopping the instance or detaching the volume from it. For more information about modifying an EBS volume running Linux, see Modifying the Size, IOPS, or Type of an EBS Volume on Linux. For more information about modifying an EBS volume running Windows, see Modifying the Size, IOPS, or Type of an EBS Volume on Windows.

When you complete a resize operation on your volume, you need to extend the volume's file-system size to take advantage of the new storage capacity. For information about extending a Linux file system, see Extending a Linux File System. For information about extending a Windows file system, see Extending a Windows File System.

You can use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. You can also track the status of a modification using DescribeVolumesModifications. For information about tracking status changes using either method, see Monitoring Volume Modifications.

With previous-generation instance types, resizing an EBS volume may require detaching and reattaching the volume or stopping and restarting the instance. For more information, see Modifying the Size, IOPS, or Type of an EBS Volume on Linux and Modifying the Size, IOPS, or Type of an EBS Volume on Windows.

If you reach the maximum volume modification rate per volume limit, you will need to wait at least six hours before applying further modifications to the affected EBS volume.

" + }, + "ModifyVolumeAttribute": { + "name": "ModifyVolumeAttribute", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ModifyVolumeAttributeRequest" + }, + "documentation": "

Modifies a volume attribute.

By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.

You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.

" + }, + "ModifyVpcAttribute": { + "name": "ModifyVpcAttribute", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ModifyVpcAttributeRequest" + }, + "documentation": "

Modifies the specified attribute of the specified VPC.

" + }, + "ModifyVpcEndpoint": { + "name": "ModifyVpcEndpoint", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ModifyVpcEndpointRequest" + }, + "output": { + "shape": "ModifyVpcEndpointResult" + }, + "documentation": "

Modifies attributes of a specified VPC endpoint. The attributes that you can modify depend on the type of VPC endpoint (interface or gateway). For more information, see VPC Endpoints in the Amazon Virtual Private Cloud User Guide.

" + }, + "ModifyVpcEndpointConnectionNotification": { + "name": "ModifyVpcEndpointConnectionNotification", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ModifyVpcEndpointConnectionNotificationRequest" + }, + "output": { + "shape": "ModifyVpcEndpointConnectionNotificationResult" + }, + "documentation": "

Modifies a connection notification for VPC endpoint or VPC endpoint service. You can change the SNS topic for the notification, or the events for which to be notified.

" + }, + "ModifyVpcEndpointServiceConfiguration": { + "name": "ModifyVpcEndpointServiceConfiguration", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ModifyVpcEndpointServiceConfigurationRequest" + }, + "output": { + "shape": "ModifyVpcEndpointServiceConfigurationResult" + }, + "documentation": "

Modifies the attributes of your VPC endpoint service configuration. You can change the Network Load Balancers for your service, and you can specify whether acceptance is required for requests to connect to your endpoint service through an interface VPC endpoint.

" + }, + "ModifyVpcEndpointServicePermissions": { + "name": "ModifyVpcEndpointServicePermissions", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ModifyVpcEndpointServicePermissionsRequest" + }, + "output": { + "shape": "ModifyVpcEndpointServicePermissionsResult" + }, + "documentation": "

Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers (IAM users, IAM roles, and AWS accounts) to connect to your endpoint service.

If you grant permissions to all principals, the service is public. Any users who know the name of a public service can send a request to attach an endpoint. If the service does not require manual approval, attachments are automatically approved.

" + }, + "ModifyVpcPeeringConnectionOptions": { + "name": "ModifyVpcPeeringConnectionOptions", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ModifyVpcPeeringConnectionOptionsRequest" + }, + "output": { + "shape": "ModifyVpcPeeringConnectionOptionsResult" + }, + "documentation": "

Modifies the VPC peering connection options on one side of a VPC peering connection. You can do the following:

  • Enable/disable communication over the peering connection between an EC2-Classic instance that's linked to your VPC (using ClassicLink) and instances in the peer VPC.

  • Enable/disable communication over the peering connection between instances in your VPC and an EC2-Classic instance that's linked to the peer VPC.

  • Enable/disable the ability to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.

If the peered VPCs are in the same AWS account, you can enable DNS resolution for queries from the local VPC. This ensures that queries from the local VPC resolve to private IP addresses in the peer VPC. This option is not available if the peered VPCs are in different AWS accounts or different Regions. For peered VPCs in different AWS accounts, each AWS account owner must initiate a separate request to modify the peering connection options. For inter-region peering connections, you must use the Region for the requester VPC to modify the requester VPC peering options and the Region for the accepter VPC to modify the accepter VPC peering options. To verify which VPCs are the accepter and the requester for a VPC peering connection, use the DescribeVpcPeeringConnections command.

" + }, + "ModifyVpcTenancy": { + "name": "ModifyVpcTenancy", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ModifyVpcTenancyRequest" + }, + "output": { + "shape": "ModifyVpcTenancyResult" + }, + "documentation": "

Modifies the instance tenancy attribute of the specified VPC. You can change the instance tenancy attribute of a VPC to default only. You cannot change the instance tenancy attribute to dedicated.

After you modify the tenancy of the VPC, any new instances that you launch into the VPC have a tenancy of default, unless you specify otherwise during launch. The tenancy of any existing instances in the VPC is not affected.

For more information, see Dedicated Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ModifyVpnConnection": { + "name": "ModifyVpnConnection", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ModifyVpnConnectionRequest" + }, + "output": { + "shape": "ModifyVpnConnectionResult" + }, + "documentation": "

Modifies the target gateway of a AWS Site-to-Site VPN connection. The following migration options are available:

  • An existing virtual private gateway to a new virtual private gateway

  • An existing virtual private gateway to a transit gateway

  • An existing transit gateway to a new transit gateway

  • An existing transit gateway to a virtual private gateway

Before you perform the migration to the new gateway, you must configure the new gateway. Use CreateVpnGateway to create a virtual private gateway, or CreateTransitGateway to create a transit gateway.

This step is required when you migrate from a virtual private gateway with static routes to a transit gateway.

You must delete the static routes before you migrate to the new gateway.

Keep a copy of the static route before you delete it. You will need to add back these routes to the transit gateway after the VPN connection migration is complete.

After you migrate to the new gateway, you might need to modify your VPC route table. Use CreateRoute and DeleteRoute to make the changes described in VPN Gateway Target Modification Required VPC Route Table Updates in the AWS Site-to-Site VPN User Guide.

When the new gateway is a transit gateway, modify the transit gateway route table to allow traffic between the VPC and the AWS Site-to-Site VPN connection. Use CreateTransitGatewayRoute to add the routes.

If you deleted VPN static routes, you must add the static routes to the transit gateway route table.

After you perform this operation, the AWS VPN endpoint's IP addresses on the AWS side and the tunnel options remain intact. Your s2slong; connection will be temporarily unavailable for approximately 10 minutes while we provision the new endpoints

" + }, + "MonitorInstances": { + "name": "MonitorInstances", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "MonitorInstancesRequest" + }, + "output": { + "shape": "MonitorInstancesResult" + }, + "documentation": "

Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.

To disable detailed monitoring, see .

" + }, + "MoveAddressToVpc": { + "name": "MoveAddressToVpc", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "MoveAddressToVpcRequest" + }, + "output": { + "shape": "MoveAddressToVpcResult" + }, + "documentation": "

Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account for more than 24 hours, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the RestoreAddressToClassic request. You cannot move an Elastic IP address that was originally allocated for use in the EC2-VPC platform to the EC2-Classic platform.

" + }, + "ProvisionByoipCidr": { + "name": "ProvisionByoipCidr", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ProvisionByoipCidrRequest" + }, + "output": { + "shape": "ProvisionByoipCidrResult" + }, + "documentation": "

Provisions an address range for use with your AWS resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr.

AWS verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.

Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from pending-provision to provisioned. To monitor the status of an address range, use DescribeByoipCidrs. To allocate an Elastic IP address from your address pool, use AllocateAddress with either the specific address from the address pool or the ID of the address pool.

" + }, + "PurchaseHostReservation": { + "name": "PurchaseHostReservation", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "PurchaseHostReservationRequest" + }, + "output": { + "shape": "PurchaseHostReservationResult" + }, + "documentation": "

Purchase a reservation with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation. This action results in the specified reservation being purchased and charged to your account.

" + }, + "PurchaseReservedInstancesOffering": { + "name": "PurchaseReservedInstancesOffering", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "PurchaseReservedInstancesOfferingRequest" + }, + "output": { + "shape": "PurchaseReservedInstancesOfferingResult" + }, + "documentation": "

Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower hourly rate compared to On-Demand instance pricing.

Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances.

For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" + }, + "PurchaseScheduledInstances": { + "name": "PurchaseScheduledInstances", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "PurchaseScheduledInstancesRequest" + }, + "output": { + "shape": "PurchaseScheduledInstancesResult" + }, + "documentation": "

Purchases the Scheduled Instances with the specified schedule.

Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term. Before you can purchase a Scheduled Instance, you must call DescribeScheduledInstanceAvailability to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance, you must call RunScheduledInstances during each scheduled time period.

After you purchase a Scheduled Instance, you can't cancel, modify, or resell your purchase.

" + }, + "RebootInstances": { + "name": "RebootInstances", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "RebootInstancesRequest" + }, + "documentation": "

Requests a reboot of the specified instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.

If an instance does not cleanly shut down within four minutes, Amazon EC2 performs a hard reboot.

For more information about troubleshooting, see Getting Console Output and Rebooting Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "RegisterImage": { + "name": "RegisterImage", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "RegisterImageRequest" + }, + "output": { + "shape": "RegisterImageResult" + }, + "documentation": "

Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating Your Own AMIs in the Amazon Elastic Compute Cloud User Guide.

For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself.

You can also use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. You specify the snapshot using the block device mapping. For more information, see Launching a Linux Instance from a Backup in the Amazon Elastic Compute Cloud User Guide.

You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes.

Some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the EC2 billing product code associated with an AMI to verify the subscription status for package updates. Creating an AMI from an EBS snapshot does not maintain this billing code, and instances launched from such an AMI are not able to connect to package update infrastructure. If you purchase a Reserved Instance offering for one of these Linux distributions and launch instances using an AMI that does not contain the required billing code, your Reserved Instance is not applied to these instances.

To create an AMI for operating systems that require a billing code, see CreateImage.

If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.

" + }, + "RejectTransitGatewayVpcAttachment": { + "name": "RejectTransitGatewayVpcAttachment", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "RejectTransitGatewayVpcAttachmentRequest" + }, + "output": { + "shape": "RejectTransitGatewayVpcAttachmentResult" + }, + "documentation": "

Rejects a request to attach a VPC to a transit gateway.

The VPC attachment must be in the pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use AcceptTransitGatewayVpcAttachment to accept a VPC attachment request.

" + }, + "RejectVpcEndpointConnections": { + "name": "RejectVpcEndpointConnections", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "RejectVpcEndpointConnectionsRequest" + }, + "output": { + "shape": "RejectVpcEndpointConnectionsResult" + }, + "documentation": "

Rejects one or more VPC endpoint connection requests to your VPC endpoint service.

" + }, + "RejectVpcPeeringConnection": { + "name": "RejectVpcPeeringConnection", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "RejectVpcPeeringConnectionRequest" + }, + "output": { + "shape": "RejectVpcPeeringConnectionResult" + }, + "documentation": "

Rejects a VPC peering connection request. The VPC peering connection must be in the pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection.

" + }, + "ReleaseAddress": { + "name": "ReleaseAddress", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ReleaseAddressRequest" + }, + "documentation": "

Releases the specified Elastic IP address.

[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.

[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).

After releasing an Elastic IP address, it is released to the IP address pool. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an AuthFailure error if the address is already allocated to another AWS account.

[EC2-VPC] After you release an Elastic IP address for use in a VPC, you might be able to recover it. For more information, see AllocateAddress.

" + }, + "ReleaseHosts": { + "name": "ReleaseHosts", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ReleaseHostsRequest" + }, + "output": { + "shape": "ReleaseHostsResult" + }, + "documentation": "

When you no longer want to use an On-Demand Dedicated Host it can be released. On-Demand billing is stopped and the host goes into released state. The host ID of Dedicated Hosts that have been released can no longer be specified in another request, for example, to modify the host. You must stop or terminate all instances on a host before it can be released.

When Dedicated Hosts are released, it may take some time for them to stop counting toward your limit and you may receive capacity errors when trying to allocate new Dedicated Hosts. Wait a few minutes and then try again.

Released hosts still appear in a DescribeHosts response.

" + }, + "ReplaceIamInstanceProfileAssociation": { + "name": "ReplaceIamInstanceProfileAssociation", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ReplaceIamInstanceProfileAssociationRequest" + }, + "output": { + "shape": "ReplaceIamInstanceProfileAssociationResult" + }, + "documentation": "

Replaces an IAM instance profile for the specified running instance. You can use this action to change the IAM instance profile that's associated with an instance without having to disassociate the existing IAM instance profile first.

Use DescribeIamInstanceProfileAssociations to get the association ID.

" + }, + "ReplaceNetworkAclAssociation": { + "name": "ReplaceNetworkAclAssociation", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ReplaceNetworkAclAssociationRequest" + }, + "output": { + "shape": "ReplaceNetworkAclAssociationResult" + }, + "documentation": "

Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

This is an idempotent operation.

" + }, + "ReplaceNetworkAclEntry": { + "name": "ReplaceNetworkAclEntry", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ReplaceNetworkAclEntryRequest" + }, + "documentation": "

Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "ReplaceRoute": { + "name": "ReplaceRoute", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ReplaceRouteRequest" + }, + "documentation": "

Replaces an existing route within a route table in a VPC. You must provide only one of the following: internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, or egress-only internet gateway.

For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "ReplaceRouteTableAssociation": { + "name": "ReplaceRouteTableAssociation", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ReplaceRouteTableAssociationRequest" + }, + "output": { + "shape": "ReplaceRouteTableAssociationResult" + }, + "documentation": "

Changes the route table associated with a given subnet in a VPC. After the operation completes, the subnet uses the routes in the new route table it's associated with. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

You can also use ReplaceRouteTableAssociation to change which table is the main route table in the VPC. You just specify the main route table's association ID and the route table to be the new main route table.

" + }, + "ReplaceTransitGatewayRoute": { + "name": "ReplaceTransitGatewayRoute", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ReplaceTransitGatewayRouteRequest" + }, + "output": { + "shape": "ReplaceTransitGatewayRouteResult" + }, + "documentation": "

Replaces the specified route in the specified transit gateway route table.

" + }, + "ReportInstanceStatus": { + "name": "ReportInstanceStatus", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ReportInstanceStatusRequest" + }, + "documentation": "

Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.

Use of this action does not change the value returned by DescribeInstanceStatus.

" + }, + "RequestSpotFleet": { + "name": "RequestSpotFleet", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "RequestSpotFleetRequest" + }, + "output": { + "shape": "RequestSpotFleetResponse" + }, + "documentation": "

Creates a Spot Fleet request.

The Spot Fleet request specifies the total target capacity and the On-Demand target capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand capacity, and launches the difference as Spot capacity.

You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.

By default, the Spot Fleet requests Spot Instances in the Spot pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload.

Alternatively, you can specify that the Spot Fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot Instances in your Spot Fleet are in different Spot pools, you can improve the availability of your fleet.

You can specify tags for the Spot Instances. You cannot tag other resource types in a Spot Fleet request because only the instance resource type is supported.

For more information, see Spot Fleet Requests in the Amazon EC2 User Guide for Linux Instances.

" + }, + "RequestSpotInstances": { + "name": "RequestSpotInstances", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "RequestSpotInstancesRequest" + }, + "output": { + "shape": "RequestSpotInstancesResult" + }, + "documentation": "

Creates a Spot Instance request.

For more information, see Spot Instance Requests in the Amazon EC2 User Guide for Linux Instances.

" + }, + "ResetEbsDefaultKmsKeyId": { + "name": "ResetEbsDefaultKmsKeyId", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ResetEbsDefaultKmsKeyIdRequest" + }, + "output": { + "shape": "ResetEbsDefaultKmsKeyIdResult" + }, + "documentation": "

Resets the default customer master key (CMK) for EBS encryption for your account in this Region to the AWS managed CMK for EBS.

After resetting the default CMK to the AWS managed CMK, you can continue to encrypt by a customer managed CMK by specifying it when you create the volume. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ResetFpgaImageAttribute": { + "name": "ResetFpgaImageAttribute", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ResetFpgaImageAttributeRequest" + }, + "output": { + "shape": "ResetFpgaImageAttributeResult" + }, + "documentation": "

Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value. You can only reset the load permission attribute.

" + }, + "ResetImageAttribute": { + "name": "ResetImageAttribute", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ResetImageAttributeRequest" + }, + "documentation": "

Resets an attribute of an AMI to its default value.

The productCodes attribute can't be reset.

" + }, + "ResetInstanceAttribute": { + "name": "ResetInstanceAttribute", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ResetInstanceAttributeRequest" + }, + "documentation": "

Resets an attribute of an instance to its default value. To reset the kernel or ramdisk, the instance must be in a stopped state. To reset the sourceDestCheck, the instance can be either running or stopped.

The sourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true, which means checking is enabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

" + }, + "ResetNetworkInterfaceAttribute": { + "name": "ResetNetworkInterfaceAttribute", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ResetNetworkInterfaceAttributeRequest" + }, + "documentation": "

Resets a network interface attribute. You can specify only one attribute at a time.

" + }, + "ResetSnapshotAttribute": { + "name": "ResetSnapshotAttribute", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ResetSnapshotAttributeRequest" + }, + "documentation": "

Resets permission settings for the specified snapshot.

For more information about modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.

" + }, + "RestoreAddressToClassic": { + "name": "RestoreAddressToClassic", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "RestoreAddressToClassicRequest" + }, + "output": { + "shape": "RestoreAddressToClassicResult" + }, + "documentation": "

Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface.

" + }, + "RevokeClientVpnIngress": { + "name": "RevokeClientVpnIngress", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "RevokeClientVpnIngressRequest" + }, + "output": { + "shape": "RevokeClientVpnIngressResult" + }, + "documentation": "

Removes an ingress authorization rule from a Client VPN endpoint.

" + }, + "RevokeSecurityGroupEgress": { + "name": "RevokeSecurityGroupEgress", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "RevokeSecurityGroupEgressRequest" + }, + "documentation": "

[VPC only] Removes the specified egress rules from a security group for EC2-VPC. This action doesn't apply to security groups for use in EC2-Classic. To remove a rule, the values that you specify (for example, ports) must match the existing rule's values exactly.

Each rule consists of the protocol and the IPv4 or IPv6 CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not have to specify the description to revoke the rule.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" + }, + "RevokeSecurityGroupIngress": { + "name": "RevokeSecurityGroupIngress", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "RevokeSecurityGroupIngressRequest" + }, + "documentation": "

Removes the specified ingress rules from a security group. To remove a rule, the values that you specify (for example, ports) must match the existing rule's values exactly.

[EC2-Classic only] If the values you specify do not match the existing rule's values, no error is returned. Use DescribeSecurityGroups to verify that the rule has been removed.

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not have to specify the description to revoke the rule.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" + }, + "RunInstances": { + "name": "RunInstances", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "RunInstancesRequest" + }, + "output": { + "shape": "Reservation" + }, + "documentation": "

Launches the specified number of instances using an AMI for which you have permissions.

You can specify a number of options, or leave the default options. The following rules apply:

  • [EC2-VPC] If you don't specify a subnet ID, we choose a default subnet from your default VPC for you. If you don't have a default VPC, you must specify a subnet ID in the request.

  • [EC2-Classic] If don't specify an Availability Zone, we choose one for you.

  • Some instance types must be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID, the request fails. For more information, see Instance Types Available Only in a VPC.

  • [EC2-VPC] All instances have a network interface with a primary private IPv4 address. If you don't specify this address, we choose one from the IPv4 range of your subnet.

  • Not all instance types support IPv6 addresses. For more information, see Instance Types.

  • If you don't specify a security group ID, we use the default security group. For more information, see Security Groups.

  • If any of the AMIs have a product code attached for which the user has not subscribed, the request fails.

You can create a launch template, which is a resource that contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify the launch template instead of specifying the launch parameters.

To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.

An instance is ready for you to use when it's in the running state. You can check the state of your instance using DescribeInstances. You can tag instances and EBS volumes during launch, after launch, or both. For more information, see CreateTags and Tagging Your Amazon EC2 Resources.

Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

For troubleshooting, see What To Do If An Instance Immediately Terminates, and Troubleshooting Connecting to Your Instance in the Amazon Elastic Compute Cloud User Guide.

" + }, + "RunScheduledInstances": { + "name": "RunScheduledInstances", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "RunScheduledInstancesRequest" + }, + "output": { + "shape": "RunScheduledInstancesResult" + }, + "documentation": "

Launches the specified Scheduled Instances.

Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances.

You must launch a Scheduled Instance during its scheduled time period. You can't stop or reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, you can launch it again after a few minutes. For more information, see Scheduled Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "SearchTransitGatewayRoutes": { + "name": "SearchTransitGatewayRoutes", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "SearchTransitGatewayRoutesRequest" + }, + "output": { + "shape": "SearchTransitGatewayRoutesResult" + }, + "documentation": "

Searches for routes in the specified transit gateway route table.

" + }, + "StartInstances": { + "name": "StartInstances", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "StartInstancesRequest" + }, + "output": { + "shape": "StartInstancesResult" + }, + "documentation": "

Starts an Amazon EBS-backed instance that you've previously stopped.

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for instance usage. However, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Every time you start your Windows instance, Amazon EC2 charges you for a full instance hour. If you stop and restart your Windows instance, a new instance hour begins and Amazon EC2 charges you for another full instance hour even if you are still within the same 60-minute period when it was stopped. Every time you start your Linux instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.

Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Performing this operation on an instance that uses an instance store as its root device returns an error.

For more information, see Stopping Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "StopInstances": { + "name": "StopInstances", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "StopInstancesRequest" + }, + "output": { + "shape": "StopInstancesResult" + }, + "documentation": "

Stops an Amazon EBS-backed instance.

You can use the Stop action to hibernate an instance if the instance is enabled for hibernation and it meets the hibernation prerequisites. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.

We don't charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your Windows instance, Amazon EC2 charges you for a full instance hour. If you stop and restart your Windows instance, a new instance hour begins and Amazon EC2 charges you for another full instance hour even if you are still within the same 60-minute period when it was stopped. Every time you start your Linux instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.

You can't start, stop, or hibernate Spot Instances, and you can't stop or hibernate instance store-backed instances. For information about using hibernation for Spot Instances, see Hibernating Interrupted Spot Instances in the Amazon Elastic Compute Cloud User Guide.

When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs.

Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, hibernating, and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshooting Stopping Your Instance in the Amazon Elastic Compute Cloud User Guide.

" + }, + "TerminateClientVpnConnections": { + "name": "TerminateClientVpnConnections", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "TerminateClientVpnConnectionsRequest" + }, + "output": { + "shape": "TerminateClientVpnConnectionsResult" + }, + "documentation": "

Terminates active Client VPN endpoint connections. This action can be used to terminate a specific client connection, or up to five connections established by a specific user.

" + }, + "TerminateInstances": { + "name": "TerminateInstances", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "TerminateInstancesRequest" + }, + "output": { + "shape": "TerminateInstancesResult" + }, + "documentation": "

Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.

If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.

Terminated instances remain visible after termination (for approximately one hour).

By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

For more information about troubleshooting, see Troubleshooting Terminating Your Instance in the Amazon Elastic Compute Cloud User Guide.

" + }, + "UnassignIpv6Addresses": { + "name": "UnassignIpv6Addresses", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "UnassignIpv6AddressesRequest" + }, + "output": { + "shape": "UnassignIpv6AddressesResult" + }, + "documentation": "

Unassigns one or more IPv6 addresses from a network interface.

" + }, + "UnassignPrivateIpAddresses": { + "name": "UnassignPrivateIpAddresses", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "UnassignPrivateIpAddressesRequest" + }, + "documentation": "

Unassigns one or more secondary private IP addresses from a network interface.

" + }, + "UnmonitorInstances": { + "name": "UnmonitorInstances", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "UnmonitorInstancesRequest" + }, + "output": { + "shape": "UnmonitorInstancesResult" + }, + "documentation": "

Disables detailed monitoring for a running instance. For more information, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.

" + }, + "UpdateSecurityGroupRuleDescriptionsEgress": { + "name": "UpdateSecurityGroupRuleDescriptionsEgress", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "UpdateSecurityGroupRuleDescriptionsEgressRequest" + }, + "output": { + "shape": "UpdateSecurityGroupRuleDescriptionsEgressResult" + }, + "documentation": "

[VPC only] Updates the description of an egress (outbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously.

You specify the description as part of the IP permissions structure. You can remove a description for a security group rule by omitting the description parameter in the request.

" + }, + "UpdateSecurityGroupRuleDescriptionsIngress": { + "name": "UpdateSecurityGroupRuleDescriptionsIngress", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "UpdateSecurityGroupRuleDescriptionsIngressRequest" + }, + "output": { + "shape": "UpdateSecurityGroupRuleDescriptionsIngressResult" + }, + "documentation": "

Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously.

You specify the description as part of the IP permissions structure. You can remove a description for a security group rule by omitting the description parameter in the request.

" + }, + "WithdrawByoipCidr": { + "name": "WithdrawByoipCidr", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "WithdrawByoipCidrRequest" + }, + "output": { + "shape": "WithdrawByoipCidrResult" + }, + "documentation": "

Stops advertising an IPv4 address range that is provisioned as an address pool.

You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.

It can take a few minutes before traffic to the specified addresses stops routing to AWS because of BGP propagation delays.

" + } + }, + "shapes": { + "AcceptReservedInstancesExchangeQuoteRequest": { + "type": "structure", + "required": [ + "ReservedInstanceIds" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ReservedInstanceIds": { + "shape": "ReservedInstanceIdSet", + "documentation": "

The IDs of the Convertible Reserved Instances to exchange for another Convertible Reserved Instance of the same or higher value.

", + "locationName": "ReservedInstanceId" + }, + "TargetConfigurations": { + "shape": "TargetConfigurationRequestSet", + "documentation": "

The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.

", + "locationName": "TargetConfiguration" + } + }, + "documentation": "

Contains the parameters for accepting the quote.

" + }, + "AcceptReservedInstancesExchangeQuoteResult": { + "type": "structure", + "members": { + "ExchangeId": { + "shape": "String", + "documentation": "

The ID of the successful exchange.

", + "locationName": "exchangeId" + } + }, + "documentation": "

The result of the exchange and whether it was successful.

" + }, + "AcceptTransitGatewayVpcAttachmentRequest": { + "type": "structure", + "required": [ + "TransitGatewayAttachmentId" + ], + "members": { + "TransitGatewayAttachmentId": { + "shape": "String", + "documentation": "

The ID of the attachment.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "AcceptTransitGatewayVpcAttachmentResult": { + "type": "structure", + "members": { + "TransitGatewayVpcAttachment": { + "shape": "TransitGatewayVpcAttachment", + "documentation": "

The VPC attachment.

", + "locationName": "transitGatewayVpcAttachment" + } + } + }, + "AcceptVpcEndpointConnectionsRequest": { + "type": "structure", + "required": [ + "ServiceId", + "VpcEndpointIds" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ServiceId": { + "shape": "String", + "documentation": "

The ID of the endpoint service.

" + }, + "VpcEndpointIds": { + "shape": "ValueStringList", + "documentation": "

The IDs of one or more interface VPC endpoints.

", + "locationName": "VpcEndpointId" + } + } + }, + "AcceptVpcEndpointConnectionsResult": { + "type": "structure", + "members": { + "Unsuccessful": { + "shape": "UnsuccessfulItemSet", + "documentation": "

Information about the interface endpoints that were not accepted, if applicable.

", + "locationName": "unsuccessful" + } + } + }, + "AcceptVpcPeeringConnectionRequest": { + "type": "structure", + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "VpcPeeringConnectionId": { + "shape": "String", + "documentation": "

The ID of the VPC peering connection. You must specify this parameter in the request.

", + "locationName": "vpcPeeringConnectionId" + } + } + }, + "AcceptVpcPeeringConnectionResult": { + "type": "structure", + "members": { + "VpcPeeringConnection": { + "shape": "VpcPeeringConnection", + "documentation": "

Information about the VPC peering connection.

", + "locationName": "vpcPeeringConnection" + } + } + }, + "AccountAttribute": { + "type": "structure", + "members": { + "AttributeName": { + "shape": "String", + "documentation": "

The name of the account attribute.

", + "locationName": "attributeName" + }, + "AttributeValues": { + "shape": "AccountAttributeValueList", + "documentation": "

The values for the account attribute.

", + "locationName": "attributeValueSet" + } + }, + "documentation": "

Describes an account attribute.

" + }, + "AccountAttributeList": { + "type": "list", + "member": { + "shape": "AccountAttribute", + "locationName": "item" + } + }, + "AccountAttributeName": { + "type": "string", + "enum": [ + "supported-platforms", + "default-vpc" + ] + }, + "AccountAttributeNameStringList": { + "type": "list", + "member": { + "shape": "AccountAttributeName", + "locationName": "attributeName" + } + }, + "AccountAttributeValue": { + "type": "structure", + "members": { + "AttributeValue": { + "shape": "String", + "documentation": "

The value of the attribute.

", + "locationName": "attributeValue" + } + }, + "documentation": "

Describes a value of an account attribute.

" + }, + "AccountAttributeValueList": { + "type": "list", + "member": { + "shape": "AccountAttributeValue", + "locationName": "item" + } + }, + "ActiveInstance": { + "type": "structure", + "members": { + "InstanceId": { + "shape": "String", + "documentation": "

The ID of the instance.

", + "locationName": "instanceId" + }, + "InstanceType": { + "shape": "String", + "documentation": "

The instance type.

", + "locationName": "instanceType" + }, + "SpotInstanceRequestId": { + "shape": "String", + "documentation": "

The ID of the Spot Instance request.

", + "locationName": "spotInstanceRequestId" + }, + "InstanceHealth": { + "shape": "InstanceHealthStatus", + "documentation": "

The health status of the instance. If the status of either the instance status check or the system status check is impaired, the health status of the instance is unhealthy. Otherwise, the health status is healthy.

", + "locationName": "instanceHealth" + } + }, + "documentation": "

Describes a running instance in a Spot Fleet.

" + }, + "ActiveInstanceSet": { + "type": "list", + "member": { + "shape": "ActiveInstance", + "locationName": "item" + } + }, + "ActivityStatus": { + "type": "string", + "enum": [ + "error", + "pending_fulfillment", + "pending_termination", + "fulfilled" + ] + }, + "Address": { + "type": "structure", + "members": { + "InstanceId": { + "shape": "String", + "documentation": "

The ID of the instance that the address is associated with (if any).

", + "locationName": "instanceId" + }, + "PublicIp": { + "shape": "String", + "documentation": "

The Elastic IP address.

", + "locationName": "publicIp" + }, + "AllocationId": { + "shape": "String", + "documentation": "

The ID representing the allocation of the address for use with EC2-VPC.

", + "locationName": "allocationId" + }, + "AssociationId": { + "shape": "String", + "documentation": "

The ID representing the association of the address with an instance in a VPC.

", + "locationName": "associationId" + }, + "Domain": { + "shape": "DomainType", + "documentation": "

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

", + "locationName": "domain" + }, + "NetworkInterfaceId": { + "shape": "String", + "documentation": "

The ID of the network interface.

", + "locationName": "networkInterfaceId" + }, + "NetworkInterfaceOwnerId": { + "shape": "String", + "documentation": "

The ID of the AWS account that owns the network interface.

", + "locationName": "networkInterfaceOwnerId" + }, + "PrivateIpAddress": { + "shape": "String", + "documentation": "

The private IP address associated with the Elastic IP address.

", + "locationName": "privateIpAddress" + }, + "Tags": { + "shape": "TagList", + "documentation": "

Any tags assigned to the Elastic IP address.

", + "locationName": "tagSet" + }, + "PublicIpv4Pool": { + "shape": "String", + "documentation": "

The ID of an address pool.

", + "locationName": "publicIpv4Pool" + } + }, + "documentation": "

Describes an Elastic IP address.

" + }, + "AddressList": { + "type": "list", + "member": { + "shape": "Address", + "locationName": "item" + } + }, + "AdvertiseByoipCidrRequest": { + "type": "structure", + "required": [ + "Cidr" + ], + "members": { + "Cidr": { + "shape": "String", + "documentation": "

The IPv4 address range, in CIDR notation. This must be the exact range that you provisioned. You can't advertise only a portion of the provisioned range.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "AdvertiseByoipCidrResult": { + "type": "structure", + "members": { + "ByoipCidr": { + "shape": "ByoipCidr", + "documentation": "

Information about the address range.

", + "locationName": "byoipCidr" + } + } + }, + "Affinity": { + "type": "string", + "enum": [ + "default", + "host" + ] + }, + "AllocateAddressRequest": { + "type": "structure", + "members": { + "Domain": { + "shape": "DomainType", + "documentation": "

Set to vpc to allocate the address for use with instances in a VPC.

Default: The address is for use with instances in EC2-Classic.

" + }, + "Address": { + "shape": "String", + "documentation": "

[EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.

" + }, + "PublicIpv4Pool": { + "shape": "String", + "documentation": "

The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. To specify a specific address from the address pool, use the Address parameter instead.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + } + }, + "AllocateAddressResult": { + "type": "structure", + "members": { + "PublicIp": { + "shape": "String", + "documentation": "

The Elastic IP address.

", + "locationName": "publicIp" + }, + "AllocationId": { + "shape": "String", + "documentation": "

[EC2-VPC] The ID that AWS assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.

", + "locationName": "allocationId" + }, + "PublicIpv4Pool": { + "shape": "String", + "documentation": "

The ID of an address pool.

", + "locationName": "publicIpv4Pool" + }, + "Domain": { + "shape": "DomainType", + "documentation": "

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

", + "locationName": "domain" + } + } + }, + "AllocateHostsRequest": { + "type": "structure", + "required": [ + "AvailabilityZone", + "InstanceType", + "Quantity" + ], + "members": { + "AutoPlacement": { + "shape": "AutoPlacement", + "documentation": "

Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see Understanding Instance Placement and Host Affinity in the Amazon EC2 User Guide for Linux Instances.

Default: on

", + "locationName": "autoPlacement" + }, + "AvailabilityZone": { + "shape": "String", + "documentation": "

The Availability Zone in which to allocate the Dedicated Host.

", + "locationName": "availabilityZone" + }, + "ClientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "locationName": "clientToken" + }, + "InstanceType": { + "shape": "String", + "documentation": "

Specifies the instance type for which to configure your Dedicated Hosts. When you specify the instance type, that is the only instance type that you can launch onto that host.

", + "locationName": "instanceType" + }, + "Quantity": { + "shape": "Integer", + "documentation": "

The number of Dedicated Hosts to allocate to your account with these parameters.

", + "locationName": "quantity" + }, + "TagSpecifications": { + "shape": "TagSpecificationList", + "documentation": "

The tags to apply to the Dedicated Host during creation.

", + "locationName": "TagSpecification" + }, + "HostRecovery": { + "shape": "HostRecovery", + "documentation": "

Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. For more information, see Host Recovery in the Amazon Elastic Compute Cloud User Guide.

Default: off

" + } + } + }, + "AllocateHostsResult": { + "type": "structure", + "members": { + "HostIds": { + "shape": "ResponseHostIdList", + "documentation": "

The ID of the allocated Dedicated Host. This is used to launch an instance onto a specific host.

", + "locationName": "hostIdSet" + } + }, + "documentation": "

Contains the output of AllocateHosts.

" + }, + "AllocationIdList": { + "type": "list", + "member": { + "shape": "String", + "locationName": "AllocationId" + } + }, + "AllocationState": { + "type": "string", + "enum": [ + "available", + "under-assessment", + "permanent-failure", + "released", + "released-permanent-failure", + "pending" + ] + }, + "AllocationStrategy": { + "type": "string", + "enum": [ + "lowestPrice", + "diversified" + ] + }, + "AllowedPrincipal": { + "type": "structure", + "members": { + "PrincipalType": { + "shape": "PrincipalType", + "documentation": "

The type of principal.

", + "locationName": "principalType" + }, + "Principal": { + "shape": "String", + "documentation": "

The Amazon Resource Name (ARN) of the principal.

", + "locationName": "principal" + } + }, + "documentation": "

Describes a principal.

" + }, + "AllowedPrincipalSet": { + "type": "list", + "member": { + "shape": "AllowedPrincipal", + "locationName": "item" + } + }, + "ApplySecurityGroupsToClientVpnTargetNetworkRequest": { + "type": "structure", + "required": [ + "ClientVpnEndpointId", + "VpcId", + "SecurityGroupIds" + ], + "members": { + "ClientVpnEndpointId": { + "shape": "String", + "documentation": "

The ID of the Client VPN endpoint.

" + }, + "VpcId": { + "shape": "String", + "documentation": "

The ID of the VPC in which the associated target network is located.

" + }, + "SecurityGroupIds": { + "shape": "ClientVpnSecurityGroupIdSet", + "documentation": "

The IDs of the security groups to apply to the associated target network. Up to 5 security groups can be applied to an associated target network.

", + "locationName": "SecurityGroupId" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "ApplySecurityGroupsToClientVpnTargetNetworkResult": { + "type": "structure", + "members": { + "SecurityGroupIds": { + "shape": "ClientVpnSecurityGroupIdSet", + "documentation": "

The IDs of the applied security groups.

", + "locationName": "securityGroupIds" + } + } + }, + "ArchitectureValues": { + "type": "string", + "enum": [ + "i386", + "x86_64", + "arm64" + ] + }, + "AssignIpv6AddressesRequest": { + "type": "structure", + "required": [ + "NetworkInterfaceId" + ], + "members": { + "Ipv6AddressCount": { + "shape": "Integer", + "documentation": "

The number of IPv6 addresses to assign to the network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.

", + "locationName": "ipv6AddressCount" + }, + "Ipv6Addresses": { + "shape": "Ipv6AddressList", + "documentation": "

One or more specific IPv6 addresses to be assigned to the network interface. You can't use this option if you're specifying a number of IPv6 addresses.

", + "locationName": "ipv6Addresses" + }, + "NetworkInterfaceId": { + "shape": "String", + "documentation": "

The ID of the network interface.

", + "locationName": "networkInterfaceId" + } + } + }, + "AssignIpv6AddressesResult": { + "type": "structure", + "members": { + "AssignedIpv6Addresses": { + "shape": "Ipv6AddressList", + "documentation": "

The IPv6 addresses assigned to the network interface.

", + "locationName": "assignedIpv6Addresses" + }, + "NetworkInterfaceId": { + "shape": "String", + "documentation": "

The ID of the network interface.

", + "locationName": "networkInterfaceId" + } + } + }, + "AssignPrivateIpAddressesRequest": { + "type": "structure", + "required": [ + "NetworkInterfaceId" + ], + "members": { + "AllowReassignment": { + "shape": "Boolean", + "documentation": "

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

", + "locationName": "allowReassignment" + }, + "NetworkInterfaceId": { + "shape": "String", + "documentation": "

The ID of the network interface.

", + "locationName": "networkInterfaceId" + }, + "PrivateIpAddresses": { + "shape": "PrivateIpAddressStringList", + "documentation": "

One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

", + "locationName": "privateIpAddress" + }, + "SecondaryPrivateIpAddressCount": { + "shape": "Integer", + "documentation": "

The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.

", + "locationName": "secondaryPrivateIpAddressCount" + } + }, + "documentation": "

Contains the parameters for AssignPrivateIpAddresses.

" + }, + "AssociateAddressRequest": { + "type": "structure", + "members": { + "AllocationId": { + "shape": "String", + "documentation": "

[EC2-VPC] The allocation ID. This is required for EC2-VPC.

" + }, + "InstanceId": { + "shape": "String", + "documentation": "

The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.

" + }, + "PublicIp": { + "shape": "String", + "documentation": "

The Elastic IP address to associate with the instance. This is required for EC2-Classic.

" + }, + "AllowReassociation": { + "shape": "Boolean", + "documentation": "

[EC2-VPC] For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface. Otherwise, the operation fails. In a VPC in an EC2-VPC-only account, reassociation is automatic, therefore you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.

", + "locationName": "allowReassociation" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "NetworkInterfaceId": { + "shape": "String", + "documentation": "

[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.

For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both.

", + "locationName": "networkInterfaceId" + }, + "PrivateIpAddress": { + "shape": "String", + "documentation": "

[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.

", + "locationName": "privateIpAddress" + } + } + }, + "AssociateAddressResult": { + "type": "structure", + "members": { + "AssociationId": { + "shape": "String", + "documentation": "

[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.

", + "locationName": "associationId" + } + } + }, + "AssociateClientVpnTargetNetworkRequest": { + "type": "structure", + "required": [ + "ClientVpnEndpointId", + "SubnetId" + ], + "members": { + "ClientVpnEndpointId": { + "shape": "String", + "documentation": "

The ID of the Client VPN endpoint.

" + }, + "SubnetId": { + "shape": "String", + "documentation": "

The ID of the subnet to associate with the Client VPN endpoint.

" + }, + "ClientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "idempotencyToken": true + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "AssociateClientVpnTargetNetworkResult": { + "type": "structure", + "members": { + "AssociationId": { + "shape": "String", + "documentation": "

The unique ID of the target network association.

", + "locationName": "associationId" + }, + "Status": { + "shape": "AssociationStatus", + "documentation": "

The current state of the target network association.

", + "locationName": "status" + } + } + }, + "AssociateDhcpOptionsRequest": { + "type": "structure", + "required": [ + "DhcpOptionsId", + "VpcId" + ], + "members": { + "DhcpOptionsId": { + "shape": "String", + "documentation": "

The ID of the DHCP options set, or default to associate no DHCP options with the VPC.

" + }, + "VpcId": { + "shape": "String", + "documentation": "

The ID of the VPC.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + } + }, + "AssociateIamInstanceProfileRequest": { + "type": "structure", + "required": [ + "IamInstanceProfile", + "InstanceId" + ], + "members": { + "IamInstanceProfile": { + "shape": "IamInstanceProfileSpecification", + "documentation": "

The IAM instance profile.

" + }, + "InstanceId": { + "shape": "String", + "documentation": "

The ID of the instance.

" + } + } + }, + "AssociateIamInstanceProfileResult": { + "type": "structure", + "members": { + "IamInstanceProfileAssociation": { + "shape": "IamInstanceProfileAssociation", + "documentation": "

Information about the IAM instance profile association.

", + "locationName": "iamInstanceProfileAssociation" + } + } + }, + "AssociateRouteTableRequest": { + "type": "structure", + "required": [ + "RouteTableId", + "SubnetId" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "RouteTableId": { + "shape": "String", + "documentation": "

The ID of the route table.

", + "locationName": "routeTableId" + }, + "SubnetId": { + "shape": "String", + "documentation": "

The ID of the subnet.

", + "locationName": "subnetId" + } + } + }, + "AssociateRouteTableResult": { + "type": "structure", + "members": { + "AssociationId": { + "shape": "String", + "documentation": "

The route table association ID. This ID is required for disassociating the route table.

", + "locationName": "associationId" + } + } + }, + "AssociateSubnetCidrBlockRequest": { + "type": "structure", + "required": [ + "Ipv6CidrBlock", + "SubnetId" + ], + "members": { + "Ipv6CidrBlock": { + "shape": "String", + "documentation": "

The IPv6 CIDR block for your subnet. The subnet must have a /64 prefix length.

", + "locationName": "ipv6CidrBlock" + }, + "SubnetId": { + "shape": "String", + "documentation": "

The ID of your subnet.

", + "locationName": "subnetId" + } + } + }, + "AssociateSubnetCidrBlockResult": { + "type": "structure", + "members": { + "Ipv6CidrBlockAssociation": { + "shape": "SubnetIpv6CidrBlockAssociation", + "documentation": "

Information about the IPv6 CIDR block association.

", + "locationName": "ipv6CidrBlockAssociation" + }, + "SubnetId": { + "shape": "String", + "documentation": "

The ID of the subnet.

", + "locationName": "subnetId" + } + } + }, + "AssociateTransitGatewayRouteTableRequest": { + "type": "structure", + "required": [ + "TransitGatewayRouteTableId", + "TransitGatewayAttachmentId" + ], + "members": { + "TransitGatewayRouteTableId": { + "shape": "String", + "documentation": "

The ID of the transit gateway route table.

" + }, + "TransitGatewayAttachmentId": { + "shape": "String", + "documentation": "

The ID of the attachment.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "AssociateTransitGatewayRouteTableResult": { + "type": "structure", + "members": { + "Association": { + "shape": "TransitGatewayAssociation", + "documentation": "

The ID of the association.

", + "locationName": "association" + } + } + }, + "AssociateVpcCidrBlockRequest": { + "type": "structure", + "required": [ + "VpcId" + ], + "members": { + "AmazonProvidedIpv6CidrBlock": { + "shape": "Boolean", + "documentation": "

Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses, or the size of the CIDR block.

", + "locationName": "amazonProvidedIpv6CidrBlock" + }, + "CidrBlock": { + "shape": "String", + "documentation": "

An IPv4 CIDR block to associate with the VPC.

" + }, + "VpcId": { + "shape": "String", + "documentation": "

The ID of the VPC.

", + "locationName": "vpcId" + } + } + }, + "AssociateVpcCidrBlockResult": { + "type": "structure", + "members": { + "Ipv6CidrBlockAssociation": { + "shape": "VpcIpv6CidrBlockAssociation", + "documentation": "

Information about the IPv6 CIDR block association.

", + "locationName": "ipv6CidrBlockAssociation" + }, + "CidrBlockAssociation": { + "shape": "VpcCidrBlockAssociation", + "documentation": "

Information about the IPv4 CIDR block association.

", + "locationName": "cidrBlockAssociation" + }, + "VpcId": { + "shape": "String", + "documentation": "

The ID of the VPC.

", + "locationName": "vpcId" + } + } + }, + "AssociatedNetworkType": { + "type": "string", + "enum": [ + "vpc" + ] + }, + "AssociatedTargetNetwork": { + "type": "structure", + "members": { + "NetworkId": { + "shape": "String", + "documentation": "

The ID of the subnet.

", + "locationName": "networkId" + }, + "NetworkType": { + "shape": "AssociatedNetworkType", + "documentation": "

The target network type.

", + "locationName": "networkType" + } + }, + "documentation": "

Describes a target network that is associated with a Client VPN endpoint. A target network is a subnet in a VPC.

" + }, + "AssociatedTargetNetworkSet": { + "type": "list", + "member": { + "shape": "AssociatedTargetNetwork", + "locationName": "item" + } + }, + "AssociationIdList": { + "type": "list", + "member": { + "shape": "String", + "locationName": "AssociationId" + } + }, + "AssociationStatus": { + "type": "structure", + "members": { + "Code": { + "shape": "AssociationStatusCode", + "documentation": "

The state of the target network association.

", + "locationName": "code" + }, + "Message": { + "shape": "String", + "documentation": "

A message about the status of the target network association, if applicable.

", + "locationName": "message" + } + }, + "documentation": "

Describes the state of a target network association.

" + }, + "AssociationStatusCode": { + "type": "string", + "enum": [ + "associating", + "associated", + "association-failed", + "disassociating", + "disassociated" + ] + }, + "AttachClassicLinkVpcRequest": { + "type": "structure", + "required": [ + "Groups", + "InstanceId", + "VpcId" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "Groups": { + "shape": "GroupIdStringList", + "documentation": "

The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.

", + "locationName": "SecurityGroupId" + }, + "InstanceId": { + "shape": "String", + "documentation": "

The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.

", + "locationName": "instanceId" + }, + "VpcId": { + "shape": "String", + "documentation": "

The ID of a ClassicLink-enabled VPC.

", + "locationName": "vpcId" + } + } + }, + "AttachClassicLinkVpcResult": { + "type": "structure", + "members": { + "Return": { + "shape": "Boolean", + "documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName": "return" + } + } + }, + "AttachInternetGatewayRequest": { + "type": "structure", + "required": [ + "InternetGatewayId", + "VpcId" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "InternetGatewayId": { + "shape": "String", + "documentation": "

The ID of the internet gateway.

", + "locationName": "internetGatewayId" + }, + "VpcId": { + "shape": "String", + "documentation": "

The ID of the VPC.

", + "locationName": "vpcId" + } + } + }, + "AttachNetworkInterfaceRequest": { + "type": "structure", + "required": [ + "DeviceIndex", + "InstanceId", + "NetworkInterfaceId" + ], + "members": { + "DeviceIndex": { + "shape": "Integer", + "documentation": "

The index of the device for the network interface attachment.

", + "locationName": "deviceIndex" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "InstanceId": { + "shape": "String", + "documentation": "

The ID of the instance.

", + "locationName": "instanceId" + }, + "NetworkInterfaceId": { + "shape": "String", + "documentation": "

The ID of the network interface.

", + "locationName": "networkInterfaceId" + } + }, + "documentation": "

Contains the parameters for AttachNetworkInterface.

" + }, + "AttachNetworkInterfaceResult": { + "type": "structure", + "members": { + "AttachmentId": { + "shape": "String", + "documentation": "

The ID of the network interface attachment.

", + "locationName": "attachmentId" + } + }, + "documentation": "

Contains the output of AttachNetworkInterface.

" + }, + "AttachVolumeRequest": { + "type": "structure", + "required": [ + "Device", + "InstanceId", + "VolumeId" + ], + "members": { + "Device": { + "shape": "String", + "documentation": "

The device name (for example, /dev/sdh or xvdh).

" + }, + "InstanceId": { + "shape": "String", + "documentation": "

The ID of the instance.

" + }, + "VolumeId": { + "shape": "String", + "documentation": "

The ID of the EBS volume. The volume and instance must be within the same Availability Zone.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + }, + "documentation": "

Contains the parameters for AttachVolume.

" + }, + "AttachVpnGatewayRequest": { + "type": "structure", + "required": [ + "VpcId", + "VpnGatewayId" + ], + "members": { + "VpcId": { + "shape": "String", + "documentation": "

The ID of the VPC.

" + }, + "VpnGatewayId": { + "shape": "String", + "documentation": "

The ID of the virtual private gateway.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + }, + "documentation": "

Contains the parameters for AttachVpnGateway.

" + }, + "AttachVpnGatewayResult": { + "type": "structure", + "members": { + "VpcAttachment": { + "shape": "VpcAttachment", + "documentation": "

Information about the attachment.

", + "locationName": "attachment" + } + }, + "documentation": "

Contains the output of AttachVpnGateway.

" + }, + "AttachmentStatus": { + "type": "string", + "enum": [ + "attaching", + "attached", + "detaching", + "detached" + ] + }, + "AttributeBooleanValue": { + "type": "structure", + "members": { + "Value": { + "shape": "Boolean", + "documentation": "

The attribute value. The valid values are true or false.

", + "locationName": "value" + } + }, + "documentation": "

Describes a value for a resource attribute that is a Boolean value.

" + }, + "AttributeValue": { + "type": "structure", + "members": { + "Value": { + "shape": "String", + "documentation": "

The attribute value. The value is case-sensitive.

", + "locationName": "value" + } + }, + "documentation": "

Describes a value for a resource attribute that is a String.

" + }, + "AuthorizationRule": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "shape": "String", + "documentation": "

The ID of the Client VPN endpoint with which the authorization rule is associated.

", + "locationName": "clientVpnEndpointId" + }, + "Description": { + "shape": "String", + "documentation": "

A brief description of the authorization rule.

", + "locationName": "description" + }, + "GroupId": { + "shape": "String", + "documentation": "

The ID of the Active Directory group to which the authorization rule grants access.

", + "locationName": "groupId" + }, + "AccessAll": { + "shape": "Boolean", + "documentation": "

Indicates whether the authorization rule grants access to all clients.

", + "locationName": "accessAll" + }, + "DestinationCidr": { + "shape": "String", + "documentation": "

The IPv4 address range, in CIDR notation, of the network to which the authorization rule applies.

", + "locationName": "destinationCidr" + }, + "Status": { + "shape": "ClientVpnAuthorizationRuleStatus", + "documentation": "

The current state of the authorization rule.

", + "locationName": "status" + } + }, + "documentation": "

Information about an authorization rule.

" + }, + "AuthorizationRuleSet": { + "type": "list", + "member": { + "shape": "AuthorizationRule", + "locationName": "item" + } + }, + "AuthorizeClientVpnIngressRequest": { + "type": "structure", + "required": [ + "ClientVpnEndpointId", + "TargetNetworkCidr" + ], + "members": { + "ClientVpnEndpointId": { + "shape": "String", + "documentation": "

The ID of the Client VPN endpoint.

" + }, + "TargetNetworkCidr": { + "shape": "String", + "documentation": "

The IPv4 address range, in CIDR notation, of the network for which access is being authorized.

" + }, + "AccessGroupId": { + "shape": "String", + "documentation": "

The ID of the Active Directory group to grant access.

" + }, + "AuthorizeAllGroups": { + "shape": "Boolean", + "documentation": "

Indicates whether to grant access to all clients. Use true to grant all clients who successfully establish a VPN connection access to the network.

" + }, + "Description": { + "shape": "String", + "documentation": "

A brief description of the authorization rule.

" + }, + "ClientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "idempotencyToken": true + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "AuthorizeClientVpnIngressResult": { + "type": "structure", + "members": { + "Status": { + "shape": "ClientVpnAuthorizationRuleStatus", + "documentation": "

The current state of the authorization rule.

", + "locationName": "status" + } + } + }, + "AuthorizeSecurityGroupEgressRequest": { + "type": "structure", + "required": [ + "GroupId" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "GroupId": { + "shape": "String", + "documentation": "

The ID of the security group.

", + "locationName": "groupId" + }, + "IpPermissions": { + "shape": "IpPermissionList", + "documentation": "

The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions.

", + "locationName": "ipPermissions" + }, + "CidrIp": { + "shape": "String", + "documentation": "

Not supported. Use a set of IP permissions to specify the CIDR.

", + "locationName": "cidrIp" + }, + "FromPort": { + "shape": "Integer", + "documentation": "

Not supported. Use a set of IP permissions to specify the port.

", + "locationName": "fromPort" + }, + "IpProtocol": { + "shape": "String", + "documentation": "

Not supported. Use a set of IP permissions to specify the protocol name or number.

", + "locationName": "ipProtocol" + }, + "ToPort": { + "shape": "Integer", + "documentation": "

Not supported. Use a set of IP permissions to specify the port.

", + "locationName": "toPort" + }, + "SourceSecurityGroupName": { + "shape": "String", + "documentation": "

Not supported. Use a set of IP permissions to specify a destination security group.

", + "locationName": "sourceSecurityGroupName" + }, + "SourceSecurityGroupOwnerId": { + "shape": "String", + "documentation": "

Not supported. Use a set of IP permissions to specify a destination security group.

", + "locationName": "sourceSecurityGroupOwnerId" + } + } + }, + "AuthorizeSecurityGroupIngressRequest": { + "type": "structure", + "members": { + "CidrIp": { + "shape": "String", + "documentation": "

The IPv4 address range, in CIDR format. You can't specify this parameter when specifying a source security group. To specify an IPv6 address range, use a set of IP permissions.

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

" + }, + "FromPort": { + "shape": "Integer", + "documentation": "

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all types. If you specify all ICMP types, you must specify all codes.

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

" + }, + "GroupId": { + "shape": "String", + "documentation": "

The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.

" + }, + "GroupName": { + "shape": "String", + "documentation": "

[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.

" + }, + "IpPermissions": { + "shape": "IpPermissionList", + "documentation": "

The sets of IP permissions.

" + }, + "IpProtocol": { + "shape": "String", + "documentation": "

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). To specify icmpv6, use a set of IP permissions.

[VPC only] Use -1 to specify all protocols. If you specify -1 or a protocol other than tcp, udp, or icmp, traffic on all ports is allowed, regardless of any ports you specify.

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

" + }, + "SourceSecurityGroupName": { + "shape": "String", + "documentation": "

[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For EC2-VPC, the source security group must be in the same VPC.

" + }, + "SourceSecurityGroupOwnerId": { + "shape": "String", + "documentation": "

[nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead.

" + }, + "ToPort": { + "shape": "Integer", + "documentation": "

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all codes. If you specify all ICMP types, you must specify all codes.

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + } + }, + "AutoAcceptSharedAttachmentsValue": { + "type": "string", + "enum": [ + "enable", + "disable" + ] + }, + "AutoPlacement": { + "type": "string", + "enum": [ + "on", + "off" + ] + }, + "AvailabilityZone": { + "type": "structure", + "members": { + "State": { + "shape": "AvailabilityZoneState", + "documentation": "

The state of the Availability Zone.

", + "locationName": "zoneState" + }, + "Messages": { + "shape": "AvailabilityZoneMessageList", + "documentation": "

Any messages about the Availability Zone.

", + "locationName": "messageSet" + }, + "RegionName": { + "shape": "String", + "documentation": "

The name of the Region.

", + "locationName": "regionName" + }, + "ZoneName": { + "shape": "String", + "documentation": "

The name of the Availability Zone.

", + "locationName": "zoneName" + }, + "ZoneId": { + "shape": "String", + "documentation": "

The ID of the Availability Zone.

", + "locationName": "zoneId" + } + }, + "documentation": "

Describes an Availability Zone.

" + }, + "AvailabilityZoneList": { + "type": "list", + "member": { + "shape": "AvailabilityZone", + "locationName": "item" + } + }, + "AvailabilityZoneMessage": { + "type": "structure", + "members": { + "Message": { + "shape": "String", + "documentation": "

The message about the Availability Zone.

", + "locationName": "message" + } + }, + "documentation": "

Describes a message about an Availability Zone.

" + }, + "AvailabilityZoneMessageList": { + "type": "list", + "member": { + "shape": "AvailabilityZoneMessage", + "locationName": "item" + } + }, + "AvailabilityZoneState": { + "type": "string", + "enum": [ + "available", + "information", + "impaired", + "unavailable" + ] + }, + "AvailableCapacity": { + "type": "structure", + "members": { + "AvailableInstanceCapacity": { + "shape": "AvailableInstanceCapacityList", + "documentation": "

The total number of instances supported by the Dedicated Host.

", + "locationName": "availableInstanceCapacity" + }, + "AvailableVCpus": { + "shape": "Integer", + "documentation": "

The number of vCPUs available on the Dedicated Host.

", + "locationName": "availableVCpus" + } + }, + "documentation": "

The capacity information for instances launched onto the Dedicated Host.

" + }, + "AvailableInstanceCapacityList": { + "type": "list", + "member": { + "shape": "InstanceCapacity", + "locationName": "item" + } + }, + "BatchState": { + "type": "string", + "enum": [ + "submitted", + "active", + "cancelled", + "failed", + "cancelled_running", + "cancelled_terminating", + "modifying" + ] + }, + "BillingProductList": { + "type": "list", + "member": { + "shape": "String", + "locationName": "item" + } + }, + "Blob": { + "type": "blob" + }, + "BlobAttributeValue": { + "type": "structure", + "members": { + "Value": { + "shape": "Blob", + "locationName": "value" + } + } + }, + "BlockDeviceMapping": { + "type": "structure", + "members": { + "DeviceName": { + "shape": "String", + "documentation": "

The device name (for example, /dev/sdh or xvdh).

", + "locationName": "deviceName" + }, + "VirtualName": { + "shape": "String", + "documentation": "

The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.

Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

", + "locationName": "virtualName" + }, + "Ebs": { + "shape": "EbsBlockDevice", + "documentation": "

Parameters used to automatically set up EBS volumes when the instance is launched.

", + "locationName": "ebs" + }, + "NoDevice": { + "shape": "String", + "documentation": "

Suppresses the specified device included in the block device mapping of the AMI.

", + "locationName": "noDevice" + } + }, + "documentation": "

Describes a block device mapping.

" + }, + "BlockDeviceMappingList": { + "type": "list", + "member": { + "shape": "BlockDeviceMapping", + "locationName": "item" + } + }, + "BlockDeviceMappingRequestList": { + "type": "list", + "member": { + "shape": "BlockDeviceMapping", + "locationName": "BlockDeviceMapping" + } + }, + "Boolean": { + "type": "boolean" + }, + "BundleIdStringList": { + "type": "list", + "member": { + "shape": "String", + "locationName": "BundleId" + } + }, + "BundleInstanceRequest": { + "type": "structure", + "required": [ + "InstanceId", + "Storage" + ], + "members": { + "InstanceId": { + "shape": "String", + "documentation": "

The ID of the instance to bundle.

Type: String

Default: None

Required: Yes

" + }, + "Storage": { + "shape": "Storage", + "documentation": "

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + }, + "documentation": "

Contains the parameters for BundleInstance.

" + }, + "BundleInstanceResult": { + "type": "structure", + "members": { + "BundleTask": { + "shape": "BundleTask", + "documentation": "

Information about the bundle task.

", + "locationName": "bundleInstanceTask" + } + }, + "documentation": "

Contains the output of BundleInstance.

" + }, + "BundleTask": { + "type": "structure", + "members": { + "BundleId": { + "shape": "String", + "documentation": "

The ID of the bundle task.

", + "locationName": "bundleId" + }, + "BundleTaskError": { + "shape": "BundleTaskError", + "documentation": "

If the task fails, a description of the error.

", + "locationName": "error" + }, + "InstanceId": { + "shape": "String", + "documentation": "

The ID of the instance associated with this bundle task.

", + "locationName": "instanceId" + }, + "Progress": { + "shape": "String", + "documentation": "

The level of task completion, as a percent (for example, 20%).

", + "locationName": "progress" + }, + "StartTime": { + "shape": "DateTime", + "documentation": "

The time this task started.

", + "locationName": "startTime" + }, + "State": { + "shape": "BundleTaskState", + "documentation": "

The state of the task.

", + "locationName": "state" + }, + "Storage": { + "shape": "Storage", + "documentation": "

The Amazon S3 storage locations.

", + "locationName": "storage" + }, + "UpdateTime": { + "shape": "DateTime", + "documentation": "

The time of the most recent update for the task.

", + "locationName": "updateTime" + } + }, + "documentation": "

Describes a bundle task.

" + }, + "BundleTaskError": { + "type": "structure", + "members": { + "Code": { + "shape": "String", + "documentation": "

The error code.

", + "locationName": "code" + }, + "Message": { + "shape": "String", + "documentation": "

The error message.

", + "locationName": "message" + } + }, + "documentation": "

Describes an error for BundleInstance.

" + }, + "BundleTaskList": { + "type": "list", + "member": { + "shape": "BundleTask", + "locationName": "item" + } + }, + "BundleTaskState": { + "type": "string", + "enum": [ + "pending", + "waiting-for-shutdown", + "bundling", + "storing", + "cancelling", + "complete", + "failed" + ] + }, + "ByoipCidr": { + "type": "structure", + "members": { + "Cidr": { + "shape": "String", + "documentation": "

The public IPv4 address range, in CIDR notation.

", + "locationName": "cidr" + }, + "Description": { + "shape": "String", + "documentation": "

The description of the address range.

", + "locationName": "description" + }, + "StatusMessage": { + "shape": "String", + "documentation": "

Upon success, contains the ID of the address pool. Otherwise, contains an error message.

", + "locationName": "statusMessage" + }, + "State": { + "shape": "ByoipCidrState", + "documentation": "

The state of the address pool.

", + "locationName": "state" + } + }, + "documentation": "

Information about an address range that is provisioned for use with your AWS resources through bring your own IP addresses (BYOIP).

" + }, + "ByoipCidrSet": { + "type": "list", + "member": { + "shape": "ByoipCidr", + "locationName": "item" + } + }, + "ByoipCidrState": { + "type": "string", + "enum": [ + "advertised", + "deprovisioned", + "failed-deprovision", + "failed-provision", + "pending-deprovision", + "pending-provision", + "provisioned" + ] + }, + "CancelBatchErrorCode": { + "type": "string", + "enum": [ + "fleetRequestIdDoesNotExist", + "fleetRequestIdMalformed", + "fleetRequestNotInCancellableState", + "unexpectedError" + ] + }, + "CancelBundleTaskRequest": { + "type": "structure", + "required": [ + "BundleId" + ], + "members": { + "BundleId": { + "shape": "String", + "documentation": "

The ID of the bundle task.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + }, + "documentation": "

Contains the parameters for CancelBundleTask.

" + }, + "CancelBundleTaskResult": { + "type": "structure", + "members": { + "BundleTask": { + "shape": "BundleTask", + "documentation": "

Information about the bundle task.

", + "locationName": "bundleInstanceTask" + } + }, + "documentation": "

Contains the output of CancelBundleTask.

" + }, + "CancelCapacityReservationRequest": { + "type": "structure", + "required": [ + "CapacityReservationId" + ], + "members": { + "CapacityReservationId": { + "shape": "String", + "documentation": "

The ID of the Capacity Reservation to be cancelled.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "CancelCapacityReservationResult": { + "type": "structure", + "members": { + "Return": { + "shape": "Boolean", + "documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName": "return" + } + } + }, + "CancelConversionRequest": { + "type": "structure", + "required": [ + "ConversionTaskId" + ], + "members": { + "ConversionTaskId": { + "shape": "String", + "documentation": "

The ID of the conversion task.

", + "locationName": "conversionTaskId" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "ReasonMessage": { + "shape": "String", + "documentation": "

The reason for canceling the conversion task.

", + "locationName": "reasonMessage" + } + } + }, + "CancelExportTaskRequest": { + "type": "structure", + "required": [ + "ExportTaskId" + ], + "members": { + "ExportTaskId": { + "shape": "String", + "documentation": "

The ID of the export task. This is the ID returned by CreateInstanceExportTask.

", + "locationName": "exportTaskId" + } + } + }, + "CancelImportTaskRequest": { + "type": "structure", + "members": { + "CancelReason": { + "shape": "String", + "documentation": "

The reason for canceling the task.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ImportTaskId": { + "shape": "String", + "documentation": "

The ID of the import image or import snapshot task to be canceled.

" + } + } + }, + "CancelImportTaskResult": { + "type": "structure", + "members": { + "ImportTaskId": { + "shape": "String", + "documentation": "

The ID of the task being canceled.

", + "locationName": "importTaskId" + }, + "PreviousState": { + "shape": "String", + "documentation": "

The current state of the task being canceled.

", + "locationName": "previousState" + }, + "State": { + "shape": "String", + "documentation": "

The current state of the task being canceled.

", + "locationName": "state" + } + } + }, + "CancelReservedInstancesListingRequest": { + "type": "structure", + "required": [ + "ReservedInstancesListingId" + ], + "members": { + "ReservedInstancesListingId": { + "shape": "String", + "documentation": "

The ID of the Reserved Instance listing.

", + "locationName": "reservedInstancesListingId" + } + }, + "documentation": "

Contains the parameters for CancelReservedInstancesListing.

" + }, + "CancelReservedInstancesListingResult": { + "type": "structure", + "members": { + "ReservedInstancesListings": { + "shape": "ReservedInstancesListingList", + "documentation": "

The Reserved Instance listing.

", + "locationName": "reservedInstancesListingsSet" + } + }, + "documentation": "

Contains the output of CancelReservedInstancesListing.

" + }, + "CancelSpotFleetRequestsError": { + "type": "structure", + "members": { + "Code": { + "shape": "CancelBatchErrorCode", + "documentation": "

The error code.

", + "locationName": "code" + }, + "Message": { + "shape": "String", + "documentation": "

The description for the error code.

", + "locationName": "message" + } + }, + "documentation": "

Describes a Spot Fleet error.

" + }, + "CancelSpotFleetRequestsErrorItem": { + "type": "structure", + "members": { + "Error": { + "shape": "CancelSpotFleetRequestsError", + "documentation": "

The error.

", + "locationName": "error" + }, + "SpotFleetRequestId": { + "shape": "String", + "documentation": "

The ID of the Spot Fleet request.

", + "locationName": "spotFleetRequestId" + } + }, + "documentation": "

Describes a Spot Fleet request that was not successfully canceled.

" + }, + "CancelSpotFleetRequestsErrorSet": { + "type": "list", + "member": { + "shape": "CancelSpotFleetRequestsErrorItem", + "locationName": "item" + } + }, + "CancelSpotFleetRequestsRequest": { + "type": "structure", + "required": [ + "SpotFleetRequestIds", + "TerminateInstances" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "SpotFleetRequestIds": { + "shape": "ValueStringList", + "documentation": "

The IDs of the Spot Fleet requests.

", + "locationName": "spotFleetRequestId" + }, + "TerminateInstances": { + "shape": "Boolean", + "documentation": "

Indicates whether to terminate instances for a Spot Fleet request if it is canceled successfully.

", + "locationName": "terminateInstances" + } + }, + "documentation": "

Contains the parameters for CancelSpotFleetRequests.

" + }, + "CancelSpotFleetRequestsResponse": { + "type": "structure", + "members": { + "SuccessfulFleetRequests": { + "shape": "CancelSpotFleetRequestsSuccessSet", + "documentation": "

Information about the Spot Fleet requests that are successfully canceled.

", + "locationName": "successfulFleetRequestSet" + }, + "UnsuccessfulFleetRequests": { + "shape": "CancelSpotFleetRequestsErrorSet", + "documentation": "

Information about the Spot Fleet requests that are not successfully canceled.

", + "locationName": "unsuccessfulFleetRequestSet" + } + }, + "documentation": "

Contains the output of CancelSpotFleetRequests.

" + }, + "CancelSpotFleetRequestsSuccessItem": { + "type": "structure", + "members": { + "CurrentSpotFleetRequestState": { + "shape": "BatchState", + "documentation": "

The current state of the Spot Fleet request.

", + "locationName": "currentSpotFleetRequestState" + }, + "PreviousSpotFleetRequestState": { + "shape": "BatchState", + "documentation": "

The previous state of the Spot Fleet request.

", + "locationName": "previousSpotFleetRequestState" + }, + "SpotFleetRequestId": { + "shape": "String", + "documentation": "

The ID of the Spot Fleet request.

", + "locationName": "spotFleetRequestId" + } + }, + "documentation": "

Describes a Spot Fleet request that was successfully canceled.

" + }, + "CancelSpotFleetRequestsSuccessSet": { + "type": "list", + "member": { + "shape": "CancelSpotFleetRequestsSuccessItem", + "locationName": "item" + } + }, + "CancelSpotInstanceRequestState": { + "type": "string", + "enum": [ + "active", + "open", + "closed", + "cancelled", + "completed" + ] + }, + "CancelSpotInstanceRequestsRequest": { + "type": "structure", + "required": [ + "SpotInstanceRequestIds" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "SpotInstanceRequestIds": { + "shape": "SpotInstanceRequestIdList", + "documentation": "

One or more Spot Instance request IDs.

", + "locationName": "SpotInstanceRequestId" + } + }, + "documentation": "

Contains the parameters for CancelSpotInstanceRequests.

" + }, + "CancelSpotInstanceRequestsResult": { + "type": "structure", + "members": { + "CancelledSpotInstanceRequests": { + "shape": "CancelledSpotInstanceRequestList", + "documentation": "

One or more Spot Instance requests.

", + "locationName": "spotInstanceRequestSet" + } + }, + "documentation": "

Contains the output of CancelSpotInstanceRequests.

" + }, + "CancelledSpotInstanceRequest": { + "type": "structure", + "members": { + "SpotInstanceRequestId": { + "shape": "String", + "documentation": "

The ID of the Spot Instance request.

", + "locationName": "spotInstanceRequestId" + }, + "State": { + "shape": "CancelSpotInstanceRequestState", + "documentation": "

The state of the Spot Instance request.

", + "locationName": "state" + } + }, + "documentation": "

Describes a request to cancel a Spot Instance.

" + }, + "CancelledSpotInstanceRequestList": { + "type": "list", + "member": { + "shape": "CancelledSpotInstanceRequest", + "locationName": "item" + } + }, + "CapacityReservation": { + "type": "structure", + "members": { + "CapacityReservationId": { + "shape": "String", + "documentation": "

The ID of the Capacity Reservation.

", + "locationName": "capacityReservationId" + }, + "InstanceType": { + "shape": "String", + "documentation": "

The type of instance for which the Capacity Reservation reserves capacity.

", + "locationName": "instanceType" + }, + "InstancePlatform": { + "shape": "CapacityReservationInstancePlatform", + "documentation": "

The type of operating system for which the Capacity Reservation reserves capacity.

", + "locationName": "instancePlatform" + }, + "AvailabilityZone": { + "shape": "String", + "documentation": "

The Availability Zone in which the capacity is reserved.

", + "locationName": "availabilityZone" + }, + "Tenancy": { + "shape": "CapacityReservationTenancy", + "documentation": "

Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

  • default - The Capacity Reservation is created on hardware that is shared with other AWS accounts.

  • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.

", + "locationName": "tenancy" + }, + "TotalInstanceCount": { + "shape": "Integer", + "documentation": "

The number of instances for which the Capacity Reservation reserves capacity.

", + "locationName": "totalInstanceCount" + }, + "AvailableInstanceCount": { + "shape": "Integer", + "documentation": "

The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.

", + "locationName": "availableInstanceCount" + }, + "EbsOptimized": { + "shape": "Boolean", + "documentation": "

Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.

", + "locationName": "ebsOptimized" + }, + "EphemeralStorage": { + "shape": "Boolean", + "documentation": "

Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.

", + "locationName": "ephemeralStorage" + }, + "State": { + "shape": "CapacityReservationState", + "documentation": "

The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

  • active - The Capacity Reservation is active and the capacity is available for your use.

  • cancelled - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

  • expired - The Capacity Reservation was manually cancelled. The reserved capacity is no longer available for your use.

  • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

  • failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

", + "locationName": "state" + }, + "EndDate": { + "shape": "DateTime", + "documentation": "

The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.

", + "locationName": "endDate" + }, + "EndDateType": { + "shape": "EndDateType", + "documentation": "

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

  • unlimited - The Capacity Reservation remains active until you explicitly cancel it.

  • limited - The Capacity Reservation expires automatically at a specified date and time.

", + "locationName": "endDateType" + }, + "InstanceMatchCriteria": { + "shape": "InstanceMatchCriteria", + "documentation": "

Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

  • open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.

  • targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

", + "locationName": "instanceMatchCriteria" + }, + "CreateDate": { + "shape": "DateTime", + "documentation": "

The date and time at which the Capacity Reservation was created.

", + "locationName": "createDate" + }, + "Tags": { + "shape": "TagList", + "documentation": "

Any tags assigned to the Capacity Reservation.

", + "locationName": "tagSet" + } + }, + "documentation": "

Describes a Capacity Reservation.

" + }, + "CapacityReservationIdSet": { + "type": "list", + "member": { + "shape": "String", + "locationName": "item" + } + }, + "CapacityReservationInstancePlatform": { + "type": "string", + "enum": [ + "Linux/UNIX", + "Red Hat Enterprise Linux", + "SUSE Linux", + "Windows", + "Windows with SQL Server", + "Windows with SQL Server Enterprise", + "Windows with SQL Server Standard", + "Windows with SQL Server Web", + "Linux with SQL Server Standard", + "Linux with SQL Server Web", + "Linux with SQL Server Enterprise" + ] + }, + "CapacityReservationPreference": { + "type": "string", + "enum": [ + "open", + "none" + ] + }, + "CapacityReservationSet": { + "type": "list", + "member": { + "shape": "CapacityReservation", + "locationName": "item" + } + }, + "CapacityReservationSpecification": { + "type": "structure", + "members": { + "CapacityReservationPreference": { + "shape": "CapacityReservationPreference", + "documentation": "

Indicates the instance's Capacity Reservation preferences. Possible preferences include:

  • open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

  • none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs as an On-Demand Instance.

" + }, + "CapacityReservationTarget": { + "shape": "CapacityReservationTarget", + "documentation": "

Information about the target Capacity Reservation.

" + } + }, + "documentation": "

Describes an instance's Capacity Reservation targeting option. You can specify only one parameter at a time. If you specify CapacityReservationPreference and CapacityReservationTarget, the request fails.

Use the CapacityReservationPreference parameter to configure the instance to run as an On-Demand Instance or to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). Use the CapacityReservationTarget parameter to explicitly target a specific Capacity Reservation.

" + }, + "CapacityReservationSpecificationResponse": { + "type": "structure", + "members": { + "CapacityReservationPreference": { + "shape": "CapacityReservationPreference", + "documentation": "

Describes the instance's Capacity Reservation preferences. Possible preferences include:

  • open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

  • none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.

", + "locationName": "capacityReservationPreference" + }, + "CapacityReservationTarget": { + "shape": "CapacityReservationTargetResponse", + "documentation": "

Information about the targeted Capacity Reservation.

", + "locationName": "capacityReservationTarget" + } + }, + "documentation": "

Describes the instance's Capacity Reservation targeting preferences. The action returns the capacityReservationPreference response element if the instance is configured to run in On-Demand capacity, or if it is configured in run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). The action returns the capacityReservationTarget response element if the instance explicily targets a specific Capacity Reservation.

" + }, + "CapacityReservationState": { + "type": "string", + "enum": [ + "active", + "expired", + "cancelled", + "pending", + "failed" + ] + }, + "CapacityReservationTarget": { + "type": "structure", + "members": { + "CapacityReservationId": { + "shape": "String", + "documentation": "

The ID of the Capacity Reservation.

" + } + }, + "documentation": "

Describes a target Capacity Reservation.

" + }, + "CapacityReservationTargetResponse": { + "type": "structure", + "members": { + "CapacityReservationId": { + "shape": "String", + "documentation": "

The ID of the Capacity Reservation.

", + "locationName": "capacityReservationId" + } + }, + "documentation": "

Describes a target Capacity Reservation.

" + }, + "CapacityReservationTenancy": { + "type": "string", + "enum": [ + "default", + "dedicated" + ] + }, + "CertificateAuthentication": { + "type": "structure", + "members": { + "ClientRootCertificateChain": { + "shape": "String", + "documentation": "

The ARN of the client certificate.

", + "locationName": "clientRootCertificateChain" + } + }, + "documentation": "

Information about the client certificate used for authentication.

" + }, + "CertificateAuthenticationRequest": { + "type": "structure", + "members": { + "ClientRootCertificateChainArn": { + "shape": "String", + "documentation": "

The ARN of the client certificate. The certificate must be signed by a certificate authority (CA) and it must be provisioned in AWS Certificate Manager (ACM).

" + } + }, + "documentation": "

Information about the client certificate to be used for authentication.

" + }, + "CidrAuthorizationContext": { + "type": "structure", + "required": [ + "Message", + "Signature" + ], + "members": { + "Message": { + "shape": "String", + "documentation": "

The plain-text authorization message for the prefix and account.

" + }, + "Signature": { + "shape": "String", + "documentation": "

The signed authorization message for the prefix and account.

" + } + }, + "documentation": "

Provides authorization for Amazon to bring a specific IP address range to a specific AWS account using bring your own IP addresses (BYOIP). For more information, see Prepare to Bring Your Address Range to Your AWS Account in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CidrBlock": { + "type": "structure", + "members": { + "CidrBlock": { + "shape": "String", + "documentation": "

The IPv4 CIDR block.

", + "locationName": "cidrBlock" + } + }, + "documentation": "

Describes an IPv4 CIDR block.

" + }, + "CidrBlockSet": { + "type": "list", + "member": { + "shape": "CidrBlock", + "locationName": "item" + } + }, + "ClassicLinkDnsSupport": { + "type": "structure", + "members": { + "ClassicLinkDnsSupported": { + "shape": "Boolean", + "documentation": "

Indicates whether ClassicLink DNS support is enabled for the VPC.

", + "locationName": "classicLinkDnsSupported" + }, + "VpcId": { + "shape": "String", + "documentation": "

The ID of the VPC.

", + "locationName": "vpcId" + } + }, + "documentation": "

Describes the ClassicLink DNS support status of a VPC.

" + }, + "ClassicLinkDnsSupportList": { + "type": "list", + "member": { + "shape": "ClassicLinkDnsSupport", + "locationName": "item" + } + }, + "ClassicLinkInstance": { + "type": "structure", + "members": { + "Groups": { + "shape": "GroupIdentifierList", + "documentation": "

A list of security groups.

", + "locationName": "groupSet" + }, + "InstanceId": { + "shape": "String", + "documentation": "

The ID of the instance.

", + "locationName": "instanceId" + }, + "Tags": { + "shape": "TagList", + "documentation": "

Any tags assigned to the instance.

", + "locationName": "tagSet" + }, + "VpcId": { + "shape": "String", + "documentation": "

The ID of the VPC.

", + "locationName": "vpcId" + } + }, + "documentation": "

Describes a linked EC2-Classic instance.

" + }, + "ClassicLinkInstanceList": { + "type": "list", + "member": { + "shape": "ClassicLinkInstance", + "locationName": "item" + } + }, + "ClassicLoadBalancer": { + "type": "structure", + "members": { + "Name": { + "shape": "String", + "documentation": "

The name of the load balancer.

", + "locationName": "name" + } + }, + "documentation": "

Describes a Classic Load Balancer.

" + }, + "ClassicLoadBalancers": { + "type": "list", + "member": { + "shape": "ClassicLoadBalancer", + "locationName": "item" + }, + "max": 5, + "min": 1 + }, + "ClassicLoadBalancersConfig": { + "type": "structure", + "members": { + "ClassicLoadBalancers": { + "shape": "ClassicLoadBalancers", + "documentation": "

One or more Classic Load Balancers.

", + "locationName": "classicLoadBalancers" + } + }, + "documentation": "

Describes the Classic Load Balancers to attach to a Spot Fleet. Spot Fleet registers the running Spot Instances with these Classic Load Balancers.

" + }, + "ClientCertificateRevocationListStatus": { + "type": "structure", + "members": { + "Code": { + "shape": "ClientCertificateRevocationListStatusCode", + "documentation": "

The state of the client certificate revocation list.

", + "locationName": "code" + }, + "Message": { + "shape": "String", + "documentation": "

A message about the status of the client certificate revocation list, if applicable.

", + "locationName": "message" + } + }, + "documentation": "

Describes the state of a client certificate revocation list.

" + }, + "ClientCertificateRevocationListStatusCode": { + "type": "string", + "enum": [ + "pending", + "active" + ] + }, + "ClientData": { + "type": "structure", + "members": { + "Comment": { + "shape": "String", + "documentation": "

A user-defined comment about the disk upload.

" + }, + "UploadEnd": { + "shape": "DateTime", + "documentation": "

The time that the disk upload ends.

" + }, + "UploadSize": { + "shape": "Double", + "documentation": "

The size of the uploaded disk image, in GiB.

" + }, + "UploadStart": { + "shape": "DateTime", + "documentation": "

The time that the disk upload starts.

" + } + }, + "documentation": "

Describes the client-specific data.

" + }, + "ClientVpnAuthentication": { + "type": "structure", + "members": { + "Type": { + "shape": "ClientVpnAuthenticationType", + "documentation": "

The authentication type used.

", + "locationName": "type" + }, + "ActiveDirectory": { + "shape": "DirectoryServiceAuthentication", + "documentation": "

Information about the Active Directory, if applicable.

", + "locationName": "activeDirectory" + }, + "MutualAuthentication": { + "shape": "CertificateAuthentication", + "documentation": "

Information about the authentication certificates, if applicable.

", + "locationName": "mutualAuthentication" + } + }, + "documentation": "

Describes the authentication methods used by a Client VPN endpoint. Client VPN supports Active Directory and mutual authentication. For more information, see Authentication in the AWS Client VPN Administrator Guide.

" + }, + "ClientVpnAuthenticationList": { + "type": "list", + "member": { + "shape": "ClientVpnAuthentication", + "locationName": "item" + } + }, + "ClientVpnAuthenticationRequest": { + "type": "structure", + "members": { + "Type": { + "shape": "ClientVpnAuthenticationType", + "documentation": "

The type of client authentication to be used. Specify certificate-authentication to use certificate-based authentication, or directory-service-authentication to use Active Directory authentication.

" + }, + "ActiveDirectory": { + "shape": "DirectoryServiceAuthenticationRequest", + "documentation": "

Information about the Active Directory to be used, if applicable. You must provide this information if Type is directory-service-authentication.

" + }, + "MutualAuthentication": { + "shape": "CertificateAuthenticationRequest", + "documentation": "

Information about the authentication certificates to be used, if applicable. You must provide this information if Type is certificate-authentication.

" + } + }, + "documentation": "

Describes the authentication method to be used by a Client VPN endpoint. Client VPN supports Active Directory and mutual authentication. For more information, see Authentication in the AWS Client VPN Administrator Guide.

" + }, + "ClientVpnAuthenticationRequestList": { + "type": "list", + "member": { + "shape": "ClientVpnAuthenticationRequest" + } + }, + "ClientVpnAuthenticationType": { + "type": "string", + "enum": [ + "certificate-authentication", + "directory-service-authentication" + ] + }, + "ClientVpnAuthorizationRuleStatus": { + "type": "structure", + "members": { + "Code": { + "shape": "ClientVpnAuthorizationRuleStatusCode", + "documentation": "

The state of the authorization rule.

", + "locationName": "code" + }, + "Message": { + "shape": "String", + "documentation": "

A message about the status of the authorization rule, if applicable.

", + "locationName": "message" + } + }, + "documentation": "

Describes the state of an authorization rule.

" + }, + "ClientVpnAuthorizationRuleStatusCode": { + "type": "string", + "enum": [ + "authorizing", + "active", + "failed", + "revoking" + ] + }, + "ClientVpnConnection": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "shape": "String", + "documentation": "

The ID of the Client VPN endpoint to which the client is connected.

", + "locationName": "clientVpnEndpointId" + }, + "Timestamp": { + "shape": "String", + "documentation": "

The current date and time.

", + "locationName": "timestamp" + }, + "ConnectionId": { + "shape": "String", + "documentation": "

The ID of the client connection.

", + "locationName": "connectionId" + }, + "Username": { + "shape": "String", + "documentation": "

The username of the client who established the client connection. This information is only provided if Active Directory client authentication is used.

", + "locationName": "username" + }, + "ConnectionEstablishedTime": { + "shape": "String", + "documentation": "

The date and time the client connection was established.

", + "locationName": "connectionEstablishedTime" + }, + "IngressBytes": { + "shape": "String", + "documentation": "

The number of bytes sent by the client.

", + "locationName": "ingressBytes" + }, + "EgressBytes": { + "shape": "String", + "documentation": "

The number of bytes received by the client.

", + "locationName": "egressBytes" + }, + "IngressPackets": { + "shape": "String", + "documentation": "

The number of packets sent by the client.

", + "locationName": "ingressPackets" + }, + "EgressPackets": { + "shape": "String", + "documentation": "

The number of packets received by the client.

", + "locationName": "egressPackets" + }, + "ClientIp": { + "shape": "String", + "documentation": "

The IP address of the client.

", + "locationName": "clientIp" + }, + "CommonName": { + "shape": "String", + "documentation": "

The common name associated with the client. This is either the name of the client certificate, or the Active Directory user name.

", + "locationName": "commonName" + }, + "Status": { + "shape": "ClientVpnConnectionStatus", + "documentation": "

The current state of the client connection.

", + "locationName": "status" + }, + "ConnectionEndTime": { + "shape": "String", + "documentation": "

The date and time the client connection was terminated.

", + "locationName": "connectionEndTime" + } + }, + "documentation": "

Describes a client connection.

" + }, + "ClientVpnConnectionSet": { + "type": "list", + "member": { + "shape": "ClientVpnConnection", + "locationName": "item" + } + }, + "ClientVpnConnectionStatus": { + "type": "structure", + "members": { + "Code": { + "shape": "ClientVpnConnectionStatusCode", + "documentation": "

The state of the client connection.

", + "locationName": "code" + }, + "Message": { + "shape": "String", + "documentation": "

A message about the status of the client connection, if applicable.

", + "locationName": "message" + } + }, + "documentation": "

Describes the status of a client connection.

" + }, + "ClientVpnConnectionStatusCode": { + "type": "string", + "enum": [ + "active", + "failed-to-terminate", + "terminating", + "terminated" + ] + }, + "ClientVpnEndpoint": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "shape": "String", + "documentation": "

The ID of the Client VPN endpoint.

", + "locationName": "clientVpnEndpointId" + }, + "Description": { + "shape": "String", + "documentation": "

A brief description of the endpoint.

", + "locationName": "description" + }, + "Status": { + "shape": "ClientVpnEndpointStatus", + "documentation": "

The current state of the Client VPN endpoint.

", + "locationName": "status" + }, + "CreationTime": { + "shape": "String", + "documentation": "

The date and time the Client VPN endpoint was created.

", + "locationName": "creationTime" + }, + "DeletionTime": { + "shape": "String", + "documentation": "

The date and time the Client VPN endpoint was deleted, if applicable.

", + "locationName": "deletionTime" + }, + "DnsName": { + "shape": "String", + "documentation": "

The DNS name to be used by clients when connecting to the Client VPN endpoint.

", + "locationName": "dnsName" + }, + "ClientCidrBlock": { + "shape": "String", + "documentation": "

The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.

", + "locationName": "clientCidrBlock" + }, + "DnsServers": { + "shape": "ValueStringList", + "documentation": "

Information about the DNS servers to be used for DNS resolution.

", + "locationName": "dnsServer" + }, + "SplitTunnel": { + "shape": "Boolean", + "documentation": "

Indicates whether VPN split tunneling is supported.

", + "locationName": "splitTunnel" + }, + "VpnProtocol": { + "shape": "VpnProtocol", + "documentation": "

The protocol used by the VPN session.

", + "locationName": "vpnProtocol" + }, + "TransportProtocol": { + "shape": "TransportProtocol", + "documentation": "

The transport protocol used by the Client VPN endpoint.

", + "locationName": "transportProtocol" + }, + "AssociatedTargetNetworks": { + "shape": "AssociatedTargetNetworkSet", + "documentation": "

Information about the associated target networks. A target network is a subnet in a VPC.

", + "deprecated": true, + "deprecatedMessage": "This property is deprecated. To view the target networks associated with a Client VPN endpoint, call DescribeClientVpnTargetNetworks and inspect the clientVpnTargetNetworks response element.", + "locationName": "associatedTargetNetwork" + }, + "ServerCertificateArn": { + "shape": "String", + "documentation": "

The ARN of the server certificate.

", + "locationName": "serverCertificateArn" + }, + "AuthenticationOptions": { + "shape": "ClientVpnAuthenticationList", + "documentation": "

Information about the authentication method used by the Client VPN endpoint.

", + "locationName": "authenticationOptions" + }, + "ConnectionLogOptions": { + "shape": "ConnectionLogResponseOptions", + "documentation": "

Information about the client connection logging options for the Client VPN endpoint.

", + "locationName": "connectionLogOptions" + }, + "Tags": { + "shape": "TagList", + "documentation": "

Any tags assigned to the Client VPN endpoint.

", + "locationName": "tagSet" + } + }, + "documentation": "

Describes a Client VPN endpoint.

" + }, + "ClientVpnEndpointStatus": { + "type": "structure", + "members": { + "Code": { + "shape": "ClientVpnEndpointStatusCode", + "documentation": "

The state of the Client VPN endpoint. Possible states include:

  • pending-associate - The Client VPN endpoint has been created but no target networks have been associated. The Client VPN endpoint cannot accept connections.

  • available - The Client VPN endpoint has been created and a target network has been associated. The Client VPN endpoint can accept connections.

  • deleting - The Client VPN endpoint is being deleted. The Client VPN endpoint cannot accept connections.

  • deleted - The Client VPN endpoint has been deleted. The Client VPN endpoint cannot accept connections.

", + "locationName": "code" + }, + "Message": { + "shape": "String", + "documentation": "

A message about the status of the Client VPN endpoint.

", + "locationName": "message" + } + }, + "documentation": "

Describes the state of a Client VPN endpoint.

" + }, + "ClientVpnEndpointStatusCode": { + "type": "string", + "enum": [ + "pending-associate", + "available", + "deleting", + "deleted" + ] + }, + "ClientVpnRoute": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "shape": "String", + "documentation": "

The ID of the Client VPN endpoint with which the route is associated.

", + "locationName": "clientVpnEndpointId" + }, + "DestinationCidr": { + "shape": "String", + "documentation": "

The IPv4 address range, in CIDR notation, of the route destination.

", + "locationName": "destinationCidr" + }, + "TargetSubnet": { + "shape": "String", + "documentation": "

The ID of the subnet through which traffic is routed.

", + "locationName": "targetSubnet" + }, + "Type": { + "shape": "String", + "documentation": "

The route type.

", + "locationName": "type" + }, + "Origin": { + "shape": "String", + "documentation": "

Indicates how the route was associated with the Client VPN endpoint. associate indicates that the route was automatically added when the target network was associated with the Client VPN endpoint. add-route indicates that the route was manually added using the CreateClientVpnRoute action.

", + "locationName": "origin" + }, + "Status": { + "shape": "ClientVpnRouteStatus", + "documentation": "

The current state of the route.

", + "locationName": "status" + }, + "Description": { + "shape": "String", + "documentation": "

A brief description of the route.

", + "locationName": "description" + } + }, + "documentation": "

Information about a Client VPN endpoint route.

" + }, + "ClientVpnRouteSet": { + "type": "list", + "member": { + "shape": "ClientVpnRoute", + "locationName": "item" + } + }, + "ClientVpnRouteStatus": { + "type": "structure", + "members": { + "Code": { + "shape": "ClientVpnRouteStatusCode", + "documentation": "

The state of the Client VPN endpoint route.

", + "locationName": "code" + }, + "Message": { + "shape": "String", + "documentation": "

A message about the status of the Client VPN endpoint route, if applicable.

", + "locationName": "message" + } + }, + "documentation": "

Describes the state of a Client VPN endpoint route.

" + }, + "ClientVpnRouteStatusCode": { + "type": "string", + "enum": [ + "creating", + "active", + "failed", + "deleting" + ] + }, + "ClientVpnSecurityGroupIdSet": { + "type": "list", + "member": { + "shape": "String", + "locationName": "item" + } + }, + "ConfirmProductInstanceRequest": { + "type": "structure", + "required": [ + "InstanceId", + "ProductCode" + ], + "members": { + "InstanceId": { + "shape": "String", + "documentation": "

The ID of the instance.

" + }, + "ProductCode": { + "shape": "String", + "documentation": "

The product code. This must be a product code that you own.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + } + }, + "ConfirmProductInstanceResult": { + "type": "structure", + "members": { + "OwnerId": { + "shape": "String", + "documentation": "

The AWS account ID of the instance owner. This is only present if the product code is attached to the instance.

", + "locationName": "ownerId" + }, + "Return": { + "shape": "Boolean", + "documentation": "

The return value of the request. Returns true if the specified product code is owned by the requester and associated with the specified instance.

", + "locationName": "return" + } + } + }, + "ConnectionLogOptions": { + "type": "structure", + "members": { + "Enabled": { + "shape": "Boolean", + "documentation": "

Indicates whether connection logging is enabled.

" + }, + "CloudwatchLogGroup": { + "shape": "String", + "documentation": "

The name of the CloudWatch Logs log group.

" + }, + "CloudwatchLogStream": { + "shape": "String", + "documentation": "

The name of the CloudWatch Logs log stream to which the connection data is published.

" + } + }, + "documentation": "

Describes the client connection logging options for the Client VPN endpoint.

" + }, + "ConnectionLogResponseOptions": { + "type": "structure", + "members": { + "Enabled": { + "shape": "Boolean", + "documentation": "

Indicates whether client connection logging is enabled for the Client VPN endpoint.

" + }, + "CloudwatchLogGroup": { + "shape": "String", + "documentation": "

The name of the Amazon CloudWatch Logs log group to which connection logging data is published.

" + }, + "CloudwatchLogStream": { + "shape": "String", + "documentation": "

The name of the Amazon CloudWatch Logs log stream to which connection logging data is published.

" + } + }, + "documentation": "

Information about the client connection logging options for a Client VPN endpoint.

" + }, + "ConnectionNotification": { + "type": "structure", + "members": { + "ConnectionNotificationId": { + "shape": "String", + "documentation": "

The ID of the notification.

", + "locationName": "connectionNotificationId" + }, + "ServiceId": { + "shape": "String", + "documentation": "

The ID of the endpoint service.

", + "locationName": "serviceId" + }, + "VpcEndpointId": { + "shape": "String", + "documentation": "

The ID of the VPC endpoint.

", + "locationName": "vpcEndpointId" + }, + "ConnectionNotificationType": { + "shape": "ConnectionNotificationType", + "documentation": "

The type of notification.

", + "locationName": "connectionNotificationType" + }, + "ConnectionNotificationArn": { + "shape": "String", + "documentation": "

The ARN of the SNS topic for the notification.

", + "locationName": "connectionNotificationArn" + }, + "ConnectionEvents": { + "shape": "ValueStringList", + "documentation": "

The events for the notification. Valid values are Accept, Connect, Delete, and Reject.

", + "locationName": "connectionEvents" + }, + "ConnectionNotificationState": { + "shape": "ConnectionNotificationState", + "documentation": "

The state of the notification.

", + "locationName": "connectionNotificationState" + } + }, + "documentation": "

Describes a connection notification for a VPC endpoint or VPC endpoint service.

" + }, + "ConnectionNotificationSet": { + "type": "list", + "member": { + "shape": "ConnectionNotification", + "locationName": "item" + } + }, + "ConnectionNotificationState": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ] + }, + "ConnectionNotificationType": { + "type": "string", + "enum": [ + "Topic" + ] + }, + "ContainerFormat": { + "type": "string", + "enum": [ + "ova" + ] + }, + "ConversionIdStringList": { + "type": "list", + "member": { + "shape": "String", + "locationName": "item" + } + }, + "ConversionTask": { + "type": "structure", + "members": { + "ConversionTaskId": { + "shape": "String", + "documentation": "

The ID of the conversion task.

", + "locationName": "conversionTaskId" + }, + "ExpirationTime": { + "shape": "String", + "documentation": "

The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.

", + "locationName": "expirationTime" + }, + "ImportInstance": { + "shape": "ImportInstanceTaskDetails", + "documentation": "

If the task is for importing an instance, this contains information about the import instance task.

", + "locationName": "importInstance" + }, + "ImportVolume": { + "shape": "ImportVolumeTaskDetails", + "documentation": "

If the task is for importing a volume, this contains information about the import volume task.

", + "locationName": "importVolume" + }, + "State": { + "shape": "ConversionTaskState", + "documentation": "

The state of the conversion task.

", + "locationName": "state" + }, + "StatusMessage": { + "shape": "String", + "documentation": "

The status message related to the conversion task.

", + "locationName": "statusMessage" + }, + "Tags": { + "shape": "TagList", + "documentation": "

Any tags assigned to the task.

", + "locationName": "tagSet" + } + }, + "documentation": "

Describes a conversion task.

" + }, + "ConversionTaskState": { + "type": "string", + "enum": [ + "active", + "cancelling", + "cancelled", + "completed" + ] + }, + "CopyFpgaImageRequest": { + "type": "structure", + "required": [ + "SourceFpgaImageId", + "SourceRegion" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "SourceFpgaImageId": { + "shape": "String", + "documentation": "

The ID of the source AFI.

" + }, + "Description": { + "shape": "String", + "documentation": "

The description for the new AFI.

" + }, + "Name": { + "shape": "String", + "documentation": "

The name for the new AFI. The default is the name of the source AFI.

" + }, + "SourceRegion": { + "shape": "String", + "documentation": "

The Region that contains the source AFI.

" + }, + "ClientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

" + } + } + }, + "CopyFpgaImageResult": { + "type": "structure", + "members": { + "FpgaImageId": { + "shape": "String", + "documentation": "

The ID of the new AFI.

", + "locationName": "fpgaImageId" + } + } + }, + "CopyImageRequest": { + "type": "structure", + "required": [ + "Name", + "SourceImageId", + "SourceRegion" + ], + "members": { + "ClientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

" + }, + "Description": { + "shape": "String", + "documentation": "

A description for the new AMI in the destination Region.

" + }, + "Encrypted": { + "shape": "Boolean", + "documentation": "

Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

", + "locationName": "encrypted" + }, + "KmsKeyId": { + "shape": "String", + "documentation": "

An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.

The specified CMK must exist in the Region that the snapshot is being copied to.

", + "locationName": "kmsKeyId" + }, + "Name": { + "shape": "String", + "documentation": "

The name of the new AMI in the destination Region.

" + }, + "SourceImageId": { + "shape": "String", + "documentation": "

The ID of the AMI to copy.

" + }, + "SourceRegion": { + "shape": "String", + "documentation": "

The name of the Region that contains the AMI to copy.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + }, + "documentation": "

Contains the parameters for CopyImage.

" + }, + "CopyImageResult": { + "type": "structure", + "members": { + "ImageId": { + "shape": "String", + "documentation": "

The ID of the new AMI.

", + "locationName": "imageId" + } + }, + "documentation": "

Contains the output of CopyImage.

" + }, + "CopySnapshotRequest": { + "type": "structure", + "required": [ + "SourceRegion", + "SourceSnapshotId" + ], + "members": { + "Description": { + "shape": "String", + "documentation": "

A description for the EBS snapshot.

" + }, + "DestinationRegion": { + "shape": "String", + "documentation": "

The destination Region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination Region in a PresignedUrl parameter, where it is required.

The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example, ec2.us-east-1.amazonaws.com). With the AWS CLI, this is specified using the --region parameter or the default Region in your AWS configuration file.

", + "locationName": "destinationRegion" + }, + "Encrypted": { + "shape": "Boolean", + "documentation": "

Specifies whether the destination snapshot should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot use it to create an unencrypted copy of an encrypted snapshot. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

", + "locationName": "encrypted" + }, + "KmsKeyId": { + "shape": "String", + "documentation": "

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK using any of the following:

  • Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

", + "locationName": "kmsKeyId" + }, + "PresignedUrl": { + "shape": "String", + "documentation": "

When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query Requests.

The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

", + "locationName": "presignedUrl" + }, + "SourceRegion": { + "shape": "String", + "documentation": "

The ID of the Region that contains the snapshot to be copied.

" + }, + "SourceSnapshotId": { + "shape": "String", + "documentation": "

The ID of the EBS snapshot to copy.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + }, + "documentation": "

Contains the parameters for CopySnapshot.

" + }, + "CopySnapshotResult": { + "type": "structure", + "members": { + "SnapshotId": { + "shape": "String", + "documentation": "

The ID of the new snapshot.

", + "locationName": "snapshotId" + } + }, + "documentation": "

Contains the output of CopySnapshot.

" + }, + "CopyTagsFromSource": { + "type": "string", + "enum": [ + "volume" + ] + }, + "CpuOptions": { + "type": "structure", + "members": { + "CoreCount": { + "shape": "Integer", + "documentation": "

The number of CPU cores for the instance.

", + "locationName": "coreCount" + }, + "ThreadsPerCore": { + "shape": "Integer", + "documentation": "

The number of threads per CPU core.

", + "locationName": "threadsPerCore" + } + }, + "documentation": "

The CPU options for the instance.

" + }, + "CpuOptionsRequest": { + "type": "structure", + "members": { + "CoreCount": { + "shape": "Integer", + "documentation": "

The number of CPU cores for the instance.

" + }, + "ThreadsPerCore": { + "shape": "Integer", + "documentation": "

The number of threads per CPU core. To disable Intel Hyper-Threading Technology for the instance, specify a value of 1. Otherwise, specify the default value of 2.

" + } + }, + "documentation": "

The CPU options for the instance. Both the core count and threads per core must be specified in the request.

" + }, + "CreateCapacityReservationRequest": { + "type": "structure", + "required": [ + "InstanceType", + "InstancePlatform", + "AvailabilityZone", + "InstanceCount" + ], + "members": { + "ClientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Constraint: Maximum 64 ASCII characters.

" + }, + "InstanceType": { + "shape": "String", + "documentation": "

The instance type for which to reserve capacity. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

" + }, + "InstancePlatform": { + "shape": "CapacityReservationInstancePlatform", + "documentation": "

The type of operating system for which to reserve capacity.

" + }, + "AvailabilityZone": { + "shape": "String", + "documentation": "

The Availability Zone in which to create the Capacity Reservation.

" + }, + "Tenancy": { + "shape": "CapacityReservationTenancy", + "documentation": "

Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

  • default - The Capacity Reservation is created on hardware that is shared with other AWS accounts.

  • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.

" + }, + "InstanceCount": { + "shape": "Integer", + "documentation": "

The number of instances for which to reserve capacity.

" + }, + "EbsOptimized": { + "shape": "Boolean", + "documentation": "

Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.

" + }, + "EphemeralStorage": { + "shape": "Boolean", + "documentation": "

Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.

" + }, + "EndDate": { + "shape": "DateTime", + "documentation": "

The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.

You must provide an EndDate value if EndDateType is limited. Omit EndDate if EndDateType is unlimited.

If the EndDateType is limited, the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.

" + }, + "EndDateType": { + "shape": "EndDateType", + "documentation": "

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

  • unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate if the EndDateType is unlimited.

  • limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if the EndDateType value is limited.

" + }, + "InstanceMatchCriteria": { + "shape": "InstanceMatchCriteria", + "documentation": "

Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

  • open - The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying any additional parameters.

  • targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

Default: open

" + }, + "TagSpecifications": { + "shape": "TagSpecificationList", + "documentation": "

The tags to apply to the Capacity Reservation during launch.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "CreateCapacityReservationResult": { + "type": "structure", + "members": { + "CapacityReservation": { + "shape": "CapacityReservation", + "documentation": "

Information about the Capacity Reservation.

", + "locationName": "capacityReservation" + } + } + }, + "CreateClientVpnEndpointRequest": { + "type": "structure", + "required": [ + "ClientCidrBlock", + "ServerCertificateArn", + "AuthenticationOptions", + "ConnectionLogOptions" + ], + "members": { + "ClientCidrBlock": { + "shape": "String", + "documentation": "

The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. The CIDR block should be /22 or greater.

" + }, + "ServerCertificateArn": { + "shape": "String", + "documentation": "

The ARN of the server certificate. For more information, see the AWS Certificate Manager User Guide.

" + }, + "AuthenticationOptions": { + "shape": "ClientVpnAuthenticationRequestList", + "documentation": "

Information about the authentication method to be used to authenticate clients.

", + "locationName": "Authentication" + }, + "ConnectionLogOptions": { + "shape": "ConnectionLogOptions", + "documentation": "

Information about the client connection logging options.

If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:

  • Client connection requests

  • Client connection results (successful and unsuccessful)

  • Reasons for unsuccessful client connection requests

  • Client connection termination time

" + }, + "DnsServers": { + "shape": "ValueStringList", + "documentation": "

Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address of the VPC that is to be associated with Client VPN endpoint is used as the DNS server.

" + }, + "TransportProtocol": { + "shape": "TransportProtocol", + "documentation": "

The transport protocol to be used by the VPN session.

Default value: udp

" + }, + "Description": { + "shape": "String", + "documentation": "

A brief description of the Client VPN endpoint.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ClientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "idempotencyToken": true + }, + "TagSpecifications": { + "shape": "TagSpecificationList", + "documentation": "

The tags to apply to the Client VPN endpoint during creation.

", + "locationName": "TagSpecification" + } + } + }, + "CreateClientVpnEndpointResult": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "shape": "String", + "documentation": "

The ID of the Client VPN endpoint.

", + "locationName": "clientVpnEndpointId" + }, + "Status": { + "shape": "ClientVpnEndpointStatus", + "documentation": "

The current state of the Client VPN endpoint.

", + "locationName": "status" + }, + "DnsName": { + "shape": "String", + "documentation": "

The DNS name to be used by clients when establishing their VPN session.

", + "locationName": "dnsName" + } + } + }, + "CreateClientVpnRouteRequest": { + "type": "structure", + "required": [ + "ClientVpnEndpointId", + "DestinationCidrBlock", + "TargetVpcSubnetId" + ], + "members": { + "ClientVpnEndpointId": { + "shape": "String", + "documentation": "

The ID of the Client VPN endpoint to which to add the route.

" + }, + "DestinationCidrBlock": { + "shape": "String", + "documentation": "

The IPv4 address range, in CIDR notation, of the route destination. For example:

  • To add a route for Internet access, enter 0.0.0.0/0

  • To add a route for a peered VPC, enter the peered VPC's IPv4 CIDR range

  • To add a route for an on-premises network, enter the AWS Site-to-Site VPN connection's IPv4 CIDR range

Route address ranges cannot overlap with the CIDR range specified for client allocation.

" + }, + "TargetVpcSubnetId": { + "shape": "String", + "documentation": "

The ID of the subnet through which you want to route traffic. The specified subnet must be an existing target network of the Client VPN endpoint.

" + }, + "Description": { + "shape": "String", + "documentation": "

A brief description of the route.

" + }, + "ClientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "idempotencyToken": true + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "CreateClientVpnRouteResult": { + "type": "structure", + "members": { + "Status": { + "shape": "ClientVpnRouteStatus", + "documentation": "

The current state of the route.

", + "locationName": "status" + } + } + }, + "CreateCustomerGatewayRequest": { + "type": "structure", + "required": [ + "BgpAsn", + "PublicIp", + "Type" + ], + "members": { + "BgpAsn": { + "shape": "Integer", + "documentation": "

For devices that support BGP, the customer gateway's BGP ASN.

Default: 65000

" + }, + "PublicIp": { + "shape": "String", + "documentation": "

The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

", + "locationName": "IpAddress" + }, + "Type": { + "shape": "GatewayType", + "documentation": "

The type of VPN connection that this customer gateway supports (ipsec.1).

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + }, + "documentation": "

Contains the parameters for CreateCustomerGateway.

" + }, + "CreateCustomerGatewayResult": { + "type": "structure", + "members": { + "CustomerGateway": { + "shape": "CustomerGateway", + "documentation": "

Information about the customer gateway.

", + "locationName": "customerGateway" + } + }, + "documentation": "

Contains the output of CreateCustomerGateway.

" + }, + "CreateDefaultSubnetRequest": { + "type": "structure", + "required": [ + "AvailabilityZone" + ], + "members": { + "AvailabilityZone": { + "shape": "String", + "documentation": "

The Availability Zone in which to create the default subnet.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "CreateDefaultSubnetResult": { + "type": "structure", + "members": { + "Subnet": { + "shape": "Subnet", + "documentation": "

Information about the subnet.

", + "locationName": "subnet" + } + } + }, + "CreateDefaultVpcRequest": { + "type": "structure", + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "CreateDefaultVpcResult": { + "type": "structure", + "members": { + "Vpc": { + "shape": "Vpc", + "documentation": "

Information about the VPC.

", + "locationName": "vpc" + } + } + }, + "CreateDhcpOptionsRequest": { + "type": "structure", + "required": [ + "DhcpConfigurations" + ], + "members": { + "DhcpConfigurations": { + "shape": "NewDhcpConfigurationList", + "documentation": "

A DHCP configuration option.

", + "locationName": "dhcpConfiguration" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + } + }, + "CreateDhcpOptionsResult": { + "type": "structure", + "members": { + "DhcpOptions": { + "shape": "DhcpOptions", + "documentation": "

A set of DHCP options.

", + "locationName": "dhcpOptions" + } + } + }, + "CreateEgressOnlyInternetGatewayRequest": { + "type": "structure", + "required": [ + "VpcId" + ], + "members": { + "ClientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "VpcId": { + "shape": "String", + "documentation": "

The ID of the VPC for which to create the egress-only internet gateway.

" + } + } + }, + "CreateEgressOnlyInternetGatewayResult": { + "type": "structure", + "members": { + "ClientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", + "locationName": "clientToken" + }, + "EgressOnlyInternetGateway": { + "shape": "EgressOnlyInternetGateway", + "documentation": "

Information about the egress-only internet gateway.

", + "locationName": "egressOnlyInternetGateway" + } + } + }, + "CreateFleetError": { + "type": "structure", + "members": { + "LaunchTemplateAndOverrides": { + "shape": "LaunchTemplateAndOverridesResponse", + "documentation": "

The launch templates and overrides that were used for launching the instances. Any parameters that you specify in the Overrides override the same parameters in the launch template.

", + "locationName": "launchTemplateAndOverrides" + }, + "Lifecycle": { + "shape": "InstanceLifecycle", + "documentation": "

Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.

", + "locationName": "lifecycle" + }, + "ErrorCode": { + "shape": "String", + "documentation": "

The error code that indicates why the instance could not be launched. For more information about error codes, see Error Codes.

", + "locationName": "errorCode" + }, + "ErrorMessage": { + "shape": "String", + "documentation": "

The error message that describes why the instance could not be launched. For more information about error messages, see ee Error Codes.

", + "locationName": "errorMessage" + } + }, + "documentation": "

Describes the instances that could not be launched by the fleet.

" + }, + "CreateFleetErrorsSet": { + "type": "list", + "member": { + "shape": "CreateFleetError", + "locationName": "item" + } + }, + "CreateFleetInstance": { + "type": "structure", + "members": { + "LaunchTemplateAndOverrides": { + "shape": "LaunchTemplateAndOverridesResponse", + "documentation": "

The launch templates and overrides that were used for launching the instances. Any parameters that you specify in the Overrides override the same parameters in the launch template.

", + "locationName": "launchTemplateAndOverrides" + }, + "Lifecycle": { + "shape": "InstanceLifecycle", + "documentation": "

Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.

", + "locationName": "lifecycle" + }, + "InstanceIds": { + "shape": "InstanceIdsSet", + "documentation": "

The IDs of the instances.

", + "locationName": "instanceIds" + }, + "InstanceType": { + "shape": "InstanceType", + "documentation": "

The instance type.

", + "locationName": "instanceType" + }, + "Platform": { + "shape": "PlatformValues", + "documentation": "

The value is Windows for Windows instances; otherwise blank.

", + "locationName": "platform" + } + }, + "documentation": "

Describes the instances that were launched by the fleet.

" + }, + "CreateFleetInstancesSet": { + "type": "list", + "member": { + "shape": "CreateFleetInstance", + "locationName": "item" + } + }, + "CreateFleetRequest": { + "type": "structure", + "required": [ + "LaunchTemplateConfigs", + "TargetCapacitySpecification" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ClientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

" + }, + "SpotOptions": { + "shape": "SpotOptionsRequest", + "documentation": "

Describes the configuration of Spot Instances in an EC2 Fleet.

" + }, + "OnDemandOptions": { + "shape": "OnDemandOptionsRequest", + "documentation": "

The allocation strategy of On-Demand Instances in an EC2 Fleet.

" + }, + "ExcessCapacityTerminationPolicy": { + "shape": "FleetExcessCapacityTerminationPolicy", + "documentation": "

Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.

" + }, + "LaunchTemplateConfigs": { + "shape": "FleetLaunchTemplateConfigListRequest", + "documentation": "

The configuration for the EC2 Fleet.

" + }, + "TargetCapacitySpecification": { + "shape": "TargetCapacitySpecificationRequest", + "documentation": "

The TotalTargetCapacity, OnDemandTargetCapacity, SpotTargetCapacity, and DefaultCapacityType structure.

" + }, + "TerminateInstancesWithExpiration": { + "shape": "Boolean", + "documentation": "

Indicates whether running instances should be terminated when the EC2 Fleet expires.

" + }, + "Type": { + "shape": "FleetType", + "documentation": "

The type of the request. By default, the EC2 Fleet places an asynchronous request for your desired capacity, and maintains it by replenishing interrupted Spot Instances (maintain). A value of instant places a synchronous one-time request, and returns errors for any instances that could not be launched. A value of request places an asynchronous one-time request without maintaining capacity or submitting requests in alternative capacity pools if capacity is unavailable. For more information, see EC2 Fleet Request Types in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ValidFrom": { + "shape": "DateTime", + "documentation": "

The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.

" + }, + "ValidUntil": { + "shape": "DateTime", + "documentation": "

The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new EC2 Fleet requests are placed or able to fulfill the request. If no value is specified, the request remains until you cancel it.

" + }, + "ReplaceUnhealthyInstances": { + "shape": "Boolean", + "documentation": "

Indicates whether EC2 Fleet should replace unhealthy instances.

" + }, + "TagSpecifications": { + "shape": "TagSpecificationList", + "documentation": "

The key-value pair for tagging the EC2 Fleet request on creation. The value for ResourceType must be fleet, otherwise the fleet request fails. To tag instances at launch, specify the tags in the launch template. For information about tagging after launch, see Tagging Your Resources.

", + "locationName": "TagSpecification" + } + } + }, + "CreateFleetResult": { + "type": "structure", + "members": { + "FleetId": { + "shape": "FleetIdentifier", + "documentation": "

The ID of the EC2 Fleet.

", + "locationName": "fleetId" + }, + "Errors": { + "shape": "CreateFleetErrorsSet", + "documentation": "

Information about the instances that could not be launched by the fleet. Valid only when Type is set to instant.

", + "locationName": "errorSet" + }, + "Instances": { + "shape": "CreateFleetInstancesSet", + "documentation": "

Information about the instances that were launched by the fleet. Valid only when Type is set to instant.

", + "locationName": "fleetInstanceSet" + } + } + }, + "CreateFlowLogsRequest": { + "type": "structure", + "required": [ + "ResourceIds", + "ResourceType", + "TrafficType" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ClientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

" + }, + "DeliverLogsPermissionArn": { + "shape": "String", + "documentation": "

The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

" + }, + "LogGroupName": { + "shape": "String", + "documentation": "

The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

" + }, + "ResourceIds": { + "shape": "ValueStringList", + "documentation": "

The ID of the subnet, network interface, or VPC for which you want to create a flow log.

Constraints: Maximum of 1000 resources

", + "locationName": "ResourceId" + }, + "ResourceType": { + "shape": "FlowLogsResourceType", + "documentation": "

The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.

" + }, + "TrafficType": { + "shape": "TrafficType", + "documentation": "

The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.

" + }, + "LogDestinationType": { + "shape": "LogDestinationType", + "documentation": "

Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data to Amazon S3, specify s3.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Default: cloud-watch-logs

" + }, + "LogDestination": { + "shape": "String", + "documentation": "

Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for LogDestinationType.

If LogDestinationType is not specified or cloud-watch-logs, specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group.

If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: bucket_ARN/subfolder_name/. For example, to specify a subfolder named my-logs in a bucket named my-bucket, use the following ARN: arn:aws:s3:::my-bucket/my-logs/. You cannot use AWSLogs as a subfolder name. This is a reserved term.

" + } + } + }, + "CreateFlowLogsResult": { + "type": "structure", + "members": { + "ClientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", + "locationName": "clientToken" + }, + "FlowLogIds": { + "shape": "ValueStringList", + "documentation": "

The IDs of the flow logs.

", + "locationName": "flowLogIdSet" + }, + "Unsuccessful": { + "shape": "UnsuccessfulItemSet", + "documentation": "

Information about the flow logs that could not be created successfully.

", + "locationName": "unsuccessful" + } + } + }, + "CreateFpgaImageRequest": { + "type": "structure", + "required": [ + "InputStorageLocation" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "InputStorageLocation": { + "shape": "StorageLocation", + "documentation": "

The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball.

" + }, + "LogsStorageLocation": { + "shape": "StorageLocation", + "documentation": "

The location in Amazon S3 for the output logs.

" + }, + "Description": { + "shape": "String", + "documentation": "

A description for the AFI.

" + }, + "Name": { + "shape": "String", + "documentation": "

A name for the AFI.

" + }, + "ClientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

" + } + } + }, + "CreateFpgaImageResult": { + "type": "structure", + "members": { + "FpgaImageId": { + "shape": "String", + "documentation": "

The FPGA image identifier (AFI ID).

", + "locationName": "fpgaImageId" + }, + "FpgaImageGlobalId": { + "shape": "String", + "documentation": "

The global FPGA image identifier (AGFI ID).

", + "locationName": "fpgaImageGlobalId" + } + } + }, + "CreateImageRequest": { + "type": "structure", + "required": [ + "InstanceId", + "Name" + ], + "members": { + "BlockDeviceMappings": { + "shape": "BlockDeviceMappingRequestList", + "documentation": "

The block device mappings. This parameter cannot be used to modify the encryption status of existing volumes or snapshots. To create an AMI with encrypted snapshots, use the CopyImage action.

", + "locationName": "blockDeviceMapping" + }, + "Description": { + "shape": "String", + "documentation": "

A description for the new image.

", + "locationName": "description" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "InstanceId": { + "shape": "String", + "documentation": "

The ID of the instance.

", + "locationName": "instanceId" + }, + "Name": { + "shape": "String", + "documentation": "

A name for the new image.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", + "locationName": "name" + }, + "NoReboot": { + "shape": "Boolean", + "documentation": "

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 instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.

", + "locationName": "noReboot" + } + } + }, + "CreateImageResult": { + "type": "structure", + "members": { + "ImageId": { + "shape": "String", + "documentation": "

The ID of the new AMI.

", + "locationName": "imageId" + } + } + }, + "CreateInstanceExportTaskRequest": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "Description": { + "shape": "String", + "documentation": "

A description for the conversion task or the resource being exported. The maximum length is 255 bytes.

", + "locationName": "description" + }, + "ExportToS3Task": { + "shape": "ExportToS3TaskSpecification", + "documentation": "

The format and location for an instance export task.

", + "locationName": "exportToS3" + }, + "InstanceId": { + "shape": "String", + "documentation": "

The ID of the instance.

", + "locationName": "instanceId" + }, + "TargetEnvironment": { + "shape": "ExportEnvironment", + "documentation": "

The target virtualization environment.

", + "locationName": "targetEnvironment" + } + } + }, + "CreateInstanceExportTaskResult": { + "type": "structure", + "members": { + "ExportTask": { + "shape": "ExportTask", + "documentation": "

Information about the instance export task.

", + "locationName": "exportTask" + } + } + }, + "CreateInternetGatewayRequest": { + "type": "structure", + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + } + }, + "CreateInternetGatewayResult": { + "type": "structure", + "members": { + "InternetGateway": { + "shape": "InternetGateway", + "documentation": "

Information about the internet gateway.

", + "locationName": "internetGateway" + } + } + }, + "CreateKeyPairRequest": { + "type": "structure", + "required": [ + "KeyName" + ], + "members": { + "KeyName": { + "shape": "String", + "documentation": "

A unique name for the key pair.

Constraints: Up to 255 ASCII characters

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + } + }, + "CreateLaunchTemplateRequest": { + "type": "structure", + "required": [ + "LaunchTemplateName", + "LaunchTemplateData" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ClientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraint: Maximum 128 ASCII characters.

" + }, + "LaunchTemplateName": { + "shape": "LaunchTemplateName", + "documentation": "

A name for the launch template.

" + }, + "VersionDescription": { + "shape": "VersionDescription", + "documentation": "

A description for the first version of the launch template.

" + }, + "LaunchTemplateData": { + "shape": "RequestLaunchTemplateData", + "documentation": "

The information for the launch template.

" + } + } + }, + "CreateLaunchTemplateResult": { + "type": "structure", + "members": { + "LaunchTemplate": { + "shape": "LaunchTemplate", + "documentation": "

Information about the launch template.

", + "locationName": "launchTemplate" + } + } + }, + "CreateLaunchTemplateVersionRequest": { + "type": "structure", + "required": [ + "LaunchTemplateData" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ClientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraint: Maximum 128 ASCII characters.

" + }, + "LaunchTemplateId": { + "shape": "String", + "documentation": "

The ID of the launch template. You must specify either the launch template ID or launch template name in the request.

" + }, + "LaunchTemplateName": { + "shape": "LaunchTemplateName", + "documentation": "

The name of the launch template. You must specify either the launch template ID or launch template name in the request.

" + }, + "SourceVersion": { + "shape": "String", + "documentation": "

The version number of the launch template version on which to base the new version. The new version inherits the same launch parameters as the source version, except for parameters that you specify in LaunchTemplateData.

" + }, + "VersionDescription": { + "shape": "VersionDescription", + "documentation": "

A description for the version of the launch template.

" + }, + "LaunchTemplateData": { + "shape": "RequestLaunchTemplateData", + "documentation": "

The information for the launch template.

" + } + } + }, + "CreateLaunchTemplateVersionResult": { + "type": "structure", + "members": { + "LaunchTemplateVersion": { + "shape": "LaunchTemplateVersion", + "documentation": "

Information about the launch template version.

", + "locationName": "launchTemplateVersion" + } + } + }, + "CreateNatGatewayRequest": { + "type": "structure", + "required": [ + "AllocationId", + "SubnetId" + ], + "members": { + "AllocationId": { + "shape": "String", + "documentation": "

The allocation ID of an Elastic IP address to associate with the NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it.

" + }, + "ClientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Constraint: Maximum 64 ASCII characters.

" + }, + "SubnetId": { + "shape": "String", + "documentation": "

The subnet in which to create the NAT gateway.

" + } + } + }, + "CreateNatGatewayResult": { + "type": "structure", + "members": { + "ClientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.

", + "locationName": "clientToken" + }, + "NatGateway": { + "shape": "NatGateway", + "documentation": "

Information about the NAT gateway.

", + "locationName": "natGateway" + } + } + }, + "CreateNetworkAclEntryRequest": { + "type": "structure", + "required": [ + "Egress", + "NetworkAclId", + "Protocol", + "RuleAction", + "RuleNumber" + ], + "members": { + "CidrBlock": { + "shape": "String", + "documentation": "

The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).

", + "locationName": "cidrBlock" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "Egress": { + "shape": "Boolean", + "documentation": "

Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).

", + "locationName": "egress" + }, + "IcmpTypeCode": { + "shape": "IcmpTypeCode", + "documentation": "

ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.

", + "locationName": "Icmp" + }, + "Ipv6CidrBlock": { + "shape": "String", + "documentation": "

The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64).

", + "locationName": "ipv6CidrBlock" + }, + "NetworkAclId": { + "shape": "String", + "documentation": "

The ID of the network ACL.

", + "locationName": "networkAclId" + }, + "PortRange": { + "shape": "PortRange", + "documentation": "

TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).

", + "locationName": "portRange" + }, + "Protocol": { + "shape": "String", + "documentation": "

The protocol number. A value of \"-1\" means all protocols. If you specify \"-1\" or a protocol number other than \"6\" (TCP), \"17\" (UDP), or \"1\" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol \"58\" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol \"58\" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.

", + "locationName": "protocol" + }, + "RuleAction": { + "shape": "RuleAction", + "documentation": "

Indicates whether to allow or deny the traffic that matches the rule.

", + "locationName": "ruleAction" + }, + "RuleNumber": { + "shape": "Integer", + "documentation": "

The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.

Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.

", + "locationName": "ruleNumber" + } + } + }, + "CreateNetworkAclRequest": { + "type": "structure", + "required": [ + "VpcId" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "VpcId": { + "shape": "String", + "documentation": "

The ID of the VPC.

", + "locationName": "vpcId" + } + } + }, + "CreateNetworkAclResult": { + "type": "structure", + "members": { + "NetworkAcl": { + "shape": "NetworkAcl", + "documentation": "

Information about the network ACL.

", + "locationName": "networkAcl" + } + } + }, + "CreateNetworkInterfacePermissionRequest": { + "type": "structure", + "required": [ + "NetworkInterfaceId", + "Permission" + ], + "members": { + "NetworkInterfaceId": { + "shape": "String", + "documentation": "

The ID of the network interface.

" + }, + "AwsAccountId": { + "shape": "String", + "documentation": "

The AWS account ID.

" + }, + "AwsService": { + "shape": "String", + "documentation": "

The AWS service. Currently not supported.

" + }, + "Permission": { + "shape": "InterfacePermissionType", + "documentation": "

The type of permission to grant.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "documentation": "

Contains the parameters for CreateNetworkInterfacePermission.

" + }, + "CreateNetworkInterfacePermissionResult": { + "type": "structure", + "members": { + "InterfacePermission": { + "shape": "NetworkInterfacePermission", + "documentation": "

Information about the permission for the network interface.

", + "locationName": "interfacePermission" + } + }, + "documentation": "

Contains the output of CreateNetworkInterfacePermission.

" + }, + "CreateNetworkInterfaceRequest": { + "type": "structure", + "required": [ + "SubnetId" + ], + "members": { + "Description": { + "shape": "String", + "documentation": "

A description for the network interface.

", + "locationName": "description" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "Groups": { + "shape": "SecurityGroupIdStringList", + "documentation": "

The IDs of one or more security groups.

", + "locationName": "SecurityGroupId" + }, + "Ipv6AddressCount": { + "shape": "Integer", + "documentation": "

The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses. If your subnet has the AssignIpv6AddressOnCreation attribute set to true, you can specify 0 to override this setting.

", + "locationName": "ipv6AddressCount" + }, + "Ipv6Addresses": { + "shape": "InstanceIpv6AddressList", + "documentation": "

One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.

", + "locationName": "ipv6Addresses" + }, + "PrivateIpAddress": { + "shape": "String", + "documentation": "

The primary private IPv4 address of the network interface. If you don't specify an IPv4 address, Amazon EC2 selects one for you from the subnet's IPv4 CIDR range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).

", + "locationName": "privateIpAddress" + }, + "PrivateIpAddresses": { + "shape": "PrivateIpAddressSpecificationList", + "documentation": "

One or more private IPv4 addresses.

", + "locationName": "privateIpAddresses" + }, + "SecondaryPrivateIpAddressCount": { + "shape": "Integer", + "documentation": "

The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses.

The number of IP addresses you can assign to a network interface varies by instance type. For more information, see IP Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide.

", + "locationName": "secondaryPrivateIpAddressCount" + }, + "InterfaceType": { + "shape": "NetworkInterfaceCreationType", + "documentation": "

Indicates the type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa. For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide.

If you are not creating an EFA, specify interface or omit this parameter.

" + }, + "SubnetId": { + "shape": "String", + "documentation": "

The ID of the subnet to associate with the network interface.

", + "locationName": "subnetId" + } + }, + "documentation": "

Contains the parameters for CreateNetworkInterface.

" + }, + "CreateNetworkInterfaceResult": { + "type": "structure", + "members": { + "NetworkInterface": { + "shape": "NetworkInterface", + "documentation": "

Information about the network interface.

", + "locationName": "networkInterface" + } + }, + "documentation": "

Contains the output of CreateNetworkInterface.

" + }, + "CreatePlacementGroupRequest": { + "type": "structure", + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "GroupName": { + "shape": "String", + "documentation": "

A name for the placement group. Must be unique within the scope of your account for the Region.

Constraints: Up to 255 ASCII characters

", + "locationName": "groupName" + }, + "Strategy": { + "shape": "PlacementStrategy", + "documentation": "

The placement strategy.

", + "locationName": "strategy" + }, + "PartitionCount": { + "shape": "Integer", + "documentation": "

The number of partitions. Valid only when Strategy is set to partition.

" + } + } + }, + "CreateReservedInstancesListingRequest": { + "type": "structure", + "required": [ + "ClientToken", + "InstanceCount", + "PriceSchedules", + "ReservedInstancesId" + ], + "members": { + "ClientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.

", + "locationName": "clientToken" + }, + "InstanceCount": { + "shape": "Integer", + "documentation": "

The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.

", + "locationName": "instanceCount" + }, + "PriceSchedules": { + "shape": "PriceScheduleSpecificationList", + "documentation": "

A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term.

", + "locationName": "priceSchedules" + }, + "ReservedInstancesId": { + "shape": "String", + "documentation": "

The ID of the active Standard Reserved Instance.

", + "locationName": "reservedInstancesId" + } + }, + "documentation": "

Contains the parameters for CreateReservedInstancesListing.

" + }, + "CreateReservedInstancesListingResult": { + "type": "structure", + "members": { + "ReservedInstancesListings": { + "shape": "ReservedInstancesListingList", + "documentation": "

Information about the Standard Reserved Instance listing.

", + "locationName": "reservedInstancesListingsSet" + } + }, + "documentation": "

Contains the output of CreateReservedInstancesListing.

" + }, + "CreateRouteRequest": { + "type": "structure", + "required": [ + "RouteTableId" + ], + "members": { + "DestinationCidrBlock": { + "shape": "String", + "documentation": "

The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match.

", + "locationName": "destinationCidrBlock" + }, + "DestinationIpv6CidrBlock": { + "shape": "String", + "documentation": "

The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.

", + "locationName": "destinationIpv6CidrBlock" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "EgressOnlyInternetGatewayId": { + "shape": "String", + "documentation": "

[IPv6 traffic only] The ID of an egress-only internet gateway.

", + "locationName": "egressOnlyInternetGatewayId" + }, + "GatewayId": { + "shape": "String", + "documentation": "

The ID of an internet gateway or virtual private gateway attached to your VPC.

", + "locationName": "gatewayId" + }, + "InstanceId": { + "shape": "String", + "documentation": "

The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.

", + "locationName": "instanceId" + }, + "NatGatewayId": { + "shape": "String", + "documentation": "

[IPv4 traffic only] The ID of a NAT gateway.

", + "locationName": "natGatewayId" + }, + "TransitGatewayId": { + "shape": "String", + "documentation": "

The ID of a transit gateway.

" + }, + "NetworkInterfaceId": { + "shape": "String", + "documentation": "

The ID of a network interface.

", + "locationName": "networkInterfaceId" + }, + "RouteTableId": { + "shape": "String", + "documentation": "

The ID of the route table for the route.

", + "locationName": "routeTableId" + }, + "VpcPeeringConnectionId": { + "shape": "String", + "documentation": "

The ID of a VPC peering connection.

", + "locationName": "vpcPeeringConnectionId" + } + } + }, + "CreateRouteResult": { + "type": "structure", + "members": { + "Return": { + "shape": "Boolean", + "documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName": "return" + } + } + }, + "CreateRouteTableRequest": { + "type": "structure", + "required": [ + "VpcId" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "VpcId": { + "shape": "String", + "documentation": "

The ID of the VPC.

", + "locationName": "vpcId" + } + } + }, + "CreateRouteTableResult": { + "type": "structure", + "members": { + "RouteTable": { + "shape": "RouteTable", + "documentation": "

Information about the route table.

", + "locationName": "routeTable" + } + } + }, + "CreateSecurityGroupRequest": { + "type": "structure", + "required": [ + "Description", + "GroupName" + ], + "members": { + "Description": { + "shape": "String", + "documentation": "

A description for the security group. This is informational only.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

", + "locationName": "GroupDescription" + }, + "GroupName": { + "shape": "String", + "documentation": "

The name of the security group.

Constraints: Up to 255 characters in length. Cannot start with sg-.

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

" + }, + "VpcId": { + "shape": "String", + "documentation": "

[EC2-VPC] The ID of the VPC. Required for EC2-VPC.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + } + }, + "CreateSecurityGroupResult": { + "type": "structure", + "members": { + "GroupId": { + "shape": "String", + "documentation": "

The ID of the security group.

", + "locationName": "groupId" + } + } + }, + "CreateSnapshotRequest": { + "type": "structure", + "required": [ + "VolumeId" + ], + "members": { + "Description": { + "shape": "String", + "documentation": "

A description for the snapshot.

" + }, + "VolumeId": { + "shape": "String", + "documentation": "

The ID of the EBS volume.

" + }, + "TagSpecifications": { + "shape": "TagSpecificationList", + "documentation": "

The tags to apply to the snapshot during creation.

", + "locationName": "TagSpecification" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + }, + "documentation": "

Contains the parameters for CreateSnapshot.

" + }, + "CreateSnapshotsRequest": { + "type": "structure", + "required": [ + "InstanceSpecification" + ], + "members": { + "Description": { + "shape": "String", + "documentation": "

A description propagated to every snapshot specified by the instance.

" + }, + "InstanceSpecification": { + "shape": "InstanceSpecification", + "documentation": "

The instance to specify which volumes should be included in the snapshots.

" + }, + "TagSpecifications": { + "shape": "TagSpecificationList", + "documentation": "

Tags to apply to every snapshot specified by the instance.

", + "locationName": "TagSpecification" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

Checks whether you have the required permissions for the action without actually making the request. Provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "CopyTagsFromSource": { + "shape": "CopyTagsFromSource", + "documentation": "

Copies the tags from the specified instance to all snapshots.

" + } + } + }, + "CreateSnapshotsResult": { + "type": "structure", + "members": { + "Snapshots": { + "shape": "SnapshotSet", + "documentation": "

List of snapshots.

", + "locationName": "snapshotSet" + } + } + }, + "CreateSpotDatafeedSubscriptionRequest": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "shape": "String", + "documentation": "

The Amazon S3 bucket in which to store the Spot Instance data feed.

", + "locationName": "bucket" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "Prefix": { + "shape": "String", + "documentation": "

A prefix for the data feed file names.

", + "locationName": "prefix" + } + }, + "documentation": "

Contains the parameters for CreateSpotDatafeedSubscription.

" + }, + "CreateSpotDatafeedSubscriptionResult": { + "type": "structure", + "members": { + "SpotDatafeedSubscription": { + "shape": "SpotDatafeedSubscription", + "documentation": "

The Spot Instance data feed subscription.

", + "locationName": "spotDatafeedSubscription" + } + }, + "documentation": "

Contains the output of CreateSpotDatafeedSubscription.

" + }, + "CreateSubnetRequest": { + "type": "structure", + "required": [ + "CidrBlock", + "VpcId" + ], + "members": { + "AvailabilityZone": { + "shape": "String", + "documentation": "

The Availability Zone for the subnet.

Default: AWS selects one for you. If you create more than one subnet in your VPC, we may not necessarily select a different zone for each subnet.

" + }, + "AvailabilityZoneId": { + "shape": "String", + "documentation": "

The AZ ID of the subnet.

" + }, + "CidrBlock": { + "shape": "String", + "documentation": "

The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24.

" + }, + "Ipv6CidrBlock": { + "shape": "String", + "documentation": "

The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length.

" + }, + "VpcId": { + "shape": "String", + "documentation": "

The ID of the VPC.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + } + }, + "CreateSubnetResult": { + "type": "structure", + "members": { + "Subnet": { + "shape": "Subnet", + "documentation": "

Information about the subnet.

", + "locationName": "subnet" + } + } + }, + "CreateTagsRequest": { + "type": "structure", + "required": [ + "Resources", + "Tags" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "Resources": { + "shape": "ResourceIdList", + "documentation": "

The IDs of the resources, separated by spaces.

Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.

", + "locationName": "ResourceId" + }, + "Tags": { + "shape": "TagList", + "documentation": "

The tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

", + "locationName": "Tag" + } + } + }, + "CreateTrafficMirrorFilterRequest": { + "type": "structure", + "members": { + "Description": { + "shape": "String", + "documentation": "

The description of the Traffic Mirror filter.

" + }, + "TagSpecifications": { + "shape": "TagSpecificationList", + "documentation": "

The tags to assign to a Traffic Mirror filter.

", + "locationName": "TagSpecification" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ClientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "idempotencyToken": true + } + } + }, + "CreateTrafficMirrorFilterResult": { + "type": "structure", + "members": { + "TrafficMirrorFilter": { + "shape": "TrafficMirrorFilter", + "documentation": "

Information about the Traffic Mirror filter.

", + "locationName": "trafficMirrorFilter" + }, + "ClientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "locationName": "clientToken" + } + } + }, + "CreateTrafficMirrorFilterRuleRequest": { + "type": "structure", + "required": [ + "TrafficMirrorFilterId", + "TrafficDirection", + "RuleNumber", + "RuleAction", + "DestinationCidrBlock", + "SourceCidrBlock" + ], + "members": { + "TrafficMirrorFilterId": { + "shape": "String", + "documentation": "

The ID of the filter that this rule is associated with.

" + }, + "TrafficDirection": { + "shape": "TrafficDirection", + "documentation": "

The type of traffic (ingress | egress).

" + }, + "RuleNumber": { + "shape": "Integer", + "documentation": "

The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given direction. The rules are processed in ascending order by rule number.

" + }, + "RuleAction": { + "shape": "TrafficMirrorRuleAction", + "documentation": "

The action to take (accept | reject) on the filtered traffic.

" + }, + "DestinationPortRange": { + "shape": "TrafficMirrorPortRangeRequest", + "documentation": "

The destination port range.

" + }, + "SourcePortRange": { + "shape": "TrafficMirrorPortRangeRequest", + "documentation": "

The source port range.

" + }, + "Protocol": { + "shape": "Integer", + "documentation": "

The protocol, for example UDP, to assign to the Traffic Mirror rule.

For information about the protocol value, see Protocol Numbers on the Internet Assigned Numbers Authority (IANA) website.

" + }, + "DestinationCidrBlock": { + "shape": "String", + "documentation": "

The destination CIDR block to assign to the Traffic Mirror rule.

" + }, + "SourceCidrBlock": { + "shape": "String", + "documentation": "

The source CIDR block to assign to the Traffic Mirror rule.

" + }, + "Description": { + "shape": "String", + "documentation": "

The description of the Traffic Mirror rule.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ClientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "idempotencyToken": true + } + } + }, + "CreateTrafficMirrorFilterRuleResult": { + "type": "structure", + "members": { + "TrafficMirrorFilterRule": { + "shape": "TrafficMirrorFilterRule", + "documentation": "

The Traffic Mirror rule.

", + "locationName": "trafficMirrorFilterRule" + }, + "ClientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "locationName": "clientToken" + } + } + }, + "CreateTrafficMirrorSessionRequest": { + "type": "structure", + "required": [ + "NetworkInterfaceId", + "TrafficMirrorTargetId", + "TrafficMirrorFilterId", + "SessionNumber" + ], + "members": { + "NetworkInterfaceId": { + "shape": "String", + "documentation": "

The ID of the source network interface.

" + }, + "TrafficMirrorTargetId": { + "shape": "String", + "documentation": "

The ID of the Traffic Mirror target.

" + }, + "TrafficMirrorFilterId": { + "shape": "String", + "documentation": "

The ID of the Traffic Mirror filter.

" + }, + "PacketLength": { + "shape": "Integer", + "documentation": "

The number of bytes in each packet to mirror. These are bytes after the VXLAN header. Do not specify this parameter when you want to mirror the entire packet. To mirror a subset of the packet, set this to the length (in bytes) that you want to mirror. For example, if you set this value to 1network0, then the first 100 bytes that meet the filter criteria are copied to the target.

If you do not want to mirror the entire packet, use the PacketLength parameter to specify the number of bytes in each packet to mirror.

" + }, + "SessionNumber": { + "shape": "Integer", + "documentation": "

The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.

Valid values are 1-32766.

" + }, + "VirtualNetworkId": { + "shape": "Integer", + "documentation": "

The VXLAN ID for the Traffic Mirror session. For more information about the VXLAN protocol, see RFC 7348. If you do not specify a VirtualNetworkId, an account-wide unique id is chosen at random.

" + }, + "Description": { + "shape": "String", + "documentation": "

The description of the Traffic Mirror session.

" + }, + "TagSpecifications": { + "shape": "TagSpecificationList", + "documentation": "

The tags to assign to a Traffic Mirror session.

", + "locationName": "TagSpecification" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ClientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "idempotencyToken": true + } + } + }, + "CreateTrafficMirrorSessionResult": { + "type": "structure", + "members": { + "TrafficMirrorSession": { + "shape": "TrafficMirrorSession", + "documentation": "

Information about the Traffic Mirror session.

", + "locationName": "trafficMirrorSession" + }, + "ClientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "locationName": "clientToken" + } + } + }, + "CreateTrafficMirrorTargetRequest": { + "type": "structure", + "members": { + "NetworkInterfaceId": { + "shape": "String", + "documentation": "

The network interface ID that is associated with the target.

" + }, + "NetworkLoadBalancerArn": { + "shape": "String", + "documentation": "

The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target.

" + }, + "Description": { + "shape": "String", + "documentation": "

The description of the Traffic Mirror target.

" + }, + "TagSpecifications": { + "shape": "TagSpecificationList", + "documentation": "

The tags to assign to the Traffic Mirror target.

", + "locationName": "TagSpecification" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ClientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "idempotencyToken": true + } + } + }, + "CreateTrafficMirrorTargetResult": { + "type": "structure", + "members": { + "TrafficMirrorTarget": { + "shape": "TrafficMirrorTarget", + "documentation": "

Information about the Traffic Mirror target.

", + "locationName": "trafficMirrorTarget" + }, + "ClientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "locationName": "clientToken" + } + } + }, + "CreateTransitGatewayRequest": { + "type": "structure", + "members": { + "Description": { + "shape": "String", + "documentation": "

A description of the transit gateway.

" + }, + "Options": { + "shape": "TransitGatewayRequestOptions", + "documentation": "

The transit gateway options.

" + }, + "TagSpecifications": { + "shape": "TagSpecificationList", + "documentation": "

The tags to apply to the transit gateway.

", + "locationName": "TagSpecification" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "CreateTransitGatewayResult": { + "type": "structure", + "members": { + "TransitGateway": { + "shape": "TransitGateway", + "documentation": "

Information about the transit gateway.

", + "locationName": "transitGateway" + } + } + }, + "CreateTransitGatewayRouteRequest": { + "type": "structure", + "required": [ + "DestinationCidrBlock", + "TransitGatewayRouteTableId" + ], + "members": { + "DestinationCidrBlock": { + "shape": "String", + "documentation": "

The CIDR range used for destination matches. Routing decisions are based on the most specific match.

" + }, + "TransitGatewayRouteTableId": { + "shape": "String", + "documentation": "

The ID of the transit gateway route table.

" + }, + "TransitGatewayAttachmentId": { + "shape": "String", + "documentation": "

The ID of the attachment.

" + }, + "Blackhole": { + "shape": "Boolean", + "documentation": "

Indicates whether to drop traffic that matches this route.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "CreateTransitGatewayRouteResult": { + "type": "structure", + "members": { + "Route": { + "shape": "TransitGatewayRoute", + "documentation": "

Information about the route.

", + "locationName": "route" + } + } + }, + "CreateTransitGatewayRouteTableRequest": { + "type": "structure", + "required": [ + "TransitGatewayId" + ], + "members": { + "TransitGatewayId": { + "shape": "String", + "documentation": "

The ID of the transit gateway.

" + }, + "TagSpecifications": { + "shape": "TagSpecificationList", + "documentation": "

The tags to apply to the transit gateway route table.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "CreateTransitGatewayRouteTableResult": { + "type": "structure", + "members": { + "TransitGatewayRouteTable": { + "shape": "TransitGatewayRouteTable", + "documentation": "

Information about the transit gateway route table.

", + "locationName": "transitGatewayRouteTable" + } + } + }, + "CreateTransitGatewayVpcAttachmentRequest": { + "type": "structure", + "required": [ + "TransitGatewayId", + "VpcId", + "SubnetIds" + ], + "members": { + "TransitGatewayId": { + "shape": "String", + "documentation": "

The ID of the transit gateway.

" + }, + "VpcId": { + "shape": "String", + "documentation": "

The ID of the VPC.

" + }, + "SubnetIds": { + "shape": "ValueStringList", + "documentation": "

The IDs of one or more subnets. You can specify only one subnet per Availability Zone. You must specify at least one subnet, but we recommend that you specify two subnets for better availability. The transit gateway uses one IP address from each specified subnet.

" + }, + "Options": { + "shape": "CreateTransitGatewayVpcAttachmentRequestOptions", + "documentation": "

The VPC attachment options.

" + }, + "TagSpecifications": { + "shape": "TagSpecificationList", + "documentation": "

The tags to apply to the VPC attachment.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "CreateTransitGatewayVpcAttachmentRequestOptions": { + "type": "structure", + "members": { + "DnsSupport": { + "shape": "DnsSupportValue", + "documentation": "

Enable or disable DNS support. The default is enable.

" + }, + "Ipv6Support": { + "shape": "Ipv6SupportValue", + "documentation": "

Enable or disable IPv6 support. The default is enable.

" + } + }, + "documentation": "

Describes the options for a VPC attachment.

" + }, + "CreateTransitGatewayVpcAttachmentResult": { + "type": "structure", + "members": { + "TransitGatewayVpcAttachment": { + "shape": "TransitGatewayVpcAttachment", + "documentation": "

Information about the VPC attachment.

", + "locationName": "transitGatewayVpcAttachment" + } + } + }, + "CreateVolumePermission": { + "type": "structure", + "members": { + "Group": { + "shape": "PermissionGroup", + "documentation": "

The group to be added or removed. The possible value is all.

", + "locationName": "group" + }, + "UserId": { + "shape": "String", + "documentation": "

The AWS account ID to be added or removed.

", + "locationName": "userId" + } + }, + "documentation": "

Describes the user or group to be added or removed from the list of create volume permissions for a volume.

" + }, + "CreateVolumePermissionList": { + "type": "list", + "member": { + "shape": "CreateVolumePermission", + "locationName": "item" + } + }, + "CreateVolumePermissionModifications": { + "type": "structure", + "members": { + "Add": { + "shape": "CreateVolumePermissionList", + "documentation": "

Adds the specified AWS account ID or group to the list.

" + }, + "Remove": { + "shape": "CreateVolumePermissionList", + "documentation": "

Removes the specified AWS account ID or group from the list.

" + } + }, + "documentation": "

Describes modifications to the list of create volume permissions for a volume.

" + }, + "CreateVolumeRequest": { + "type": "structure", + "required": [ + "AvailabilityZone" + ], + "members": { + "AvailabilityZone": { + "shape": "String", + "documentation": "

The Availability Zone in which to create the volume.

" + }, + "Encrypted": { + "shape": "Boolean", + "documentation": "

Specifies whether the volume should be encrypted. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Encryption by Default in the Amazon Elastic Compute Cloud User Guide.

Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types.

", + "locationName": "encrypted" + }, + "Iops": { + "shape": "Integer", + "documentation": "

The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 50 IOPS/GiB. Range is 100 to 64,000 IOPS for volumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

This parameter is valid only for Provisioned IOPS SSD (io1) volumes.

" + }, + "KmsKeyId": { + "shape": "String", + "documentation": "

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK using any of the following:

  • Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

" + }, + "Size": { + "shape": "Integer", + "documentation": "

The size of the volume, in GiBs.

Constraints: 1-16,384 for gp2, 4-16,384 for io1, 500-16,384 for st1, 500-16,384 for sc1, and 1-1,024 for standard. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

At least one of Size or SnapshotId is required.

" + }, + "SnapshotId": { + "shape": "String", + "documentation": "

The snapshot from which to create the volume.

At least one of Size or SnapshotId are required.

" + }, + "VolumeType": { + "shape": "VolumeType", + "documentation": "

The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

Defaults: If no volume type is specified, the default is standard in us-east-1, eu-west-1, eu-central-1, us-west-2, us-west-1, sa-east-1, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, ap-south-1, us-gov-west-1, and cn-north-1. In all other Regions, EBS defaults to gp2.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "TagSpecifications": { + "shape": "TagSpecificationList", + "documentation": "

The tags to apply to the volume during creation.

", + "locationName": "TagSpecification" + } + }, + "documentation": "

Contains the parameters for CreateVolume.

" + }, + "CreateVpcEndpointConnectionNotificationRequest": { + "type": "structure", + "required": [ + "ConnectionNotificationArn", + "ConnectionEvents" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ServiceId": { + "shape": "String", + "documentation": "

The ID of the endpoint service.

" + }, + "VpcEndpointId": { + "shape": "String", + "documentation": "

The ID of the endpoint.

" + }, + "ConnectionNotificationArn": { + "shape": "String", + "documentation": "

The ARN of the SNS topic for the notifications.

" + }, + "ConnectionEvents": { + "shape": "ValueStringList", + "documentation": "

One or more endpoint events for which to receive notifications. Valid values are Accept, Connect, Delete, and Reject.

" + }, + "ClientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

" + } + } + }, + "CreateVpcEndpointConnectionNotificationResult": { + "type": "structure", + "members": { + "ConnectionNotification": { + "shape": "ConnectionNotification", + "documentation": "

Information about the notification.

", + "locationName": "connectionNotification" + }, + "ClientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the request.

", + "locationName": "clientToken" + } + } + }, + "CreateVpcEndpointRequest": { + "type": "structure", + "required": [ + "VpcId", + "ServiceName" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "VpcEndpointType": { + "shape": "VpcEndpointType", + "documentation": "

The type of endpoint.

Default: Gateway

" + }, + "VpcId": { + "shape": "String", + "documentation": "

The ID of the VPC in which the endpoint will be used.

" + }, + "ServiceName": { + "shape": "String", + "documentation": "

The service name. To get a list of available services, use the DescribeVpcEndpointServices request, or get the name from the service provider.

" + }, + "PolicyDocument": { + "shape": "String", + "documentation": "

A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service.

" + }, + "RouteTableIds": { + "shape": "ValueStringList", + "documentation": "

(Gateway endpoint) One or more route table IDs.

", + "locationName": "RouteTableId" + }, + "SubnetIds": { + "shape": "ValueStringList", + "documentation": "

(Interface endpoint) The ID of one or more subnets in which to create an endpoint network interface.

", + "locationName": "SubnetId" + }, + "SecurityGroupIds": { + "shape": "ValueStringList", + "documentation": "

(Interface endpoint) The ID of one or more security groups to associate with the endpoint network interface.

", + "locationName": "SecurityGroupId" + }, + "ClientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

" + }, + "PrivateDnsEnabled": { + "shape": "Boolean", + "documentation": "

(Interface endpoint) Indicate whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com) which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.

To use a private hosted zone, you must set the following VPC attributes to true: enableDnsHostnames and enableDnsSupport. Use ModifyVpcAttribute to set the VPC attributes.

Default: true

" + } + }, + "documentation": "

Contains the parameters for CreateVpcEndpoint.

" + }, + "CreateVpcEndpointResult": { + "type": "structure", + "members": { + "VpcEndpoint": { + "shape": "VpcEndpoint", + "documentation": "

Information about the endpoint.

", + "locationName": "vpcEndpoint" + }, + "ClientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the request.

", + "locationName": "clientToken" + } + }, + "documentation": "

Contains the output of CreateVpcEndpoint.

" + }, + "CreateVpcEndpointServiceConfigurationRequest": { + "type": "structure", + "required": [ + "NetworkLoadBalancerArns" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "AcceptanceRequired": { + "shape": "Boolean", + "documentation": "

Indicate whether requests from service consumers to create an endpoint to your service must be accepted. To accept a request, use AcceptVpcEndpointConnections.

" + }, + "NetworkLoadBalancerArns": { + "shape": "ValueStringList", + "documentation": "

The Amazon Resource Names (ARNs) of one or more Network Load Balancers for your service.

", + "locationName": "NetworkLoadBalancerArn" + }, + "ClientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

" + } + } + }, + "CreateVpcEndpointServiceConfigurationResult": { + "type": "structure", + "members": { + "ServiceConfiguration": { + "shape": "ServiceConfiguration", + "documentation": "

Information about the service configuration.

", + "locationName": "serviceConfiguration" + }, + "ClientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the request.

", + "locationName": "clientToken" + } + } + }, + "CreateVpcPeeringConnectionRequest": { + "type": "structure", + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "PeerOwnerId": { + "shape": "String", + "documentation": "

The AWS account ID of the owner of the accepter VPC.

Default: Your AWS account ID

", + "locationName": "peerOwnerId" + }, + "PeerVpcId": { + "shape": "String", + "documentation": "

The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request.

", + "locationName": "peerVpcId" + }, + "VpcId": { + "shape": "String", + "documentation": "

The ID of the requester VPC. You must specify this parameter in the request.

", + "locationName": "vpcId" + }, + "PeerRegion": { + "shape": "String", + "documentation": "

The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.

Default: The Region in which you make the request.

" + } + } + }, + "CreateVpcPeeringConnectionResult": { + "type": "structure", + "members": { + "VpcPeeringConnection": { + "shape": "VpcPeeringConnection", + "documentation": "

Information about the VPC peering connection.

", + "locationName": "vpcPeeringConnection" + } + } + }, + "CreateVpcRequest": { + "type": "structure", + "required": [ + "CidrBlock" + ], + "members": { + "CidrBlock": { + "shape": "String", + "documentation": "

The IPv4 network range for the VPC, in CIDR notation. For example, 10.0.0.0/16.

" + }, + "AmazonProvidedIpv6CidrBlock": { + "shape": "Boolean", + "documentation": "

Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IP addresses, or the size of the CIDR block.

", + "locationName": "amazonProvidedIpv6CidrBlock" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "InstanceTenancy": { + "shape": "Tenancy", + "documentation": "

The tenancy options for instances launched into the VPC. For default, instances are launched with shared tenancy by default. You can launch instances with any tenancy into a shared tenancy VPC. For dedicated, instances are launched as dedicated tenancy instances by default. You can only launch instances with a tenancy of dedicated or host into a dedicated tenancy VPC.

Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

Default: default

", + "locationName": "instanceTenancy" + } + } + }, + "CreateVpcResult": { + "type": "structure", + "members": { + "Vpc": { + "shape": "Vpc", + "documentation": "

Information about the VPC.

", + "locationName": "vpc" + } + } + }, + "CreateVpnConnectionRequest": { + "type": "structure", + "required": [ + "CustomerGatewayId", + "Type" + ], + "members": { + "CustomerGatewayId": { + "shape": "String", + "documentation": "

The ID of the customer gateway.

" + }, + "Type": { + "shape": "String", + "documentation": "

The type of VPN connection (ipsec.1).

" + }, + "VpnGatewayId": { + "shape": "String", + "documentation": "

The ID of the virtual private gateway. If you specify a virtual private gateway, you cannot specify a transit gateway.

" + }, + "TransitGatewayId": { + "shape": "String", + "documentation": "

The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private gateway.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "Options": { + "shape": "VpnConnectionOptionsSpecification", + "documentation": "

The options for the VPN connection.

", + "locationName": "options" + } + }, + "documentation": "

Contains the parameters for CreateVpnConnection.

" + }, + "CreateVpnConnectionResult": { + "type": "structure", + "members": { + "VpnConnection": { + "shape": "VpnConnection", + "documentation": "

Information about the VPN connection.

", + "locationName": "vpnConnection" + } + }, + "documentation": "

Contains the output of CreateVpnConnection.

" + }, + "CreateVpnConnectionRouteRequest": { + "type": "structure", + "required": [ + "DestinationCidrBlock", + "VpnConnectionId" + ], + "members": { + "DestinationCidrBlock": { + "shape": "String", + "documentation": "

The CIDR block associated with the local subnet of the customer network.

" + }, + "VpnConnectionId": { + "shape": "String", + "documentation": "

The ID of the VPN connection.

" + } + }, + "documentation": "

Contains the parameters for CreateVpnConnectionRoute.

" + }, + "CreateVpnGatewayRequest": { + "type": "structure", + "required": [ + "Type" + ], + "members": { + "AvailabilityZone": { + "shape": "String", + "documentation": "

The Availability Zone for the virtual private gateway.

" + }, + "Type": { + "shape": "GatewayType", + "documentation": "

The type of VPN connection this virtual private gateway supports.

" + }, + "AmazonSideAsn": { + "shape": "Long", + "documentation": "

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If you're using a 16-bit ASN, it must be in the 64512 to 65534 range. If you're using a 32-bit ASN, it must be in the 4200000000 to 4294967294 range.

Default: 64512

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + }, + "documentation": "

Contains the parameters for CreateVpnGateway.

" + }, + "CreateVpnGatewayResult": { + "type": "structure", + "members": { + "VpnGateway": { + "shape": "VpnGateway", + "documentation": "

Information about the virtual private gateway.

", + "locationName": "vpnGateway" + } + }, + "documentation": "

Contains the output of CreateVpnGateway.

" + }, + "CreditSpecification": { + "type": "structure", + "members": { + "CpuCredits": { + "shape": "String", + "documentation": "

The credit option for CPU usage of a T2 or T3 instance. Valid values are standard and unlimited.

", + "locationName": "cpuCredits" + } + }, + "documentation": "

Describes the credit option for CPU usage of a T2 or T3 instance.

" + }, + "CreditSpecificationRequest": { + "type": "structure", + "required": [ + "CpuCredits" + ], + "members": { + "CpuCredits": { + "shape": "String", + "documentation": "

The credit option for CPU usage of a T2 or T3 instance. Valid values are standard and unlimited.

" + } + }, + "documentation": "

The credit option for CPU usage of a T2 or T3 instance.

" + }, + "CurrencyCodeValues": { + "type": "string", + "enum": [ + "USD" + ] + }, + "CustomerGateway": { + "type": "structure", + "members": { + "BgpAsn": { + "shape": "String", + "documentation": "

The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

", + "locationName": "bgpAsn" + }, + "CustomerGatewayId": { + "shape": "String", + "documentation": "

The ID of the customer gateway.

", + "locationName": "customerGatewayId" + }, + "IpAddress": { + "shape": "String", + "documentation": "

The Internet-routable IP address of the customer gateway's outside interface.

", + "locationName": "ipAddress" + }, + "State": { + "shape": "String", + "documentation": "

The current state of the customer gateway (pending | available | deleting | deleted).

", + "locationName": "state" + }, + "Type": { + "shape": "String", + "documentation": "

The type of VPN connection the customer gateway supports (ipsec.1).

", + "locationName": "type" + }, + "Tags": { + "shape": "TagList", + "documentation": "

Any tags assigned to the customer gateway.

", + "locationName": "tagSet" + } + }, + "documentation": "

Describes a customer gateway.

" + }, + "CustomerGatewayIdStringList": { + "type": "list", + "member": { + "shape": "String", + "locationName": "CustomerGatewayId" + } + }, + "CustomerGatewayList": { + "type": "list", + "member": { + "shape": "CustomerGateway", + "locationName": "item" + } + }, + "DatafeedSubscriptionState": { + "type": "string", + "enum": [ + "Active", + "Inactive" + ] + }, + "DateTime": { + "type": "timestamp" + }, + "DefaultRouteTableAssociationValue": { + "type": "string", + "enum": [ + "enable", + "disable" + ] + }, + "DefaultRouteTablePropagationValue": { + "type": "string", + "enum": [ + "enable", + "disable" + ] + }, + "DefaultTargetCapacityType": { + "type": "string", + "enum": [ + "spot", + "on-demand" + ] + }, + "DeleteClientVpnEndpointRequest": { + "type": "structure", + "required": [ + "ClientVpnEndpointId" + ], + "members": { + "ClientVpnEndpointId": { + "shape": "String", + "documentation": "

The ID of the Client VPN to be deleted.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DeleteClientVpnEndpointResult": { + "type": "structure", + "members": { + "Status": { + "shape": "ClientVpnEndpointStatus", + "documentation": "

The current state of the Client VPN endpoint.

", + "locationName": "status" + } + } + }, + "DeleteClientVpnRouteRequest": { + "type": "structure", + "required": [ + "ClientVpnEndpointId", + "DestinationCidrBlock" + ], + "members": { + "ClientVpnEndpointId": { + "shape": "String", + "documentation": "

The ID of the Client VPN endpoint from which the route is to be deleted.

" + }, + "TargetVpcSubnetId": { + "shape": "String", + "documentation": "

The ID of the target subnet used by the route.

" + }, + "DestinationCidrBlock": { + "shape": "String", + "documentation": "

The IPv4 address range, in CIDR notation, of the route to be deleted.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DeleteClientVpnRouteResult": { + "type": "structure", + "members": { + "Status": { + "shape": "ClientVpnRouteStatus", + "documentation": "

The current state of the route.

", + "locationName": "status" + } + } + }, + "DeleteCustomerGatewayRequest": { + "type": "structure", + "required": [ + "CustomerGatewayId" + ], + "members": { + "CustomerGatewayId": { + "shape": "String", + "documentation": "

The ID of the customer gateway.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + }, + "documentation": "

Contains the parameters for DeleteCustomerGateway.

" + }, + "DeleteDhcpOptionsRequest": { + "type": "structure", + "required": [ + "DhcpOptionsId" + ], + "members": { + "DhcpOptionsId": { + "shape": "String", + "documentation": "

The ID of the DHCP options set.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + } + }, + "DeleteEgressOnlyInternetGatewayRequest": { + "type": "structure", + "required": [ + "EgressOnlyInternetGatewayId" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "EgressOnlyInternetGatewayId": { + "shape": "EgressOnlyInternetGatewayId", + "documentation": "

The ID of the egress-only internet gateway.

" + } + } + }, + "DeleteEgressOnlyInternetGatewayResult": { + "type": "structure", + "members": { + "ReturnCode": { + "shape": "Boolean", + "documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName": "returnCode" + } + } + }, + "DeleteFleetError": { + "type": "structure", + "members": { + "Code": { + "shape": "DeleteFleetErrorCode", + "documentation": "

The error code.

", + "locationName": "code" + }, + "Message": { + "shape": "String", + "documentation": "

The description for the error code.

", + "locationName": "message" + } + }, + "documentation": "

Describes an EC2 Fleet error.

" + }, + "DeleteFleetErrorCode": { + "type": "string", + "enum": [ + "fleetIdDoesNotExist", + "fleetIdMalformed", + "fleetNotInDeletableState", + "unexpectedError" + ] + }, + "DeleteFleetErrorItem": { + "type": "structure", + "members": { + "Error": { + "shape": "DeleteFleetError", + "documentation": "

The error.

", + "locationName": "error" + }, + "FleetId": { + "shape": "FleetIdentifier", + "documentation": "

The ID of the EC2 Fleet.

", + "locationName": "fleetId" + } + }, + "documentation": "

Describes an EC2 Fleet that was not successfully deleted.

" + }, + "DeleteFleetErrorSet": { + "type": "list", + "member": { + "shape": "DeleteFleetErrorItem", + "locationName": "item" + } + }, + "DeleteFleetSuccessItem": { + "type": "structure", + "members": { + "CurrentFleetState": { + "shape": "FleetStateCode", + "documentation": "

The current state of the EC2 Fleet.

", + "locationName": "currentFleetState" + }, + "PreviousFleetState": { + "shape": "FleetStateCode", + "documentation": "

The previous state of the EC2 Fleet.

", + "locationName": "previousFleetState" + }, + "FleetId": { + "shape": "FleetIdentifier", + "documentation": "

The ID of the EC2 Fleet.

", + "locationName": "fleetId" + } + }, + "documentation": "

Describes an EC2 Fleet that was successfully deleted.

" + }, + "DeleteFleetSuccessSet": { + "type": "list", + "member": { + "shape": "DeleteFleetSuccessItem", + "locationName": "item" + } + }, + "DeleteFleetsRequest": { + "type": "structure", + "required": [ + "FleetIds", + "TerminateInstances" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "FleetIds": { + "shape": "FleetIdSet", + "documentation": "

The IDs of the EC2 Fleets.

", + "locationName": "FleetId" + }, + "TerminateInstances": { + "shape": "Boolean", + "documentation": "

Indicates whether to terminate instances for an EC2 Fleet if it is deleted successfully.

" + } + } + }, + "DeleteFleetsResult": { + "type": "structure", + "members": { + "SuccessfulFleetDeletions": { + "shape": "DeleteFleetSuccessSet", + "documentation": "

Information about the EC2 Fleets that are successfully deleted.

", + "locationName": "successfulFleetDeletionSet" + }, + "UnsuccessfulFleetDeletions": { + "shape": "DeleteFleetErrorSet", + "documentation": "

Information about the EC2 Fleets that are not successfully deleted.

", + "locationName": "unsuccessfulFleetDeletionSet" + } + } + }, + "DeleteFlowLogsRequest": { + "type": "structure", + "required": [ + "FlowLogIds" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "FlowLogIds": { + "shape": "ValueStringList", + "documentation": "

One or more flow log IDs.

Constraint: Maximum of 1000 flow log IDs.

", + "locationName": "FlowLogId" + } + } + }, + "DeleteFlowLogsResult": { + "type": "structure", + "members": { + "Unsuccessful": { + "shape": "UnsuccessfulItemSet", + "documentation": "

Information about the flow logs that could not be deleted successfully.

", + "locationName": "unsuccessful" + } + } + }, + "DeleteFpgaImageRequest": { + "type": "structure", + "required": [ + "FpgaImageId" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "FpgaImageId": { + "shape": "String", + "documentation": "

The ID of the AFI.

" + } + } + }, + "DeleteFpgaImageResult": { + "type": "structure", + "members": { + "Return": { + "shape": "Boolean", + "documentation": "

Is true if the request succeeds, and an error otherwise.

", + "locationName": "return" + } + } + }, + "DeleteInternetGatewayRequest": { + "type": "structure", + "required": [ + "InternetGatewayId" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "InternetGatewayId": { + "shape": "String", + "documentation": "

The ID of the internet gateway.

", + "locationName": "internetGatewayId" + } + } + }, + "DeleteKeyPairRequest": { + "type": "structure", + "required": [ + "KeyName" + ], + "members": { + "KeyName": { + "shape": "String", + "documentation": "

The name of the key pair.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + } + }, + "DeleteLaunchTemplateRequest": { + "type": "structure", + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "LaunchTemplateId": { + "shape": "String", + "documentation": "

The ID of the launch template. You must specify either the launch template ID or launch template name in the request.

" + }, + "LaunchTemplateName": { + "shape": "LaunchTemplateName", + "documentation": "

The name of the launch template. You must specify either the launch template ID or launch template name in the request.

" + } + } + }, + "DeleteLaunchTemplateResult": { + "type": "structure", + "members": { + "LaunchTemplate": { + "shape": "LaunchTemplate", + "documentation": "

Information about the launch template.

", + "locationName": "launchTemplate" + } + } + }, + "DeleteLaunchTemplateVersionsRequest": { + "type": "structure", + "required": [ + "Versions" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "LaunchTemplateId": { + "shape": "String", + "documentation": "

The ID of the launch template. You must specify either the launch template ID or launch template name in the request.

" + }, + "LaunchTemplateName": { + "shape": "LaunchTemplateName", + "documentation": "

The name of the launch template. You must specify either the launch template ID or launch template name in the request.

" + }, + "Versions": { + "shape": "VersionStringList", + "documentation": "

The version numbers of one or more launch template versions to delete.

", + "locationName": "LaunchTemplateVersion" + } + } + }, + "DeleteLaunchTemplateVersionsResponseErrorItem": { + "type": "structure", + "members": { + "LaunchTemplateId": { + "shape": "String", + "documentation": "

The ID of the launch template.

", + "locationName": "launchTemplateId" + }, + "LaunchTemplateName": { + "shape": "String", + "documentation": "

The name of the launch template.

", + "locationName": "launchTemplateName" + }, + "VersionNumber": { + "shape": "Long", + "documentation": "

The version number of the launch template.

", + "locationName": "versionNumber" + }, + "ResponseError": { + "shape": "ResponseError", + "documentation": "

Information about the error.

", + "locationName": "responseError" + } + }, + "documentation": "

Describes a launch template version that could not be deleted.

" + }, + "DeleteLaunchTemplateVersionsResponseErrorSet": { + "type": "list", + "member": { + "shape": "DeleteLaunchTemplateVersionsResponseErrorItem", + "locationName": "item" + } + }, + "DeleteLaunchTemplateVersionsResponseSuccessItem": { + "type": "structure", + "members": { + "LaunchTemplateId": { + "shape": "String", + "documentation": "

The ID of the launch template.

", + "locationName": "launchTemplateId" + }, + "LaunchTemplateName": { + "shape": "String", + "documentation": "

The name of the launch template.

", + "locationName": "launchTemplateName" + }, + "VersionNumber": { + "shape": "Long", + "documentation": "

The version number of the launch template.

", + "locationName": "versionNumber" + } + }, + "documentation": "

Describes a launch template version that was successfully deleted.

" + }, + "DeleteLaunchTemplateVersionsResponseSuccessSet": { + "type": "list", + "member": { + "shape": "DeleteLaunchTemplateVersionsResponseSuccessItem", + "locationName": "item" + } + }, + "DeleteLaunchTemplateVersionsResult": { + "type": "structure", + "members": { + "SuccessfullyDeletedLaunchTemplateVersions": { + "shape": "DeleteLaunchTemplateVersionsResponseSuccessSet", + "documentation": "

Information about the launch template versions that were successfully deleted.

", + "locationName": "successfullyDeletedLaunchTemplateVersionSet" + }, + "UnsuccessfullyDeletedLaunchTemplateVersions": { + "shape": "DeleteLaunchTemplateVersionsResponseErrorSet", + "documentation": "

Information about the launch template versions that could not be deleted.

", + "locationName": "unsuccessfullyDeletedLaunchTemplateVersionSet" + } + } + }, + "DeleteNatGatewayRequest": { + "type": "structure", + "required": [ + "NatGatewayId" + ], + "members": { + "NatGatewayId": { + "shape": "String", + "documentation": "

The ID of the NAT gateway.

" + } + } + }, + "DeleteNatGatewayResult": { + "type": "structure", + "members": { + "NatGatewayId": { + "shape": "String", + "documentation": "

The ID of the NAT gateway.

", + "locationName": "natGatewayId" + } + } + }, + "DeleteNetworkAclEntryRequest": { + "type": "structure", + "required": [ + "Egress", + "NetworkAclId", + "RuleNumber" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "Egress": { + "shape": "Boolean", + "documentation": "

Indicates whether the rule is an egress rule.

", + "locationName": "egress" + }, + "NetworkAclId": { + "shape": "String", + "documentation": "

The ID of the network ACL.

", + "locationName": "networkAclId" + }, + "RuleNumber": { + "shape": "Integer", + "documentation": "

The rule number of the entry to delete.

", + "locationName": "ruleNumber" + } + } + }, + "DeleteNetworkAclRequest": { + "type": "structure", + "required": [ + "NetworkAclId" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "NetworkAclId": { + "shape": "String", + "documentation": "

The ID of the network ACL.

", + "locationName": "networkAclId" + } + } + }, + "DeleteNetworkInterfacePermissionRequest": { + "type": "structure", + "required": [ + "NetworkInterfacePermissionId" + ], + "members": { + "NetworkInterfacePermissionId": { + "shape": "String", + "documentation": "

The ID of the network interface permission.

" + }, + "Force": { + "shape": "Boolean", + "documentation": "

Specify true to remove the permission even if the network interface is attached to an instance.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "documentation": "

Contains the parameters for DeleteNetworkInterfacePermission.

" + }, + "DeleteNetworkInterfacePermissionResult": { + "type": "structure", + "members": { + "Return": { + "shape": "Boolean", + "documentation": "

Returns true if the request succeeds, otherwise returns an error.

", + "locationName": "return" + } + }, + "documentation": "

Contains the output for DeleteNetworkInterfacePermission.

" + }, + "DeleteNetworkInterfaceRequest": { + "type": "structure", + "required": [ + "NetworkInterfaceId" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "NetworkInterfaceId": { + "shape": "String", + "documentation": "

The ID of the network interface.

", + "locationName": "networkInterfaceId" + } + }, + "documentation": "

Contains the parameters for DeleteNetworkInterface.

" + }, + "DeletePlacementGroupRequest": { + "type": "structure", + "required": [ + "GroupName" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "GroupName": { + "shape": "String", + "documentation": "

The name of the placement group.

", + "locationName": "groupName" + } + } + }, + "DeleteRouteRequest": { + "type": "structure", + "required": [ + "RouteTableId" + ], + "members": { + "DestinationCidrBlock": { + "shape": "String", + "documentation": "

The IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.

", + "locationName": "destinationCidrBlock" + }, + "DestinationIpv6CidrBlock": { + "shape": "String", + "documentation": "

The IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly.

", + "locationName": "destinationIpv6CidrBlock" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "RouteTableId": { + "shape": "String", + "documentation": "

The ID of the route table.

", + "locationName": "routeTableId" + } + } + }, + "DeleteRouteTableRequest": { + "type": "structure", + "required": [ + "RouteTableId" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "RouteTableId": { + "shape": "String", + "documentation": "

The ID of the route table.

", + "locationName": "routeTableId" + } + } + }, + "DeleteSecurityGroupRequest": { + "type": "structure", + "members": { + "GroupId": { + "shape": "String", + "documentation": "

The ID of the security group. Required for a nondefault VPC.

" + }, + "GroupName": { + "shape": "String", + "documentation": "

[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + } + }, + "DeleteSnapshotRequest": { + "type": "structure", + "required": [ + "SnapshotId" + ], + "members": { + "SnapshotId": { + "shape": "String", + "documentation": "

The ID of the EBS snapshot.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + }, + "documentation": "

Contains the parameters for DeleteSnapshot.

" + }, + "DeleteSpotDatafeedSubscriptionRequest": { + "type": "structure", + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + }, + "documentation": "

Contains the parameters for DeleteSpotDatafeedSubscription.

" + }, + "DeleteSubnetRequest": { + "type": "structure", + "required": [ + "SubnetId" + ], + "members": { + "SubnetId": { + "shape": "String", + "documentation": "

The ID of the subnet.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + } + }, + "DeleteTagsRequest": { + "type": "structure", + "required": [ + "Resources" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "Resources": { + "shape": "ResourceIdList", + "documentation": "

The IDs of the resources, separated by spaces.

Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.

", + "locationName": "resourceId" + }, + "Tags": { + "shape": "TagList", + "documentation": "

The tags to delete. Specify a tag key and an optional tag value to delete specific tags. If you specify a tag key without a tag value, we delete any tag with this key regardless of its value. If you specify a tag key with an empty string as the tag value, we delete the tag only if its value is an empty string.

If you omit this parameter, we delete all user-defined tags for the specified resources. We do not delete AWS-generated tags (tags that have the aws: prefix).

", + "locationName": "tag" + } + } + }, + "DeleteTrafficMirrorFilterRequest": { + "type": "structure", + "required": [ + "TrafficMirrorFilterId" + ], + "members": { + "TrafficMirrorFilterId": { + "shape": "String", + "documentation": "

The ID of the Traffic Mirror filter.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DeleteTrafficMirrorFilterResult": { + "type": "structure", + "members": { + "TrafficMirrorFilterId": { + "shape": "String", + "documentation": "

The ID of the Traffic Mirror filter.

", + "locationName": "trafficMirrorFilterId" + } + } + }, + "DeleteTrafficMirrorFilterRuleRequest": { + "type": "structure", + "required": [ + "TrafficMirrorFilterRuleId" + ], + "members": { + "TrafficMirrorFilterRuleId": { + "shape": "String", + "documentation": "

The ID of the Traffic Mirror rule.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DeleteTrafficMirrorFilterRuleResult": { + "type": "structure", + "members": { + "TrafficMirrorFilterRuleId": { + "shape": "String", + "documentation": "

The ID of the deleted Traffic Mirror rule.

", + "locationName": "trafficMirrorFilterRuleId" + } + } + }, + "DeleteTrafficMirrorSessionRequest": { + "type": "structure", + "required": [ + "TrafficMirrorSessionId" + ], + "members": { + "TrafficMirrorSessionId": { + "shape": "String", + "documentation": "

The ID of the Traffic Mirror session.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DeleteTrafficMirrorSessionResult": { + "type": "structure", + "members": { + "TrafficMirrorSessionId": { + "shape": "String", + "documentation": "

The ID of the deleted Traffic Mirror session.

", + "locationName": "trafficMirrorSessionId" + } + } + }, + "DeleteTrafficMirrorTargetRequest": { + "type": "structure", + "required": [ + "TrafficMirrorTargetId" + ], + "members": { + "TrafficMirrorTargetId": { + "shape": "String", + "documentation": "

The ID of the Traffic Mirror target.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DeleteTrafficMirrorTargetResult": { + "type": "structure", + "members": { + "TrafficMirrorTargetId": { + "shape": "String", + "documentation": "

The ID of the deleted Traffic Mirror target.

", + "locationName": "trafficMirrorTargetId" + } + } + }, + "DeleteTransitGatewayRequest": { + "type": "structure", + "required": [ + "TransitGatewayId" + ], + "members": { + "TransitGatewayId": { + "shape": "String", + "documentation": "

The ID of the transit gateway.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DeleteTransitGatewayResult": { + "type": "structure", + "members": { + "TransitGateway": { + "shape": "TransitGateway", + "documentation": "

Information about the deleted transit gateway.

", + "locationName": "transitGateway" + } + } + }, + "DeleteTransitGatewayRouteRequest": { + "type": "structure", + "required": [ + "TransitGatewayRouteTableId", + "DestinationCidrBlock" + ], + "members": { + "TransitGatewayRouteTableId": { + "shape": "String", + "documentation": "

The ID of the transit gateway route table.

" + }, + "DestinationCidrBlock": { + "shape": "String", + "documentation": "

The CIDR range for the route. This must match the CIDR for the route exactly.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DeleteTransitGatewayRouteResult": { + "type": "structure", + "members": { + "Route": { + "shape": "TransitGatewayRoute", + "documentation": "

Information about the route.

", + "locationName": "route" + } + } + }, + "DeleteTransitGatewayRouteTableRequest": { + "type": "structure", + "required": [ + "TransitGatewayRouteTableId" + ], + "members": { + "TransitGatewayRouteTableId": { + "shape": "String", + "documentation": "

The ID of the transit gateway route table.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DeleteTransitGatewayRouteTableResult": { + "type": "structure", + "members": { + "TransitGatewayRouteTable": { + "shape": "TransitGatewayRouteTable", + "documentation": "

Information about the deleted transit gateway route table.

", + "locationName": "transitGatewayRouteTable" + } + } + }, + "DeleteTransitGatewayVpcAttachmentRequest": { + "type": "structure", + "required": [ + "TransitGatewayAttachmentId" + ], + "members": { + "TransitGatewayAttachmentId": { + "shape": "String", + "documentation": "

The ID of the attachment.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DeleteTransitGatewayVpcAttachmentResult": { + "type": "structure", + "members": { + "TransitGatewayVpcAttachment": { + "shape": "TransitGatewayVpcAttachment", + "documentation": "

Information about the deleted VPC attachment.

", + "locationName": "transitGatewayVpcAttachment" + } + } + }, + "DeleteVolumeRequest": { + "type": "structure", + "required": [ + "VolumeId" + ], + "members": { + "VolumeId": { + "shape": "String", + "documentation": "

The ID of the volume.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + }, + "documentation": "

Contains the parameters for DeleteVolume.

" + }, + "DeleteVpcEndpointConnectionNotificationsRequest": { + "type": "structure", + "required": [ + "ConnectionNotificationIds" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ConnectionNotificationIds": { + "shape": "ValueStringList", + "documentation": "

One or more notification IDs.

", + "locationName": "ConnectionNotificationId" + } + } + }, + "DeleteVpcEndpointConnectionNotificationsResult": { + "type": "structure", + "members": { + "Unsuccessful": { + "shape": "UnsuccessfulItemSet", + "documentation": "

Information about the notifications that could not be deleted successfully.

", + "locationName": "unsuccessful" + } + } + }, + "DeleteVpcEndpointServiceConfigurationsRequest": { + "type": "structure", + "required": [ + "ServiceIds" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ServiceIds": { + "shape": "ValueStringList", + "documentation": "

The IDs of one or more services.

", + "locationName": "ServiceId" + } + } + }, + "DeleteVpcEndpointServiceConfigurationsResult": { + "type": "structure", + "members": { + "Unsuccessful": { + "shape": "UnsuccessfulItemSet", + "documentation": "

Information about the service configurations that were not deleted, if applicable.

", + "locationName": "unsuccessful" + } + } + }, + "DeleteVpcEndpointsRequest": { + "type": "structure", + "required": [ + "VpcEndpointIds" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "VpcEndpointIds": { + "shape": "ValueStringList", + "documentation": "

One or more VPC endpoint IDs.

", + "locationName": "VpcEndpointId" + } + }, + "documentation": "

Contains the parameters for DeleteVpcEndpoints.

" + }, + "DeleteVpcEndpointsResult": { + "type": "structure", + "members": { + "Unsuccessful": { + "shape": "UnsuccessfulItemSet", + "documentation": "

Information about the VPC endpoints that were not successfully deleted.

", + "locationName": "unsuccessful" + } + }, + "documentation": "

Contains the output of DeleteVpcEndpoints.

" + }, + "DeleteVpcPeeringConnectionRequest": { + "type": "structure", + "required": [ + "VpcPeeringConnectionId" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "VpcPeeringConnectionId": { + "shape": "String", + "documentation": "

The ID of the VPC peering connection.

", + "locationName": "vpcPeeringConnectionId" + } + } + }, + "DeleteVpcPeeringConnectionResult": { + "type": "structure", + "members": { + "Return": { + "shape": "Boolean", + "documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName": "return" + } + } + }, + "DeleteVpcRequest": { + "type": "structure", + "required": [ + "VpcId" + ], + "members": { + "VpcId": { + "shape": "String", + "documentation": "

The ID of the VPC.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + } + }, + "DeleteVpnConnectionRequest": { + "type": "structure", + "required": [ + "VpnConnectionId" + ], + "members": { + "VpnConnectionId": { + "shape": "String", + "documentation": "

The ID of the VPN connection.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + }, + "documentation": "

Contains the parameters for DeleteVpnConnection.

" + }, + "DeleteVpnConnectionRouteRequest": { + "type": "structure", + "required": [ + "DestinationCidrBlock", + "VpnConnectionId" + ], + "members": { + "DestinationCidrBlock": { + "shape": "String", + "documentation": "

The CIDR block associated with the local subnet of the customer network.

" + }, + "VpnConnectionId": { + "shape": "String", + "documentation": "

The ID of the VPN connection.

" + } + }, + "documentation": "

Contains the parameters for DeleteVpnConnectionRoute.

" + }, + "DeleteVpnGatewayRequest": { + "type": "structure", + "required": [ + "VpnGatewayId" + ], + "members": { + "VpnGatewayId": { + "shape": "String", + "documentation": "

The ID of the virtual private gateway.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + }, + "documentation": "

Contains the parameters for DeleteVpnGateway.

" + }, + "DeprovisionByoipCidrRequest": { + "type": "structure", + "required": [ + "Cidr" + ], + "members": { + "Cidr": { + "shape": "String", + "documentation": "

The public IPv4 address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DeprovisionByoipCidrResult": { + "type": "structure", + "members": { + "ByoipCidr": { + "shape": "ByoipCidr", + "documentation": "

Information about the address range.

", + "locationName": "byoipCidr" + } + } + }, + "DeregisterImageRequest": { + "type": "structure", + "required": [ + "ImageId" + ], + "members": { + "ImageId": { + "shape": "String", + "documentation": "

The ID of the AMI.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + }, + "documentation": "

Contains the parameters for DeregisterImage.

" + }, + "DescribeAccountAttributesRequest": { + "type": "structure", + "members": { + "AttributeNames": { + "shape": "AccountAttributeNameStringList", + "documentation": "

The account attribute names.

", + "locationName": "attributeName" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + } + }, + "DescribeAccountAttributesResult": { + "type": "structure", + "members": { + "AccountAttributes": { + "shape": "AccountAttributeList", + "documentation": "

Information about the account attributes.

", + "locationName": "accountAttributeSet" + } + } + }, + "DescribeAddressesRequest": { + "type": "structure", + "members": { + "Filters": { + "shape": "FilterList", + "documentation": "

One or more filters. Filter names and values are case-sensitive.

  • allocation-id - [EC2-VPC] The allocation ID for the address.

  • association-id - [EC2-VPC] The association ID for the address.

  • domain - Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc).

  • instance-id - The ID of the instance the address is associated with, if any.

  • network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.

  • network-interface-owner-id - The AWS account ID of the owner.

  • private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address.

  • public-ip - The Elastic IP address.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

", + "locationName": "Filter" + }, + "PublicIps": { + "shape": "PublicIpStringList", + "documentation": "

One or more Elastic IP addresses.

Default: Describes all your Elastic IP addresses.

", + "locationName": "PublicIp" + }, + "AllocationIds": { + "shape": "AllocationIdList", + "documentation": "

[EC2-VPC] Information about the allocation IDs.

", + "locationName": "AllocationId" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + } + }, + "DescribeAddressesResult": { + "type": "structure", + "members": { + "Addresses": { + "shape": "AddressList", + "documentation": "

Information about the Elastic IP addresses.

", + "locationName": "addressesSet" + } + } + }, + "DescribeAggregateIdFormatRequest": { + "type": "structure", + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DescribeAggregateIdFormatResult": { + "type": "structure", + "members": { + "UseLongIdsAggregated": { + "shape": "Boolean", + "documentation": "

Indicates whether all resource types in the Region are configured to use longer IDs. This value is only true if all users are configured to use longer IDs for all resources types in the Region.

", + "locationName": "useLongIdsAggregated" + }, + "Statuses": { + "shape": "IdFormatList", + "documentation": "

Information about each resource's ID format.

", + "locationName": "statusSet" + } + } + }, + "DescribeAvailabilityZonesRequest": { + "type": "structure", + "members": { + "Filters": { + "shape": "FilterList", + "documentation": "

The filters.

  • message - Information about the Availability Zone.

  • region-name - The name of the Region for the Availability Zone (for example, us-east-1).

  • state - The state of the Availability Zone (available | information | impaired | unavailable).

  • zone-id - The ID of the Availability Zone (for example, use1-az1).

  • zone-name - The name of the Availability Zone (for example, us-east-1a).

", + "locationName": "Filter" + }, + "ZoneNames": { + "shape": "ZoneNameStringList", + "documentation": "

The names of the Availability Zones.

", + "locationName": "ZoneName" + }, + "ZoneIds": { + "shape": "ZoneIdStringList", + "documentation": "

The IDs of the Availability Zones.

", + "locationName": "ZoneId" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + } + }, + "DescribeAvailabilityZonesResult": { + "type": "structure", + "members": { + "AvailabilityZones": { + "shape": "AvailabilityZoneList", + "documentation": "

Information about the Availability Zones.

", + "locationName": "availabilityZoneInfo" + } + } + }, + "DescribeBundleTasksRequest": { + "type": "structure", + "members": { + "BundleIds": { + "shape": "BundleIdStringList", + "documentation": "

The bundle task IDs.

Default: Describes all your bundle tasks.

", + "locationName": "BundleId" + }, + "Filters": { + "shape": "FilterList", + "documentation": "

The filters.

  • bundle-id - The ID of the bundle task.

  • error-code - If the task failed, the error code returned.

  • error-message - If the task failed, the error message returned.

  • instance-id - The ID of the instance.

  • progress - The level of task completion, as a percentage (for example, 20%).

  • s3-bucket - The Amazon S3 bucket to store the AMI.

  • s3-prefix - The beginning of the AMI name.

  • start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).

  • state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed).

  • update-time - The time of the most recent update for the task.

", + "locationName": "Filter" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + } + }, + "DescribeBundleTasksResult": { + "type": "structure", + "members": { + "BundleTasks": { + "shape": "BundleTaskList", + "documentation": "

Information about the bundle tasks.

", + "locationName": "bundleInstanceTasksSet" + } + } + }, + "DescribeByoipCidrsRequest": { + "type": "structure", + "required": [ + "MaxResults" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "

The token for the next page of results.

" + } + } + }, + "DescribeByoipCidrsResult": { + "type": "structure", + "members": { + "ByoipCidrs": { + "shape": "ByoipCidrSet", + "documentation": "

Information about your address ranges.

", + "locationName": "byoipCidrSet" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName": "nextToken" + } + } + }, + "DescribeCapacityReservationsMaxResults": { + "type": "integer", + "max": 1000, + "min": 1 + }, + "DescribeCapacityReservationsRequest": { + "type": "structure", + "members": { + "CapacityReservationIds": { + "shape": "CapacityReservationIdSet", + "documentation": "

The ID of the Capacity Reservation.

", + "locationName": "CapacityReservationId" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to retrieve the next page of results.

" + }, + "MaxResults": { + "shape": "DescribeCapacityReservationsMaxResults", + "documentation": "

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value.

" + }, + "Filters": { + "shape": "FilterList", + "documentation": "

One or more filters.

", + "locationName": "Filter" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DescribeCapacityReservationsResult": { + "type": "structure", + "members": { + "NextToken": { + "shape": "String", + "documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName": "nextToken" + }, + "CapacityReservations": { + "shape": "CapacityReservationSet", + "documentation": "

Information about the Capacity Reservations.

", + "locationName": "capacityReservationSet" + } + } + }, + "DescribeClassicLinkInstancesRequest": { + "type": "structure", + "members": { + "Filters": { + "shape": "FilterList", + "documentation": "

One or more filters.

  • group-id - The ID of a VPC security group that's associated with the instance.

  • instance-id - The ID of the instance.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • vpc-id - The ID of the VPC to which the instance is linked.

    vpc-id - The ID of the VPC that the instance is linked to.

", + "locationName": "Filter" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "InstanceIds": { + "shape": "InstanceIdStringList", + "documentation": "

One or more instance IDs. Must be instances linked to a VPC through ClassicLink.

", + "locationName": "InstanceId" + }, + "MaxResults": { + "shape": "Integer", + "documentation": "

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Constraint: If the value is greater than 1000, we return only 1000 items.

", + "locationName": "maxResults" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token for the next page of results.

", + "locationName": "nextToken" + } + } + }, + "DescribeClassicLinkInstancesResult": { + "type": "structure", + "members": { + "Instances": { + "shape": "ClassicLinkInstanceList", + "documentation": "

Information about one or more linked EC2-Classic instances.

", + "locationName": "instancesSet" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName": "nextToken" + } + } + }, + "DescribeClientVpnAuthorizationRulesRequest": { + "type": "structure", + "required": [ + "ClientVpnEndpointId" + ], + "members": { + "ClientVpnEndpointId": { + "shape": "String", + "documentation": "

The ID of the Client VPN endpoint.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "

The token to retrieve the next page of results.

" + }, + "Filters": { + "shape": "FilterList", + "documentation": "

One or more filters. Filter names and values are case-sensitive.

", + "locationName": "Filter" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.

" + } + } + }, + "DescribeClientVpnAuthorizationRulesResult": { + "type": "structure", + "members": { + "AuthorizationRules": { + "shape": "AuthorizationRuleSet", + "documentation": "

Information about the authorization rules.

", + "locationName": "authorizationRule" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName": "nextToken" + } + } + }, + "DescribeClientVpnConnectionsRequest": { + "type": "structure", + "required": [ + "ClientVpnEndpointId" + ], + "members": { + "ClientVpnEndpointId": { + "shape": "String", + "documentation": "

The ID of the Client VPN endpoint.

" + }, + "Filters": { + "shape": "FilterList", + "documentation": "

One or more filters. Filter names and values are case-sensitive.

", + "locationName": "Filter" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "

The token to retrieve the next page of results.

" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DescribeClientVpnConnectionsResult": { + "type": "structure", + "members": { + "Connections": { + "shape": "ClientVpnConnectionSet", + "documentation": "

Information about the active and terminated client connections.

", + "locationName": "connections" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName": "nextToken" + } + } + }, + "DescribeClientVpnEndpointsRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointIds": { + "shape": "ValueStringList", + "documentation": "

The ID of the Client VPN endpoint.

", + "locationName": "ClientVpnEndpointId" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.

" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "

The token to retrieve the next page of results.

" + }, + "Filters": { + "shape": "FilterList", + "documentation": "

One or more filters. Filter names and values are case-sensitive.

", + "locationName": "Filter" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DescribeClientVpnEndpointsResult": { + "type": "structure", + "members": { + "ClientVpnEndpoints": { + "shape": "EndpointSet", + "documentation": "

Information about the Client VPN endpoints.

", + "locationName": "clientVpnEndpoint" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName": "nextToken" + } + } + }, + "DescribeClientVpnRoutesRequest": { + "type": "structure", + "required": [ + "ClientVpnEndpointId" + ], + "members": { + "ClientVpnEndpointId": { + "shape": "String", + "documentation": "

The ID of the Client VPN endpoint.

" + }, + "Filters": { + "shape": "FilterList", + "documentation": "

One or more filters. Filter names and values are case-sensitive.

", + "locationName": "Filter" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.

" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "

The token to retrieve the next page of results.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DescribeClientVpnRoutesResult": { + "type": "structure", + "members": { + "Routes": { + "shape": "ClientVpnRouteSet", + "documentation": "

Information about the Client VPN endpoint routes.

", + "locationName": "routes" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName": "nextToken" + } + } + }, + "DescribeClientVpnTargetNetworksRequest": { + "type": "structure", + "required": [ + "ClientVpnEndpointId" + ], + "members": { + "ClientVpnEndpointId": { + "shape": "String", + "documentation": "

The ID of the Client VPN endpoint.

" + }, + "AssociationIds": { + "shape": "ValueStringList", + "documentation": "

The IDs of the target network associations.

" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.

" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "

The token to retrieve the next page of results.

" + }, + "Filters": { + "shape": "FilterList", + "documentation": "

One or more filters. Filter names and values are case-sensitive.

", + "locationName": "Filter" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DescribeClientVpnTargetNetworksResult": { + "type": "structure", + "members": { + "ClientVpnTargetNetworks": { + "shape": "TargetNetworkSet", + "documentation": "

Information about the associated target networks.

", + "locationName": "clientVpnTargetNetworks" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName": "nextToken" + } + } + }, + "DescribeConversionTaskList": { + "type": "list", + "member": { + "shape": "ConversionTask", + "locationName": "item" + } + }, + "DescribeConversionTasksRequest": { + "type": "structure", + "members": { + "ConversionTaskIds": { + "shape": "ConversionIdStringList", + "documentation": "

The conversion task IDs.

", + "locationName": "conversionTaskId" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + } + }, + "DescribeConversionTasksResult": { + "type": "structure", + "members": { + "ConversionTasks": { + "shape": "DescribeConversionTaskList", + "documentation": "

Information about the conversion tasks.

", + "locationName": "conversionTasks" + } + } + }, + "DescribeCustomerGatewaysRequest": { + "type": "structure", + "members": { + "CustomerGatewayIds": { + "shape": "CustomerGatewayIdStringList", + "documentation": "

One or more customer gateway IDs.

Default: Describes all your customer gateways.

", + "locationName": "CustomerGatewayId" + }, + "Filters": { + "shape": "FilterList", + "documentation": "

One or more filters.

  • bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

  • customer-gateway-id - The ID of the customer gateway.

  • ip-address - The IP address of the customer gateway's Internet-routable external interface.

  • state - The state of the customer gateway (pending | available | deleting | deleted).

  • type - The type of customer gateway. Currently, the only supported type is ipsec.1.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

", + "locationName": "Filter" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + }, + "documentation": "

Contains the parameters for DescribeCustomerGateways.

" + }, + "DescribeCustomerGatewaysResult": { + "type": "structure", + "members": { + "CustomerGateways": { + "shape": "CustomerGatewayList", + "documentation": "

Information about one or more customer gateways.

", + "locationName": "customerGatewaySet" + } + }, + "documentation": "

Contains the output of DescribeCustomerGateways.

" + }, + "DescribeDhcpOptionsMaxResults": { + "type": "integer", + "max": 1000, + "min": 5 + }, + "DescribeDhcpOptionsRequest": { + "type": "structure", + "members": { + "DhcpOptionsIds": { + "shape": "DhcpOptionsIdStringList", + "documentation": "

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

", + "locationName": "DhcpOptionsId" + }, + "Filters": { + "shape": "FilterList", + "documentation": "

One or more filters.

  • dhcp-options-id - The ID of a DHCP options set.

  • key - The key for one of the options (for example, domain-name).

  • value - The value for one of the options.

  • owner-id - The ID of the AWS account that owns the DHCP options set.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

", + "locationName": "Filter" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token for the next page of results.

" + }, + "MaxResults": { + "shape": "DescribeDhcpOptionsMaxResults", + "documentation": "

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + } + } + }, + "DescribeDhcpOptionsResult": { + "type": "structure", + "members": { + "DhcpOptions": { + "shape": "DhcpOptionsList", + "documentation": "

Information about one or more DHCP options sets.

", + "locationName": "dhcpOptionsSet" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName": "nextToken" + } + } + }, + "DescribeEgressOnlyInternetGatewaysRequest": { + "type": "structure", + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "EgressOnlyInternetGatewayIds": { + "shape": "EgressOnlyInternetGatewayIdList", + "documentation": "

One or more egress-only internet gateway IDs.

", + "locationName": "EgressOnlyInternetGatewayId" + }, + "MaxResults": { + "shape": "Integer", + "documentation": "

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token for the next page of results.

" + } + } + }, + "DescribeEgressOnlyInternetGatewaysResult": { + "type": "structure", + "members": { + "EgressOnlyInternetGateways": { + "shape": "EgressOnlyInternetGatewayList", + "documentation": "

Information about the egress-only internet gateways.

", + "locationName": "egressOnlyInternetGatewaySet" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName": "nextToken" + } + } + }, + "DescribeElasticGpusMaxResults": { + "type": "integer", + "max": 1000, + "min": 10 + }, + "DescribeElasticGpusRequest": { + "type": "structure", + "members": { + "ElasticGpuIds": { + "shape": "ElasticGpuIdSet", + "documentation": "

The Elastic Graphics accelerator IDs.

", + "locationName": "ElasticGpuId" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "Filters": { + "shape": "FilterList", + "documentation": "

The filters.

  • availability-zone - The Availability Zone in which the Elastic Graphics accelerator resides.

  • elastic-gpu-health - The status of the Elastic Graphics accelerator (OK | IMPAIRED).

  • elastic-gpu-state - The state of the Elastic Graphics accelerator (ATTACHED).

  • elastic-gpu-type - The type of Elastic Graphics accelerator; for example, eg1.medium.

  • instance-id - The ID of the instance to which the Elastic Graphics accelerator is associated.

", + "locationName": "Filter" + }, + "MaxResults": { + "shape": "DescribeElasticGpusMaxResults", + "documentation": "

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000.

" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to request the next page of results.

" + } + } + }, + "DescribeElasticGpusResult": { + "type": "structure", + "members": { + "ElasticGpuSet": { + "shape": "ElasticGpuSet", + "documentation": "

Information about the Elastic Graphics accelerators.

", + "locationName": "elasticGpuSet" + }, + "MaxResults": { + "shape": "Integer", + "documentation": "

The total number of items to return. If the total number of items available is more than the value specified in max-items then a Next-Token will be provided in the output that you can use to resume pagination.

", + "locationName": "maxResults" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName": "nextToken" + } + } + }, + "DescribeExportTasksRequest": { + "type": "structure", + "members": { + "ExportTaskIds": { + "shape": "ExportTaskIdStringList", + "documentation": "

The export task IDs.

", + "locationName": "exportTaskId" + } + } + }, + "DescribeExportTasksResult": { + "type": "structure", + "members": { + "ExportTasks": { + "shape": "ExportTaskList", + "documentation": "

Information about the export tasks.

", + "locationName": "exportTaskSet" + } + } + }, + "DescribeFleetError": { + "type": "structure", + "members": { + "LaunchTemplateAndOverrides": { + "shape": "LaunchTemplateAndOverridesResponse", + "documentation": "

The launch templates and overrides that were used for launching the instances. Any parameters that you specify in the Overrides override the same parameters in the launch template.

", + "locationName": "launchTemplateAndOverrides" + }, + "Lifecycle": { + "shape": "InstanceLifecycle", + "documentation": "

Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.

", + "locationName": "lifecycle" + }, + "ErrorCode": { + "shape": "String", + "documentation": "

The error code that indicates why the instance could not be launched. For more information about error codes, see Error Codes.

", + "locationName": "errorCode" + }, + "ErrorMessage": { + "shape": "String", + "documentation": "

The error message that describes why the instance could not be launched. For more information about error messages, see ee Error Codes.

", + "locationName": "errorMessage" + } + }, + "documentation": "

Describes the instances that could not be launched by the fleet.

" + }, + "DescribeFleetHistoryRequest": { + "type": "structure", + "required": [ + "FleetId", + "StartTime" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "EventType": { + "shape": "FleetEventType", + "documentation": "

The type of events to describe. By default, all events are described.

" + }, + "MaxResults": { + "shape": "Integer", + "documentation": "

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token for the next set of results.

" + }, + "FleetId": { + "shape": "FleetIdentifier", + "documentation": "

The ID of the EC2 Fleet.

" + }, + "StartTime": { + "shape": "DateTime", + "documentation": "

The start date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

" + } + } + }, + "DescribeFleetHistoryResult": { + "type": "structure", + "members": { + "HistoryRecords": { + "shape": "HistoryRecordSet", + "documentation": "

Information about the events in the history of the EC2 Fleet.

", + "locationName": "historyRecordSet" + }, + "LastEvaluatedTime": { + "shape": "DateTime", + "documentation": "

The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.

If nextToken indicates that there are more results, this value is not present.

", + "locationName": "lastEvaluatedTime" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token for the next set of results.

", + "locationName": "nextToken" + }, + "FleetId": { + "shape": "FleetIdentifier", + "documentation": "

The ID of the EC Fleet.

", + "locationName": "fleetId" + }, + "StartTime": { + "shape": "DateTime", + "documentation": "

The start date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName": "startTime" + } + } + }, + "DescribeFleetInstancesRequest": { + "type": "structure", + "required": [ + "FleetId" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "MaxResults": { + "shape": "Integer", + "documentation": "

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token for the next set of results.

" + }, + "FleetId": { + "shape": "FleetIdentifier", + "documentation": "

The ID of the EC2 Fleet.

" + }, + "Filters": { + "shape": "FilterList", + "documentation": "

The filters.

  • instance-type - The instance type.

", + "locationName": "Filter" + } + } + }, + "DescribeFleetInstancesResult": { + "type": "structure", + "members": { + "ActiveInstances": { + "shape": "ActiveInstanceSet", + "documentation": "

The running instances. This list is refreshed periodically and might be out of date.

", + "locationName": "activeInstanceSet" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token for the next set of results.

", + "locationName": "nextToken" + }, + "FleetId": { + "shape": "FleetIdentifier", + "documentation": "

The ID of the EC2 Fleet.

", + "locationName": "fleetId" + } + } + }, + "DescribeFleetsErrorSet": { + "type": "list", + "member": { + "shape": "DescribeFleetError", + "locationName": "item" + } + }, + "DescribeFleetsInstances": { + "type": "structure", + "members": { + "LaunchTemplateAndOverrides": { + "shape": "LaunchTemplateAndOverridesResponse", + "documentation": "

The launch templates and overrides that were used for launching the instances. Any parameters that you specify in the Overrides override the same parameters in the launch template.

", + "locationName": "launchTemplateAndOverrides" + }, + "Lifecycle": { + "shape": "InstanceLifecycle", + "documentation": "

Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.

", + "locationName": "lifecycle" + }, + "InstanceIds": { + "shape": "InstanceIdsSet", + "documentation": "

The IDs of the instances.

", + "locationName": "instanceIds" + }, + "InstanceType": { + "shape": "InstanceType", + "documentation": "

The instance type.

", + "locationName": "instanceType" + }, + "Platform": { + "shape": "PlatformValues", + "documentation": "

The value is Windows for Windows instances; otherwise blank.

", + "locationName": "platform" + } + }, + "documentation": "

Describes the instances that were launched by the fleet.

" + }, + "DescribeFleetsInstancesSet": { + "type": "list", + "member": { + "shape": "DescribeFleetsInstances", + "locationName": "item" + } + }, + "DescribeFleetsRequest": { + "type": "structure", + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "MaxResults": { + "shape": "Integer", + "documentation": "

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token for the next set of results.

" + }, + "FleetIds": { + "shape": "FleetIdSet", + "documentation": "

The ID of the EC2 Fleets.

", + "locationName": "FleetId" + }, + "Filters": { + "shape": "FilterList", + "documentation": "

The filters.

  • activity-status - The progress of the EC2 Fleet ( error | pending-fulfillment | pending-termination | fulfilled).

  • excess-capacity-termination-policy - Indicates whether to terminate running instances if the target capacity is decreased below the current EC2 Fleet size (true | false).

  • fleet-state - The state of the EC2 Fleet (submitted | active | deleted | failed | deleted-running | deleted-terminating | modifying).

  • replace-unhealthy-instances - Indicates whether EC2 Fleet should replace unhealthy instances (true | false).

  • type - The type of request (instant | request | maintain).

", + "locationName": "Filter" + } + } + }, + "DescribeFleetsResult": { + "type": "structure", + "members": { + "NextToken": { + "shape": "String", + "documentation": "

The token for the next set of results.

", + "locationName": "nextToken" + }, + "Fleets": { + "shape": "FleetSet", + "documentation": "

Information about the EC2 Fleets.

", + "locationName": "fleetSet" + } + } + }, + "DescribeFlowLogsRequest": { + "type": "structure", + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "Filter": { + "shape": "FilterList", + "documentation": "

One or more filters.

  • deliver-log-status - The status of the logs delivery (SUCCESS | FAILED).

  • log-destination-type - The type of destination to which the flow log publishes data. Possible destination types include cloud-watch-logs and S3.

  • flow-log-id - The ID of the flow log.

  • log-group-name - The name of the log group.

  • resource-id - The ID of the VPC, subnet, or network interface.

  • traffic-type - The type of traffic (ACCEPT | REJECT | ALL).

" + }, + "FlowLogIds": { + "shape": "ValueStringList", + "documentation": "

One or more flow log IDs.

Constraint: Maximum of 1000 flow log IDs.

", + "locationName": "FlowLogId" + }, + "MaxResults": { + "shape": "Integer", + "documentation": "

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token for the next page of results.

" + } + } + }, + "DescribeFlowLogsResult": { + "type": "structure", + "members": { + "FlowLogs": { + "shape": "FlowLogSet", + "documentation": "

Information about the flow logs.

", + "locationName": "flowLogSet" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName": "nextToken" + } + } + }, + "DescribeFpgaImageAttributeRequest": { + "type": "structure", + "required": [ + "FpgaImageId", + "Attribute" + ], + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "FpgaImageId": { + "shape": "String", + "documentation": "

The ID of the AFI.

" + }, + "Attribute": { + "shape": "FpgaImageAttributeName", + "documentation": "

The AFI attribute.

" + } + } + }, + "DescribeFpgaImageAttributeResult": { + "type": "structure", + "members": { + "FpgaImageAttribute": { + "shape": "FpgaImageAttribute", + "documentation": "

Information about the attribute.

", + "locationName": "fpgaImageAttribute" + } + } + }, + "DescribeFpgaImagesRequest": { + "type": "structure", + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "FpgaImageIds": { + "shape": "FpgaImageIdList", + "documentation": "

The AFI IDs.

", + "locationName": "FpgaImageId" + }, + "Owners": { + "shape": "OwnerStringList", + "documentation": "

Filters the AFI by owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace).

", + "locationName": "Owner" + }, + "Filters": { + "shape": "FilterList", + "documentation": "

The filters.

  • create-time - The creation time of the AFI.

  • fpga-image-id - The FPGA image identifier (AFI ID).

  • fpga-image-global-id - The global FPGA image identifier (AGFI ID).

  • name - The name of the AFI.

  • owner-id - The AWS account ID of the AFI owner.

  • product-code - The product code.

  • shell-version - The version of the AWS Shell that was used to create the bitstream.

  • state - The state of the AFI (pending | failed | available | unavailable).

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • update-time - The time of the most recent update.

", + "locationName": "Filter" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "

The token to retrieve the next page of results.

" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "

The maximum number of results to return in a single call.

" + } + } + }, + "DescribeFpgaImagesResult": { + "type": "structure", + "members": { + "FpgaImages": { + "shape": "FpgaImageList", + "documentation": "

Information about the FPGA images.

", + "locationName": "fpgaImageSet" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName": "nextToken" + } + } + }, + "DescribeHostReservationOfferingsRequest": { + "type": "structure", + "members": { + "Filter": { + "shape": "FilterList", + "documentation": "

The filters.

  • instance-family - The instance family of the offering (for example, m4).

  • payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

" + }, + "MaxDuration": { + "shape": "Integer", + "documentation": "

This is the maximum duration of the reservation to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 94608000 for three years.

" + }, + "MaxResults": { + "shape": "DescribeHostReservationsMaxResults", + "documentation": "

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

" + }, + "MinDuration": { + "shape": "Integer", + "documentation": "

This is the minimum duration of the reservation you'd like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 31536000 for one year.

" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to use to retrieve the next page of results.

" + }, + "OfferingId": { + "shape": "String", + "documentation": "

The ID of the reservation offering.

" + } + } + }, + "DescribeHostReservationOfferingsResult": { + "type": "structure", + "members": { + "NextToken": { + "shape": "String", + "documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName": "nextToken" + }, + "OfferingSet": { + "shape": "HostOfferingSet", + "documentation": "

Information about the offerings.

", + "locationName": "offeringSet" + } + } + }, + "DescribeHostReservationsMaxResults": { + "type": "integer", + "max": 500, + "min": 5 + }, + "DescribeHostReservationsRequest": { + "type": "structure", + "members": { + "Filter": { + "shape": "FilterList", + "documentation": "

The filters.

  • instance-family - The instance family (for example, m4).

  • payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

  • state - The state of the reservation (payment-pending | payment-failed | active | retired).

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

" + }, + "HostReservationIdSet": { + "shape": "HostReservationIdSet", + "documentation": "

The host reservation IDs.

" + }, + "MaxResults": { + "shape": "Integer", + "documentation": "

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to use to retrieve the next page of results.

" + } + } + }, + "DescribeHostReservationsResult": { + "type": "structure", + "members": { + "HostReservationSet": { + "shape": "HostReservationSet", + "documentation": "

Details about the reservation's configuration.

", + "locationName": "hostReservationSet" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName": "nextToken" + } + } + }, + "DescribeHostsRequest": { + "type": "structure", + "members": { + "Filter": { + "shape": "FilterList", + "documentation": "

The filters.

  • auto-placement - Whether auto-placement is enabled or disabled (on | off).

  • availability-zone - The Availability Zone of the host.

  • client-token - The idempotency token that you provided when you allocated the host.

  • host-reservation-id - The ID of the reservation assigned to this host.

  • instance-type - The instance type size that the Dedicated Host is configured to support.

  • state - The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure).

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

", + "locationName": "filter" + }, + "HostIds": { + "shape": "RequestHostIdList", + "documentation": "

The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.

", + "locationName": "hostId" + }, + "MaxResults": { + "shape": "Integer", + "documentation": "

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

You cannot specify this parameter and the host IDs parameter in the same request.

", + "locationName": "maxResults" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to use to retrieve the next page of results.

", + "locationName": "nextToken" + } + } + }, + "DescribeHostsResult": { + "type": "structure", + "members": { + "Hosts": { + "shape": "HostList", + "documentation": "

Information about the Dedicated Hosts.

", + "locationName": "hostSet" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName": "nextToken" + } + } + }, + "DescribeIamInstanceProfileAssociationsRequest": { + "type": "structure", + "members": { + "AssociationIds": { + "shape": "AssociationIdList", + "documentation": "

The IAM instance profile associations.

", + "locationName": "AssociationId" + }, + "Filters": { + "shape": "FilterList", + "documentation": "

The filters.

  • instance-id - The ID of the instance.

  • state - The state of the association (associating | associated | disassociating | disassociated).

", + "locationName": "Filter" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "

The token to request the next page of results.

" + } + } + }, + "DescribeIamInstanceProfileAssociationsResult": { + "type": "structure", + "members": { + "IamInstanceProfileAssociations": { + "shape": "IamInstanceProfileAssociationSet", + "documentation": "

Information about the IAM instance profile associations.

", + "locationName": "iamInstanceProfileAssociationSet" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName": "nextToken" + } + } + }, + "DescribeIdFormatRequest": { + "type": "structure", + "members": { + "Resource": { + "shape": "String", + "documentation": "

The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway

" + } + } + }, + "DescribeIdFormatResult": { + "type": "structure", + "members": { + "Statuses": { + "shape": "IdFormatList", + "documentation": "

Information about the ID format for the resource.

", + "locationName": "statusSet" + } + } + }, + "DescribeIdentityIdFormatRequest": { + "type": "structure", + "required": [ + "PrincipalArn" + ], + "members": { + "PrincipalArn": { + "shape": "String", + "documentation": "

The ARN of the principal, which can be an IAM role, IAM user, or the root user.

", + "locationName": "principalArn" + }, + "Resource": { + "shape": "String", + "documentation": "

The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway

", + "locationName": "resource" + } + } + }, + "DescribeIdentityIdFormatResult": { + "type": "structure", + "members": { + "Statuses": { + "shape": "IdFormatList", + "documentation": "

Information about the ID format for the resources.

", + "locationName": "statusSet" + } + } + }, + "DescribeImageAttributeRequest": { + "type": "structure", + "required": [ + "Attribute", + "ImageId" + ], + "members": { + "Attribute": { + "shape": "ImageAttributeName", + "documentation": "

The AMI attribute.

Note: Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use DescribeImages to get information about the block device mapping for the AMI.

" + }, + "ImageId": { + "shape": "String", + "documentation": "

The ID of the AMI.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + }, + "documentation": "

Contains the parameters for DescribeImageAttribute.

" + }, + "DescribeImagesRequest": { + "type": "structure", + "members": { + "ExecutableUsers": { + "shape": "ExecutableByStringList", + "documentation": "

Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).

", + "locationName": "ExecutableBy" + }, + "Filters": { + "shape": "FilterList", + "documentation": "

The filters.

  • architecture - The image architecture (i386 | x86_64 | arm64).

  • block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).

  • block-device-mapping.snapshot-id - The ID of the snapshot used for the EBS volume.

  • block-device-mapping.volume-size - The volume size of the EBS volume, in GiB.

  • block-device-mapping.volume-type - The volume type of the EBS volume (gp2 | io1 | st1 | sc1 | standard).

  • block-device-mapping.encrypted - A Boolean that indicates whether the EBS volume is encrypted.

  • description - The description of the image (provided during image creation).

  • ena-support - A Boolean that indicates whether enhanced networking with ENA is enabled.

  • hypervisor - The hypervisor type (ovm | xen).

  • image-id - The ID of the image.

  • image-type - The image type (machine | kernel | ramdisk).

  • is-public - A Boolean that indicates whether the image is public.

  • kernel-id - The kernel ID.

  • manifest-location - The location of the image manifest.

  • name - The name of the AMI (provided during image creation).

  • owner-alias - String value from an Amazon-maintained list (amazon | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.

  • owner-id - The AWS account ID of the image owner.

  • platform - The platform. To only list Windows-based AMIs, use windows.

  • product-code - The product code.

  • product-code.type - The type of the product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • root-device-name - The device name of the root device volume (for example, /dev/sda1).

  • root-device-type - The type of the root device volume (ebs | instance-store).

  • state - The state of the image (available | pending | failed).

  • state-reason-code - The reason code for the state change.

  • state-reason-message - The message for the state change.

  • sriov-net-support - A value of simple indicates that enhanced networking with the Intel 82599 VF interface is enabled.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • virtualization-type - The virtualization type (paravirtual | hvm).

", + "locationName": "Filter" + }, + "ImageIds": { + "shape": "ImageIdStringList", + "documentation": "

The image IDs.

Default: Describes all images available to you.

", + "locationName": "ImageId" + }, + "Owners": { + "shape": "OwnerStringList", + "documentation": "

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-marketplace | microsoft). Omitting this option returns all images for which you have launch permissions, regardless of ownership.

", + "locationName": "Owner" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + } + }, + "DescribeImagesResult": { + "type": "structure", + "members": { + "Images": { + "shape": "ImageList", + "documentation": "

Information about the images.

", + "locationName": "imagesSet" + } + } + }, + "DescribeImportImageTasksRequest": { + "type": "structure", + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "Filters": { + "shape": "FilterList", + "documentation": "

Filter tasks using the task-state filter and one of the following values: active, completed, deleting, deleted.

" + }, + "ImportTaskIds": { + "shape": "ImportTaskIdList", + "documentation": "

A list of import image task IDs.

", + "locationName": "ImportTaskId" + }, + "MaxResults": { + "shape": "Integer", + "documentation": "

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "NextToken": { + "shape": "String", + "documentation": "

A token that indicates the next page of results.

" + } + } + }, + "DescribeImportImageTasksResult": { + "type": "structure", + "members": { + "ImportImageTasks": { + "shape": "ImportImageTaskList", + "documentation": "

A list of zero or more import image tasks that are currently active or were completed or canceled in the previous 7 days.

", + "locationName": "importImageTaskSet" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to use to get the next page of results. This value is null when there are no more results to return.

", + "locationName": "nextToken" + } + } + }, + "DescribeImportSnapshotTasksRequest": { + "type": "structure", + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "Filters": { + "shape": "FilterList", + "documentation": "

The filters.

" + }, + "ImportTaskIds": { + "shape": "ImportTaskIdList", + "documentation": "

A list of import snapshot task IDs.

", + "locationName": "ImportTaskId" + }, + "MaxResults": { + "shape": "Integer", + "documentation": "

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "NextToken": { + "shape": "String", + "documentation": "

A token that indicates the next page of results.

" + } + } + }, + "DescribeImportSnapshotTasksResult": { + "type": "structure", + "members": { + "ImportSnapshotTasks": { + "shape": "ImportSnapshotTaskList", + "documentation": "

A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the previous 7 days.

", + "locationName": "importSnapshotTaskSet" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to use to get the next page of results. This value is null when there are no more results to return.

", + "locationName": "nextToken" + } + } + }, + "DescribeInstanceAttributeRequest": { + "type": "structure", + "required": [ + "Attribute", + "InstanceId" + ], + "members": { + "Attribute": { + "shape": "InstanceAttributeName", + "documentation": "

The instance attribute.

Note: The enaSupport attribute is not supported at this time.

", + "locationName": "attribute" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "InstanceId": { + "shape": "String", + "documentation": "

The ID of the instance.

", + "locationName": "instanceId" + } + } + }, + "DescribeInstanceCreditSpecificationsMaxResults": { + "type": "integer", + "max": 1000, + "min": 5 + }, + "DescribeInstanceCreditSpecificationsRequest": { + "type": "structure", + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "Filters": { + "shape": "FilterList", + "documentation": "

The filters.

  • instance-id - The ID of the instance.

", + "locationName": "Filter" + }, + "InstanceIds": { + "shape": "InstanceIdStringList", + "documentation": "

The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 1000 explicitly specified instance IDs.

", + "locationName": "InstanceId" + }, + "MaxResults": { + "shape": "DescribeInstanceCreditSpecificationsMaxResults", + "documentation": "

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.

" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to retrieve the next page of results.

" + } + } + }, + "DescribeInstanceCreditSpecificationsResult": { + "type": "structure", + "members": { + "InstanceCreditSpecifications": { + "shape": "InstanceCreditSpecificationList", + "documentation": "

Information about the credit option for CPU usage of an instance.

", + "locationName": "instanceCreditSpecificationSet" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName": "nextToken" + } + } + }, + "DescribeInstanceStatusRequest": { + "type": "structure", + "members": { + "Filters": { + "shape": "FilterList", + "documentation": "

The filters.

  • availability-zone - The Availability Zone of the instance.

  • event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

  • event.description - A description of the event.

  • event.instance-event-id - The ID of the event whose date and time you are modifying.

  • event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).

  • instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

  • instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

  • system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

  • system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

", + "locationName": "Filter" + }, + "InstanceIds": { + "shape": "InstanceIdStringList", + "documentation": "

The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

", + "locationName": "InstanceId" + }, + "MaxResults": { + "shape": "Integer", + "documentation": "

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.

" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to retrieve the next page of results.

" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "IncludeAllInstances": { + "shape": "Boolean", + "documentation": "

When true, includes the health status for all instances. When false, includes the health status for running instances only.

Default: false

", + "locationName": "includeAllInstances" + } + } + }, + "DescribeInstanceStatusResult": { + "type": "structure", + "members": { + "InstanceStatuses": { + "shape": "InstanceStatusList", + "documentation": "

Information about the status of the instances.

", + "locationName": "instanceStatusSet" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName": "nextToken" + } + } + }, + "DescribeInstancesRequest": { + "type": "structure", + "members": { + "Filters": { + "shape": "FilterList", + "documentation": "

The filters.

  • affinity - The affinity setting for an instance running on a Dedicated Host (default | host).

  • architecture - The instance architecture (i386 | x86_64 | arm64).

  • availability-zone - The Availability Zone of the instance.

  • block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z.

  • block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).

  • block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).

  • block-device-mapping.volume-id - The volume ID of the EBS volume.

  • client-token - The idempotency token you provided when you launched the instance.

  • dns-name - The public DNS name of the instance.

  • group-id - The ID of the security group for the instance. EC2-Classic only.

  • group-name - The name of the security group for the instance. EC2-Classic only.

  • hibernation-options.configured - A Boolean that indicates whether the instance is enabled for hibernation. A value of true means that the instance is enabled for hibernation.

  • host-id - The ID of the Dedicated Host on which the instance is running, if applicable.

  • hypervisor - The hypervisor type of the instance (ovm | xen).

  • iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.

  • image-id - The ID of the image used to launch the instance.

  • instance-id - The ID of the instance.

  • instance-lifecycle - Indicates whether this is a Spot Instance or a Scheduled Instance (spot | scheduled).

  • instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-type - The type of instance (for example, t2.micro).

  • instance.group-id - The ID of the security group for the instance.

  • instance.group-name - The name of the security group for the instance.

  • ip-address - The public IPv4 address of the instance.

  • kernel-id - The kernel ID.

  • key-name - The name of the key pair used when the instance was launched.

  • launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).

  • launch-time - The time when the instance was launched.

  • monitoring-state - Indicates whether detailed monitoring is enabled (disabled | enabled).

  • network-interface.addresses.private-ip-address - The private IPv4 address associated with the network interface.

  • network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.

  • network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address (IPv4) with a network interface.

  • network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address associated with the network interface.

  • network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.

  • network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.

  • network-interface.association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.

  • network-interface.association.association-id - The association ID returned when the network interface was associated with an IPv4 address.

  • network-interface.attachment.attachment-id - The ID of the interface attachment.

  • network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.

  • network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • network-interface.attachment.device-index - The device index to which the network interface is attached.

  • network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • network-interface.attachment.attach-time - The time that the network interface was attached to an instance.

  • network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.

  • network-interface.availability-zone - The Availability Zone for the network interface.

  • network-interface.description - The description of the network interface.

  • network-interface.group-id - The ID of a security group associated with the network interface.

  • network-interface.group-name - The name of a security group associated with the network interface.

  • network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network interface.

  • network-interface.mac-address - The MAC address of the network interface.

  • network-interface.network-interface-id - The ID of the network interface.

  • network-interface.owner-id - The ID of the owner of the network interface.

  • network-interface.private-dns-name - The private DNS name of the network interface.

  • network-interface.requester-id - The requester ID for the network interface.

  • network-interface.requester-managed - Indicates whether the network interface is being managed by AWS.

  • network-interface.status - The status of the network interface (available) | in-use).

  • network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.

  • network-interface.subnet-id - The ID of the subnet for the network interface.

  • network-interface.vpc-id - The ID of the VPC for the network interface.

  • owner-id - The AWS account ID of the instance owner.

  • placement-group-name - The name of the placement group for the instance.

  • placement-partition-number - The partition in which the instance is located.

  • platform - The platform. To list only Windows instances, use windows.

  • private-dns-name - The private IPv4 DNS name of the instance.

  • private-ip-address - The private IPv4 address of the instance.

  • product-code - The product code associated with the AMI used to launch the instance.

  • product-code.type - The type of product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • reason - The reason for the current state of the instance (for example, shows \"User Initiated [date]\" when you stop or terminate the instance). Similar to the state-reason-code filter.

  • requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • reservation-id - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID.

  • root-device-name - The device name of the root device volume (for example, /dev/sda1).

  • root-device-type - The type of the root device volume (ebs | instance-store).

  • source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.

  • spot-instance-request-id - The ID of the Spot Instance request.

  • state-reason-code - The reason code for the state change.

  • state-reason-message - A message that describes the state change.

  • subnet-id - The ID of the subnet for the instance.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

  • tenancy - The tenancy of an instance (dedicated | default | host).

  • virtualization-type - The virtualization type of the instance (paravirtual | hvm).

  • vpc-id - The ID of the VPC that the instance is running in.

", + "locationName": "Filter" + }, + "InstanceIds": { + "shape": "InstanceIdStringList", + "documentation": "

The instance IDs.

Default: Describes all your instances.

", + "locationName": "InstanceId" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "MaxResults": { + "shape": "Integer", + "documentation": "

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.

", + "locationName": "maxResults" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to request the next page of results.

", + "locationName": "nextToken" + } + } + }, + "DescribeInstancesResult": { + "type": "structure", + "members": { + "Reservations": { + "shape": "ReservationList", + "documentation": "

Information about the reservations.

", + "locationName": "reservationSet" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName": "nextToken" + } + } + }, + "DescribeInternetGatewaysMaxResults": { + "type": "integer", + "max": 1000, + "min": 5 + }, + "DescribeInternetGatewaysRequest": { + "type": "structure", + "members": { + "Filters": { + "shape": "FilterList", + "documentation": "

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.

  • attachment.vpc-id - The ID of an attached VPC.

  • internet-gateway-id - The ID of the Internet gateway.

  • owner-id - The ID of the AWS account that owns the internet gateway.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

", + "locationName": "Filter" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "InternetGatewayIds": { + "shape": "ValueStringList", + "documentation": "

One or more internet gateway IDs.

Default: Describes all your internet gateways.

", + "locationName": "internetGatewayId" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token for the next page of results.

" + }, + "MaxResults": { + "shape": "DescribeInternetGatewaysMaxResults", + "documentation": "

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + } + } + }, + "DescribeInternetGatewaysResult": { + "type": "structure", + "members": { + "InternetGateways": { + "shape": "InternetGatewayList", + "documentation": "

Information about one or more internet gateways.

", + "locationName": "internetGatewaySet" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName": "nextToken" + } + } + }, + "DescribeKeyPairsRequest": { + "type": "structure", + "members": { + "Filters": { + "shape": "FilterList", + "documentation": "

The filters.

  • fingerprint - The fingerprint of the key pair.

  • key-name - The name of the key pair.

", + "locationName": "Filter" + }, + "KeyNames": { + "shape": "KeyNameStringList", + "documentation": "

The key pair names.

Default: Describes all your key pairs.

", + "locationName": "KeyName" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + } + }, + "DescribeKeyPairsResult": { + "type": "structure", + "members": { + "KeyPairs": { + "shape": "KeyPairList", + "documentation": "

Information about the key pairs.

", + "locationName": "keySet" + } + } + }, + "DescribeLaunchTemplateVersionsRequest": { + "type": "structure", + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "LaunchTemplateId": { + "shape": "String", + "documentation": "

The ID of the launch template. You must specify either the launch template ID or launch template name in the request.

" + }, + "LaunchTemplateName": { + "shape": "LaunchTemplateName", + "documentation": "

The name of the launch template. You must specify either the launch template ID or launch template name in the request.

" + }, + "Versions": { + "shape": "VersionStringList", + "documentation": "

One or more versions of the launch template.

", + "locationName": "LaunchTemplateVersion" + }, + "MinVersion": { + "shape": "String", + "documentation": "

The version number after which to describe launch template versions.

" + }, + "MaxVersion": { + "shape": "String", + "documentation": "

The version number up to which to describe launch template versions.

" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to request the next page of results.

" + }, + "MaxResults": { + "shape": "Integer", + "documentation": "

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 1 and 200.

" + }, + "Filters": { + "shape": "FilterList", + "documentation": "

One or more filters.

  • create-time - The time the launch template version was created.

  • ebs-optimized - A boolean that indicates whether the instance is optimized for Amazon EBS I/O.

  • iam-instance-profile - The ARN of the IAM instance profile.

  • image-id - The ID of the AMI.

  • instance-type - The instance type.

  • is-default-version - A boolean that indicates whether the launch template version is the default version.

  • kernel-id - The kernel ID.

  • ram-disk-id - The RAM disk ID.

", + "locationName": "Filter" + } + } + }, + "DescribeLaunchTemplateVersionsResult": { + "type": "structure", + "members": { + "LaunchTemplateVersions": { + "shape": "LaunchTemplateVersionSet", + "documentation": "

Information about the launch template versions.

", + "locationName": "launchTemplateVersionSet" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName": "nextToken" + } + } + }, + "DescribeLaunchTemplatesMaxResults": { + "type": "integer", + "max": 200, + "min": 1 + }, + "DescribeLaunchTemplatesRequest": { + "type": "structure", + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "LaunchTemplateIds": { + "shape": "ValueStringList", + "documentation": "

One or more launch template IDs.

", + "locationName": "LaunchTemplateId" + }, + "LaunchTemplateNames": { + "shape": "LaunchTemplateNameStringList", + "documentation": "

One or more launch template names.

", + "locationName": "LaunchTemplateName" + }, + "Filters": { + "shape": "FilterList", + "documentation": "

One or more filters.

  • create-time - The time the launch template was created.

  • launch-template-name - The name of the launch template.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

", + "locationName": "Filter" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to request the next page of results.

" + }, + "MaxResults": { + "shape": "DescribeLaunchTemplatesMaxResults", + "documentation": "

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 1 and 200.

" + } + } + }, + "DescribeLaunchTemplatesResult": { + "type": "structure", + "members": { + "LaunchTemplates": { + "shape": "LaunchTemplateSet", + "documentation": "

Information about the launch templates.

", + "locationName": "launchTemplates" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName": "nextToken" + } + } + }, + "DescribeMovingAddressesRequest": { + "type": "structure", + "members": { + "Filters": { + "shape": "FilterList", + "documentation": "

One or more filters.

  • moving-status - The status of the Elastic IP address (MovingToVpc | RestoringToClassic).

", + "locationName": "filter" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "MaxResults": { + "shape": "Integer", + "documentation": "

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value outside of this range, an error is returned.

Default: If no value is provided, the default is 1000.

", + "locationName": "maxResults" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token for the next page of results.

", + "locationName": "nextToken" + }, + "PublicIps": { + "shape": "ValueStringList", + "documentation": "

One or more Elastic IP addresses.

", + "locationName": "publicIp" + } + } + }, + "DescribeMovingAddressesResult": { + "type": "structure", + "members": { + "MovingAddressStatuses": { + "shape": "MovingAddressStatusSet", + "documentation": "

The status for each Elastic IP address.

", + "locationName": "movingAddressStatusSet" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName": "nextToken" + } + } + }, + "DescribeNatGatewaysRequest": { + "type": "structure", + "members": { + "Filter": { + "shape": "FilterList", + "documentation": "

One or more filters.

  • nat-gateway-id - The ID of the NAT gateway.

  • state - The state of the NAT gateway (pending | failed | available | deleting | deleted).

  • subnet-id - The ID of the subnet in which the NAT gateway resides.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • vpc-id - The ID of the VPC in which the NAT gateway resides.

" + }, + "MaxResults": { + "shape": "Integer", + "documentation": "

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + }, + "NatGatewayIds": { + "shape": "ValueStringList", + "documentation": "

One or more NAT gateway IDs.

", + "locationName": "NatGatewayId" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token for the next page of results.

" + } + } + }, + "DescribeNatGatewaysResult": { + "type": "structure", + "members": { + "NatGateways": { + "shape": "NatGatewayList", + "documentation": "

Information about the NAT gateways.

", + "locationName": "natGatewaySet" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName": "nextToken" + } + } + }, + "DescribeNetworkAclsMaxResults": { + "type": "integer", + "max": 1000, + "min": 5 + }, + "DescribeNetworkAclsRequest": { + "type": "structure", + "members": { + "Filters": { + "shape": "FilterList", + "documentation": "

One or more filters.

  • association.association-id - The ID of an association ID for the ACL.

  • association.network-acl-id - The ID of the network ACL involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • default - Indicates whether the ACL is the default network ACL for the VPC.

  • entry.cidr - The IPv4 CIDR range specified in the entry.

  • entry.icmp.code - The ICMP code specified in the entry, if any.

  • entry.icmp.type - The ICMP type specified in the entry, if any.

  • entry.ipv6-cidr - The IPv6 CIDR range specified in the entry.

  • entry.port-range.from - The start of the port range specified in the entry.

  • entry.port-range.to - The end of the port range specified in the entry.

  • entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).

  • entry.rule-action - Allows or denies the matching traffic (allow | deny).

  • entry.rule-number - The number of an entry (in other words, rule) in the set of ACL entries.

  • network-acl-id - The ID of the network ACL.

  • owner-id - The ID of the AWS account that owns the network ACL.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • vpc-id - The ID of the VPC for the network ACL.

", + "locationName": "Filter" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "NetworkAclIds": { + "shape": "ValueStringList", + "documentation": "

One or more network ACL IDs.

Default: Describes all your network ACLs.

", + "locationName": "NetworkAclId" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token for the next page of results.

" + }, + "MaxResults": { + "shape": "DescribeNetworkAclsMaxResults", + "documentation": "

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + } + } + }, + "DescribeNetworkAclsResult": { + "type": "structure", + "members": { + "NetworkAcls": { + "shape": "NetworkAclList", + "documentation": "

Information about one or more network ACLs.

", + "locationName": "networkAclSet" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName": "nextToken" + } + } + }, + "DescribeNetworkInterfaceAttributeRequest": { + "type": "structure", + "required": [ + "NetworkInterfaceId" + ], + "members": { + "Attribute": { + "shape": "NetworkInterfaceAttribute", + "documentation": "

The attribute of the network interface. This parameter is required.

", + "locationName": "attribute" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "NetworkInterfaceId": { + "shape": "String", + "documentation": "

The ID of the network interface.

", + "locationName": "networkInterfaceId" + } + }, + "documentation": "

Contains the parameters for DescribeNetworkInterfaceAttribute.

" + }, + "DescribeNetworkInterfaceAttributeResult": { + "type": "structure", + "members": { + "Attachment": { + "shape": "NetworkInterfaceAttachment", + "documentation": "

The attachment (if any) of the network interface.

", + "locationName": "attachment" + }, + "Description": { + "shape": "AttributeValue", + "documentation": "

The description of the network interface.

", + "locationName": "description" + }, + "Groups": { + "shape": "GroupIdentifierList", + "documentation": "

The security groups associated with the network interface.

", + "locationName": "groupSet" + }, + "NetworkInterfaceId": { + "shape": "String", + "documentation": "

The ID of the network interface.

", + "locationName": "networkInterfaceId" + }, + "SourceDestCheck": { + "shape": "AttributeBooleanValue", + "documentation": "

Indicates whether source/destination checking is enabled.

", + "locationName": "sourceDestCheck" + } + }, + "documentation": "

Contains the output of DescribeNetworkInterfaceAttribute.

" + }, + "DescribeNetworkInterfacePermissionsMaxResults": { + "type": "integer", + "max": 255, + "min": 5 + }, + "DescribeNetworkInterfacePermissionsRequest": { + "type": "structure", + "members": { + "NetworkInterfacePermissionIds": { + "shape": "NetworkInterfacePermissionIdList", + "documentation": "

One or more network interface permission IDs.

", + "locationName": "NetworkInterfacePermissionId" + }, + "Filters": { + "shape": "FilterList", + "documentation": "

One or more filters.

  • network-interface-permission.network-interface-permission-id - The ID of the permission.

  • network-interface-permission.network-interface-id - The ID of the network interface.

  • network-interface-permission.aws-account-id - The AWS account ID.

  • network-interface-permission.aws-service - The AWS service.

  • network-interface-permission.permission - The type of permission (INSTANCE-ATTACH | EIP-ASSOCIATE).

", + "locationName": "Filter" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to request the next page of results.

" + }, + "MaxResults": { + "shape": "DescribeNetworkInterfacePermissionsMaxResults", + "documentation": "

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. If this parameter is not specified, up to 50 results are returned by default.

" + } + }, + "documentation": "

Contains the parameters for DescribeNetworkInterfacePermissions.

" + }, + "DescribeNetworkInterfacePermissionsResult": { + "type": "structure", + "members": { + "NetworkInterfacePermissions": { + "shape": "NetworkInterfacePermissionList", + "documentation": "

The network interface permissions.

", + "locationName": "networkInterfacePermissions" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to use to retrieve the next page of results.

", + "locationName": "nextToken" + } + }, + "documentation": "

Contains the output for DescribeNetworkInterfacePermissions.

" + }, + "DescribeNetworkInterfacesMaxResults": { + "type": "integer", + "max": 1000, + "min": 5 + }, + "DescribeNetworkInterfacesRequest": { + "type": "structure", + "members": { + "Filters": { + "shape": "FilterList", + "documentation": "

One or more filters.

  • addresses.private-ip-address - The private IPv4 addresses associated with the network interface.

  • addresses.primary - Whether the private IPv4 address is the primary IP address associated with the network interface.

  • addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address (IPv4).

  • addresses.association.owner-id - The owner ID of the addresses associated with the network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IPv4 address.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.

  • association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.

  • association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.

  • association.public-dns-name - The public DNS name for the network interface (IPv4).

  • attachment.attachment-id - The ID of the interface attachment.

  • attachment.attach.time - The time that the network interface was attached to an instance.

  • attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.

  • attachment.device-index - The device index to which the network interface is attached.

  • attachment.instance-id - The ID of the instance to which the network interface is attached.

  • attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • attachment.nat-gateway-id - The ID of the NAT gateway to which the network interface is attached.

  • attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • availability-zone - The Availability Zone of the network interface.

  • description - The description of the network interface.

  • group-id - The ID of a security group associated with the network interface.

  • group-name - The name of a security group associated with the network interface.

  • ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.

  • mac-address - The MAC address of the network interface.

  • network-interface-id - The ID of the network interface.

  • owner-id - The AWS account ID of the network interface owner.

  • private-ip-address - The private IPv4 address or addresses of the network interface.

  • private-dns-name - The private DNS name of the network interface (IPv4).

  • requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • requester-managed - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on).

  • source-dest-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.

  • status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.

  • subnet-id - The ID of the subnet for the network interface.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • vpc-id - The ID of the VPC for the network interface.

", + "locationName": "filter" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "NetworkInterfaceIds": { + "shape": "NetworkInterfaceIdList", + "documentation": "

One or more network interface IDs.

Default: Describes all your network interfaces.

", + "locationName": "NetworkInterfaceId" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to retrieve the next page of results.

" + }, + "MaxResults": { + "shape": "DescribeNetworkInterfacesMaxResults", + "documentation": "

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

" + } + }, + "documentation": "

Contains the parameters for DescribeNetworkInterfaces.

" + }, + "DescribeNetworkInterfacesResult": { + "type": "structure", + "members": { + "NetworkInterfaces": { + "shape": "NetworkInterfaceList", + "documentation": "

Information about one or more network interfaces.

", + "locationName": "networkInterfaceSet" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName": "nextToken" + } + }, + "documentation": "

Contains the output of DescribeNetworkInterfaces.

" + }, + "DescribePlacementGroupsRequest": { + "type": "structure", + "members": { + "Filters": { + "shape": "FilterList", + "documentation": "

The filters.

  • group-name - The name of the placement group.

  • state - The state of the placement group (pending | available | deleting | deleted).

  • strategy - The strategy of the placement group (cluster | spread | partition).

", + "locationName": "Filter" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + }, + "GroupNames": { + "shape": "PlacementGroupStringList", + "documentation": "

The names of the placement groups.

Default: Describes all your placement groups, or only those otherwise specified.

", + "locationName": "groupName" + } + } + }, + "DescribePlacementGroupsResult": { + "type": "structure", + "members": { + "PlacementGroups": { + "shape": "PlacementGroupList", + "documentation": "

Information about the placement groups.

", + "locationName": "placementGroupSet" + } + } + }, + "DescribePrefixListsRequest": { + "type": "structure", + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "Filters": { + "shape": "FilterList", + "documentation": "

One or more filters.

  • prefix-list-id: The ID of a prefix list.

  • prefix-list-name: The name of a prefix list.

", + "locationName": "Filter" + }, + "MaxResults": { + "shape": "Integer", + "documentation": "

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token for the next page of results.

" + }, + "PrefixListIds": { + "shape": "ValueStringList", + "documentation": "

One or more prefix list IDs.

", + "locationName": "PrefixListId" + } + } + }, + "DescribePrefixListsResult": { + "type": "structure", + "members": { + "NextToken": { + "shape": "String", + "documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName": "nextToken" + }, + "PrefixLists": { + "shape": "PrefixListSet", + "documentation": "

All available prefix lists.

", + "locationName": "prefixListSet" + } + } + }, + "DescribePrincipalIdFormatRequest": { + "type": "structure", + "members": { + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "Resources": { + "shape": "ResourceList", + "documentation": "

The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway

", + "locationName": "Resource" + }, + "MaxResults": { + "shape": "Integer", + "documentation": "

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to request the next page of results.

" + } + } + }, + "DescribePrincipalIdFormatResult": { + "type": "structure", + "members": { + "Principals": { + "shape": "PrincipalIdFormatList", + "documentation": "

Information about the ID format settings for the ARN.

", + "locationName": "principalSet" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName": "nextToken" + } + } + }, + "DescribePublicIpv4PoolsRequest": { + "type": "structure", + "members": { + "PoolIds": { + "shape": "ValueStringList", + "documentation": "

The IDs of the address pools.

", + "locationName": "PoolId" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "

The token for the next page of results.

" + }, + "MaxResults": { + "shape": "PoolMaxResults", + "documentation": "

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + } + } + }, + "DescribePublicIpv4PoolsResult": { + "type": "structure", + "members": { + "PublicIpv4Pools": { + "shape": "PublicIpv4PoolSet", + "documentation": "

Information about the address pools.

", + "locationName": "publicIpv4PoolSet" + }, + "NextToken": { + "shape": "String", + "documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName": "nextToken" + } + } + }, + "DescribeRegionsRequest": { + "type": "structure", + "members": { + "Filters": { + "shape": "FilterList", + "documentation": "

The filters.

  • endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com).

  • region-name - The name of the Region (for example, us-east-1).

", + "locationName": "Filter" + }, + "RegionNames": { + "shape": "RegionNameStringList", + "documentation": "

The names of the Regions.

", + "locationName": "RegionName" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "

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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName": "dryRun" + } + } + }, + "DescribeRegionsResult": { + "type": "structure", + "members": { + "Regions": { + "shape": "RegionList", + "documentation": "

Information about the Regions.

", + "locationName": "regionInfo" + } + } + }, + "DescribeReservedInstancesListingsRequest": { + "type": "structure", + "members": { + "Filters": { + "shape": "FilterList", + "documentation": "

One or more filters.

  • reserved-instances-id - The ID of the Reserved Instances.

  • reserved-instances-listing-id - The ID of the Reserved Instances listing.

  • status - The status of the Reserved Instance listing (pending | active | cancelled | closed).

  • status-message - The reason for the status.

", + "locationName": "Filter" + }, + "ReservedInstancesId": { + "shape": "String", + "documentation": "

One or more Reserved Instance IDs.

", + "locationName": "reservedInstancesId" + }, + "ReservedInstancesListingId": { + "shape": "String", + "documentation": "

One or more Reserved Instance listing IDs.

", + "locationName": "reservedInstancesListingId" + } + }, + "documentation": "

Contains the parameters for DescribeReservedInstancesListings.

" + }, + "DescribeReservedInstancesListingsResult": { + "type": "structure", + "members": { + "ReservedInstancesListings": { + "shape": "ReservedInstancesListingList", + "documentation": "

Information about the Reserved Instance listing.

", + "locationName": "reservedInstancesListingsSet" + } + }, + "documentation": "

Contains the output of DescribeReservedInstancesListings.

" + }, + "DescribeReservedInstancesModificationsRequest": { + "type": "structure", + "members": { + "Filters": { + "shape": "FilterList", + "documentation": "

One or more filters.

  • client-token - The idempotency token for the modification request.

  • create-date - The time when the modification request was created.

  • effective-date - The time when the modification becomes effective.

  • modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.

  • modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.

  • modification-result.target-configuration.instance-count - The number of new Reserved Instances.

  • modification-result.target-configuration.instance-type - The instance type of the