{ "id": "@itentialopensource/adapter-aws_ec2", "type": "Adapter", "export": "Awsec2", "title": "Awsec2", "src": "adapter.js", "roles": [ "admin" ], "methods": [ { "name": "iapUpdateAdapterConfiguration", "summary": "Updates the adapter configuration", "description": "Updates the adapter configuration file with the provided changes", "input": [ { "name": "configFile", "type": "string", "info": "The name of the file to change", "required": true, "schema": { "title": "configFile", "type": "string" } }, { "name": "changes", "type": "object", "info": "JSON object containing the configuration changes", "required": true, "schema": { "title": "changes", "type": "object" } }, { "name": "entity", "type": "string", "info": "The entity in which the changes are being made", "required": false, "schema": { "title": "entity", "type": "string" } }, { "name": "type", "type": "string", "info": "The type of file to change - action, schema, or mock", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "action", "type": "string", "info": "The action to be changed", "required": false, "schema": { "title": "action", "type": "string" } }, { "name" : "replace", "type": "boolean", "info": "True to replace entire mock data, false to merge/append", "required": false, "schema": { "title": "replace", "type" : "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUpdateAdapterConfiguration" }, "task": true }, { "name": "iapSuspendAdapter", "summary": "Suspends the adapter", "description": "Suspends the adapter", "input": [ { "name": "mode", "type": "enum", "enumerals": [ "pause", "error" ], "info": "How incoming requests are handled. Defaults to 'pause'", "description": "How incoming requests are handled. Defaults to 'pause'", "schema": { "title": "mode", "type": "string" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapSuspendAdapter" }, "task": true }, { "name": "iapUnsuspendAdapter", "summary": "Unsuspends the adapter", "description": "Unsuspends the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUnsuspendAdapter" }, "task": true }, { "name": "iapGetAdapterQueue", "summary": "Return the requests that are waiting in the queue if throttling is enabled", "description": "Return the requests that are waiting in the queue if throttling is enabled", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter queue", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetAdapterQueue" }, "task": true }, { "name": "iapFindAdapterPath", "summary": "Provides the ability to see if a particular API path is supported by the adapter", "description": "Provides the ability to see if a particular API path is supported by the adapter", "input": [ { "name": "apiPath", "type": "string", "info": "The API Path you want to check - make sure to not include base path and version", "description": "The API Path you want to check - make sure to not include base path and version", "schema": { "title": "apiPath", "type": "string" }, "required": true } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapFindAdapterPath" }, "task": true }, { "name": "iapTroubleshootAdapter", "summary": "Runs troubleshoot script for adapter", "description": "Runs troubleshoot script for adapter", "input": [ { "name": "props", "type": "object", "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}", "required": true, "schema": { "title": "props", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapTroubleshootAdapter" }, "task": true }, { "name": "iapRunAdapterHealthcheck", "summary": "Runs healthcheck script for adapter", "description": "Runs healthcheck script for adapter", "input": [], "output": { "name": "result", "type": "boolean", "description": "Whether healthcheck passed or failed", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterHealthcheck" }, "task": true }, { "name": "iapRunAdapterConnectivity", "summary": "Runs connectivity check script for adapter", "description": "Runs connectivity check script for adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterConnectivity" }, "task": true }, { "name": "iapRunAdapterBasicGet", "summary": "Runs basicGet script for adapter", "description": "Runs basicGet script for adapter", "input": [ { "name": "maxCalls", "required": false, "type": "number", "info": "How many GET endpoints to test (defaults to 5)", "schema": { "title": "maxCalls", "type": "number", "default": 5 } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterBasicGet" }, "task": true }, { "name": "iapMoveAdapterEntitiesToDB", "summary": "Moves entities from an adapter into the Itential Platform database", "description": "Moves entities from an adapter into the Itential Platform database", "input": [], "output": { "name": "res", "type": "object", "description": "A JSON Object containing status, code and the response from the mongo transaction", "schema": { "title": "res", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapMoveAdapterEntitiesToDB" }, "task": true }, { "name": "iapDeactivateTasks", "summary": "Deactivate the inputted tasks", "description": "Deactivate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to deactivate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapDeactivateTasks" }, "task": true }, { "name": "iapActivateTasks", "summary": "Activate the inputted tasks", "description": "activate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to activate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapActivateTasks" }, "task": true }, { "name": "iapPopulateEntityCache", "summary": "Populate the cache for the given entities", "description": "Populate the cache for the given entities", "input": [ { "name": "entityTypes", "type": "array", "info": "the entity type(s) to populate", "required": true, "schema": { "title": "entityTypes", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapPopulateEntityCache" }, "task": true }, { "name": "iapRetrieveEntitiesCache", "summary": "Retrieves data from cache for specified entity type", "description": "Retrieves data from cache for specified entity type", "input": [ { "name": "entityType", "type": "string", "info": "entity of which to retrieve", "required": true, "schema": { "title": "entityType", "type": "string" } }, { "name": "options", "type": "object", "info": "settings of which data to return and how to return it", "required": false, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRetrieveEntitiesCache" }, "task": true }, { "name": "getDevice", "summary": "Get the Appliance", "description": "Get the Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevice" }, "task": false }, { "name": "getDevicesFiltered", "summary": "Get Appliances that match the filter", "description": "Get Appliances that match the filter", "input": [ { "name": "options", "type": "object", "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }", "required": true, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevicesFiltered" }, "task": false }, { "name": "isAlive", "summary": "Checks the status for the provided Appliance", "description": "Checks the status for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "boolean", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/isAlive" }, "task": false }, { "name": "getConfig", "summary": "Gets a config for the provided Appliance", "description": "Gets a config for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } }, { "name": "format", "type": "string", "info": "The format to be returned - this is ignored as we always return json", "required": false, "schema": { "title": "format", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getConfig" }, "task": false }, { "name": "iapGetDeviceCount", "summary": "Gets a device count from the system", "description": "Gets a device count from the system", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetDeviceCount" }, "task": false }, { "name": "iapExpandedGenericAdapterRequest", "summary": "Makes the requested generic call with additional options", "description": "Makes the requested generic call with additional options via metadata", "input": [ { "name": "metadata", "type": "object", "info": "metadata for the call (optional)", "description": "metadata for the call - allows for many enhancements (optional)", "schema": { "title": "metadata", "type": "object" }, "required": false }, { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": false }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": false }, { "name": "pathVars", "type": "object", "info": "the parameters to be put within the url path (optional)", "description": "the parameters to be put within the url path (optional)", "schema": { "title": "pathVars", "type": "object" }, "required": false }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapExpandedGenericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequest", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequestNoBasePath", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequestNoBasePath" }, "task": true }, { "name": "iapRunAdapterLint", "summary": "Run the adapter lint script to return the results", "description": "Run the adapter lint script to return the results", "input": [], "output": { "name": "result", "type": "string", "description": "A string containing the run results", "schema": { "title": "result", "type": "string" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterLint" }, "task": true }, { "name": "iapRunAdapterTests", "summary": "Run the adapter test scripts (baseunit and unit) to return the results", "description": "Run the adapter test scripts (baseunit and unit) to return the results", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterTests" }, "task": true }, { "name": "iapGetAdapterInventory", "summary": "Provide inventory information abbout the adapter", "description": "Provide inventory information abbout the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapGetAdapterInventory" }, "task": true }, { "name": "refreshAwsKeys", "summary": "Changes the access key and the secret key on the adapter's properties", "description": "Changes the access key and the secret key on the adapter's properties", "input": [ { "name": "accessKey", "type": "string", "info": "The access key for AWS", "description": "The access key for AWS", "schema": { "title": "accessKey", "type": "string" }, "required": true }, { "name": "secretKey", "type": "string", "info": "The secret key for AWS", "description": "The secret key for AWS", "schema": { "title": "secretKey", "type": "string" }, "required": true }, { "name": "sessionToken", "type": "string", "info": "The session token for AWS", "description": "The session token for AWS", "schema": { "title": "sessionToken", "type": "string" }, "required": true } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/refreshAwsKeys" }, "task": true }, { "name": "acceptReservedInstancesExchangeQuote", "summary": "Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.", "description": "Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "reservedInstanceId", "type": "array", "info": "The IDs of the Convertible Reserved Instances to exchange for another Convertible Reserved Instance of the same or higher value.", "required": true, "schema": { "title": "reservedInstanceId", "type": "array" } }, { "name": "targetConfiguration", "type": "array", "info": "The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.", "required": false, "schema": { "title": "targetConfiguration", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/acceptReservedInstancesExchangeQuote" }, "task": true }, { "name": "acceptReservedInstancesExchangeQuoteSTSRole", "summary": "Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.", "description": "Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "reservedInstanceId", "type": "array", "info": "The IDs of the Convertible Reserved Instances to exchange for another Convertible Reserved Instance of the same or higher value.", "required": true, "schema": { "title": "reservedInstanceId", "type": "array" } }, { "name": "targetConfiguration", "type": "array", "info": "The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.", "required": false, "schema": { "title": "targetConfiguration", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/acceptReservedInstancesExchangeQuoteSTSRole" }, "task": true }, { "name": "acceptTransitGatewayVpcAttachment", "summary": "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.", "description": "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.", "input": [ { "name": "transitGatewayAttachmentId", "type": "string", "info": "The ID of the attachment.", "required": true, "schema": { "title": "transitGatewayAttachmentId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/acceptTransitGatewayVpcAttachment" }, "task": true }, { "name": "acceptTransitGatewayVpcAttachmentSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "transitGatewayAttachmentId", "type": "string", "info": "The ID of the attachment.", "required": true, "schema": { "title": "transitGatewayAttachmentId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/acceptTransitGatewayVpcAttachmentSTSRole" }, "task": true }, { "name": "acceptVpcEndpointConnections", "summary": "Accepts one or more interface VPC endpoint connection requests to your VPC endpoint service.", "description": "Accepts one or more interface VPC endpoint connection requests to your VPC endpoint service.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "serviceId", "type": "string", "info": "The ID of the endpoint service.", "required": true, "schema": { "title": "serviceId", "type": "string" } }, { "name": "vpcEndpointId", "type": "array", "info": "The IDs of one or more interface VPC endpoints.", "required": true, "schema": { "title": "vpcEndpointId", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/acceptVpcEndpointConnections" }, "task": true }, { "name": "acceptVpcEndpointConnectionsSTSRole", "summary": "Accepts one or more interface VPC endpoint connection requests to your VPC endpoint service.", "description": "Accepts one or more interface VPC endpoint connection requests to your VPC endpoint service.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "serviceId", "type": "string", "info": "The ID of the endpoint service.", "required": true, "schema": { "title": "serviceId", "type": "string" } }, { "name": "vpcEndpointId", "type": "array", "info": "The IDs of one or more interface VPC endpoints.", "required": true, "schema": { "title": "vpcEndpointId", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/acceptVpcEndpointConnectionsSTSRole" }, "task": true }, { "name": "acceptVpcPeeringConnection", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "vpcPeeringConnectionId", "type": "string", "info": "The ID of the VPC peering connection. You must specify this parameter in the request.", "required": false, "schema": { "title": "vpcPeeringConnectionId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/acceptVpcPeeringConnection" }, "task": true }, { "name": "acceptVpcPeeringConnectionSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "vpcPeeringConnectionId", "type": "string", "info": "The ID of the VPC peering connection. You must specify this parameter in the request.", "required": false, "schema": { "title": "vpcPeeringConnectionId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/acceptVpcPeeringConnectionSTSRole" }, "task": true }, { "name": "advertiseByoipCidr", "summary": "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 simultaneo...(description truncated)", "description": "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 simultaneo...(description truncated)", "input": [ { "name": "cidr", "type": "string", "info": "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.", "required": true, "schema": { "title": "cidr", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/advertiseByoipCidr" }, "task": true }, { "name": "advertiseByoipCidrSTSRole", "summary": "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 simultaneo...(description truncated)", "description": "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 simultaneo...(description truncated)", "input": [ { "name": "cidr", "type": "string", "info": "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.", "required": true, "schema": { "title": "cidr", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/advertiseByoipCidrSTSRole" }, "task": true }, { "name": "allocateAddress", "summary": "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 you...(description truncated)", "description": "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 you...(description truncated)", "input": [ { "name": "domain", "type": "string", "info": "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.", "required": false, "schema": { "title": "domain", "type": "string" } }, { "name": "address", "type": "string", "info": "[EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.", "required": false, "schema": { "title": "address", "type": "string" } }, { "name": "publicIpv4Pool", "type": "string", "info": "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,...(description truncated)", "required": false, "schema": { "title": "publicIpv4Pool", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/allocateAddress" }, "task": true }, { "name": "allocateAddressSTSRole", "summary": "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 you...(description truncated)", "description": "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 you...(description truncated)", "input": [ { "name": "domain", "type": "string", "info": "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.", "required": false, "schema": { "title": "domain", "type": "string" } }, { "name": "address", "type": "string", "info": "[EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.", "required": false, "schema": { "title": "address", "type": "string" } }, { "name": "publicIpv4Pool", "type": "string", "info": "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,...(description truncated)", "required": false, "schema": { "title": "publicIpv4Pool", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/allocateAddressSTSRole" }, "task": true }, { "name": "allocateHosts", "summary": "Allocates a Dedicated Host to your account. At a minimum, specify the instance size type, Availability Zone, and quantity of hosts to allocate.", "description": "Allocates a Dedicated Host to your account. At a minimum, specify the instance size type, Availability Zone, and quantity of hosts to allocate.", "input": [ { "name": "autoPlacement", "type": "string", "info": "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...(description truncated)", "required": false, "schema": { "title": "autoPlacement", "type": "string" } }, { "name": "availabilityZone", "type": "string", "info": "The Availability Zone in which to allocate the Dedicated Host.", "required": true, "schema": { "title": "availabilityZone", "type": "string" } }, { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic ...(description truncated)", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "instanceType", "type": "string", "info": "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 ...(description truncated)", "required": true, "schema": { "title": "instanceType", "type": "string" } }, { "name": "quantity", "type": "number", "info": "The number of Dedicated Hosts to allocate to your account with these parameters.", "required": true, "schema": { "title": "quantity", "type": "number" } }, { "name": "tagSpecification", "type": "array", "info": "The tags to apply to the Dedicated Host during creation.", "required": false, "schema": { "title": "tagSpecification", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/allocateHosts" }, "task": true }, { "name": "allocateHostsSTSRole", "summary": "Allocates a Dedicated Host to your account. At a minimum, specify the instance size type, Availability Zone, and quantity of hosts to allocate.", "description": "Allocates a Dedicated Host to your account. At a minimum, specify the instance size type, Availability Zone, and quantity of hosts to allocate.", "input": [ { "name": "autoPlacement", "type": "string", "info": "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...(description truncated)", "required": false, "schema": { "title": "autoPlacement", "type": "string" } }, { "name": "availabilityZone", "type": "string", "info": "The Availability Zone in which to allocate the Dedicated Host.", "required": true, "schema": { "title": "availabilityZone", "type": "string" } }, { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic ...(description truncated)", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "instanceType", "type": "string", "info": "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 ...(description truncated)", "required": true, "schema": { "title": "instanceType", "type": "string" } }, { "name": "quantity", "type": "number", "info": "The number of Dedicated Hosts to allocate to your account with these parameters.", "required": true, "schema": { "title": "quantity", "type": "number" } }, { "name": "tagSpecification", "type": "array", "info": "The tags to apply to the Dedicated Host during creation.", "required": false, "schema": { "title": "tagSpecification", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/allocateHostsSTSRole" }, "task": true }, { "name": "applySecurityGroupsToClientVpnTargetNetwork", "summary": "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.", "description": "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.", "input": [ { "name": "clientVpnEndpointId", "type": "string", "info": "The ID of the Client VPN endpoint.", "required": true, "schema": { "title": "clientVpnEndpointId", "type": "string" } }, { "name": "vpcId", "type": "string", "info": "The ID of the VPC in which the associated target network is located.", "required": true, "schema": { "title": "vpcId", "type": "string" } }, { "name": "securityGroupId", "type": "array", "info": "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.", "required": true, "schema": { "title": "securityGroupId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/applySecurityGroupsToClientVpnTargetNetwork" }, "task": true }, { "name": "applySecurityGroupsToClientVpnTargetNetworkSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "clientVpnEndpointId", "type": "string", "info": "The ID of the Client VPN endpoint.", "required": true, "schema": { "title": "clientVpnEndpointId", "type": "string" } }, { "name": "vpcId", "type": "string", "info": "The ID of the VPC in which the associated target network is located.", "required": true, "schema": { "title": "vpcId", "type": "string" } }, { "name": "securityGroupId", "type": "array", "info": "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.", "required": true, "schema": { "title": "securityGroupId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/applySecurityGroupsToClientVpnTargetNetworkSTSRole" }, "task": true }, { "name": "assignIpv6Addresses", "summary": "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 C...(description truncated)", "description": "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 C...(description truncated)", "input": [ { "name": "ipv6AddressCount", "type": "number", "info": "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 s...(description truncated)", "required": false, "schema": { "title": "ipv6AddressCount", "type": "number" } }, { "name": "ipv6Addresses", "type": "array", "info": "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.", "required": false, "schema": { "title": "ipv6Addresses", "type": "array" } }, { "name": "networkInterfaceId", "type": "string", "info": "The ID of the network interface.", "required": true, "schema": { "title": "networkInterfaceId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/assignIpv6Addresses" }, "task": true }, { "name": "assignIpv6AddressesSTSRole", "summary": "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 C...(description truncated)", "description": "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 C...(description truncated)", "input": [ { "name": "ipv6AddressCount", "type": "number", "info": "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 s...(description truncated)", "required": false, "schema": { "title": "ipv6AddressCount", "type": "number" } }, { "name": "ipv6Addresses", "type": "array", "info": "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.", "required": false, "schema": { "title": "ipv6Addresses", "type": "array" } }, { "name": "networkInterfaceId", "type": "string", "info": "The ID of the network interface.", "required": true, "schema": { "title": "networkInterfaceId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/assignIpv6AddressesSTSRole" }, "task": true }, { "name": "assignPrivateIpAddresses", "summary": "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...(description truncated)", "description": "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...(description truncated)", "input": [ { "name": "allowReassignment", "type": "boolean", "info": "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.", "required": false, "schema": { "title": "allowReassignment", "type": "boolean" } }, { "name": "networkInterfaceId", "type": "string", "info": "The ID of the network interface.", "required": true, "schema": { "title": "networkInterfaceId", "type": "string" } }, { "name": "privateIpAddress", "type": "array", "info": "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 sec...(description truncated)", "required": false, "schema": { "title": "privateIpAddress", "type": "array" } }, { "name": "secondaryPrivateIpAddressCount", "type": "number", "info": "The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.", "required": false, "schema": { "title": "secondaryPrivateIpAddressCount", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/assignPrivateIpAddresses" }, "task": true }, { "name": "assignPrivateIpAddressesSTSRole", "summary": "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...(description truncated)", "description": "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...(description truncated)", "input": [ { "name": "allowReassignment", "type": "boolean", "info": "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.", "required": false, "schema": { "title": "allowReassignment", "type": "boolean" } }, { "name": "networkInterfaceId", "type": "string", "info": "The ID of the network interface.", "required": true, "schema": { "title": "networkInterfaceId", "type": "string" } }, { "name": "privateIpAddress", "type": "array", "info": "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 sec...(description truncated)", "required": false, "schema": { "title": "privateIpAddress", "type": "array" } }, { "name": "secondaryPrivateIpAddressCount", "type": "number", "info": "The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.", "required": false, "schema": { "title": "secondaryPrivateIpAddressCount", "type": "number" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/assignPrivateIpAddressesSTSRole" }, "task": true }, { "name": "associateAddress", "summary": "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 a...(description truncated)", "description": "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 a...(description truncated)", "input": [ { "name": "allocationId", "type": "string", "info": "[EC2-VPC] The allocation ID. This is required for EC2-VPC.", "required": false, "schema": { "title": "allocationId", "type": "string" } }, { "name": "instanceId", "type": "string", "info": "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 fai...(description truncated)", "required": false, "schema": { "title": "instanceId", "type": "string" } }, { "name": "publicIp", "type": "string", "info": "The Elastic IP address to associate with the instance. This is required for EC2-Classic.", "required": false, "schema": { "title": "publicIp", "type": "string" } }, { "name": "allowReassociation", "type": "boolean", "info": "[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 reassoci...(description truncated)", "required": false, "schema": { "title": "allowReassociation", "type": "boolean" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "networkInterfaceId", "type": "string", "info": "[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 e...(description truncated)", "required": false, "schema": { "title": "networkInterfaceId", "type": "string" } }, { "name": "privateIpAddress", "type": "string", "info": "[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 associate...(description truncated)", "required": false, "schema": { "title": "privateIpAddress", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/associateAddress" }, "task": true }, { "name": "associateAddressSTSRole", "summary": "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 a...(description truncated)", "description": "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 a...(description truncated)", "input": [ { "name": "allocationId", "type": "string", "info": "[EC2-VPC] The allocation ID. This is required for EC2-VPC.", "required": false, "schema": { "title": "allocationId", "type": "string" } }, { "name": "instanceId", "type": "string", "info": "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 fai...(description truncated)", "required": false, "schema": { "title": "instanceId", "type": "string" } }, { "name": "publicIp", "type": "string", "info": "The Elastic IP address to associate with the instance. This is required for EC2-Classic.", "required": false, "schema": { "title": "publicIp", "type": "string" } }, { "name": "allowReassociation", "type": "boolean", "info": "[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 reassoci...(description truncated)", "required": false, "schema": { "title": "allowReassociation", "type": "boolean" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "networkInterfaceId", "type": "string", "info": "[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 e...(description truncated)", "required": false, "schema": { "title": "networkInterfaceId", "type": "string" } }, { "name": "privateIpAddress", "type": "string", "info": "[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 associate...(description truncated)", "required": false, "schema": { "title": "privateIpAddress", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/associateAddressSTSRole" }, "task": true }, { "name": "associateClientVpnTargetNetwork", "summary": "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.", "description": "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.", "input": [ { "name": "clientVpnEndpointId", "type": "string", "info": "The ID of the Client VPN endpoint.", "required": true, "schema": { "title": "clientVpnEndpointId", "type": "string" } }, { "name": "subnetId", "type": "string", "info": "The ID of the subnet to associate with the Client VPN endpoint.", "required": true, "schema": { "title": "subnetId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/associateClientVpnTargetNetwork" }, "task": true }, { "name": "associateClientVpnTargetNetworkSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "clientVpnEndpointId", "type": "string", "info": "The ID of the Client VPN endpoint.", "required": true, "schema": { "title": "clientVpnEndpointId", "type": "string" } }, { "name": "subnetId", "type": "string", "info": "The ID of the subnet to associate with the Client VPN endpoint.", "required": true, "schema": { "title": "subnetId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/associateClientVpnTargetNetworkSTSRole" }, "task": true }, { "name": "associateDhcpOptions", "summary": "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 operat...(description truncated)", "description": "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 operat...(description truncated)", "input": [ { "name": "dhcpOptionsId", "type": "string", "info": "The ID of the DHCP options set, or default to associate no DHCP options with the VPC.", "required": true, "schema": { "title": "dhcpOptionsId", "type": "string" } }, { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/associateDhcpOptions" }, "task": true }, { "name": "associateDhcpOptionsSTSRole", "summary": "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 operat...(description truncated)", "description": "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 operat...(description truncated)", "input": [ { "name": "dhcpOptionsId", "type": "string", "info": "The ID of the DHCP options set, or default to associate no DHCP options with the VPC.", "required": true, "schema": { "title": "dhcpOptionsId", "type": "string" } }, { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/associateDhcpOptionsSTSRole" }, "task": true }, { "name": "associateIamInstanceProfile", "summary": "Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance.", "description": "Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance.", "input": [ { "name": "iamInstanceProfileArn", "type": "string", "info": "Describes an IAM instance profile.\nThe Amazon Resource Name (ARN) of the instance profile.", "required": false, "schema": { "title": "iamInstanceProfileArn", "type": "string" } }, { "name": "iamInstanceProfileName", "type": "string", "info": "Describes an IAM instance profile.\nThe name of the instance profile.", "required": false, "schema": { "title": "iamInstanceProfileName", "type": "string" } }, { "name": "instanceId", "type": "string", "info": "The ID of the instance.", "required": true, "schema": { "title": "instanceId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/associateIamInstanceProfile" }, "task": true }, { "name": "associateIamInstanceProfileSTSRole", "summary": "Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance.", "description": "Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance.", "input": [ { "name": "iamInstanceProfileArn", "type": "string", "info": "Describes an IAM instance profile.\nThe Amazon Resource Name (ARN) of the instance profile.", "required": false, "schema": { "title": "iamInstanceProfileArn", "type": "string" } }, { "name": "iamInstanceProfileName", "type": "string", "info": "Describes an IAM instance profile.\nThe name of the instance profile.", "required": false, "schema": { "title": "iamInstanceProfileName", "type": "string" } }, { "name": "instanceId", "type": "string", "info": "The ID of the instance.", "required": true, "schema": { "title": "instanceId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/associateIamInstanceProfileSTSRole" }, "task": true }, { "name": "associateRouteTable", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "routeTableId", "type": "string", "info": "The ID of the route table.", "required": true, "schema": { "title": "routeTableId", "type": "string" } }, { "name": "subnetId", "type": "string", "info": "The ID of the subnet.", "required": true, "schema": { "title": "subnetId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/associateRouteTable" }, "task": true }, { "name": "associateRouteTableSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "routeTableId", "type": "string", "info": "The ID of the route table.", "required": true, "schema": { "title": "routeTableId", "type": "string" } }, { "name": "subnetId", "type": "string", "info": "The ID of the subnet.", "required": true, "schema": { "title": "subnetId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/associateRouteTableSTSRole" }, "task": true }, { "name": "associateSubnetCidrBlock", "summary": "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.", "description": "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.", "input": [ { "name": "ipv6CidrBlock", "type": "string", "info": "The IPv6 CIDR block for your subnet. The subnet must have a /64 prefix length.", "required": true, "schema": { "title": "ipv6CidrBlock", "type": "string" } }, { "name": "subnetId", "type": "string", "info": "The ID of your subnet.", "required": true, "schema": { "title": "subnetId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/associateSubnetCidrBlock" }, "task": true }, { "name": "associateSubnetCidrBlockSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "ipv6CidrBlock", "type": "string", "info": "The IPv6 CIDR block for your subnet. The subnet must have a /64 prefix length.", "required": true, "schema": { "title": "ipv6CidrBlock", "type": "string" } }, { "name": "subnetId", "type": "string", "info": "The ID of your subnet.", "required": true, "schema": { "title": "subnetId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/associateSubnetCidrBlockSTSRole" }, "task": true }, { "name": "associateTransitGatewayRouteTable", "summary": "Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.", "description": "Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.", "input": [ { "name": "transitGatewayRouteTableId", "type": "string", "info": "The ID of the transit gateway route table.", "required": true, "schema": { "title": "transitGatewayRouteTableId", "type": "string" } }, { "name": "transitGatewayAttachmentId", "type": "string", "info": "The ID of the attachment.", "required": true, "schema": { "title": "transitGatewayAttachmentId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/associateTransitGatewayRouteTable" }, "task": true }, { "name": "associateTransitGatewayRouteTableSTSRole", "summary": "Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.", "description": "Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.", "input": [ { "name": "transitGatewayRouteTableId", "type": "string", "info": "The ID of the transit gateway route table.", "required": true, "schema": { "title": "transitGatewayRouteTableId", "type": "string" } }, { "name": "transitGatewayAttachmentId", "type": "string", "info": "The ID of the attachment.", "required": true, "schema": { "title": "transitGatewayAttachmentId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/associateTransitGatewayRouteTableSTSRole" }, "task": true }, { "name": "associateVpcCidrBlock", "summary": "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 .", "description": "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 .", "input": [ { "name": "amazonProvidedIpv6CidrBlock", "type": "boolean", "info": "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.", "required": false, "schema": { "title": "amazonProvidedIpv6CidrBlock", "type": "boolean" } }, { "name": "cidrBlock", "type": "string", "info": "An IPv4 CIDR block to associate with the VPC.", "required": false, "schema": { "title": "cidrBlock", "type": "string" } }, { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/associateVpcCidrBlock" }, "task": true }, { "name": "associateVpcCidrBlockSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "amazonProvidedIpv6CidrBlock", "type": "boolean", "info": "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.", "required": false, "schema": { "title": "amazonProvidedIpv6CidrBlock", "type": "boolean" } }, { "name": "cidrBlock", "type": "string", "info": "An IPv4 CIDR block to associate with the VPC.", "required": false, "schema": { "title": "cidrBlock", "type": "string" } }, { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/associateVpcCidrBlockSTSRole" }, "task": true }, { "name": "attachClassicLinkVpc", "summary": "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 group...(description truncated)", "description": "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 group...(description truncated)", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "securityGroupId", "type": "array", "info": "The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.", "required": true, "schema": { "title": "securityGroupId", "type": "array" } }, { "name": "instanceId", "type": "string", "info": "The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.", "required": true, "schema": { "title": "instanceId", "type": "string" } }, { "name": "vpcId", "type": "string", "info": "The ID of a ClassicLink-enabled VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/attachClassicLinkVpc" }, "task": true }, { "name": "attachClassicLinkVpcSTSRole", "summary": "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 group...(description truncated)", "description": "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 group...(description truncated)", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "securityGroupId", "type": "array", "info": "The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.", "required": true, "schema": { "title": "securityGroupId", "type": "array" } }, { "name": "instanceId", "type": "string", "info": "The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.", "required": true, "schema": { "title": "instanceId", "type": "string" } }, { "name": "vpcId", "type": "string", "info": "The ID of a ClassicLink-enabled VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/attachClassicLinkVpcSTSRole" }, "task": true }, { "name": "attachInternetGateway", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "internetGatewayId", "type": "string", "info": "The ID of the internet gateway.", "required": true, "schema": { "title": "internetGatewayId", "type": "string" } }, { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/attachInternetGateway" }, "task": true }, { "name": "attachInternetGatewaySTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "internetGatewayId", "type": "string", "info": "The ID of the internet gateway.", "required": true, "schema": { "title": "internetGatewayId", "type": "string" } }, { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/attachInternetGatewaySTSRole" }, "task": true }, { "name": "attachNetworkInterface", "summary": "Attaches a network interface to an instance.", "description": "Attaches a network interface to an instance.", "input": [ { "name": "deviceIndex", "type": "number", "info": "The index of the device for the network interface attachment.", "required": true, "schema": { "title": "deviceIndex", "type": "number" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "instanceId", "type": "string", "info": "The ID of the instance.", "required": true, "schema": { "title": "instanceId", "type": "string" } }, { "name": "networkInterfaceId", "type": "string", "info": "The ID of the network interface.", "required": true, "schema": { "title": "networkInterfaceId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/attachNetworkInterface" }, "task": true }, { "name": "attachNetworkInterfaceSTSRole", "summary": "Attaches a network interface to an instance.", "description": "Attaches a network interface to an instance.", "input": [ { "name": "deviceIndex", "type": "number", "info": "The index of the device for the network interface attachment.", "required": true, "schema": { "title": "deviceIndex", "type": "number" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "instanceId", "type": "string", "info": "The ID of the instance.", "required": true, "schema": { "title": "instanceId", "type": "string" } }, { "name": "networkInterfaceId", "type": "string", "info": "The ID of the network interface.", "required": true, "schema": { "title": "networkInterfaceId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/attachNetworkInterfaceSTSRole" }, "task": true }, { "name": "attachVolume", "summary": "Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name. Encrypted EBS volumes may only be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide . For a list of supported device names, see Attaching an EBS Volume to an Instance . Any device names that aren't reserved for instance store volumes can be used for EBS volumes. For mo...(description truncated)", "description": "Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name. Encrypted EBS volumes may only be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide . For a list of supported device names, see Attaching an EBS Volume to an Instance . Any device names that aren't reserved for instance store volumes can be used for EBS volumes. For mo...(description truncated)", "input": [ { "name": "device", "type": "string", "info": "The device name (for example, /dev/sdh or xvdh ).", "required": true, "schema": { "title": "device", "type": "string" } }, { "name": "instanceId", "type": "string", "info": "The ID of the instance.", "required": true, "schema": { "title": "instanceId", "type": "string" } }, { "name": "volumeId", "type": "string", "info": "The ID of the EBS volume. The volume and instance must be within the same Availability Zone.", "required": true, "schema": { "title": "volumeId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/attachVolume" }, "task": true }, { "name": "attachVolumeSTSRole", "summary": "Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name. Encrypted EBS volumes may only be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide . For a list of supported device names, see Attaching an EBS Volume to an Instance . Any device names that aren't reserved for instance store volumes can be used for EBS volumes. For mo...(description truncated)", "description": "Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name. Encrypted EBS volumes may only be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide . For a list of supported device names, see Attaching an EBS Volume to an Instance . Any device names that aren't reserved for instance store volumes can be used for EBS volumes. For mo...(description truncated)", "input": [ { "name": "device", "type": "string", "info": "The device name (for example, /dev/sdh or xvdh ).", "required": true, "schema": { "title": "device", "type": "string" } }, { "name": "instanceId", "type": "string", "info": "The ID of the instance.", "required": true, "schema": { "title": "instanceId", "type": "string" } }, { "name": "volumeId", "type": "string", "info": "The ID of the EBS volume. The volume and instance must be within the same Availability Zone.", "required": true, "schema": { "title": "volumeId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/attachVolumeSTSRole" }, "task": true }, { "name": "attachVpnGateway", "summary": "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 .", "description": "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 .", "input": [ { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } }, { "name": "vpnGatewayId", "type": "string", "info": "The ID of the virtual private gateway.", "required": true, "schema": { "title": "vpnGatewayId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/attachVpnGateway" }, "task": true }, { "name": "attachVpnGatewaySTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } }, { "name": "vpnGatewayId", "type": "string", "info": "The ID of the virtual private gateway.", "required": true, "schema": { "title": "vpnGatewayId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/attachVpnGatewaySTSRole" }, "task": true }, { "name": "authorizeClientVpnIngress", "summary": "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.", "description": "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.", "input": [ { "name": "clientVpnEndpointId", "type": "string", "info": "The ID of the Client VPN endpoint.", "required": true, "schema": { "title": "clientVpnEndpointId", "type": "string" } }, { "name": "targetNetworkCidr", "type": "string", "info": "The IPv4 address range, in CIDR notation, of the network for which access is being authorized.", "required": true, "schema": { "title": "targetNetworkCidr", "type": "string" } }, { "name": "accessGroupId", "type": "string", "info": "The ID of the Active Directory group to grant access.", "required": false, "schema": { "title": "accessGroupId", "type": "string" } }, { "name": "authorizeAllGroups", "type": "boolean", "info": "Indicates whether to grant access to all clients. Use true to grant all clients who successfully establish a VPN connection access to the network.", "required": false, "schema": { "title": "authorizeAllGroups", "type": "boolean" } }, { "name": "description", "type": "string", "info": "A brief description of the authorization rule.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/authorizeClientVpnIngress" }, "task": true }, { "name": "authorizeClientVpnIngressSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "clientVpnEndpointId", "type": "string", "info": "The ID of the Client VPN endpoint.", "required": true, "schema": { "title": "clientVpnEndpointId", "type": "string" } }, { "name": "targetNetworkCidr", "type": "string", "info": "The IPv4 address range, in CIDR notation, of the network for which access is being authorized.", "required": true, "schema": { "title": "targetNetworkCidr", "type": "string" } }, { "name": "accessGroupId", "type": "string", "info": "The ID of the Active Directory group to grant access.", "required": false, "schema": { "title": "accessGroupId", "type": "string" } }, { "name": "authorizeAllGroups", "type": "boolean", "info": "Indicates whether to grant access to all clients. Use true to grant all clients who successfully establish a VPN connection access to the network.", "required": false, "schema": { "title": "authorizeAllGroups", "type": "boolean" } }, { "name": "description", "type": "string", "info": "A brief description of the authorization rule.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/authorizeClientVpnIngressSTSRole" }, "task": true }, { "name": "authorizeSecurityGroupEgress", "summary": "[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 destination IPv4 or IPv6 CIDR address ranges, or to the specified destination security groups for the same VPC. 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 fo...(description truncated)", "description": "[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 destination IPv4 or IPv6 CIDR address ranges, or to the specified destination security groups for the same VPC. 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 fo...(description truncated)", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "groupId", "type": "string", "info": "The ID of the security group.", "required": true, "schema": { "title": "groupId", "type": "string" } }, { "name": "ipPermissions", "type": "array", "info": "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.", "required": false, "schema": { "title": "ipPermissions", "type": "array" } }, { "name": "cidrIp", "type": "string", "info": "Not supported. Use a set of IP permissions to specify the CIDR.", "required": false, "schema": { "title": "cidrIp", "type": "string" } }, { "name": "fromPort", "type": "number", "info": "Not supported. Use a set of IP permissions to specify the port.", "required": false, "schema": { "title": "fromPort", "type": "number" } }, { "name": "ipProtocol", "type": "string", "info": "Not supported. Use a set of IP permissions to specify the protocol name or number.", "required": false, "schema": { "title": "ipProtocol", "type": "string" } }, { "name": "toPort", "type": "number", "info": "Not supported. Use a set of IP permissions to specify the port.", "required": false, "schema": { "title": "toPort", "type": "number" } }, { "name": "sourceSecurityGroupName", "type": "string", "info": "Not supported. Use a set of IP permissions to specify a destination security group.", "required": false, "schema": { "title": "sourceSecurityGroupName", "type": "string" } }, { "name": "sourceSecurityGroupOwnerId", "type": "string", "info": "Not supported. Use a set of IP permissions to specify a destination security group.", "required": false, "schema": { "title": "sourceSecurityGroupOwnerId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/authorizeSecurityGroupEgress" }, "task": true }, { "name": "authorizeSecurityGroupEgressSTSRole", "summary": "[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 destination IPv4 or IPv6 CIDR address ranges, or to the specified destination security groups for the same VPC. 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 fo...(description truncated)", "description": "[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 destination IPv4 or IPv6 CIDR address ranges, or to the specified destination security groups for the same VPC. 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 fo...(description truncated)", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "groupId", "type": "string", "info": "The ID of the security group.", "required": true, "schema": { "title": "groupId", "type": "string" } }, { "name": "ipPermissions", "type": "array", "info": "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.", "required": false, "schema": { "title": "ipPermissions", "type": "array" } }, { "name": "cidrIp", "type": "string", "info": "Not supported. Use a set of IP permissions to specify the CIDR.", "required": false, "schema": { "title": "cidrIp", "type": "string" } }, { "name": "fromPort", "type": "number", "info": "Not supported. Use a set of IP permissions to specify the port.", "required": false, "schema": { "title": "fromPort", "type": "number" } }, { "name": "ipProtocol", "type": "string", "info": "Not supported. Use a set of IP permissions to specify the protocol name or number.", "required": false, "schema": { "title": "ipProtocol", "type": "string" } }, { "name": "toPort", "type": "number", "info": "Not supported. Use a set of IP permissions to specify the port.", "required": false, "schema": { "title": "toPort", "type": "number" } }, { "name": "sourceSecurityGroupName", "type": "string", "info": "Not supported. Use a set of IP permissions to specify a destination security group.", "required": false, "schema": { "title": "sourceSecurityGroupName", "type": "string" } }, { "name": "sourceSecurityGroupOwnerId", "type": "string", "info": "Not supported. Use a set of IP permissions to specify a destination security group.", "required": false, "schema": { "title": "sourceSecurityGroupOwnerId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/authorizeSecurityGroupEgressSTSRole" }, "task": true }, { "name": "authorizeSecurityGroupIngress", "summary": "Adds the specified ingress rules to a security group. An inbound rule permits instances to receive traffic from the specified destination IPv4 or IPv6 CIDR address ranges, or from 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 prop...(description truncated)", "description": "Adds the specified ingress rules to a security group. An inbound rule permits instances to receive traffic from the specified destination IPv4 or IPv6 CIDR address ranges, or from 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 prop...(description truncated)", "input": [ { "name": "cidrIp", "type": "string", "info": "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 permi...(description truncated)", "required": false, "schema": { "title": "cidrIp", "type": "string" } }, { "name": "fromPort", "type": "number", "info": "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, yo...(description truncated)", "required": false, "schema": { "title": "fromPort", "type": "number" } }, { "name": "groupId", "type": "string", "info": "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 s...(description truncated)", "required": false, "schema": { "title": "groupId", "type": "string" } }, { "name": "groupName", "type": "string", "info": "[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.", "required": false, "schema": { "title": "groupName", "type": "string" } }, { "name": "ipPermissions", "type": "array", "info": "The sets of IP permissions.", "required": false, "schema": { "title": "ipPermissions", "type": "array" } }, { "name": "ipProtocol", "type": "string", "info": "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 pr...(description truncated)", "required": false, "schema": { "title": "ipProtocol", "type": "string" } }, { "name": "sourceSecurityGroupName", "type": "string", "info": "[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...(description truncated)", "required": false, "schema": { "title": "sourceSecurityGroupName", "type": "string" } }, { "name": "sourceSecurityGroupOwnerId", "type": "string", "info": "[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...(description truncated)", "required": false, "schema": { "title": "sourceSecurityGroupOwnerId", "type": "string" } }, { "name": "toPort", "type": "number", "info": "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 ...(description truncated)", "required": false, "schema": { "title": "toPort", "type": "number" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/authorizeSecurityGroupIngress" }, "task": true }, { "name": "authorizeSecurityGroupIngressSTSRole", "summary": "Adds the specified ingress rules to a security group. An inbound rule permits instances to receive traffic from the specified destination IPv4 or IPv6 CIDR address ranges, or from 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 prop...(description truncated)", "description": "Adds the specified ingress rules to a security group. An inbound rule permits instances to receive traffic from the specified destination IPv4 or IPv6 CIDR address ranges, or from 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 prop...(description truncated)", "input": [ { "name": "cidrIp", "type": "string", "info": "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 permi...(description truncated)", "required": false, "schema": { "title": "cidrIp", "type": "string" } }, { "name": "fromPort", "type": "number", "info": "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, yo...(description truncated)", "required": false, "schema": { "title": "fromPort", "type": "number" } }, { "name": "groupId", "type": "string", "info": "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 s...(description truncated)", "required": false, "schema": { "title": "groupId", "type": "string" } }, { "name": "groupName", "type": "string", "info": "[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.", "required": false, "schema": { "title": "groupName", "type": "string" } }, { "name": "ipPermissions", "type": "array", "info": "The sets of IP permissions.", "required": false, "schema": { "title": "ipPermissions", "type": "array" } }, { "name": "ipProtocol", "type": "string", "info": "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 pr...(description truncated)", "required": false, "schema": { "title": "ipProtocol", "type": "string" } }, { "name": "sourceSecurityGroupName", "type": "string", "info": "[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...(description truncated)", "required": false, "schema": { "title": "sourceSecurityGroupName", "type": "string" } }, { "name": "sourceSecurityGroupOwnerId", "type": "string", "info": "[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...(description truncated)", "required": false, "schema": { "title": "sourceSecurityGroupOwnerId", "type": "string" } }, { "name": "toPort", "type": "number", "info": "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 ...(description truncated)", "required": false, "schema": { "title": "toPort", "type": "number" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/authorizeSecurityGroupIngressSTSRole" }, "task": true }, { "name": "bundleInstance", "summary": "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.", "description": "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.", "input": [ { "name": "instanceId", "type": "string", "info": "The ID of the instance to bundle. Type: String Default: None Required: Yes", "required": true, "schema": { "title": "instanceId", "type": "string" } }, { "name": "storageS3", "type": "string", "info": "Describes the storage location for an instance store-backed AMI.\nAn Amazon S3 storage location.", "required": false, "schema": { "title": "storageS3", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/bundleInstance" }, "task": true }, { "name": "bundleInstanceSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "instanceId", "type": "string", "info": "The ID of the instance to bundle. Type: String Default: None Required: Yes", "required": true, "schema": { "title": "instanceId", "type": "string" } }, { "name": "storageS3", "type": "string", "info": "Describes the storage location for an instance store-backed AMI.\nAn Amazon S3 storage location.", "required": false, "schema": { "title": "storageS3", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/bundleInstanceSTSRole" }, "task": true }, { "name": "cancelBundleTask", "summary": "Cancels a bundling operation for an instance store-backed Windows instance.", "description": "Cancels a bundling operation for an instance store-backed Windows instance.", "input": [ { "name": "bundleId", "type": "string", "info": "The ID of the bundle task.", "required": true, "schema": { "title": "bundleId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/cancelBundleTask" }, "task": true }, { "name": "cancelBundleTaskSTSRole", "summary": "Cancels a bundling operation for an instance store-backed Windows instance.", "description": "Cancels a bundling operation for an instance store-backed Windows instance.", "input": [ { "name": "bundleId", "type": "string", "info": "The ID of the bundle task.", "required": true, "schema": { "title": "bundleId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/cancelBundleTaskSTSRole" }, "task": true }, { "name": "cancelCapacityReservation", "summary": "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...(description truncated)", "description": "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...(description truncated)", "input": [ { "name": "capacityReservationId", "type": "string", "info": "The ID of the Capacity Reservation to be cancelled.", "required": true, "schema": { "title": "capacityReservationId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/cancelCapacityReservation" }, "task": true }, { "name": "cancelCapacityReservationSTSRole", "summary": "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...(description truncated)", "description": "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...(description truncated)", "input": [ { "name": "capacityReservationId", "type": "string", "info": "The ID of the Capacity Reservation to be cancelled.", "required": true, "schema": { "title": "capacityReservationId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/cancelCapacityReservationSTSRole" }, "task": true }, { "name": "cancelConversionTask", "summary": "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 .", "description": "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 .", "input": [ { "name": "conversionTaskId", "type": "string", "info": "The ID of the conversion task.", "required": true, "schema": { "title": "conversionTaskId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "reasonMessage", "type": "string", "info": "The reason for canceling the conversion task.", "required": false, "schema": { "title": "reasonMessage", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/cancelConversionTask" }, "task": true }, { "name": "cancelConversionTaskSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "conversionTaskId", "type": "string", "info": "The ID of the conversion task.", "required": true, "schema": { "title": "conversionTaskId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "reasonMessage", "type": "string", "info": "The reason for canceling the conversion task.", "required": false, "schema": { "title": "reasonMessage", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/cancelConversionTaskSTSRole" }, "task": true }, { "name": "cancelExportTask", "summary": "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.", "description": "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.", "input": [ { "name": "exportTaskId", "type": "string", "info": "The ID of the export task. This is the ID returned by CreateInstanceExportTask .", "required": true, "schema": { "title": "exportTaskId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/cancelExportTask" }, "task": true }, { "name": "cancelExportTaskSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "exportTaskId", "type": "string", "info": "The ID of the export task. This is the ID returned by CreateInstanceExportTask .", "required": true, "schema": { "title": "exportTaskId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/cancelExportTaskSTSRole" }, "task": true }, { "name": "cancelImportTask", "summary": "Cancels an in-process import virtual machine or import snapshot task.", "description": "Cancels an in-process import virtual machine or import snapshot task.", "input": [ { "name": "cancelReason", "type": "string", "info": "The reason for canceling the task.", "required": false, "schema": { "title": "cancelReason", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "importTaskId", "type": "string", "info": "The ID of the import image or import snapshot task to be canceled.", "required": false, "schema": { "title": "importTaskId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/cancelImportTask" }, "task": true }, { "name": "cancelImportTaskSTSRole", "summary": "Cancels an in-process import virtual machine or import snapshot task.", "description": "Cancels an in-process import virtual machine or import snapshot task.", "input": [ { "name": "cancelReason", "type": "string", "info": "The reason for canceling the task.", "required": false, "schema": { "title": "cancelReason", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "importTaskId", "type": "string", "info": "The ID of the import image or import snapshot task to be canceled.", "required": false, "schema": { "title": "importTaskId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/cancelImportTaskSTSRole" }, "task": true }, { "name": "cancelReservedInstancesListing", "summary": "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 .", "description": "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 .", "input": [ { "name": "reservedInstancesListingId", "type": "string", "info": "The ID of the Reserved Instance listing.", "required": true, "schema": { "title": "reservedInstancesListingId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/cancelReservedInstancesListing" }, "task": true }, { "name": "cancelReservedInstancesListingSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "reservedInstancesListingId", "type": "string", "info": "The ID of the Reserved Instance listing.", "required": true, "schema": { "title": "reservedInstancesListingId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/cancelReservedInstancesListingSTSRole" }, "task": true }, { "name": "cancelSpotFleetRequests", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "spotFleetRequestId", "type": "array", "info": "The IDs of the Spot Fleet requests.", "required": true, "schema": { "title": "spotFleetRequestId", "type": "array" } }, { "name": "terminateInstances", "type": "boolean", "info": "Indicates whether to terminate instances for a Spot Fleet request if it is canceled successfully.", "required": true, "schema": { "title": "terminateInstances", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/cancelSpotFleetRequests" }, "task": true }, { "name": "cancelSpotFleetRequestsSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "spotFleetRequestId", "type": "array", "info": "The IDs of the Spot Fleet requests.", "required": true, "schema": { "title": "spotFleetRequestId", "type": "array" } }, { "name": "terminateInstances", "type": "boolean", "info": "Indicates whether to terminate instances for a Spot Fleet request if it is canceled successfully.", "required": true, "schema": { "title": "terminateInstances", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/cancelSpotFleetRequestsSTSRole" }, "task": true }, { "name": "cancelSpotInstanceRequests", "summary": "Cancels one or more Spot Instance requests. Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.", "description": "Cancels one or more Spot Instance requests. Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "spotInstanceRequestId", "type": "array", "info": "One or more Spot Instance request IDs.", "required": true, "schema": { "title": "spotInstanceRequestId", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/cancelSpotInstanceRequests" }, "task": true }, { "name": "cancelSpotInstanceRequestsSTSRole", "summary": "Cancels one or more Spot Instance requests. Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.", "description": "Cancels one or more Spot Instance requests. Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "spotInstanceRequestId", "type": "array", "info": "One or more Spot Instance request IDs.", "required": true, "schema": { "title": "spotInstanceRequestId", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/cancelSpotInstanceRequestsSTSRole" }, "task": true }, { "name": "confirmProductInstance", "summary": "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.", "description": "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.", "input": [ { "name": "instanceId", "type": "string", "info": "The ID of the instance.", "required": true, "schema": { "title": "instanceId", "type": "string" } }, { "name": "productCode", "type": "string", "info": "The product code. This must be a product code that you own.", "required": true, "schema": { "title": "productCode", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/confirmProductInstance" }, "task": true }, { "name": "confirmProductInstanceSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "instanceId", "type": "string", "info": "The ID of the instance.", "required": true, "schema": { "title": "instanceId", "type": "string" } }, { "name": "productCode", "type": "string", "info": "The product code. This must be a product code that you own.", "required": true, "schema": { "title": "productCode", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/confirmProductInstanceSTSRole" }, "task": true }, { "name": "copyFpgaImage", "summary": "Copies the specified Amazon FPGA Image (AFI) to the current Region.", "description": "Copies the specified Amazon FPGA Image (AFI) to the current Region.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "sourceFpgaImageId", "type": "string", "info": "The ID of the source AFI.", "required": true, "schema": { "title": "sourceFpgaImageId", "type": "string" } }, { "name": "description", "type": "string", "info": "The description for the new AFI.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "name", "type": "string", "info": "The name for the new AFI. The default is the name of the source AFI.", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "sourceRegion", "type": "string", "info": "The Region that contains the source AFI.", "required": true, "schema": { "title": "sourceRegion", "type": "string" } }, { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency .", "required": false, "schema": { "title": "clientToken", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/copyFpgaImage" }, "task": true }, { "name": "copyFpgaImageSTSRole", "summary": "Copies the specified Amazon FPGA Image (AFI) to the current Region.", "description": "Copies the specified Amazon FPGA Image (AFI) to the current Region.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "sourceFpgaImageId", "type": "string", "info": "The ID of the source AFI.", "required": true, "schema": { "title": "sourceFpgaImageId", "type": "string" } }, { "name": "description", "type": "string", "info": "The description for the new AFI.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "name", "type": "string", "info": "The name for the new AFI. The default is the name of the source AFI.", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "sourceRegion", "type": "string", "info": "The Region that contains the source AFI.", "required": true, "schema": { "title": "sourceRegion", "type": "string" } }, { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency .", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/copyFpgaImageSTSRole" }, "task": true }, { "name": "copyImage", "summary": "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, ...(description truncated)", "description": "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, ...(description truncated)", "input": [ { "name": "clientToken", "type": "string", "info": "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 C...(description truncated)", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "description", "type": "string", "info": "A description for the new AMI in the destination Region.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "encrypted", "type": "boolean", "info": "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 unencrypt...(description truncated)", "required": false, "schema": { "title": "encrypted", "type": "boolean" } }, { "name": "kmsKeyId", "type": "string", "info": "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 wa...(description truncated)", "required": false, "schema": { "title": "kmsKeyId", "type": "string" } }, { "name": "name", "type": "string", "info": "The name of the new AMI in the destination Region.", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "sourceImageId", "type": "string", "info": "The ID of the AMI to copy.", "required": true, "schema": { "title": "sourceImageId", "type": "string" } }, { "name": "sourceRegion", "type": "string", "info": "The name of the Region that contains the AMI to copy.", "required": true, "schema": { "title": "sourceRegion", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/copyImage" }, "task": true }, { "name": "copyImageSTSRole", "summary": "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, ...(description truncated)", "description": "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, ...(description truncated)", "input": [ { "name": "clientToken", "type": "string", "info": "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 C...(description truncated)", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "description", "type": "string", "info": "A description for the new AMI in the destination Region.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "encrypted", "type": "boolean", "info": "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 unencrypt...(description truncated)", "required": false, "schema": { "title": "encrypted", "type": "boolean" } }, { "name": "kmsKeyId", "type": "string", "info": "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 wa...(description truncated)", "required": false, "schema": { "title": "kmsKeyId", "type": "string" } }, { "name": "name", "type": "string", "info": "The name of the new AMI in the destination Region.", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "sourceImageId", "type": "string", "info": "The ID of the AMI to copy.", "required": true, "schema": { "title": "sourceImageId", "type": "string" } }, { "name": "sourceRegion", "type": "string", "info": "The name of the Region that contains the AMI to copy.", "required": true, "schema": { "title": "sourceRegion", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/copyImageSTSRole" }, "task": true }, { "name": "copySnapshot", "summary": "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). The snapshot is copied to the regional endpoint that you send the HTTP request to. Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless the Encrypted flag is specified during the snapshot copy operati...(description truncated)", "description": "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). The snapshot is copied to the regional endpoint that you send the HTTP request to. Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless the Encrypted flag is specified during the snapshot copy operati...(description truncated)", "input": [ { "name": "description", "type": "string", "info": "A description for the EBS snapshot.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "destinationRegion", "type": "string", "info": "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 Pres...(description truncated)", "required": false, "schema": { "title": "destinationRegion", "type": "string" } }, { "name": "encrypted", "type": "boolean", "info": "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 ...(description truncated)", "required": false, "schema": { "title": "encrypted", "type": "boolean" } }, { "name": "kmsKeyId", "type": "string", "info": "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 wa...(description truncated)", "required": false, "schema": { "title": "kmsKeyId", "type": "string" } }, { "name": "presignedUrl", "type": "string", "info": "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 mo...(description truncated)", "required": false, "schema": { "title": "presignedUrl", "type": "string" } }, { "name": "sourceRegion", "type": "string", "info": "The ID of the Region that contains the snapshot to be copied.", "required": true, "schema": { "title": "sourceRegion", "type": "string" } }, { "name": "sourceSnapshotId", "type": "string", "info": "The ID of the EBS snapshot to copy.", "required": true, "schema": { "title": "sourceSnapshotId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/copySnapshot" }, "task": true }, { "name": "copySnapshotSTSRole", "summary": "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). The snapshot is copied to the regional endpoint that you send the HTTP request to. Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless the Encrypted flag is specified during the snapshot copy operati...(description truncated)", "description": "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). The snapshot is copied to the regional endpoint that you send the HTTP request to. Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless the Encrypted flag is specified during the snapshot copy operati...(description truncated)", "input": [ { "name": "description", "type": "string", "info": "A description for the EBS snapshot.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "destinationRegion", "type": "string", "info": "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 Pres...(description truncated)", "required": false, "schema": { "title": "destinationRegion", "type": "string" } }, { "name": "encrypted", "type": "boolean", "info": "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 ...(description truncated)", "required": false, "schema": { "title": "encrypted", "type": "boolean" } }, { "name": "kmsKeyId", "type": "string", "info": "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 wa...(description truncated)", "required": false, "schema": { "title": "kmsKeyId", "type": "string" } }, { "name": "presignedUrl", "type": "string", "info": "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 mo...(description truncated)", "required": false, "schema": { "title": "presignedUrl", "type": "string" } }, { "name": "sourceRegion", "type": "string", "info": "The ID of the Region that contains the snapshot to be copied.", "required": true, "schema": { "title": "sourceRegion", "type": "string" } }, { "name": "sourceSnapshotId", "type": "string", "info": "The ID of the EBS snapshot to copy.", "required": true, "schema": { "title": "sourceSnapshotId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/copySnapshotSTSRole" }, "task": true }, { "name": "createCapacityReservation", "summary": "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 ...(description truncated)", "description": "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 ...(description truncated)", "input": [ { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency . Constraint: Maximum...(description truncated)", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "instanceType", "type": "string", "info": "The instance type for which to reserve capacity. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide .", "required": true, "schema": { "title": "instanceType", "type": "string" } }, { "name": "instancePlatform", "type": "string", "info": "The type of operating system for which to reserve capacity.", "required": true, "schema": { "title": "instancePlatform", "type": "string" } }, { "name": "availabilityZone", "type": "string", "info": "The Availability Zone in which to create the Capacity Reservation.", "required": true, "schema": { "title": "availabilityZone", "type": "string" } }, { "name": "tenancy", "type": "string", "info": "Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings: default - The Capacity Reservation is ...(description truncated)", "required": false, "schema": { "title": "tenancy", "type": "string" } }, { "name": "instanceCount", "type": "number", "info": "The number of instances for which to reserve capacity.", "required": true, "schema": { "title": "instanceCount", "type": "number" } }, { "name": "ebsOptimized", "type": "boolean", "info": "Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration ...(description truncated)", "required": false, "schema": { "title": "ebsOptimized", "type": "boolean" } }, { "name": "ephemeralStorage", "type": "boolean", "info": "Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.", "required": false, "schema": { "title": "ephemeralStorage", "type": "boolean" } }, { "name": "endDate", "type": "string", "info": "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 instance...(description truncated)", "required": false, "schema": { "title": "endDate", "type": "string" } }, { "name": "endDateType", "type": "string", "info": "Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types: unlimited - The Capacity Reservation r...(description truncated)", "required": false, "schema": { "title": "endDateType", "type": "string" } }, { "name": "instanceMatchCriteria", "type": "string", "info": "Indicates the type of instance launches that the Capacity Reservation accepts. The options include: open - The Capacity Reservation automatically matches all in...(description truncated)", "required": false, "schema": { "title": "instanceMatchCriteria", "type": "string" } }, { "name": "tagSpecifications", "type": "array", "info": "The tags to apply to the Capacity Reservation during launch.", "required": false, "schema": { "title": "tagSpecifications", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createCapacityReservation" }, "task": true }, { "name": "createCapacityReservationSTSRole", "summary": "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 ...(description truncated)", "description": "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 ...(description truncated)", "input": [ { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency . Constraint: Maximum...(description truncated)", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "instanceType", "type": "string", "info": "The instance type for which to reserve capacity. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide .", "required": true, "schema": { "title": "instanceType", "type": "string" } }, { "name": "instancePlatform", "type": "string", "info": "The type of operating system for which to reserve capacity.", "required": true, "schema": { "title": "instancePlatform", "type": "string" } }, { "name": "availabilityZone", "type": "string", "info": "The Availability Zone in which to create the Capacity Reservation.", "required": true, "schema": { "title": "availabilityZone", "type": "string" } }, { "name": "tenancy", "type": "string", "info": "Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings: default - The Capacity Reservation is ...(description truncated)", "required": false, "schema": { "title": "tenancy", "type": "string" } }, { "name": "instanceCount", "type": "number", "info": "The number of instances for which to reserve capacity.", "required": true, "schema": { "title": "instanceCount", "type": "number" } }, { "name": "ebsOptimized", "type": "boolean", "info": "Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration ...(description truncated)", "required": false, "schema": { "title": "ebsOptimized", "type": "boolean" } }, { "name": "ephemeralStorage", "type": "boolean", "info": "Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.", "required": false, "schema": { "title": "ephemeralStorage", "type": "boolean" } }, { "name": "endDate", "type": "string", "info": "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 instance...(description truncated)", "required": false, "schema": { "title": "endDate", "type": "string" } }, { "name": "endDateType", "type": "string", "info": "Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types: unlimited - The Capacity Reservation r...(description truncated)", "required": false, "schema": { "title": "endDateType", "type": "string" } }, { "name": "instanceMatchCriteria", "type": "string", "info": "Indicates the type of instance launches that the Capacity Reservation accepts. The options include: open - The Capacity Reservation automatically matches all in...(description truncated)", "required": false, "schema": { "title": "instanceMatchCriteria", "type": "string" } }, { "name": "tagSpecifications", "type": "array", "info": "The tags to apply to the Capacity Reservation during launch.", "required": false, "schema": { "title": "tagSpecifications", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createCapacityReservationSTSRole" }, "task": true }, { "name": "createCapacityReservations", "summary": "Creates multiple new Capacity Reservations 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 ...(description truncated)", "description": "Creates multiple new Capacity Reservations 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 ...(description truncated)", "input": [ { "name": "capacityReservationArray", "type": "array", "info": "An array of objects(capacity reservation parameters). clientToken, instanceType, instancePlatform, availabilityZone, tenancy, instanceCount, ebsOptimized, ephemeralStorage, endDate, endDateType, instanceMatchCriteria, tagSpecifications, dryRun.", "required": true, "schema": { "title": "capacityReservationArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createCapacityReservations" }, "task": true }, { "name": "createCapacityReservationsSTSRole", "summary": "Creates multiple new Capacity Reservations 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 ...(description truncated)", "description": "Creates multiple new Capacity Reservations 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 ...(description truncated)", "input": [ { "name": "capacityReservationArray", "type": "array", "info": "An array of objects(capacity reservation parameters). clientToken, instanceType, instancePlatform, availabilityZone, tenancy, instanceCount, ebsOptimized, ephemeralStorage, endDate, endDateType, instanceMatchCriteria, tagSpecifications, dryRun.", "required": true, "schema": { "title": "capacityReservationArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createCapacityReservationsSTSRole" }, "task": true }, { "name": "createClientVpnEndpoint", "summary": "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.", "description": "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.", "input": [ { "name": "clientCidrBlock", "type": "string", "info": "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 associate...(description truncated)", "required": true, "schema": { "title": "clientCidrBlock", "type": "string" } }, { "name": "serverCertificateArn", "type": "string", "info": "The ARN of the server certificate. For more information, see the AWS Certificate Manager User Guide .", "required": true, "schema": { "title": "serverCertificateArn", "type": "string" } }, { "name": "authentication", "type": "array", "info": "Information about the authentication method to be used to authenticate clients.", "required": true, "schema": { "title": "authentication", "type": "array" } }, { "name": "connectionLogOptionsEnabled", "type": "string", "info": "Describes the client connection logging options for the Client VPN endpoint.\nIndicates whether connection logging is enabled.", "required": false, "schema": { "title": "connectionLogOptionsEnabled", "type": "string" } }, { "name": "connectionLogOptionsCloudwatchLogGroup", "type": "string", "info": "Describes the client connection logging options for the Client VPN endpoint.\nThe name of the CloudWatch Logs log group.", "required": false, "schema": { "title": "connectionLogOptionsCloudwatchLogGroup", "type": "string" } }, { "name": "connectionLogOptionsCloudwatchLogStream", "type": "string", "info": "Describes the client connection logging options for the Client VPN endpoint.\nThe name of the CloudWatch Logs log stream to which the connection data is published.", "required": false, "schema": { "title": "connectionLogOptionsCloudwatchLogStream", "type": "string" } }, { "name": "dnsServers", "type": "array", "info": "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 t...(description truncated)", "required": false, "schema": { "title": "dnsServers", "type": "array" } }, { "name": "transportProtocol", "type": "string", "info": "The transport protocol to be used by the VPN session. Default value: udp", "required": false, "schema": { "title": "transportProtocol", "type": "string" } }, { "name": "description", "type": "string", "info": "A brief description of the Client VPN endpoint.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency .", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "tagSpecification", "type": "array", "info": "The tags to apply to the Client VPN endpoint during creation.", "required": false, "schema": { "title": "tagSpecification", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createClientVpnEndpoint" }, "task": true }, { "name": "createClientVpnEndpointSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "clientCidrBlock", "type": "string", "info": "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 associate...(description truncated)", "required": true, "schema": { "title": "clientCidrBlock", "type": "string" } }, { "name": "serverCertificateArn", "type": "string", "info": "The ARN of the server certificate. For more information, see the AWS Certificate Manager User Guide .", "required": true, "schema": { "title": "serverCertificateArn", "type": "string" } }, { "name": "authentication", "type": "array", "info": "Information about the authentication method to be used to authenticate clients.", "required": true, "schema": { "title": "authentication", "type": "array" } }, { "name": "connectionLogOptionsEnabled", "type": "string", "info": "Describes the client connection logging options for the Client VPN endpoint.\nIndicates whether connection logging is enabled.", "required": false, "schema": { "title": "connectionLogOptionsEnabled", "type": "string" } }, { "name": "connectionLogOptionsCloudwatchLogGroup", "type": "string", "info": "Describes the client connection logging options for the Client VPN endpoint.\nThe name of the CloudWatch Logs log group.", "required": false, "schema": { "title": "connectionLogOptionsCloudwatchLogGroup", "type": "string" } }, { "name": "connectionLogOptionsCloudwatchLogStream", "type": "string", "info": "Describes the client connection logging options for the Client VPN endpoint.\nThe name of the CloudWatch Logs log stream to which the connection data is published.", "required": false, "schema": { "title": "connectionLogOptionsCloudwatchLogStream", "type": "string" } }, { "name": "dnsServers", "type": "array", "info": "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 t...(description truncated)", "required": false, "schema": { "title": "dnsServers", "type": "array" } }, { "name": "transportProtocol", "type": "string", "info": "The transport protocol to be used by the VPN session. Default value: udp", "required": false, "schema": { "title": "transportProtocol", "type": "string" } }, { "name": "description", "type": "string", "info": "A brief description of the Client VPN endpoint.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency .", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "tagSpecification", "type": "array", "info": "The tags to apply to the Client VPN endpoint during creation.", "required": false, "schema": { "title": "tagSpecification", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createClientVpnEndpointSTSRole" }, "task": true }, { "name": "createClientVpnEndpoints", "summary": "Creates multiple Client VPN endpoints. 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.", "description": "Creates multiple Client VPN endpoints. 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.", "input": [ { "name": "clientVpnEndpointArray", "type": "array", "info": "An array of objects(capacity reservation parameters). clientCidrBlock, serverCertificateArn, authentication, connectionLogOptionsEnabled, connectionLogOptionsCloudwatchLogGroup, connectionLogOptionsCloudwatchLogStream, dnsServers, transportProtocol, description, dryRun, clientToken, tagSpecification.", "required": true, "schema": { "title": "clientVpnEndpointArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createClientVpnEndpoints" }, "task": true }, { "name": "createClientVpnEndpointsSTSRole", "summary": "Creates multiple Client VPN endpoints. 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.", "description": "Creates multiple Client VPN endpoints. 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.", "input": [ { "name": "clientVpnEndpointArray", "type": "array", "info": "An array of objects(capacity reservation parameters). clientCidrBlock, serverCertificateArn, authentication, connectionLogOptionsEnabled, connectionLogOptionsCloudwatchLogGroup, connectionLogOptionsCloudwatchLogStream, dnsServers, transportProtocol, description, dryRun, clientToken, tagSpecification.", "required": true, "schema": { "title": "clientVpnEndpointArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createClientVpnEndpointsSTSRole" }, "task": true }, { "name": "createClientVpnRoute", "summary": "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.", "description": "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.", "input": [ { "name": "clientVpnEndpointId", "type": "string", "info": "The ID of the Client VPN endpoint to which to add the route.", "required": true, "schema": { "title": "clientVpnEndpointId", "type": "string" } }, { "name": "destinationCidrBlock", "type": "string", "info": "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 ...(description truncated)", "required": true, "schema": { "title": "destinationCidrBlock", "type": "string" } }, { "name": "targetVpcSubnetId", "type": "string", "info": "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.", "required": true, "schema": { "title": "targetVpcSubnetId", "type": "string" } }, { "name": "description", "type": "string", "info": "A brief description of the route.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createClientVpnRoute" }, "task": true }, { "name": "createClientVpnRouteSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "clientVpnEndpointId", "type": "string", "info": "The ID of the Client VPN endpoint to which to add the route.", "required": true, "schema": { "title": "clientVpnEndpointId", "type": "string" } }, { "name": "destinationCidrBlock", "type": "string", "info": "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 ...(description truncated)", "required": true, "schema": { "title": "destinationCidrBlock", "type": "string" } }, { "name": "targetVpcSubnetId", "type": "string", "info": "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.", "required": true, "schema": { "title": "targetVpcSubnetId", "type": "string" } }, { "name": "description", "type": "string", "info": "A brief description of the route.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createClientVpnRouteSTSRole" }, "task": true }, { "name": "createClientVpnRoutes", "summary": "Adds multiple routes 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.", "description": "Adds multiple routes 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.", "input": [ { "name": "createClientVpnRouteArray", "type": "array", "info": "An array of objects(Client Vpn Routes parameters). clientVpnEndpointId, destinationCidrBlock, targetVpcSubnetId, description, dryRun.", "required": true, "schema": { "title": "createClientVpnRouteArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createClientVpnRoutes" }, "task": true }, { "name": "createClientVpnRoutesSTSRole", "summary": "Adds multiple routes 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.", "description": "Adds multiple routes 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.", "input": [ { "name": "createClientVpnRouteArray", "type": "array", "info": "An array of objects(Client Vpn Routes parameters). clientVpnEndpointId, destinationCidrBlock, targetVpcSubnetId, description, dryRun.", "required": true, "schema": { "title": "createClientVpnRouteArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createClientVpnRoutesSTSRole" }, "task": true }, { "name": "createCustomerGateway", "summary": "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 t...(description truncated)", "description": "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 t...(description truncated)", "input": [ { "name": "bgpAsn", "type": "number", "info": "For devices that support BGP, the customer gateway's BGP ASN. Default: 65000", "required": true, "schema": { "title": "bgpAsn", "type": "number" } }, { "name": "ipAddress", "type": "string", "info": "The Internet-routable IP address for the customer gateway's outside interface. The address must be static.", "required": true, "schema": { "title": "ipAddress", "type": "string" } }, { "name": "type", "type": "string", "info": "The type of VPN connection that this customer gateway supports ( ipsec.1 ).", "required": true, "schema": { "title": "type", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createCustomerGateway" }, "task": true }, { "name": "createCustomerGatewaySTSRole", "summary": "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 t...(description truncated)", "description": "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 t...(description truncated)", "input": [ { "name": "bgpAsn", "type": "number", "info": "For devices that support BGP, the customer gateway's BGP ASN. Default: 65000", "required": true, "schema": { "title": "bgpAsn", "type": "number" } }, { "name": "ipAddress", "type": "string", "info": "The Internet-routable IP address for the customer gateway's outside interface. The address must be static.", "required": true, "schema": { "title": "ipAddress", "type": "string" } }, { "name": "type", "type": "string", "info": "The type of VPN connection that this customer gateway supports ( ipsec.1 ).", "required": true, "schema": { "title": "type", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createCustomerGatewaySTSRole" }, "task": true }, { "name": "createCustomerGateways", "summary": "Create multiple customer gateways. 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 t...(description truncated)", "description": "Create multiple customer gateways. 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 t...(description truncated)", "input": [ { "name": "createCustomerGatewayArray", "type": "array", "info": "An array of objects(CustomerGateway parameters). bgpAsn, ipAddress, type, dryRun.", "required": true, "schema": { "title": "createCustomerGatewayArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createCustomerGateways" }, "task": true }, { "name": "createCustomerGatewaysSTSRole", "summary": "Create multiple customer gateways. 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 t...(description truncated)", "description": "Create multiple customer gateways. 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 t...(description truncated)", "input": [ { "name": "createCustomerGatewayArray", "type": "array", "info": "An array of objects(CustomerGateway parameters). bgpAsn, ipAddress, type, dryRun.", "required": true, "schema": { "title": "createCustomerGatewayArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createCustomerGatewaysSTSRole" }, "task": true }, { "name": "createDefaultSubnet", "summary": "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 .", "description": "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 .", "input": [ { "name": "availabilityZone", "type": "string", "info": "The Availability Zone in which to create the default subnet.", "required": true, "schema": { "title": "availabilityZone", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createDefaultSubnet" }, "task": true }, { "name": "createDefaultSubnetSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "availabilityZone", "type": "string", "info": "The Availability Zone in which to create the default subnet.", "required": true, "schema": { "title": "availabilityZone", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createDefaultSubnetSTSRole" }, "task": true }, { "name": "createDefaultSubnets", "summary": "Creates mutiple default subnets 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", "description": "Creates mutiple default subnets 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", "input": [ { "name": "createDefaultSubnetArray", "type": "array", "info": "An array of objects(CustomerGateway parameters). bgpAsn, ipAddress, type, dryRun.", "required": true, "schema": { "title": "createDefaultSubnetArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createDefaultSubnets" }, "task": true }, { "name": "createDefaultSubnetsSTSRole", "summary": "Creates mutiple default subnets 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", "description": "Creates mutiple default subnets 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", "input": [ { "name": "createDefaultSubnetArray", "type": "array", "info": "An array of objects(CustomerGateway parameters). bgpAsn, ipAddress, type, dryRun.", "required": true, "schema": { "title": "createDefaultSubnetArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createDefaultSubnetsSTSRole" }, "task": true }, { "name": "createDefaultVpc", "summary": "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 t...(description truncated)", "description": "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 t...(description truncated)", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createDefaultVpc" }, "task": true }, { "name": "createDefaultVpcSTSRole", "summary": "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 t...(description truncated)", "description": "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 t...(description truncated)", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createDefaultVpcSTSRole" }, "task": true }, { "name": "createDefaultVpcs", "summary": "Creates multiple default VPCs 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.", "description": "Creates multiple default VPCs 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.", "input": [ { "name": "createDefaultVpcArray", "type": "array", "info": "An array of objects(CustomerGateway parameters). dryRun.", "required": true, "schema": { "title": "createDefaultVpcArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createDefaultVpcs" }, "task": true }, { "name": "createDefaultVpcsSTSRole", "summary": "Creates multiple default VPCs 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.", "description": "Creates multiple default VPCs 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.", "input": [ { "name": "createDefaultVpcArray", "type": "array", "info": "An array of objects(CustomerGateway parameters). dryRun.", "required": true, "schema": { "title": "createDefaultVpcArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createDefaultVpcsSTSRole" }, "task": true }, { "name": "createDhcpOptions", "summary": "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 m...(description truncated)", "description": "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 m...(description truncated)", "input": [ { "name": "dhcpConfiguration", "type": "array", "info": "A DHCP configuration option.", "required": true, "schema": { "title": "dhcpConfiguration", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createDhcpOptions" }, "task": true }, { "name": "createDhcpOptionsSTSRole", "summary": "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 m...(description truncated)", "description": "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 m...(description truncated)", "input": [ { "name": "dhcpConfiguration", "type": "array", "info": "A DHCP configuration option.", "required": true, "schema": { "title": "dhcpConfiguration", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createDhcpOptionsSTSRole" }, "task": true }, { "name": "createMultipleDhcpOptions", "summary": "Creates multiple 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.", "description": "Creates multiple 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.", "input": [ { "name": "dhcpOptionsArray", "type": "array", "info": "An array of objects(Dhcp Options parameters). dhcpConfiguration, dryRun.", "required": true, "schema": { "title": "dhcpOptionsArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createMultipleDhcpOptions" }, "task": true }, { "name": "createMultipleDhcpOptionsSTSRole", "summary": "Creates multiple 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.", "description": "Creates multiple 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.", "input": [ { "name": "dhcpOptionsArray", "type": "array", "info": "An array of objects(Dhcp Options parameters). dhcpConfiguration, dryRun.", "required": true, "schema": { "title": "dhcpOptionsArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createMultipleDhcpOptionsSTSRole" }, "task": true }, { "name": "createEgressOnlyInternetGateway", "summary": "[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.", "description": "[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.", "input": [ { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency .", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "vpcId", "type": "string", "info": "The ID of the VPC for which to create the egress-only internet gateway.", "required": true, "schema": { "title": "vpcId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createEgressOnlyInternetGateway" }, "task": true }, { "name": "createEgressOnlyInternetGatewaySTSRole", "summary": "[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.", "description": "[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.", "input": [ { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency .", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "vpcId", "type": "string", "info": "The ID of the VPC for which to create the egress-only internet gateway.", "required": true, "schema": { "title": "vpcId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createEgressOnlyInternetGatewaySTSRole" }, "task": true }, { "name": "createEgressOnlyInternetGateways", "summary": "Creates multiple egress-only internet gateways for your VPC.[IPv6 only]", "description": "Creates multiple egress-only internet gateways for your VPC.[IPv6 only]", "input": [ { "name": "EgressOnlyInternetGatewaysArray", "type": "array", "info": "An array of objects(InternetGateway parameters). clientToken, dryRun, vpcId.", "required": true, "schema": { "title": "EgressOnlyInternetGatewaysArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createEgressOnlyInternetGateways" }, "task": true }, { "name": "createEgressOnlyInternetGatewaysSTSRole", "summary": "Creates multiple egress-only internet gateways for your VPC.[IPv6 only]", "description": "Creates multiple egress-only internet gateways for your VPC.[IPv6 only]", "input": [ { "name": "EgressOnlyInternetGatewaysArray", "type": "array", "info": "An array of objects(InternetGateway parameters). clientToken, dryRun, vpcId.", "required": true, "schema": { "title": "EgressOnlyInternetGatewaysArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createEgressOnlyInternetGatewaysSTSRole" }, "task": true }, { "name": "createFleet", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency .", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "spotOptionsAllocationStrategy", "type": "string", "info": "Describes the configuration of Spot Instances in an EC2 Fleet request.\nIndicates how to allocate the target capacity across the Spot pools specified by the Spot Fleet req...(description truncated)", "required": false, "schema": { "title": "spotOptionsAllocationStrategy", "type": "string" } }, { "name": "spotOptionsInstanceInterruptionBehavior", "type": "string", "info": "Describes the configuration of Spot Instances in an EC2 Fleet request.\nThe behavior when a Spot Instance is interrupted. The default is terminate .", "required": false, "schema": { "title": "spotOptionsInstanceInterruptionBehavior", "type": "string" } }, { "name": "spotOptionsInstancePoolsToUseCount", "type": "string", "info": "Describes the configuration of Spot Instances in an EC2 Fleet request.\nThe number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot ...(description truncated)", "required": false, "schema": { "title": "spotOptionsInstancePoolsToUseCount", "type": "string" } }, { "name": "spotOptionsSingleInstanceType", "type": "string", "info": "Describes the configuration of Spot Instances in an EC2 Fleet request.\nIndicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.", "required": false, "schema": { "title": "spotOptionsSingleInstanceType", "type": "string" } }, { "name": "spotOptionsSingleAvailabilityZone", "type": "string", "info": "Describes the configuration of Spot Instances in an EC2 Fleet request.\nIndicates that the fleet launches all Spot Instances into a single Availability Zone.", "required": false, "schema": { "title": "spotOptionsSingleAvailabilityZone", "type": "string" } }, { "name": "spotOptionsMinTargetCapacity", "type": "string", "info": "Describes the configuration of Spot Instances in an EC2 Fleet request.\nThe minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is not ...(description truncated)", "required": false, "schema": { "title": "spotOptionsMinTargetCapacity", "type": "string" } }, { "name": "onDemandOptionsAllocationStrategy", "type": "string", "info": "The allocation strategy of On-Demand Instances in an EC2 Fleet.\nThe order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowest...(description truncated)", "required": false, "schema": { "title": "onDemandOptionsAllocationStrategy", "type": "string" } }, { "name": "onDemandOptionsSingleInstanceType", "type": "string", "info": "The allocation strategy of On-Demand Instances in an EC2 Fleet.\nIndicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.", "required": false, "schema": { "title": "onDemandOptionsSingleInstanceType", "type": "string" } }, { "name": "onDemandOptionsSingleAvailabilityZone", "type": "string", "info": "The allocation strategy of On-Demand Instances in an EC2 Fleet.\nIndicates that the fleet launches all On-Demand Instances into a single Availability Zone.", "required": false, "schema": { "title": "onDemandOptionsSingleAvailabilityZone", "type": "string" } }, { "name": "onDemandOptionsMinTargetCapacity", "type": "string", "info": "The allocation strategy of On-Demand Instances in an EC2 Fleet.\nThe minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is not re...(description truncated)", "required": false, "schema": { "title": "onDemandOptionsMinTargetCapacity", "type": "string" } }, { "name": "excessCapacityTerminationPolicy", "type": "string", "info": "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.", "required": false, "schema": { "title": "excessCapacityTerminationPolicy", "type": "string" } }, { "name": "launchTemplateConfigs", "type": "array", "info": "The configuration for the EC2 Fleet.", "required": true, "schema": { "title": "launchTemplateConfigs", "type": "array" } }, { "name": "targetCapacitySpecificationTotalTargetCapacity", "type": "string", "info": "The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application work...(description truncated)", "required": false, "schema": { "title": "targetCapacitySpecificationTotalTargetCapacity", "type": "string" } }, { "name": "targetCapacitySpecificationOnDemandTargetCapacity", "type": "string", "info": "The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application work...(description truncated)", "required": false, "schema": { "title": "targetCapacitySpecificationOnDemandTargetCapacity", "type": "string" } }, { "name": "targetCapacitySpecificationSpotTargetCapacity", "type": "string", "info": "The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application work...(description truncated)", "required": false, "schema": { "title": "targetCapacitySpecificationSpotTargetCapacity", "type": "string" } }, { "name": "targetCapacitySpecificationDefaultTargetCapacityType", "type": "string", "info": "The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application work...(description truncated)", "required": false, "schema": { "title": "targetCapacitySpecificationDefaultTargetCapacityType", "type": "string" } }, { "name": "terminateInstancesWithExpiration", "type": "boolean", "info": "Indicates whether running instances should be terminated when the EC2 Fleet expires.", "required": false, "schema": { "title": "terminateInstancesWithExpiration", "type": "boolean" } }, { "name": "type", "type": "string", "info": "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 (...(description truncated)", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "validFrom", "type": "string", "info": "The start date and time of the request, in UTC format (for example, YYYY - MM - DD T HH : MM : SS Z). The default is to start fulfilling the request immediately.", "required": false, "schema": { "title": "validFrom", "type": "string" } }, { "name": "validUntil", "type": "string", "info": "The end date and time of the request, in UTC format (for example, YYYY - MM - DD T HH : MM : SS Z). At this point, no new EC2 Fleet requests are placed or able to fulfil...(description truncated)", "required": false, "schema": { "title": "validUntil", "type": "string" } }, { "name": "replaceUnhealthyInstances", "type": "boolean", "info": "Indicates whether EC2 Fleet should replace unhealthy instances.", "required": false, "schema": { "title": "replaceUnhealthyInstances", "type": "boolean" } }, { "name": "tagSpecification", "type": "array", "info": "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 lau...(description truncated)", "required": false, "schema": { "title": "tagSpecification", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createFleet" }, "task": true }, { "name": "createFleetSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency .", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "spotOptionsAllocationStrategy", "type": "string", "info": "Describes the configuration of Spot Instances in an EC2 Fleet request.\nIndicates how to allocate the target capacity across the Spot pools specified by the Spot Fleet req...(description truncated)", "required": false, "schema": { "title": "spotOptionsAllocationStrategy", "type": "string" } }, { "name": "spotOptionsInstanceInterruptionBehavior", "type": "string", "info": "Describes the configuration of Spot Instances in an EC2 Fleet request.\nThe behavior when a Spot Instance is interrupted. The default is terminate .", "required": false, "schema": { "title": "spotOptionsInstanceInterruptionBehavior", "type": "string" } }, { "name": "spotOptionsInstancePoolsToUseCount", "type": "string", "info": "Describes the configuration of Spot Instances in an EC2 Fleet request.\nThe number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot ...(description truncated)", "required": false, "schema": { "title": "spotOptionsInstancePoolsToUseCount", "type": "string" } }, { "name": "spotOptionsSingleInstanceType", "type": "string", "info": "Describes the configuration of Spot Instances in an EC2 Fleet request.\nIndicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.", "required": false, "schema": { "title": "spotOptionsSingleInstanceType", "type": "string" } }, { "name": "spotOptionsSingleAvailabilityZone", "type": "string", "info": "Describes the configuration of Spot Instances in an EC2 Fleet request.\nIndicates that the fleet launches all Spot Instances into a single Availability Zone.", "required": false, "schema": { "title": "spotOptionsSingleAvailabilityZone", "type": "string" } }, { "name": "spotOptionsMinTargetCapacity", "type": "string", "info": "Describes the configuration of Spot Instances in an EC2 Fleet request.\nThe minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is not ...(description truncated)", "required": false, "schema": { "title": "spotOptionsMinTargetCapacity", "type": "string" } }, { "name": "onDemandOptionsAllocationStrategy", "type": "string", "info": "The allocation strategy of On-Demand Instances in an EC2 Fleet.\nThe order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowest...(description truncated)", "required": false, "schema": { "title": "onDemandOptionsAllocationStrategy", "type": "string" } }, { "name": "onDemandOptionsSingleInstanceType", "type": "string", "info": "The allocation strategy of On-Demand Instances in an EC2 Fleet.\nIndicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.", "required": false, "schema": { "title": "onDemandOptionsSingleInstanceType", "type": "string" } }, { "name": "onDemandOptionsSingleAvailabilityZone", "type": "string", "info": "The allocation strategy of On-Demand Instances in an EC2 Fleet.\nIndicates that the fleet launches all On-Demand Instances into a single Availability Zone.", "required": false, "schema": { "title": "onDemandOptionsSingleAvailabilityZone", "type": "string" } }, { "name": "onDemandOptionsMinTargetCapacity", "type": "string", "info": "The allocation strategy of On-Demand Instances in an EC2 Fleet.\nThe minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is not re...(description truncated)", "required": false, "schema": { "title": "onDemandOptionsMinTargetCapacity", "type": "string" } }, { "name": "excessCapacityTerminationPolicy", "type": "string", "info": "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.", "required": false, "schema": { "title": "excessCapacityTerminationPolicy", "type": "string" } }, { "name": "launchTemplateConfigs", "type": "array", "info": "The configuration for the EC2 Fleet.", "required": true, "schema": { "title": "launchTemplateConfigs", "type": "array" } }, { "name": "targetCapacitySpecificationTotalTargetCapacity", "type": "string", "info": "The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application work...(description truncated)", "required": false, "schema": { "title": "targetCapacitySpecificationTotalTargetCapacity", "type": "string" } }, { "name": "targetCapacitySpecificationOnDemandTargetCapacity", "type": "string", "info": "The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application work...(description truncated)", "required": false, "schema": { "title": "targetCapacitySpecificationOnDemandTargetCapacity", "type": "string" } }, { "name": "targetCapacitySpecificationSpotTargetCapacity", "type": "string", "info": "The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application work...(description truncated)", "required": false, "schema": { "title": "targetCapacitySpecificationSpotTargetCapacity", "type": "string" } }, { "name": "targetCapacitySpecificationDefaultTargetCapacityType", "type": "string", "info": "The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application work...(description truncated)", "required": false, "schema": { "title": "targetCapacitySpecificationDefaultTargetCapacityType", "type": "string" } }, { "name": "terminateInstancesWithExpiration", "type": "boolean", "info": "Indicates whether running instances should be terminated when the EC2 Fleet expires.", "required": false, "schema": { "title": "terminateInstancesWithExpiration", "type": "boolean" } }, { "name": "type", "type": "string", "info": "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 (...(description truncated)", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "validFrom", "type": "string", "info": "The start date and time of the request, in UTC format (for example, YYYY - MM - DD T HH : MM : SS Z). The default is to start fulfilling the request immediately.", "required": false, "schema": { "title": "validFrom", "type": "string" } }, { "name": "validUntil", "type": "string", "info": "The end date and time of the request, in UTC format (for example, YYYY - MM - DD T HH : MM : SS Z). At this point, no new EC2 Fleet requests are placed or able to fulfil...(description truncated)", "required": false, "schema": { "title": "validUntil", "type": "string" } }, { "name": "replaceUnhealthyInstances", "type": "boolean", "info": "Indicates whether EC2 Fleet should replace unhealthy instances.", "required": false, "schema": { "title": "replaceUnhealthyInstances", "type": "boolean" } }, { "name": "tagSpecification", "type": "array", "info": "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 lau...(description truncated)", "required": false, "schema": { "title": "tagSpecification", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createFleetSTSRole" }, "task": true }, { "name": "createFleets", "summary": "Launches multiple EC2 Fleets.", "description": "Launches multiple EC2 Fleets.", "input": [ { "name": "fleetsArray", "type": "array", "info": "An array of objects(Fleet parameters). bilityZone, spotOptionsMinTargetCapacity, onDemandOptionsAllocationStrategy, onDemandOptionsSingleInstanceType, onDemandOptionsSingleAvailabilityZone, onDemandOptionsMinTargetCapacity, excessCapacityTerminationPolicy, launchTemplateConfigs, targetCapacitySpecificationTotalTargetCapacity, targetCapacitySpecificationOnDemandTargetCapacity, targetCapacitySpecificationSpotTargetCapacity, targetCapacitySpecificationDefaultTargetCapacityType, terminateInstancesWithExpiration, type, validFrom, validUntil, replaceUnhealthyInstances, tagSpecification.", "required": true, "schema": { "title": "fleetsArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createFleets" }, "task": true }, { "name": "createFleetsSTSRole", "summary": "Launches multiple EC2 Fleets.", "description": "Launches multiple EC2 Fleets.", "input": [ { "name": "fleetsArray", "type": "array", "info": "An array of objects(Fleet parameters). bilityZone, spotOptionsMinTargetCapacity, onDemandOptionsAllocationStrategy, onDemandOptionsSingleInstanceType, onDemandOptionsSingleAvailabilityZone, onDemandOptionsMinTargetCapacity, excessCapacityTerminationPolicy, launchTemplateConfigs, targetCapacitySpecificationTotalTargetCapacity, targetCapacitySpecificationOnDemandTargetCapacity, targetCapacitySpecificationSpotTargetCapacity, targetCapacitySpecificationDefaultTargetCapacityType, terminateInstancesWithExpiration, type, validFrom, validUntil, replaceUnhealthyInstances, tagSpecification.", "required": true, "schema": { "title": "fleetsArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createFleetsSTSRole" }, "task": true }, { "name": "createFlowLogs", "summary": "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 l...(description truncated)", "description": "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 l...(description truncated)", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency .", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "deliverLogsPermissionArn", "type": "string", "info": "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 n...(description truncated)", "required": false, "schema": { "title": "deliverLogsPermissionArn", "type": "string" } }, { "name": "logGroupName", "type": "string", "info": "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 Deliver...(description truncated)", "required": false, "schema": { "title": "logGroupName", "type": "string" } }, { "name": "resourceId", "type": "array", "info": "The ID of the subnet, network interface, or VPC for which you want to create a flow log. Constraints: Maximum of 1000 resources", "required": true, "schema": { "title": "resourceId", "type": "array" } }, { "name": "resourceType", "type": "string", "info": "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.", "required": true, "schema": { "title": "resourceType", "type": "string" } }, { "name": "trafficType", "type": "string", "info": "The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.", "required": true, "schema": { "title": "trafficType", "type": "string" } }, { "name": "logDestinationType", "type": "string", "info": "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...(description truncated)", "required": false, "schema": { "title": "logDestinationType", "type": "string" } }, { "name": "logDestination", "type": "string", "info": "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 ...(description truncated)", "required": false, "schema": { "title": "logDestination", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createFlowLogs" }, "task": true }, { "name": "createFlowLogsSTSRole", "summary": "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 l...(description truncated)", "description": "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 l...(description truncated)", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency .", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "deliverLogsPermissionArn", "type": "string", "info": "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 n...(description truncated)", "required": false, "schema": { "title": "deliverLogsPermissionArn", "type": "string" } }, { "name": "logGroupName", "type": "string", "info": "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 Deliver...(description truncated)", "required": false, "schema": { "title": "logGroupName", "type": "string" } }, { "name": "resourceId", "type": "array", "info": "The ID of the subnet, network interface, or VPC for which you want to create a flow log. Constraints: Maximum of 1000 resources", "required": true, "schema": { "title": "resourceId", "type": "array" } }, { "name": "resourceType", "type": "string", "info": "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.", "required": true, "schema": { "title": "resourceType", "type": "string" } }, { "name": "trafficType", "type": "string", "info": "The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.", "required": true, "schema": { "title": "trafficType", "type": "string" } }, { "name": "logDestinationType", "type": "string", "info": "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...(description truncated)", "required": false, "schema": { "title": "logDestinationType", "type": "string" } }, { "name": "logDestination", "type": "string", "info": "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 ...(description truncated)", "required": false, "schema": { "title": "logDestination", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createFlowLogsSTSRole" }, "task": true }, { "name": "createMultipleFlowLogs", "summary": "Creates multiple flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC.", "description": "Creates multiple flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC.", "input": [ { "name": "flowLogsArray", "type": "array", "info": "An array of objects(FlowLogs parameters). dryRun, clientToken, deliverLogsPermissionArn, logGroupName, resourceId, resourceType, trafficType, logDestinationType, logDestination.", "required": true, "schema": { "title": "flowLogsArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createMultipleFlowLogs" }, "task": true }, { "name": "createMultipleFlowLogsSTSRole", "summary": "Creates multiple flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC.", "description": "Creates multiple flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC.", "input": [ { "name": "flowLogsArray", "type": "array", "info": "An array of objects(FlowLogs parameters). dryRun, clientToken, deliverLogsPermissionArn, logGroupName, resourceId, resourceType, trafficType, logDestinationType, logDestination.", "required": true, "schema": { "title": "flowLogsArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createMultipleFlowLogsSTSRole" }, "task": true }, { "name": "createFpgaImage", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "inputStorageLocationBucket", "type": "string", "info": "Describes a storage location in Amazon S3.\nThe name of the S3 bucket.", "required": false, "schema": { "title": "inputStorageLocationBucket", "type": "string" } }, { "name": "inputStorageLocationKey", "type": "string", "info": "Describes a storage location in Amazon S3.\nThe key.", "required": false, "schema": { "title": "inputStorageLocationKey", "type": "string" } }, { "name": "logsStorageLocationBucket", "type": "string", "info": "Describes a storage location in Amazon S3.\nThe name of the S3 bucket.", "required": false, "schema": { "title": "logsStorageLocationBucket", "type": "string" } }, { "name": "logsStorageLocationKey", "type": "string", "info": "Describes a storage location in Amazon S3.\nThe key.", "required": false, "schema": { "title": "logsStorageLocationKey", "type": "string" } }, { "name": "description", "type": "string", "info": "A description for the AFI.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "name", "type": "string", "info": "A name for the AFI.", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency .", "required": false, "schema": { "title": "clientToken", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createFpgaImage" }, "task": true }, { "name": "createFpgaImageSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "inputStorageLocationBucket", "type": "string", "info": "Describes a storage location in Amazon S3.\nThe name of the S3 bucket.", "required": false, "schema": { "title": "inputStorageLocationBucket", "type": "string" } }, { "name": "inputStorageLocationKey", "type": "string", "info": "Describes a storage location in Amazon S3.\nThe key.", "required": false, "schema": { "title": "inputStorageLocationKey", "type": "string" } }, { "name": "logsStorageLocationBucket", "type": "string", "info": "Describes a storage location in Amazon S3.\nThe name of the S3 bucket.", "required": false, "schema": { "title": "logsStorageLocationBucket", "type": "string" } }, { "name": "logsStorageLocationKey", "type": "string", "info": "Describes a storage location in Amazon S3.\nThe key.", "required": false, "schema": { "title": "logsStorageLocationKey", "type": "string" } }, { "name": "description", "type": "string", "info": "A description for the AFI.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "name", "type": "string", "info": "A name for the AFI.", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency .", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createFpgaImageSTSRole" }, "task": true }, { "name": "createFpgaImages", "summary": "Creates multiple Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).", "description": "Creates multiple Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).", "input": [ { "name": "FpgaImagesArray", "type": "array", "info": "An array of objects(FpgaImage parameters). dryRun, clientToken, deliverLogsPermissionArn, logGroupName, resourceId, resourceType, trafficType, logDestinationType, logDestination.", "required": true, "schema": { "title": "FpgaImagesArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createFpgaImages" }, "task": true }, { "name": "createFpgaImagesSTSRole", "summary": "Creates multiple Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).", "description": "Creates multiple Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).", "input": [ { "name": "FpgaImagesArray", "type": "array", "info": "An array of objects(FpgaImage parameters). dryRun, clientToken, deliverLogsPermissionArn, logGroupName, resourceId, resourceType, trafficType, logDestinationType, logDestination.", "required": true, "schema": { "title": "FpgaImagesArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createFpgaImagesSTSRole" }, "task": true }, { "name": "createImage", "summary": "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 Co...(description truncated)", "description": "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 Co...(description truncated)", "input": [ { "name": "blockDeviceMapping", "type": "array", "info": "Tthe 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...(description truncated)", "required": false, "schema": { "title": "blockDeviceMapping", "type": "array" } }, { "name": "description", "type": "string", "info": "A description for the new image.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "instanceId", "type": "string", "info": "The ID of the instance.", "required": true, "schema": { "title": "instanceId", "type": "string" } }, { "name": "name", "type": "string", "info": "A name for the new image. Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single ...(description truncated)", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "noReboot", "type": "boolean", "info": "By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the 'No Reboot' option is set, Amazon EC2 doesn't shut down the instanc...(description truncated)", "required": false, "schema": { "title": "noReboot", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createImage" }, "task": true }, { "name": "createImageSTSRole", "summary": "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 Co...(description truncated)", "description": "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 Co...(description truncated)", "input": [ { "name": "blockDeviceMapping", "type": "array", "info": "Tthe 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...(description truncated)", "required": false, "schema": { "title": "blockDeviceMapping", "type": "array" } }, { "name": "description", "type": "string", "info": "A description for the new image.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "instanceId", "type": "string", "info": "The ID of the instance.", "required": true, "schema": { "title": "instanceId", "type": "string" } }, { "name": "name", "type": "string", "info": "A name for the new image. Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single ...(description truncated)", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "noReboot", "type": "boolean", "info": "By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the 'No Reboot' option is set, Amazon EC2 doesn't shut down the instanc...(description truncated)", "required": false, "schema": { "title": "noReboot", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createImageSTSRole" }, "task": true }, { "name": "createImages", "summary": "Creates multiple Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.", "description": "Creates multiple Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.", "input": [ { "name": "ImagesArray", "type": "array", "info": "An array of objects(image parameters). blockDeviceMapping, description, dryRun, instanceId, name, noReboot.", "required": true, "schema": { "title": "ImagesArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createImages" }, "task": true }, { "name": "createImagesSTSRole", "summary": "Creates multiple Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.", "description": "Creates multiple Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.", "input": [ { "name": "ImagesArray", "type": "array", "info": "An array of objects(image parameters). blockDeviceMapping, description, dryRun, instanceId, name, noReboot.", "required": true, "schema": { "title": "ImagesArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createImagesSTSRole" }, "task": true }, { "name": "createInstanceExportTask", "summary": "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 .", "description": "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 .", "input": [ { "name": "description", "type": "string", "info": "A description for the conversion task or the resource being exported. The maximum length is 255 bytes.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "exportToS3ContainerFormat", "type": "string", "info": "Describes an instance export task.\nThe container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.", "required": false, "schema": { "title": "exportToS3ContainerFormat", "type": "string" } }, { "name": "exportToS3DiskImageFormat", "type": "string", "info": "Describes an instance export task.\nThe format for the exported image.", "required": false, "schema": { "title": "exportToS3DiskImageFormat", "type": "string" } }, { "name": "exportToS3S3Bucket", "type": "string", "info": "Describes an instance export task.\nThe S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account ...(description truncated)", "required": false, "schema": { "title": "exportToS3S3Bucket", "type": "string" } }, { "name": "exportToS3S3Prefix", "type": "string", "info": "Describes an instance export task.\nThe image is written to a single object in the S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.", "required": false, "schema": { "title": "exportToS3S3Prefix", "type": "string" } }, { "name": "instanceId", "type": "string", "info": "The ID of the instance.", "required": true, "schema": { "title": "instanceId", "type": "string" } }, { "name": "targetEnvironment", "type": "string", "info": "The target virtualization environment.", "required": false, "schema": { "title": "targetEnvironment", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createInstanceExportTask" }, "task": true }, { "name": "createInstanceExportTaskSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "description", "type": "string", "info": "A description for the conversion task or the resource being exported. The maximum length is 255 bytes.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "exportToS3ContainerFormat", "type": "string", "info": "Describes an instance export task.\nThe container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.", "required": false, "schema": { "title": "exportToS3ContainerFormat", "type": "string" } }, { "name": "exportToS3DiskImageFormat", "type": "string", "info": "Describes an instance export task.\nThe format for the exported image.", "required": false, "schema": { "title": "exportToS3DiskImageFormat", "type": "string" } }, { "name": "exportToS3S3Bucket", "type": "string", "info": "Describes an instance export task.\nThe S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account ...(description truncated)", "required": false, "schema": { "title": "exportToS3S3Bucket", "type": "string" } }, { "name": "exportToS3S3Prefix", "type": "string", "info": "Describes an instance export task.\nThe image is written to a single object in the S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.", "required": false, "schema": { "title": "exportToS3S3Prefix", "type": "string" } }, { "name": "instanceId", "type": "string", "info": "The ID of the instance.", "required": true, "schema": { "title": "instanceId", "type": "string" } }, { "name": "targetEnvironment", "type": "string", "info": "The target virtualization environment.", "required": false, "schema": { "title": "targetEnvironment", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createInstanceExportTaskSTSRole" }, "task": true }, { "name": "createInstanceExportTasks", "summary": "Exports multiple running or stopped instance to an S3 bucket.", "description": "Exports multiple running or stopped instance to an S3 bucket.", "input": [ { "name": "InstanceExportTasksArray", "type": "array", "info": "An array of objects(InstanceExportTask parameters). description, exportToS3ContainerFormat, exportToS3DiskImageFormat, exportToS3S3Bucket, exportToS3S3Prefix, instanceId, targetEnvironment.", "required": true, "schema": { "title": "InstanceExportTasksArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createInstanceExportTasks" }, "task": true }, { "name": "createInstanceExportTasksSTSRole", "summary": "Exports multiple running or stopped instance to an S3 bucket.", "description": "Exports multiple running or stopped instance to an S3 bucket.", "input": [ { "name": "InstanceExportTasksArray", "type": "array", "info": "An array of objects(InstanceExportTask parameters). description, exportToS3ContainerFormat, exportToS3DiskImageFormat, exportToS3S3Bucket, exportToS3S3Prefix, instanceId, targetEnvironment.", "required": true, "schema": { "title": "InstanceExportTasksArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createInstanceExportTasksSTSRole" }, "task": true }, { "name": "createInternetGateway", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createInternetGateway" }, "task": true }, { "name": "createInternetGatewaySTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createInternetGatewaySTSRole" }, "task": true }, { "name": "createInternetGateways", "summary": "Creates multiple internet gateways 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 .", "description": "Creates multiple internet gateways 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 .", "input": [ { "name": "internetGatewayArray", "type": "array", "info": "An array of objects(internet gateway parameters). dryRun.", "required": true, "schema": { "title": "internetGatewayArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createInternetGateways" }, "task": true }, { "name": "createInternetGatewaysSTSRole", "summary": "Creates multiple internet gateways 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 .", "description": "Creates multiple internet gateways 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 .", "input": [ { "name": "internetGatewayArray", "type": "array", "info": "An array of objects(internet gateway parameters). dryRun.", "required": true, "schema": { "title": "internetGatewayArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createInternetGatewaysSTSRole" }, "task": true }, { "name": "createKeyPair", "summary": "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...(description truncated)", "description": "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...(description truncated)", "input": [ { "name": "keyName", "type": "string", "info": "A unique name for the key pair. Constraints: Up to 255 ASCII characters", "required": true, "schema": { "title": "keyName", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createKeyPair" }, "task": true }, { "name": "createKeyPairSTSRole", "summary": "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...(description truncated)", "description": "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...(description truncated)", "input": [ { "name": "keyName", "type": "string", "info": "A unique name for the key pair. Constraints: Up to 255 ASCII characters", "required": true, "schema": { "title": "keyName", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createKeyPairSTSRole" }, "task": true }, { "name": "createKeyPairs", "summary": "Creates multiple 2048-bit RSA key pairs with the specified name.", "description": "Creates multiple 2048-bit RSA key pairs with the specified name.", "input": [ { "name": "KeyPairsArray", "type": "array", "info": "An array of objects(KeyPair parameters). keyName, dryRun.", "required": true, "schema": { "title": "KeyPairsArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createKeyPairs" }, "task": true }, { "name": "createKeyPairsSTSRole", "summary": "Creates multiple 2048-bit RSA key pairs with the specified name.", "description": "Creates multiple 2048-bit RSA key pairs with the specified name.", "input": [ { "name": "KeyPairsArray", "type": "array", "info": "An array of objects(KeyPair parameters). keyName, dryRun.", "required": true, "schema": { "title": "KeyPairsArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createKeyPairsSTSRole" }, "task": true }, { "name": "createLaunchTemplate", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency . Constraint: Maximum 128 ASCII...(description truncated)", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "launchTemplateName", "type": "string", "info": "A name for the launch template.", "required": true, "schema": { "title": "launchTemplateName", "type": "string" } }, { "name": "versionDescription", "type": "string", "info": "A description for the first version of the launch template.", "required": false, "schema": { "title": "versionDescription", "type": "string" } }, { "name": "launchTemplateDataKernelId", "type": "string", "info": "The information to include in the launch template.\n The ID of the kernel. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, se...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataKernelId", "type": "string" } }, { "name": "launchTemplateDataEbsOptimized", "type": "string", "info": "The information to include in the launch template.\nIndicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amaz...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataEbsOptimized", "type": "string" } }, { "name": "launchTemplateDataIamInstanceProfile", "type": "string", "info": "The information to include in the launch template.\nThe IAM instance profile.", "required": false, "schema": { "title": "launchTemplateDataIamInstanceProfile", "type": "string" } }, { "name": "launchTemplateDataBlockDeviceMappings", "type": "array", "info": "The information to include in the launch template.\n The block device mapping. Supplying both a snapshot ID and an encryption value as arguments for block-device mappi...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataBlockDeviceMappings", "type": "array" } }, { "name": "launchTemplateDataNetworkInterfaces", "type": "array", "info": "The information to include in the launch template.\nOne or more network interfaces. If you specify a network interface, you must specify any security groups as part of the...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataNetworkInterfaces", "type": "array" } }, { "name": "launchTemplateDataImageId", "type": "string", "info": "The information to include in the launch template.\nThe ID of the AMI, which you can get by using DescribeImages .", "required": false, "schema": { "title": "launchTemplateDataImageId", "type": "string" } }, { "name": "launchTemplateDataInstanceType", "type": "string", "info": "The information to include in the launch template.\nThe instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide .", "required": false, "schema": { "title": "launchTemplateDataInstanceType", "type": "string" } }, { "name": "launchTemplateDataKeyName", "type": "string", "info": "The information to include in the launch template.\n The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair . If you do not specif...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataKeyName", "type": "string" } }, { "name": "launchTemplateDataMonitoring", "type": "string", "info": "The information to include in the launch template.\nThe monitoring for the instance.", "required": false, "schema": { "title": "launchTemplateDataMonitoring", "type": "string" } }, { "name": "launchTemplateDataPlacement", "type": "string", "info": "The information to include in the launch template.\nThe placement for the instance.", "required": false, "schema": { "title": "launchTemplateDataPlacement", "type": "string" } }, { "name": "launchTemplateDataRamDiskId", "type": "string", "info": "The information to include in the launch template.\n The ID of the RAM disk. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, ...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataRamDiskId", "type": "string" } }, { "name": "launchTemplateDataDisableApiTermination", "type": "string", "info": "The information to include in the launch template.\nIf set to true , you can't terminate the instance using the Amazon EC2 console, CLI, or API. To change this attribute ...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataDisableApiTermination", "type": "string" } }, { "name": "launchTemplateDataInstanceInitiatedShutdownBehavior", "type": "string", "info": "The information to include in the launch template.\n Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating sy...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataInstanceInitiatedShutdownBehavior", "type": "string" } }, { "name": "launchTemplateDataUserData", "type": "string", "info": "The information to include in the launch template.\nThe Base64-encoded user data to make available to the instance. For more information, see Running Commands on Your Lin...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataUserData", "type": "string" } }, { "name": "launchTemplateDataTagSpecifications", "type": "array", "info": "The information to include in the launch template.\nThe tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags ...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataTagSpecifications", "type": "array" } }, { "name": "launchTemplateDataElasticGpuSpecifications", "type": "array", "info": "The information to include in the launch template.\nAn elastic GPU to associate with the instance.", "required": false, "schema": { "title": "launchTemplateDataElasticGpuSpecifications", "type": "array" } }, { "name": "launchTemplateDataElasticInferenceAccelerators", "type": "array", "info": "The information to include in the launch template.\n The elastic inference accelerator for the instance.", "required": false, "schema": { "title": "launchTemplateDataElasticInferenceAccelerators", "type": "array" } }, { "name": "launchTemplateDataSecurityGroupIds", "type": "array", "info": "The information to include in the launch template.\nOne or more security group IDs. You can create a security group using CreateSecurityGroup . You cannot specify both a ...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataSecurityGroupIds", "type": "array" } }, { "name": "launchTemplateDataSecurityGroups", "type": "array", "info": "The information to include in the launch template.\n[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs inst...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataSecurityGroups", "type": "array" } }, { "name": "launchTemplateDataInstanceMarketOptions", "type": "string", "info": "The information to include in the launch template.\nThe market (purchasing) option for the instances.", "required": false, "schema": { "title": "launchTemplateDataInstanceMarketOptions", "type": "string" } }, { "name": "launchTemplateDataCreditSpecification", "type": "string", "info": "The information to include in the launch template.\nThe credit option for CPU usage of the instance. Valid for T2 or T3 instances only.", "required": false, "schema": { "title": "launchTemplateDataCreditSpecification", "type": "string" } }, { "name": "launchTemplateDataCpuOptions", "type": "string", "info": "The information to include in the launch template.\nThe CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Clo...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataCpuOptions", "type": "string" } }, { "name": "launchTemplateDataCapacityReservationSpecification", "type": "string", "info": "The information to include in the launch template.\nThe Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation pr...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataCapacityReservationSpecification", "type": "string" } }, { "name": "launchTemplateDataLicenseSpecifications", "type": "array", "info": "The information to include in the launch template.\nThe license configurations.", "required": false, "schema": { "title": "launchTemplateDataLicenseSpecifications", "type": "array" } }, { "name": "launchTemplateDataHibernationOptions", "type": "string", "info": "The information to include in the launch template.\nIndicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hiber...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataHibernationOptions", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createLaunchTemplate" }, "task": true }, { "name": "createLaunchTemplateSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency . Constraint: Maximum 128 ASCII...(description truncated)", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "launchTemplateName", "type": "string", "info": "A name for the launch template.", "required": true, "schema": { "title": "launchTemplateName", "type": "string" } }, { "name": "versionDescription", "type": "string", "info": "A description for the first version of the launch template.", "required": false, "schema": { "title": "versionDescription", "type": "string" } }, { "name": "launchTemplateDataKernelId", "type": "string", "info": "The information to include in the launch template.\n The ID of the kernel. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, se...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataKernelId", "type": "string" } }, { "name": "launchTemplateDataEbsOptimized", "type": "string", "info": "The information to include in the launch template.\nIndicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amaz...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataEbsOptimized", "type": "string" } }, { "name": "launchTemplateDataIamInstanceProfile", "type": "string", "info": "The information to include in the launch template.\nThe IAM instance profile.", "required": false, "schema": { "title": "launchTemplateDataIamInstanceProfile", "type": "string" } }, { "name": "launchTemplateDataBlockDeviceMappings", "type": "array", "info": "The information to include in the launch template.\n The block device mapping. Supplying both a snapshot ID and an encryption value as arguments for block-device mappi...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataBlockDeviceMappings", "type": "array" } }, { "name": "launchTemplateDataNetworkInterfaces", "type": "array", "info": "The information to include in the launch template.\nOne or more network interfaces. If you specify a network interface, you must specify any security groups as part of the...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataNetworkInterfaces", "type": "array" } }, { "name": "launchTemplateDataImageId", "type": "string", "info": "The information to include in the launch template.\nThe ID of the AMI, which you can get by using DescribeImages .", "required": false, "schema": { "title": "launchTemplateDataImageId", "type": "string" } }, { "name": "launchTemplateDataInstanceType", "type": "string", "info": "The information to include in the launch template.\nThe instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide .", "required": false, "schema": { "title": "launchTemplateDataInstanceType", "type": "string" } }, { "name": "launchTemplateDataKeyName", "type": "string", "info": "The information to include in the launch template.\n The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair . If you do not specif...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataKeyName", "type": "string" } }, { "name": "launchTemplateDataMonitoring", "type": "string", "info": "The information to include in the launch template.\nThe monitoring for the instance.", "required": false, "schema": { "title": "launchTemplateDataMonitoring", "type": "string" } }, { "name": "launchTemplateDataPlacement", "type": "string", "info": "The information to include in the launch template.\nThe placement for the instance.", "required": false, "schema": { "title": "launchTemplateDataPlacement", "type": "string" } }, { "name": "launchTemplateDataRamDiskId", "type": "string", "info": "The information to include in the launch template.\n The ID of the RAM disk. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, ...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataRamDiskId", "type": "string" } }, { "name": "launchTemplateDataDisableApiTermination", "type": "string", "info": "The information to include in the launch template.\nIf set to true , you can't terminate the instance using the Amazon EC2 console, CLI, or API. To change this attribute ...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataDisableApiTermination", "type": "string" } }, { "name": "launchTemplateDataInstanceInitiatedShutdownBehavior", "type": "string", "info": "The information to include in the launch template.\n Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating sy...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataInstanceInitiatedShutdownBehavior", "type": "string" } }, { "name": "launchTemplateDataUserData", "type": "string", "info": "The information to include in the launch template.\nThe Base64-encoded user data to make available to the instance. For more information, see Running Commands on Your Lin...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataUserData", "type": "string" } }, { "name": "launchTemplateDataTagSpecifications", "type": "array", "info": "The information to include in the launch template.\nThe tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags ...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataTagSpecifications", "type": "array" } }, { "name": "launchTemplateDataElasticGpuSpecifications", "type": "array", "info": "The information to include in the launch template.\nAn elastic GPU to associate with the instance.", "required": false, "schema": { "title": "launchTemplateDataElasticGpuSpecifications", "type": "array" } }, { "name": "launchTemplateDataElasticInferenceAccelerators", "type": "array", "info": "The information to include in the launch template.\n The elastic inference accelerator for the instance.", "required": false, "schema": { "title": "launchTemplateDataElasticInferenceAccelerators", "type": "array" } }, { "name": "launchTemplateDataSecurityGroupIds", "type": "array", "info": "The information to include in the launch template.\nOne or more security group IDs. You can create a security group using CreateSecurityGroup . You cannot specify both a ...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataSecurityGroupIds", "type": "array" } }, { "name": "launchTemplateDataSecurityGroups", "type": "array", "info": "The information to include in the launch template.\n[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs inst...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataSecurityGroups", "type": "array" } }, { "name": "launchTemplateDataInstanceMarketOptions", "type": "string", "info": "The information to include in the launch template.\nThe market (purchasing) option for the instances.", "required": false, "schema": { "title": "launchTemplateDataInstanceMarketOptions", "type": "string" } }, { "name": "launchTemplateDataCreditSpecification", "type": "string", "info": "The information to include in the launch template.\nThe credit option for CPU usage of the instance. Valid for T2 or T3 instances only.", "required": false, "schema": { "title": "launchTemplateDataCreditSpecification", "type": "string" } }, { "name": "launchTemplateDataCpuOptions", "type": "string", "info": "The information to include in the launch template.\nThe CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Clo...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataCpuOptions", "type": "string" } }, { "name": "launchTemplateDataCapacityReservationSpecification", "type": "string", "info": "The information to include in the launch template.\nThe Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation pr...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataCapacityReservationSpecification", "type": "string" } }, { "name": "launchTemplateDataLicenseSpecifications", "type": "array", "info": "The information to include in the launch template.\nThe license configurations.", "required": false, "schema": { "title": "launchTemplateDataLicenseSpecifications", "type": "array" } }, { "name": "launchTemplateDataHibernationOptions", "type": "string", "info": "The information to include in the launch template.\nIndicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hiber...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataHibernationOptions", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createLaunchTemplateSTSRole" }, "task": true }, { "name": "createLaunchTemplates", "summary": "Creates multiple launch templates.", "description": "Creates multiple launch templates.", "input": [ { "name": "LaunchTemplatesArray", "type": "array", "info": "An array of objects(LaunchTemplates parameters). dryRun, clientToken, launchTemplateName, versionDescription, launchTemplateDataKernelId, launchTemplateDataEbsOptimized, launchTemplateDataIamInstanceProfile, launchTemplateDataBlockDeviceMappings, launchTemplateDataNetworkInterfaces, launchTemplateDataImageId, launchTemplateDataInstanceType, launchTemplateDataKeyName, launchTemplateDataMonitoring, launchTemplateDataPlacement, launchTemplateDataRamDiskId, launchTemplateDataDisableApiTermination, launchTemplateDataInstanceInitiatedShutdownBehavior, launchTemplateDataUserData, launchTemplateDataTagSpecifications, launchTemplateDataElasticGpuSpecifications, launchTemplateDataElasticInferenceAccelerators, launchTemplateDataSecurityGroupIds, launchTemplateDataSecurityGroups, launchTemplateDataInstanceMarketOptions, launchTemplateDataCreditSpecification, launchTemplateDataCpuOptions, launchTemplateDataCapacityReservationSpecification, launchTemplateDataLicenseSpecifications, launchTemplateDataHibernationOptions.", "required": true, "schema": { "title": "LaunchTemplatesArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createLaunchTemplates" }, "task": true }, { "name": "createLaunchTemplatesSTSRole", "summary": "Creates multiple launch templates.", "description": "Creates multiple launch templates.", "input": [ { "name": "LaunchTemplatesArray", "type": "array", "info": "An array of objects(LaunchTemplates parameters). dryRun, clientToken, launchTemplateName, versionDescription, launchTemplateDataKernelId, launchTemplateDataEbsOptimized, launchTemplateDataIamInstanceProfile, launchTemplateDataBlockDeviceMappings, launchTemplateDataNetworkInterfaces, launchTemplateDataImageId, launchTemplateDataInstanceType, launchTemplateDataKeyName, launchTemplateDataMonitoring, launchTemplateDataPlacement, launchTemplateDataRamDiskId, launchTemplateDataDisableApiTermination, launchTemplateDataInstanceInitiatedShutdownBehavior, launchTemplateDataUserData, launchTemplateDataTagSpecifications, launchTemplateDataElasticGpuSpecifications, launchTemplateDataElasticInferenceAccelerators, launchTemplateDataSecurityGroupIds, launchTemplateDataSecurityGroups, launchTemplateDataInstanceMarketOptions, launchTemplateDataCreditSpecification, launchTemplateDataCpuOptions, launchTemplateDataCapacityReservationSpecification, launchTemplateDataLicenseSpecifications, launchTemplateDataHibernationOptions.", "required": true, "schema": { "title": "LaunchTemplatesArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createLaunchTemplatesSTSRole" }, "task": true }, { "name": "createLaunchTemplateVersion", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency . Constraint: Maximum 128 ASCII...(description truncated)", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "launchTemplateId", "type": "string", "info": "The ID of the launch template. You must specify either the launch template ID or launch template name in the request.", "required": false, "schema": { "title": "launchTemplateId", "type": "string" } }, { "name": "launchTemplateName", "type": "string", "info": "The name of the launch template. You must specify either the launch template ID or launch template name in the request.", "required": false, "schema": { "title": "launchTemplateName", "type": "string" } }, { "name": "sourceVersion", "type": "string", "info": "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 ...(description truncated)", "required": false, "schema": { "title": "sourceVersion", "type": "string" } }, { "name": "versionDescription", "type": "string", "info": "A description for the version of the launch template.", "required": false, "schema": { "title": "versionDescription", "type": "string" } }, { "name": "launchTemplateDataKernelId", "type": "string", "info": "The information to include in the launch template.\n The ID of the kernel. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, se...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataKernelId", "type": "string" } }, { "name": "launchTemplateDataEbsOptimized", "type": "string", "info": "The information to include in the launch template.\nIndicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amaz...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataEbsOptimized", "type": "string" } }, { "name": "launchTemplateDataIamInstanceProfile", "type": "string", "info": "The information to include in the launch template.\nThe IAM instance profile.", "required": false, "schema": { "title": "launchTemplateDataIamInstanceProfile", "type": "string" } }, { "name": "launchTemplateDataBlockDeviceMappings", "type": "array", "info": "The information to include in the launch template.\n The block device mapping. Supplying both a snapshot ID and an encryption value as arguments for block-device mappi...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataBlockDeviceMappings", "type": "array" } }, { "name": "launchTemplateDataNetworkInterfaces", "type": "array", "info": "The information to include in the launch template.\nOne or more network interfaces. If you specify a network interface, you must specify any security groups as part of the...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataNetworkInterfaces", "type": "array" } }, { "name": "launchTemplateDataImageId", "type": "string", "info": "The information to include in the launch template.\nThe ID of the AMI, which you can get by using DescribeImages .", "required": false, "schema": { "title": "launchTemplateDataImageId", "type": "string" } }, { "name": "launchTemplateDataInstanceType", "type": "string", "info": "The information to include in the launch template.\nThe instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide .", "required": false, "schema": { "title": "launchTemplateDataInstanceType", "type": "string" } }, { "name": "launchTemplateDataKeyName", "type": "string", "info": "The information to include in the launch template.\n The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair . If you do not specif...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataKeyName", "type": "string" } }, { "name": "launchTemplateDataMonitoring", "type": "string", "info": "The information to include in the launch template.\nThe monitoring for the instance.", "required": false, "schema": { "title": "launchTemplateDataMonitoring", "type": "string" } }, { "name": "launchTemplateDataPlacement", "type": "string", "info": "The information to include in the launch template.\nThe placement for the instance.", "required": false, "schema": { "title": "launchTemplateDataPlacement", "type": "string" } }, { "name": "launchTemplateDataRamDiskId", "type": "string", "info": "The information to include in the launch template.\n The ID of the RAM disk. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, ...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataRamDiskId", "type": "string" } }, { "name": "launchTemplateDataDisableApiTermination", "type": "string", "info": "The information to include in the launch template.\nIf set to true , you can't terminate the instance using the Amazon EC2 console, CLI, or API. To change this attribute ...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataDisableApiTermination", "type": "string" } }, { "name": "launchTemplateDataInstanceInitiatedShutdownBehavior", "type": "string", "info": "The information to include in the launch template.\n Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating sy...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataInstanceInitiatedShutdownBehavior", "type": "string" } }, { "name": "launchTemplateDataUserData", "type": "string", "info": "The information to include in the launch template.\nThe Base64-encoded user data to make available to the instance. For more information, see Running Commands on Your Lin...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataUserData", "type": "string" } }, { "name": "launchTemplateDataTagSpecifications", "type": "array", "info": "The information to include in the launch template.\nThe tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags ...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataTagSpecifications", "type": "array" } }, { "name": "launchTemplateDataElasticGpuSpecifications", "type": "array", "info": "The information to include in the launch template.\nAn elastic GPU to associate with the instance.", "required": false, "schema": { "title": "launchTemplateDataElasticGpuSpecifications", "type": "array" } }, { "name": "launchTemplateDataElasticInferenceAccelerators", "type": "array", "info": "The information to include in the launch template.\n The elastic inference accelerator for the instance.", "required": false, "schema": { "title": "launchTemplateDataElasticInferenceAccelerators", "type": "array" } }, { "name": "launchTemplateDataSecurityGroupIds", "type": "array", "info": "The information to include in the launch template.\nOne or more security group IDs. You can create a security group using CreateSecurityGroup . You cannot specify both a ...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataSecurityGroupIds", "type": "array" } }, { "name": "launchTemplateDataSecurityGroups", "type": "array", "info": "The information to include in the launch template.\n[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs inst...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataSecurityGroups", "type": "array" } }, { "name": "launchTemplateDataInstanceMarketOptions", "type": "string", "info": "The information to include in the launch template.\nThe market (purchasing) option for the instances.", "required": false, "schema": { "title": "launchTemplateDataInstanceMarketOptions", "type": "string" } }, { "name": "launchTemplateDataCreditSpecification", "type": "string", "info": "The information to include in the launch template.\nThe credit option for CPU usage of the instance. Valid for T2 or T3 instances only.", "required": false, "schema": { "title": "launchTemplateDataCreditSpecification", "type": "string" } }, { "name": "launchTemplateDataCpuOptions", "type": "string", "info": "The information to include in the launch template.\nThe CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Clo...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataCpuOptions", "type": "string" } }, { "name": "launchTemplateDataCapacityReservationSpecification", "type": "string", "info": "The information to include in the launch template.\nThe Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation pr...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataCapacityReservationSpecification", "type": "string" } }, { "name": "launchTemplateDataLicenseSpecifications", "type": "array", "info": "The information to include in the launch template.\nThe license configurations.", "required": false, "schema": { "title": "launchTemplateDataLicenseSpecifications", "type": "array" } }, { "name": "launchTemplateDataHibernationOptions", "type": "string", "info": "The information to include in the launch template.\nIndicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hiber...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataHibernationOptions", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createLaunchTemplateVersion" }, "task": true }, { "name": "createLaunchTemplateVersionSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency . Constraint: Maximum 128 ASCII...(description truncated)", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "launchTemplateId", "type": "string", "info": "The ID of the launch template. You must specify either the launch template ID or launch template name in the request.", "required": false, "schema": { "title": "launchTemplateId", "type": "string" } }, { "name": "launchTemplateName", "type": "string", "info": "The name of the launch template. You must specify either the launch template ID or launch template name in the request.", "required": false, "schema": { "title": "launchTemplateName", "type": "string" } }, { "name": "sourceVersion", "type": "string", "info": "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 ...(description truncated)", "required": false, "schema": { "title": "sourceVersion", "type": "string" } }, { "name": "versionDescription", "type": "string", "info": "A description for the version of the launch template.", "required": false, "schema": { "title": "versionDescription", "type": "string" } }, { "name": "launchTemplateDataKernelId", "type": "string", "info": "The information to include in the launch template.\n The ID of the kernel. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, se...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataKernelId", "type": "string" } }, { "name": "launchTemplateDataEbsOptimized", "type": "string", "info": "The information to include in the launch template.\nIndicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amaz...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataEbsOptimized", "type": "string" } }, { "name": "launchTemplateDataIamInstanceProfile", "type": "string", "info": "The information to include in the launch template.\nThe IAM instance profile.", "required": false, "schema": { "title": "launchTemplateDataIamInstanceProfile", "type": "string" } }, { "name": "launchTemplateDataBlockDeviceMappings", "type": "array", "info": "The information to include in the launch template.\n The block device mapping. Supplying both a snapshot ID and an encryption value as arguments for block-device mappi...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataBlockDeviceMappings", "type": "array" } }, { "name": "launchTemplateDataNetworkInterfaces", "type": "array", "info": "The information to include in the launch template.\nOne or more network interfaces. If you specify a network interface, you must specify any security groups as part of the...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataNetworkInterfaces", "type": "array" } }, { "name": "launchTemplateDataImageId", "type": "string", "info": "The information to include in the launch template.\nThe ID of the AMI, which you can get by using DescribeImages .", "required": false, "schema": { "title": "launchTemplateDataImageId", "type": "string" } }, { "name": "launchTemplateDataInstanceType", "type": "string", "info": "The information to include in the launch template.\nThe instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide .", "required": false, "schema": { "title": "launchTemplateDataInstanceType", "type": "string" } }, { "name": "launchTemplateDataKeyName", "type": "string", "info": "The information to include in the launch template.\n The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair . If you do not specif...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataKeyName", "type": "string" } }, { "name": "launchTemplateDataMonitoring", "type": "string", "info": "The information to include in the launch template.\nThe monitoring for the instance.", "required": false, "schema": { "title": "launchTemplateDataMonitoring", "type": "string" } }, { "name": "launchTemplateDataPlacement", "type": "string", "info": "The information to include in the launch template.\nThe placement for the instance.", "required": false, "schema": { "title": "launchTemplateDataPlacement", "type": "string" } }, { "name": "launchTemplateDataRamDiskId", "type": "string", "info": "The information to include in the launch template.\n The ID of the RAM disk. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, ...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataRamDiskId", "type": "string" } }, { "name": "launchTemplateDataDisableApiTermination", "type": "string", "info": "The information to include in the launch template.\nIf set to true , you can't terminate the instance using the Amazon EC2 console, CLI, or API. To change this attribute ...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataDisableApiTermination", "type": "string" } }, { "name": "launchTemplateDataInstanceInitiatedShutdownBehavior", "type": "string", "info": "The information to include in the launch template.\n Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating sy...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataInstanceInitiatedShutdownBehavior", "type": "string" } }, { "name": "launchTemplateDataUserData", "type": "string", "info": "The information to include in the launch template.\nThe Base64-encoded user data to make available to the instance. For more information, see Running Commands on Your Lin...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataUserData", "type": "string" } }, { "name": "launchTemplateDataTagSpecifications", "type": "array", "info": "The information to include in the launch template.\nThe tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags ...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataTagSpecifications", "type": "array" } }, { "name": "launchTemplateDataElasticGpuSpecifications", "type": "array", "info": "The information to include in the launch template.\nAn elastic GPU to associate with the instance.", "required": false, "schema": { "title": "launchTemplateDataElasticGpuSpecifications", "type": "array" } }, { "name": "launchTemplateDataElasticInferenceAccelerators", "type": "array", "info": "The information to include in the launch template.\n The elastic inference accelerator for the instance.", "required": false, "schema": { "title": "launchTemplateDataElasticInferenceAccelerators", "type": "array" } }, { "name": "launchTemplateDataSecurityGroupIds", "type": "array", "info": "The information to include in the launch template.\nOne or more security group IDs. You can create a security group using CreateSecurityGroup . You cannot specify both a ...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataSecurityGroupIds", "type": "array" } }, { "name": "launchTemplateDataSecurityGroups", "type": "array", "info": "The information to include in the launch template.\n[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs inst...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataSecurityGroups", "type": "array" } }, { "name": "launchTemplateDataInstanceMarketOptions", "type": "string", "info": "The information to include in the launch template.\nThe market (purchasing) option for the instances.", "required": false, "schema": { "title": "launchTemplateDataInstanceMarketOptions", "type": "string" } }, { "name": "launchTemplateDataCreditSpecification", "type": "string", "info": "The information to include in the launch template.\nThe credit option for CPU usage of the instance. Valid for T2 or T3 instances only.", "required": false, "schema": { "title": "launchTemplateDataCreditSpecification", "type": "string" } }, { "name": "launchTemplateDataCpuOptions", "type": "string", "info": "The information to include in the launch template.\nThe CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Clo...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataCpuOptions", "type": "string" } }, { "name": "launchTemplateDataCapacityReservationSpecification", "type": "string", "info": "The information to include in the launch template.\nThe Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation pr...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataCapacityReservationSpecification", "type": "string" } }, { "name": "launchTemplateDataLicenseSpecifications", "type": "array", "info": "The information to include in the launch template.\nThe license configurations.", "required": false, "schema": { "title": "launchTemplateDataLicenseSpecifications", "type": "array" } }, { "name": "launchTemplateDataHibernationOptions", "type": "string", "info": "The information to include in the launch template.\nIndicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hiber...(description truncated)", "required": false, "schema": { "title": "launchTemplateDataHibernationOptions", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createLaunchTemplateVersionSTSRole" }, "task": true }, { "name": "createLaunchTemplateVersions", "summary": "Creates multiple new version for a launch template.", "description": "Creates multiple new version for a launch template.", "input": [ { "name": "LaunchTemplateVersionsArray", "type": "array", "info": "An array of objects(LaunchTemplateVersions parameters). dryRun, clientToken, launchTemplateId, launchTemplateName, sourceVersion, versionDescription, launchTemplateDataKernelId, launchTemplateDataEbsOptimized, launchTemplateDataIamInstanceProfile, launchTemplateDataBlockDeviceMappings, launchTemplateDataNetworkInterfaces, launchTemplateDataImageId, launchTemplateDataInstanceType, launchTemplateDataKeyName, launchTemplateDataMonitoring, launchTemplateDataPlacement, launchTemplateDataRamDiskId, launchTemplateDataDisableApiTermination, launchTemplateDataInstanceInitiatedShutdownBehavior, launchTemplateDataUserData, launchTemplateDataTagSpecifications, launchTemplateDataElasticGpuSpecifications, launchTemplateDataElasticInferenceAccelerators, launchTemplateDataSecurityGroupIds, launchTemplateDataSecurityGroups, launchTemplateDataInstanceMarketOptions, launchTemplateDataCreditSpecification, launchTemplateDataCpuOptions, launchTemplateDataCapacityReservationSpecification, launchTemplateDataLicenseSpecifications, launchTemplateDataHibernationOptions.", "required": true, "schema": { "title": "LaunchTemplateVersionsArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createLaunchTemplateVersions" }, "task": true }, { "name": "createLaunchTemplateVersionsSTSRole", "summary": "Creates multiple new version for a launch template.", "description": "Creates multiple new version for a launch template.", "input": [ { "name": "LaunchTemplateVersionsArray", "type": "array", "info": "An array of objects(LaunchTemplateVersions parameters). dryRun, clientToken, launchTemplateId, launchTemplateName, sourceVersion, versionDescription, launchTemplateDataKernelId, launchTemplateDataEbsOptimized, launchTemplateDataIamInstanceProfile, launchTemplateDataBlockDeviceMappings, launchTemplateDataNetworkInterfaces, launchTemplateDataImageId, launchTemplateDataInstanceType, launchTemplateDataKeyName, launchTemplateDataMonitoring, launchTemplateDataPlacement, launchTemplateDataRamDiskId, launchTemplateDataDisableApiTermination, launchTemplateDataInstanceInitiatedShutdownBehavior, launchTemplateDataUserData, launchTemplateDataTagSpecifications, launchTemplateDataElasticGpuSpecifications, launchTemplateDataElasticInferenceAccelerators, launchTemplateDataSecurityGroupIds, launchTemplateDataSecurityGroups, launchTemplateDataInstanceMarketOptions, launchTemplateDataCreditSpecification, launchTemplateDataCpuOptions, launchTemplateDataCapacityReservationSpecification, launchTemplateDataLicenseSpecifications, launchTemplateDataHibernationOptions.", "required": true, "schema": { "title": "LaunchTemplateVersionsArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createLaunchTemplateVersionsSTSRole" }, "task": true }, { "name": "createNatGateway", "summary": "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 .", "description": "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 .", "input": [ { "name": "allocationId", "type": "string", "info": "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 i...(description truncated)", "required": true, "schema": { "title": "allocationId", "type": "string" } }, { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency . Constraint: Maximum...(description truncated)", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "subnetId", "type": "string", "info": "The subnet in which to create the NAT gateway.", "required": true, "schema": { "title": "subnetId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createNatGateway" }, "task": true }, { "name": "createNatGatewaySTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "allocationId", "type": "string", "info": "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 i...(description truncated)", "required": true, "schema": { "title": "allocationId", "type": "string" } }, { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency . Constraint: Maximum...(description truncated)", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "subnetId", "type": "string", "info": "The subnet in which to create the NAT gateway.", "required": true, "schema": { "title": "subnetId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createNatGatewaySTSRole" }, "task": true }, { "name": "createNatGateways", "summary": "Creates multiple NAT gateways in the specified public subnet.", "description": "Creates multiple NAT gateways in the specified public subnet.", "input": [ { "name": "NatGatewaysArray", "type": "array", "info": "An array of objects(NatGateway parameters).allocationId, clientToken, subnetId", "required": true, "schema": { "title": "NatGatewaysArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createNatGateways" }, "task": true }, { "name": "createNatGatewaysSTSRole", "summary": "Creates multiple NAT gateways in the specified public subnet.", "description": "Creates multiple NAT gateways in the specified public subnet.", "input": [ { "name": "NatGatewaysArray", "type": "array", "info": "An array of objects(NatGateway parameters).allocationId, clientToken, subnetId", "required": true, "schema": { "title": "NatGatewaysArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createNatGatewaysSTSRole" }, "task": true }, { "name": "createNetworkAcl", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createNetworkAcl" }, "task": true }, { "name": "createNetworkAclSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createNetworkAclSTSRole" }, "task": true }, { "name": "createNetworkAcls", "summary": "Creates multiple network ACL in a VPC.", "description": "Creates multiple network ACL in a VPC.", "input": [ { "name": "NetworkAclsArray", "type": "array", "info": "An array of objects(NetworkAcl parameters).dryRun, vpcId", "required": true, "schema": { "title": "NetworkAclsArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createNetworkAcls" }, "task": true }, { "name": "createNetworkAclsSTSRole", "summary": "Creates multiple network ACL in a VPC.", "description": "Creates multiple network ACL in a VPC.", "input": [ { "name": "NetworkAclsArray", "type": "array", "info": "An array of objects(NetworkAcl parameters).dryRun, vpcId", "required": true, "schema": { "title": "NetworkAclsArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createNetworkAclsSTSRole" }, "task": true }, { "name": "createNetworkAclEntry", "summary": "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 (f...(description truncated)", "description": "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 (f...(description truncated)", "input": [ { "name": "cidrBlock", "type": "string", "info": "The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24 ).", "required": false, "schema": { "title": "cidrBlock", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "egress", "type": "boolean", "info": "Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).", "required": true, "schema": { "title": "egress", "type": "boolean" } }, { "name": "icmpCode", "type": "string", "info": "Describes the ICMP type and code.\nThe ICMP code. A value of -1 means all codes for the specified ICMP type.", "required": false, "schema": { "title": "icmpCode", "type": "string" } }, { "name": "icmpType", "type": "string", "info": "Describes the ICMP type and code.\nThe ICMP type. A value of -1 means all types.", "required": false, "schema": { "title": "icmpType", "type": "string" } }, { "name": "ipv6CidrBlock", "type": "string", "info": "The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64 ).", "required": false, "schema": { "title": "ipv6CidrBlock", "type": "string" } }, { "name": "networkAclId", "type": "string", "info": "The ID of the network ACL.", "required": true, "schema": { "title": "networkAclId", "type": "string" } }, { "name": "portRangeFrom", "type": "string", "info": "Describes a range of ports.\nThe first port in the range.", "required": false, "schema": { "title": "portRangeFrom", "type": "string" } }, { "name": "portRangeTo", "type": "string", "info": "Describes a range of ports.\nThe last port in the range.", "required": false, "schema": { "title": "portRangeTo", "type": "string" } }, { "name": "protocol", "type": "string", "info": "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 i...(description truncated)", "required": true, "schema": { "title": "protocol", "type": "string" } }, { "name": "ruleAction", "type": "string", "info": "Indicates whether to allow or deny the traffic that matches the rule.", "required": true, "schema": { "title": "ruleAction", "type": "string" } }, { "name": "ruleNumber", "type": "number", "info": "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...(description truncated)", "required": true, "schema": { "title": "ruleNumber", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createNetworkAclEntry" }, "task": true }, { "name": "createNetworkAclEntrySTSRole", "summary": "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 (f...(description truncated)", "description": "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 (f...(description truncated)", "input": [ { "name": "cidrBlock", "type": "string", "info": "The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24 ).", "required": false, "schema": { "title": "cidrBlock", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "egress", "type": "boolean", "info": "Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).", "required": true, "schema": { "title": "egress", "type": "boolean" } }, { "name": "icmpCode", "type": "string", "info": "Describes the ICMP type and code.\nThe ICMP code. A value of -1 means all codes for the specified ICMP type.", "required": false, "schema": { "title": "icmpCode", "type": "string" } }, { "name": "icmpType", "type": "string", "info": "Describes the ICMP type and code.\nThe ICMP type. A value of -1 means all types.", "required": false, "schema": { "title": "icmpType", "type": "string" } }, { "name": "ipv6CidrBlock", "type": "string", "info": "The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64 ).", "required": false, "schema": { "title": "ipv6CidrBlock", "type": "string" } }, { "name": "networkAclId", "type": "string", "info": "The ID of the network ACL.", "required": true, "schema": { "title": "networkAclId", "type": "string" } }, { "name": "portRangeFrom", "type": "string", "info": "Describes a range of ports.\nThe first port in the range.", "required": false, "schema": { "title": "portRangeFrom", "type": "string" } }, { "name": "portRangeTo", "type": "string", "info": "Describes a range of ports.\nThe last port in the range.", "required": false, "schema": { "title": "portRangeTo", "type": "string" } }, { "name": "protocol", "type": "string", "info": "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 i...(description truncated)", "required": true, "schema": { "title": "protocol", "type": "string" } }, { "name": "ruleAction", "type": "string", "info": "Indicates whether to allow or deny the traffic that matches the rule.", "required": true, "schema": { "title": "ruleAction", "type": "string" } }, { "name": "ruleNumber", "type": "number", "info": "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...(description truncated)", "required": true, "schema": { "title": "ruleNumber", "type": "number" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createNetworkAclEntrySTSRole" }, "task": true }, { "name": "createNetworkAclEntries", "summary": "Creates multiple entries (a rule) in a network ACL with the specified rule number.", "description": "Creates multiple entries (a rule) in a network ACL with the specified rule number.", "input": [ { "name": "NetworkAclEntriesArray", "type": "array", "info": "An array of objects(NetworkAclEntries parameters).cidrBlock, dryRun, egress, icmpCode, icmpType, ipv6CidrBlock, networkAclId, portRangeFrom, portRangeTo, protocol, ruleAction, ruleNumber", "required": true, "schema": { "title": "NetworkAclEntriesArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createNetworkAclEntries" }, "task": true }, { "name": "createNetworkAclEntriesSTSRole", "summary": "Creates multiple entries (a rule) in a network ACL with the specified rule number.", "description": "Creates multiple entries (a rule) in a network ACL with the specified rule number.", "input": [ { "name": "NetworkAclEntriesArray", "type": "array", "info": "An array of objects(NetworkAclEntries parameters).cidrBlock, dryRun, egress, icmpCode, icmpType, ipv6CidrBlock, networkAclId, portRangeFrom, portRangeTo, protocol, ruleAction, ruleNumber", "required": true, "schema": { "title": "NetworkAclEntriesArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createNetworkAclEntriesSTSRole" }, "task": true }, { "name": "createNetworkInterface", "summary": "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 .", "description": "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 .", "input": [ { "name": "description", "type": "string", "info": "A description for the network interface.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "securityGroupId", "type": "array", "info": "The IDs of one or more security groups.", "required": false, "schema": { "title": "securityGroupId", "type": "array" } }, { "name": "ipv6AddressCount", "type": "number", "info": "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 spe...(description truncated)", "required": false, "schema": { "title": "ipv6AddressCount", "type": "number" } }, { "name": "ipv6Addresses", "type": "array", "info": "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.", "required": false, "schema": { "title": "ipv6Addresses", "type": "array" } }, { "name": "privateIpAddress", "type": "string", "info": "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 ...(description truncated)", "required": false, "schema": { "title": "privateIpAddress", "type": "string" } }, { "name": "privateIpAddresses", "type": "array", "info": "One or more private IPv4 addresses.", "required": false, "schema": { "title": "privateIpAddresses", "type": "array" } }, { "name": "secondaryPrivateIpAddressCount", "type": "number", "info": "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 addre...(description truncated)", "required": false, "schema": { "title": "secondaryPrivateIpAddressCount", "type": "number" } }, { "name": "interfaceType", "type": "string", "info": "Indicates whether the network interface is an Elastic Fabric Adapter (EFA). Only specify this parameter to create an EFA. For more information, see Elastic Fabric Adapt...(description truncated)", "required": false, "schema": { "title": "interfaceType", "type": "string" } }, { "name": "subnetId", "type": "string", "info": "The ID of the subnet to associate with the network interface.", "required": true, "schema": { "title": "subnetId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createNetworkInterface" }, "task": true }, { "name": "createNetworkInterfaceSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "description", "type": "string", "info": "A description for the network interface.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "securityGroupId", "type": "array", "info": "The IDs of one or more security groups.", "required": false, "schema": { "title": "securityGroupId", "type": "array" } }, { "name": "ipv6AddressCount", "type": "number", "info": "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 spe...(description truncated)", "required": false, "schema": { "title": "ipv6AddressCount", "type": "number" } }, { "name": "ipv6Addresses", "type": "array", "info": "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.", "required": false, "schema": { "title": "ipv6Addresses", "type": "array" } }, { "name": "privateIpAddress", "type": "string", "info": "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 ...(description truncated)", "required": false, "schema": { "title": "privateIpAddress", "type": "string" } }, { "name": "privateIpAddresses", "type": "array", "info": "One or more private IPv4 addresses.", "required": false, "schema": { "title": "privateIpAddresses", "type": "array" } }, { "name": "secondaryPrivateIpAddressCount", "type": "number", "info": "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 addre...(description truncated)", "required": false, "schema": { "title": "secondaryPrivateIpAddressCount", "type": "number" } }, { "name": "interfaceType", "type": "string", "info": "Indicates whether the network interface is an Elastic Fabric Adapter (EFA). Only specify this parameter to create an EFA. For more information, see Elastic Fabric Adapt...(description truncated)", "required": false, "schema": { "title": "interfaceType", "type": "string" } }, { "name": "subnetId", "type": "string", "info": "The ID of the subnet to associate with the network interface.", "required": true, "schema": { "title": "subnetId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createNetworkInterfaceSTSRole" }, "task": true }, { "name": "createNetworkInterfaces", "summary": "Creates multiple network interfaces in the specified subnet.", "description": "Creates multiple network interfaces in the specified subnet.", "input": [ { "name": "NetworkInterfacesArray", "type": "array", "info": "An array of objects(NetworkAclEntries parameters).description, dryRun, securityGroupId, ipv6AddressCount, ipv6Addresses, privateIpAddress, privateIpAddresses, secondaryPrivateIpAddressCount, interfaceType, subnetId", "required": true, "schema": { "title": "NetworkInterfacesArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createNetworkInterfaces" }, "task": true }, { "name": "createNetworkInterfacesSTSRole", "summary": "Creates multiple network interfaces in the specified subnet.", "description": "Creates multiple network interfaces in the specified subnet.", "input": [ { "name": "NetworkInterfacesArray", "type": "array", "info": "An array of objects(NetworkAclEntries parameters).description, dryRun, securityGroupId, ipv6AddressCount, ipv6Addresses, privateIpAddress, privateIpAddresses, secondaryPrivateIpAddressCount, interfaceType, subnetId", "required": true, "schema": { "title": "NetworkInterfacesArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createNetworkInterfacesSTSRole" }, "task": true }, { "name": "createNetworkInterfacePermission", "summary": "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.", "description": "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.", "input": [ { "name": "networkInterfaceId", "type": "string", "info": "The ID of the network interface.", "required": true, "schema": { "title": "networkInterfaceId", "type": "string" } }, { "name": "awsAccountId", "type": "string", "info": "The AWS account ID.", "required": false, "schema": { "title": "awsAccountId", "type": "string" } }, { "name": "awsService", "type": "string", "info": "The AWS service. Currently not supported.", "required": false, "schema": { "title": "awsService", "type": "string" } }, { "name": "permission", "type": "string", "info": "The type of permission to grant.", "required": true, "schema": { "title": "permission", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createNetworkInterfacePermission" }, "task": true }, { "name": "createNetworkInterfacePermissionSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "networkInterfaceId", "type": "string", "info": "The ID of the network interface.", "required": true, "schema": { "title": "networkInterfaceId", "type": "string" } }, { "name": "awsAccountId", "type": "string", "info": "The AWS account ID.", "required": false, "schema": { "title": "awsAccountId", "type": "string" } }, { "name": "awsService", "type": "string", "info": "The AWS service. Currently not supported.", "required": false, "schema": { "title": "awsService", "type": "string" } }, { "name": "permission", "type": "string", "info": "The type of permission to grant.", "required": true, "schema": { "title": "permission", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createNetworkInterfacePermissionSTSRole" }, "task": true }, { "name": "createNetworkInterfacePermissions", "summary": "Grants multiple AWS-authorized account permissions to attach the specified network interface to an instance in their account.", "description": "Grants multiple AWS-authorized account permissions to attach the specified network interface to an instance in their account.", "input": [ { "name": "InterfacePermissionsArray", "type": "array", "info": "An array of objects(InterfacePermission parameters). networkInterfaceId, awsAccountId, awsService, permission, dryRun", "required": true, "schema": { "title": "InterfacePermissionsArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createNetworkInterfacePermissions" }, "task": true }, { "name": "createNetworkInterfacePermissionsSTSRole", "summary": "Grants multiple AWS-authorized account permissions to attach the specified network interface to an instance in their account.", "description": "Grants multiple AWS-authorized account permissions to attach the specified network interface to an instance in their account.", "input": [ { "name": "InterfacePermissionsArray", "type": "array", "info": "An array of objects(InterfacePermission parameters). networkInterfaceId, awsAccountId, awsService, permission, dryRun", "required": true, "schema": { "title": "InterfacePermissionsArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createNetworkInterfacePermissionsSTSRole" }, "task": true }, { "name": "createPlacementGroup", "summary": "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 d...(description truncated)", "description": "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 d...(description truncated)", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "groupName", "type": "string", "info": "A name for the placement group. Must be unique within the scope of your account for the Region. Constraints: Up to 255 ASCII characters", "required": false, "schema": { "title": "groupName", "type": "string" } }, { "name": "strategy", "type": "string", "info": "The placement strategy.", "required": false, "schema": { "title": "strategy", "type": "string" } }, { "name": "partitionCount", "type": "number", "info": "The number of partitions. Valid only when Strategy is set to partition .", "required": false, "schema": { "title": "partitionCount", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createPlacementGroup" }, "task": true }, { "name": "createPlacementGroupSTSRole", "summary": "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 d...(description truncated)", "description": "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 d...(description truncated)", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "groupName", "type": "string", "info": "A name for the placement group. Must be unique within the scope of your account for the Region. Constraints: Up to 255 ASCII characters", "required": false, "schema": { "title": "groupName", "type": "string" } }, { "name": "strategy", "type": "string", "info": "The placement strategy.", "required": false, "schema": { "title": "strategy", "type": "string" } }, { "name": "partitionCount", "type": "number", "info": "The number of partitions. Valid only when Strategy is set to partition .", "required": false, "schema": { "title": "partitionCount", "type": "number" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createPlacementGroupSTSRole" }, "task": true }, { "name": "createPlacementGroups", "summary": "Creates multiple placement groups in which to launch instances.", "description": "Creates multiple placement groups in which to launch instances.", "input": [ { "name": "PlacementGroupsArray", "type": "array", "info": "An array of objects(PlacementGroup parameters). dryRun, groupName, strategy, partitionCount", "required": true, "schema": { "title": "PlacementGroupsArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createPlacementGroups" }, "task": true }, { "name": "createPlacementGroupsSTSRole", "summary": "Creates multiple placement groups in which to launch instances.", "description": "Creates multiple placement groups in which to launch instances.", "input": [ { "name": "PlacementGroupsArray", "type": "array", "info": "An array of objects(PlacementGroup parameters). dryRun, groupName, strategy, partitionCount", "required": true, "schema": { "title": "PlacementGroupsArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createPlacementGroupsSTSRole" }, "task": true }, { "name": "createReservedInstancesListing", "summary": "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 Re...(description truncated)", "description": "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 Re...(description truncated)", "input": [ { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency...(description truncated)", "required": true, "schema": { "title": "clientToken", "type": "string" } }, { "name": "instanceCount", "type": "number", "info": "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 ...(description truncated)", "required": true, "schema": { "title": "instanceCount", "type": "number" } }, { "name": "priceSchedules", "type": "array", "info": "A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term.", "required": true, "schema": { "title": "priceSchedules", "type": "array" } }, { "name": "reservedInstancesId", "type": "string", "info": "The ID of the active Standard Reserved Instance.", "required": true, "schema": { "title": "reservedInstancesId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createReservedInstancesListing" }, "task": true }, { "name": "createReservedInstancesListingSTSRole", "summary": "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 Re...(description truncated)", "description": "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 Re...(description truncated)", "input": [ { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency...(description truncated)", "required": true, "schema": { "title": "clientToken", "type": "string" } }, { "name": "instanceCount", "type": "number", "info": "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 ...(description truncated)", "required": true, "schema": { "title": "instanceCount", "type": "number" } }, { "name": "priceSchedules", "type": "array", "info": "A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term.", "required": true, "schema": { "title": "priceSchedules", "type": "array" } }, { "name": "reservedInstancesId", "type": "string", "info": "The ID of the active Standard Reserved Instance.", "required": true, "schema": { "title": "reservedInstancesId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createReservedInstancesListingSTSRole" }, "task": true }, { "name": "createReservedInstancesListings", "summary": "Creates multiple listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace.", "description": "Creates multiple listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace.", "input": [ { "name": "ReservedInstancesListingArray", "type": "array", "info": "An array of objects(ReservedInstancesListing parameters). clientToken, instanceCount, priceSchedules, reservedInstancesId", "required": true, "schema": { "title": "ReservedInstancesListingArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createReservedInstancesListings" }, "task": true }, { "name": "createReservedInstancesListingsSTSRole", "summary": "Creates multiple listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace.", "description": "Creates multiple listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace.", "input": [ { "name": "ReservedInstancesListingArray", "type": "array", "info": "An array of objects(ReservedInstancesListing parameters). clientToken, instanceCount, priceSchedules, reservedInstancesId", "required": true, "schema": { "title": "ReservedInstancesListingArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createReservedInstancesListingsSTSRole" }, "task": true }, { "name": "createRoute", "summary": "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 targ...(description truncated)", "description": "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 targ...(description truncated)", "input": [ { "name": "destinationCidrBlock", "type": "string", "info": "The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match.", "required": false, "schema": { "title": "destinationCidrBlock", "type": "string" } }, { "name": "destinationIpv6CidrBlock", "type": "string", "info": "The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.", "required": false, "schema": { "title": "destinationIpv6CidrBlock", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "egressOnlyInternetGatewayId", "type": "string", "info": "[IPv6 traffic only] The ID of an egress-only internet gateway.", "required": false, "schema": { "title": "egressOnlyInternetGatewayId", "type": "string" } }, { "name": "gatewayId", "type": "string", "info": "The ID of an internet gateway or virtual private gateway attached to your VPC.", "required": false, "schema": { "title": "gatewayId", "type": "string" } }, { "name": "instanceId", "type": "string", "info": "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.", "required": false, "schema": { "title": "instanceId", "type": "string" } }, { "name": "natGatewayId", "type": "string", "info": "[IPv4 traffic only] The ID of a NAT gateway.", "required": false, "schema": { "title": "natGatewayId", "type": "string" } }, { "name": "transitGatewayId", "type": "string", "info": "The ID of a transit gateway.", "required": false, "schema": { "title": "transitGatewayId", "type": "string" } }, { "name": "networkInterfaceId", "type": "string", "info": "The ID of a network interface.", "required": false, "schema": { "title": "networkInterfaceId", "type": "string" } }, { "name": "routeTableId", "type": "string", "info": "The ID of the route table for the route.", "required": true, "schema": { "title": "routeTableId", "type": "string" } }, { "name": "vpcPeeringConnectionId", "type": "string", "info": "The ID of a VPC peering connection.", "required": false, "schema": { "title": "vpcPeeringConnectionId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createRoute" }, "task": true }, { "name": "createRouteSTSRole", "summary": "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 targ...(description truncated)", "description": "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 targ...(description truncated)", "input": [ { "name": "destinationCidrBlock", "type": "string", "info": "The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match.", "required": false, "schema": { "title": "destinationCidrBlock", "type": "string" } }, { "name": "destinationIpv6CidrBlock", "type": "string", "info": "The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.", "required": false, "schema": { "title": "destinationIpv6CidrBlock", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "egressOnlyInternetGatewayId", "type": "string", "info": "[IPv6 traffic only] The ID of an egress-only internet gateway.", "required": false, "schema": { "title": "egressOnlyInternetGatewayId", "type": "string" } }, { "name": "gatewayId", "type": "string", "info": "The ID of an internet gateway or virtual private gateway attached to your VPC.", "required": false, "schema": { "title": "gatewayId", "type": "string" } }, { "name": "instanceId", "type": "string", "info": "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.", "required": false, "schema": { "title": "instanceId", "type": "string" } }, { "name": "natGatewayId", "type": "string", "info": "[IPv4 traffic only] The ID of a NAT gateway.", "required": false, "schema": { "title": "natGatewayId", "type": "string" } }, { "name": "transitGatewayId", "type": "string", "info": "The ID of a transit gateway.", "required": false, "schema": { "title": "transitGatewayId", "type": "string" } }, { "name": "networkInterfaceId", "type": "string", "info": "The ID of a network interface.", "required": false, "schema": { "title": "networkInterfaceId", "type": "string" } }, { "name": "routeTableId", "type": "string", "info": "The ID of the route table for the route.", "required": true, "schema": { "title": "routeTableId", "type": "string" } }, { "name": "vpcPeeringConnectionId", "type": "string", "info": "The ID of a VPC peering connection.", "required": false, "schema": { "title": "vpcPeeringConnectionId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createRouteSTSRole" }, "task": true }, { "name": "createRoutes", "summary": "Creates multiple routes 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 targ...(description truncated)", "description": "Creates multiple routes 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 targ...(description truncated)", "input": [ { "name": "routeArray", "type": "array", "info": "An array of objects(route parameters).", "required": true, "schema": { "title": "routeArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createRoutes" }, "task": true }, { "name": "createRoutesSTSRole", "summary": "Creates multiple routes 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 targ...(description truncated)", "description": "Creates multiple routes 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 targ...(description truncated)", "input": [ { "name": "routeArray", "type": "array", "info": "An array of objects(route parameters).", "required": true, "schema": { "title": "routeArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createRoutesSTSRole" }, "task": true }, { "name": "createRouteTable", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createRouteTable" }, "task": true }, { "name": "createRouteTableSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createRouteTableSTSRole" }, "task": true }, { "name": "createRouteTables", "summary": "Creates multiple route tables 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 .", "description": "Creates multiple route tables 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 .", "input": [ { "name": "routeTableArray", "type": "array", "info": "An array of objects(routeTable parameters).", "required": true, "schema": { "title": "routeTableArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createRouteTables" }, "task": true }, { "name": "createRouteTablesSTSRole", "summary": "Creates multiple route tables 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 .", "description": "Creates multiple route tables 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 .", "input": [ { "name": "routeTableArray", "type": "array", "info": "An array of objects(routeTable parameters).", "required": true, "schema": { "title": "routeTableArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createRouteTablesSTSRole" }, "task": true }, { "name": "createSecurityGroup", "summary": "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...(description truncated)", "description": "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...(description truncated)", "input": [ { "name": "groupDescription", "type": "string", "info": "A description for the security group. This is informational only. Constraints: Up to 255 characters in length Constraints for EC2-Classic: ASCII characters Constra...(description truncated)", "required": true, "schema": { "title": "groupDescription", "type": "string" } }, { "name": "groupName", "type": "string", "info": "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...(description truncated)", "required": true, "schema": { "title": "groupName", "type": "string" } }, { "name": "vpcId", "type": "string", "info": "[EC2-VPC] The ID of the VPC. Required for EC2-VPC.", "required": false, "schema": { "title": "vpcId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createSecurityGroup" }, "task": true }, { "name": "createSecurityGroupSTSRole", "summary": "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...(description truncated)", "description": "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...(description truncated)", "input": [ { "name": "groupDescription", "type": "string", "info": "A description for the security group. This is informational only. Constraints: Up to 255 characters in length Constraints for EC2-Classic: ASCII characters Constra...(description truncated)", "required": true, "schema": { "title": "groupDescription", "type": "string" } }, { "name": "groupName", "type": "string", "info": "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...(description truncated)", "required": true, "schema": { "title": "groupName", "type": "string" } }, { "name": "vpcId", "type": "string", "info": "[EC2-VPC] The ID of the VPC. Required for EC2-VPC.", "required": false, "schema": { "title": "vpcId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createSecurityGroupSTSRole" }, "task": true }, { "name": "createSecurityGroups", "summary": "Creates multiple security groups. 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...(description truncated)", "description": "Creates multiple security groups. 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...(description truncated)", "input": [ { "name": "securityGroupArray", "type": "array", "info": "A description for the security group. This is informational only. Constraints: Up to 255 characters in length Constraints for EC2-Classic: ASCII characters Constra...(description truncated)", "required": true, "schema": { "title": "securityGroupArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createSecurityGroups" }, "task": true }, { "name": "createSecurityGroupsSTSRole", "summary": "Creates multiple security groups. 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...(description truncated)", "description": "Creates multiple security groups. 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...(description truncated)", "input": [ { "name": "securityGroupArray", "type": "array", "info": "A description for the security group. This is informational only. Constraints: Up to 255 characters in length Constraints for EC2-Classic: ASCII characters Constra...(description truncated)", "required": true, "schema": { "title": "securityGroupArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createSecurityGroupsSTSRole" }, "task": true }, { "name": "createSnapshot", "summary": "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 i...(description truncated)", "description": "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 i...(description truncated)", "input": [ { "name": "description", "type": "string", "info": "A description for the snapshot.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "volumeId", "type": "string", "info": "The ID of the EBS volume.", "required": true, "schema": { "title": "volumeId", "type": "string" } }, { "name": "tagSpecification", "type": "array", "info": "The tags to apply to the snapshot during creation.", "required": false, "schema": { "title": "tagSpecification", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createSnapshot" }, "task": true }, { "name": "createSnapshotSTSRole", "summary": "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 i...(description truncated)", "description": "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 i...(description truncated)", "input": [ { "name": "description", "type": "string", "info": "A description for the snapshot.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "volumeId", "type": "string", "info": "The ID of the EBS volume.", "required": true, "schema": { "title": "volumeId", "type": "string" } }, { "name": "tagSpecification", "type": "array", "info": "The tags to apply to the snapshot during creation.", "required": false, "schema": { "title": "tagSpecification", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createSnapshotSTSRole" }, "task": true }, { "name": "createSnapshots", "summary": "Creates multiple snapshots of an EBS volume and stores it in Amazon S3.", "description": "Creates multiple snapshots of an EBS volume and stores it in Amazon S3.", "input": [ { "name": "SnapshotsArray", "type": "array", "info": "An array of objects(Snapshot parameters). description, volumeId, tagSpecification, dryRun", "required": true, "schema": { "title": "SnapshotsArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createSnapshots" }, "task": true }, { "name": "createSnapshotsSTSRole", "summary": "Creates multiple snapshots of an EBS volume and stores it in Amazon S3.", "description": "Creates multiple snapshots of an EBS volume and stores it in Amazon S3.", "input": [ { "name": "SnapshotsArray", "type": "array", "info": "An array of objects(Snapshot parameters). description, volumeId, tagSpecification, dryRun", "required": true, "schema": { "title": "SnapshotsArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createSnapshotsSTSRole" }, "task": true }, { "name": "createSpotDatafeedSubscription", "summary": "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 .", "description": "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 .", "input": [ { "name": "bucket", "type": "string", "info": "The Amazon S3 bucket in which to store the Spot Instance data feed.", "required": true, "schema": { "title": "bucket", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "prefix", "type": "string", "info": "A prefix for the data feed file names.", "required": false, "schema": { "title": "prefix", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createSpotDatafeedSubscription" }, "task": true }, { "name": "createSpotDatafeedSubscriptionSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "bucket", "type": "string", "info": "The Amazon S3 bucket in which to store the Spot Instance data feed.", "required": true, "schema": { "title": "bucket", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "prefix", "type": "string", "info": "A prefix for the data feed file names.", "required": false, "schema": { "title": "prefix", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createSpotDatafeedSubscriptionSTSRole" }, "task": true }, { "name": "createSpotDatafeedSubscriptions", "summary": "Creates multiple data feeds for Spot Instances, enabling you to view Spot Instance usage logs.", "description": "Creates multiple data feeds for Spot Instances, enabling you to view Spot Instance usage logs.", "input": [ { "name": "SpotDatafeedSubscriptionsArray", "type": "array", "info": "An array of objects(SpotDatafeedSubscription parameters). bucket, dryRun, prefix", "required": true, "schema": { "title": "SpotDatafeedSubscriptionsArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createSpotDatafeedSubscriptions" }, "task": true }, { "name": "createSpotDatafeedSubscriptionsSTSRole", "summary": "Creates multiple data feeds for Spot Instances, enabling you to view Spot Instance usage logs.", "description": "Creates multiple data feeds for Spot Instances, enabling you to view Spot Instance usage logs.", "input": [ { "name": "SpotDatafeedSubscriptionsArray", "type": "array", "info": "An array of objects(SpotDatafeedSubscription parameters). bucket, dryRun, prefix", "required": true, "schema": { "title": "SpotDatafeedSubscriptionsArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createSpotDatafeedSubscriptionsSTSRole" }, "task": true }, { "name": "createSubnet", "summary": "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 l...(description truncated)", "description": "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 l...(description truncated)", "input": [ { "name": "availabilityZone", "type": "string", "info": "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 ...(description truncated)", "required": false, "schema": { "title": "availabilityZone", "type": "string" } }, { "name": "availabilityZoneId", "type": "string", "info": "The AZ ID of the subnet.", "required": false, "schema": { "title": "availabilityZoneId", "type": "string" } }, { "name": "cidrBlock", "type": "string", "info": "The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24 .", "required": true, "schema": { "title": "cidrBlock", "type": "string" } }, { "name": "ipv6CidrBlock", "type": "string", "info": "The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length.", "required": false, "schema": { "title": "ipv6CidrBlock", "type": "string" } }, { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createSubnet" }, "task": true }, { "name": "createSubnetSTSRole", "summary": "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 l...(description truncated)", "description": "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 l...(description truncated)", "input": [ { "name": "availabilityZone", "type": "string", "info": "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 ...(description truncated)", "required": false, "schema": { "title": "availabilityZone", "type": "string" } }, { "name": "availabilityZoneId", "type": "string", "info": "The AZ ID of the subnet.", "required": false, "schema": { "title": "availabilityZoneId", "type": "string" } }, { "name": "cidrBlock", "type": "string", "info": "The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24 .", "required": true, "schema": { "title": "cidrBlock", "type": "string" } }, { "name": "ipv6CidrBlock", "type": "string", "info": "The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length.", "required": false, "schema": { "title": "ipv6CidrBlock", "type": "string" } }, { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createSubnetSTSRole" }, "task": true }, { "name": "createSubnets", "summary": "Creates subnets 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 l...(description truncated)", "description": "Creates subnets 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 l...(description truncated)", "input": [ { "name": "subnetArray", "type": "array", "info": "An array of objects(subnet parameters).", "required": true, "schema": { "title": "subnetArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createSubnets" }, "task": true }, { "name": "createSubnetsSTSRole", "summary": "Creates subnets 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 l...(description truncated)", "description": "Creates subnets 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 l...(description truncated)", "input": [ { "name": "subnetArray", "type": "array", "info": "An array of objects(subnet parameters).", "required": true, "schema": { "title": "subnetArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createSubnetsSTSRole" }, "task": true }, { "name": "createTags", "summary": "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 ...(description truncated)", "description": "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 ...(description truncated)", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "resourceId", "type": "array", "info": "The IDs of the resources, separated by spaces. Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.", "required": true, "schema": { "title": "resourceId", "type": "array" } }, { "name": "tag", "type": "array", "info": "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.", "required": true, "schema": { "title": "tag", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createTags" }, "task": true }, { "name": "createTagsSTSRole", "summary": "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 ...(description truncated)", "description": "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 ...(description truncated)", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "resourceId", "type": "array", "info": "The IDs of the resources, separated by spaces. Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.", "required": true, "schema": { "title": "resourceId", "type": "array" } }, { "name": "tag", "type": "array", "info": "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.", "required": true, "schema": { "title": "tag", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createTagsSTSRole" }, "task": true }, { "name": "createMultipleTags", "summary": "Adds or overwrites multiple specified tags for the specified Amazon EC2 resource or resources.", "description": "Adds or overwrites multiple specified tags for the specified Amazon EC2 resource or resources.", "input": [ { "name": "MultipleTagsArray", "type": "array", "info": "An array of objects(Tags parameters). dryRun, resourceId, tag", "required": true, "schema": { "title": "MultipleTagsArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createMultipleTags" }, "task": true }, { "name": "createMultipleTagsSTSRole", "summary": "Adds or overwrites multiple specified tags for the specified Amazon EC2 resource or resources.", "description": "Adds or overwrites multiple specified tags for the specified Amazon EC2 resource or resources.", "input": [ { "name": "MultipleTagsArray", "type": "array", "info": "An array of objects(Tags parameters). dryRun, resourceId, tag", "required": true, "schema": { "title": "MultipleTagsArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createMultipleTagsSTSRole" }, "task": true }, { "name": "createTransitGateway", "summary": "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 t...(description truncated)", "description": "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 t...(description truncated)", "input": [ { "name": "description", "type": "string", "info": "A description of the transit gateway.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "optionsAmazonSideAsn", "type": "string", "info": "Describes the options for a transit gateway.\nA private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs an...(description truncated)", "required": false, "schema": { "title": "optionsAmazonSideAsn", "type": "string" } }, { "name": "optionsAutoAcceptSharedAttachments", "type": "string", "info": "Describes the options for a transit gateway.\nEnable or disable automatic acceptance of attachment requests. The default is disable .", "required": false, "schema": { "title": "optionsAutoAcceptSharedAttachments", "type": "string" } }, { "name": "optionsDefaultRouteTableAssociation", "type": "string", "info": "Describes the options for a transit gateway.\nEnable or disable automatic association with the default association route table. The default is enable .", "required": false, "schema": { "title": "optionsDefaultRouteTableAssociation", "type": "string" } }, { "name": "optionsDefaultRouteTablePropagation", "type": "string", "info": "Describes the options for a transit gateway.\nEnable or disable automatic propagation of routes to the default propagation route table. The default is enable .", "required": false, "schema": { "title": "optionsDefaultRouteTablePropagation", "type": "string" } }, { "name": "optionsVpnEcmpSupport", "type": "string", "info": "Describes the options for a transit gateway.\nEnable or disable Equal Cost Multipath Protocol support.", "required": false, "schema": { "title": "optionsVpnEcmpSupport", "type": "string" } }, { "name": "optionsDnsSupport", "type": "string", "info": "Describes the options for a transit gateway.\nEnable or disable DNS support.", "required": false, "schema": { "title": "optionsDnsSupport", "type": "string" } }, { "name": "tagSpecification", "type": "array", "info": "The tags to apply to the transit gateway.", "required": false, "schema": { "title": "tagSpecification", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createTransitGateway" }, "task": true }, { "name": "createTransitGatewaySTSRole", "summary": "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 t...(description truncated)", "description": "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 t...(description truncated)", "input": [ { "name": "description", "type": "string", "info": "A description of the transit gateway.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "optionsAmazonSideAsn", "type": "string", "info": "Describes the options for a transit gateway.\nA private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs an...(description truncated)", "required": false, "schema": { "title": "optionsAmazonSideAsn", "type": "string" } }, { "name": "optionsAutoAcceptSharedAttachments", "type": "string", "info": "Describes the options for a transit gateway.\nEnable or disable automatic acceptance of attachment requests. The default is disable .", "required": false, "schema": { "title": "optionsAutoAcceptSharedAttachments", "type": "string" } }, { "name": "optionsDefaultRouteTableAssociation", "type": "string", "info": "Describes the options for a transit gateway.\nEnable or disable automatic association with the default association route table. The default is enable .", "required": false, "schema": { "title": "optionsDefaultRouteTableAssociation", "type": "string" } }, { "name": "optionsDefaultRouteTablePropagation", "type": "string", "info": "Describes the options for a transit gateway.\nEnable or disable automatic propagation of routes to the default propagation route table. The default is enable .", "required": false, "schema": { "title": "optionsDefaultRouteTablePropagation", "type": "string" } }, { "name": "optionsVpnEcmpSupport", "type": "string", "info": "Describes the options for a transit gateway.\nEnable or disable Equal Cost Multipath Protocol support.", "required": false, "schema": { "title": "optionsVpnEcmpSupport", "type": "string" } }, { "name": "optionsDnsSupport", "type": "string", "info": "Describes the options for a transit gateway.\nEnable or disable DNS support.", "required": false, "schema": { "title": "optionsDnsSupport", "type": "string" } }, { "name": "tagSpecification", "type": "array", "info": "The tags to apply to the transit gateway.", "required": false, "schema": { "title": "tagSpecification", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createTransitGatewaySTSRole" }, "task": true }, { "name": "createTransitGateways", "summary": "Creates multiple transit gateways", "description": "Creates multiple transit gateways", "input": [ { "name": "TransitGatewaysArray", "type": "array", "info": "An array of objects(TransitGateway parameters). description, optionsAmazonSideAsn, optionsAutoAcceptSharedAttachments, optionsDefaultRouteTableAssociation, optionsDefaultRouteTablePropagation, optionsVpnEcmpSupport, optionsDnsSupport, tagSpecification, dryRun", "required": true, "schema": { "title": "TransitGatewaysArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createTransitGateways" }, "task": true }, { "name": "createTransitGatewaysSTSRole", "summary": "Creates multiple transit gateways", "description": "Creates multiple transit gateways", "input": [ { "name": "TransitGatewaysArray", "type": "array", "info": "An array of objects(TransitGateway parameters). description, optionsAmazonSideAsn, optionsAutoAcceptSharedAttachments, optionsDefaultRouteTableAssociation, optionsDefaultRouteTablePropagation, optionsVpnEcmpSupport, optionsDnsSupport, tagSpecification, dryRun", "required": true, "schema": { "title": "TransitGatewaysArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createTransitGatewaysSTSRole" }, "task": true }, { "name": "createTransitGatewayRoute", "summary": "Creates a static route for the specified transit gateway route table.", "description": "Creates a static route for the specified transit gateway route table.", "input": [ { "name": "destinationCidrBlock", "type": "string", "info": "The CIDR range used for destination matches. Routing decisions are based on the most specific match.", "required": true, "schema": { "title": "destinationCidrBlock", "type": "string" } }, { "name": "transitGatewayRouteTableId", "type": "string", "info": "The ID of the transit gateway route table.", "required": true, "schema": { "title": "transitGatewayRouteTableId", "type": "string" } }, { "name": "transitGatewayAttachmentId", "type": "string", "info": "The ID of the attachment.", "required": false, "schema": { "title": "transitGatewayAttachmentId", "type": "string" } }, { "name": "blackhole", "type": "boolean", "info": "Indicates whether to drop traffic that matches this route.", "required": false, "schema": { "title": "blackhole", "type": "boolean" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createTransitGatewayRoute" }, "task": true }, { "name": "createTransitGatewayRouteSTSRole", "summary": "Creates a static route for the specified transit gateway route table.", "description": "Creates a static route for the specified transit gateway route table.", "input": [ { "name": "destinationCidrBlock", "type": "string", "info": "The CIDR range used for destination matches. Routing decisions are based on the most specific match.", "required": true, "schema": { "title": "destinationCidrBlock", "type": "string" } }, { "name": "transitGatewayRouteTableId", "type": "string", "info": "The ID of the transit gateway route table.", "required": true, "schema": { "title": "transitGatewayRouteTableId", "type": "string" } }, { "name": "transitGatewayAttachmentId", "type": "string", "info": "The ID of the attachment.", "required": false, "schema": { "title": "transitGatewayAttachmentId", "type": "string" } }, { "name": "blackhole", "type": "boolean", "info": "Indicates whether to drop traffic that matches this route.", "required": false, "schema": { "title": "blackhole", "type": "boolean" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createTransitGatewayRouteSTSRole" }, "task": true }, { "name": "createTransitGatewayRoutes", "summary": "Creates multiple static routes for the specified transit gateway route table.", "description": "Creates multiple static routes for the specified transit gateway route table.", "input": [ { "name": "TransitGatewayRoutesArray", "type": "array", "info": "An array of objects(TransitGatewayRoute parameters). destinationCidrBlock, transitGatewayRouteTableId, transitGatewayAttachmentId, blackhole, dryRun", "required": true, "schema": { "title": "TransitGatewayRoutesArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createTransitGatewayRoutes" }, "task": true }, { "name": "createTransitGatewayRoutesSTSRole", "summary": "Creates multiple static routes for the specified transit gateway route table.", "description": "Creates multiple static routes for the specified transit gateway route table.", "input": [ { "name": "TransitGatewayRoutesArray", "type": "array", "info": "An array of objects(TransitGatewayRoute parameters). destinationCidrBlock, transitGatewayRouteTableId, transitGatewayAttachmentId, blackhole, dryRun", "required": true, "schema": { "title": "TransitGatewayRoutesArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createTransitGatewayRoutesSTSRole" }, "task": true }, { "name": "createTransitGatewayRouteTable", "summary": "Creates a route table for the specified transit gateway.", "description": "Creates a route table for the specified transit gateway.", "input": [ { "name": "transitGatewayId", "type": "string", "info": "The ID of the transit gateway.", "required": true, "schema": { "title": "transitGatewayId", "type": "string" } }, { "name": "tagSpecifications", "type": "array", "info": "The tags to apply to the transit gateway route table.", "required": false, "schema": { "title": "tagSpecifications", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createTransitGatewayRouteTable" }, "task": true }, { "name": "createTransitGatewayRouteTableSTSRole", "summary": "Creates a route table for the specified transit gateway.", "description": "Creates a route table for the specified transit gateway.", "input": [ { "name": "transitGatewayId", "type": "string", "info": "The ID of the transit gateway.", "required": true, "schema": { "title": "transitGatewayId", "type": "string" } }, { "name": "tagSpecifications", "type": "array", "info": "The tags to apply to the transit gateway route table.", "required": false, "schema": { "title": "tagSpecifications", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createTransitGatewayRouteTableSTSRole" }, "task": true }, { "name": "createTransitGatewayRouteTables", "summary": "Creates multiple route tables for the specified transit gateway.", "description": "Creates multiple route tables for the specified transit gateway.", "input": [ { "name": "TransitGatewayRouteTablesArray", "type": "array", "info": "An array of objects(TransitGatewayRouteTable parameters). transitGatewayId, tagSpecifications, dryRun", "required": true, "schema": { "title": "TransitGatewayRouteTablesArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createTransitGatewayRouteTables" }, "task": true }, { "name": "createTransitGatewayRouteTablesSTSRole", "summary": "Creates multiple route tables for the specified transit gateway.", "description": "Creates multiple route tables for the specified transit gateway.", "input": [ { "name": "TransitGatewayRouteTablesArray", "type": "array", "info": "An array of objects(TransitGatewayRouteTable parameters). transitGatewayId, tagSpecifications, dryRun", "required": true, "schema": { "title": "TransitGatewayRouteTablesArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createTransitGatewayRouteTablesSTSRole" }, "task": true }, { "name": "createTransitGatewayVpcAttachment", "summary": "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 .", "description": "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 .", "input": [ { "name": "transitGatewayId", "type": "string", "info": "The ID of the transit gateway.", "required": true, "schema": { "title": "transitGatewayId", "type": "string" } }, { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } }, { "name": "subnetIds", "type": "array", "info": "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...(description truncated)", "required": true, "schema": { "title": "subnetIds", "type": "array" } }, { "name": "optionsDnsSupport", "type": "string", "info": "Describes the options for a VPC attachment.\nEnable or disable DNS support. The default is enable .", "required": false, "schema": { "title": "optionsDnsSupport", "type": "string" } }, { "name": "optionsIpv6Support", "type": "string", "info": "Describes the options for a VPC attachment.\nEnable or disable IPv6 support. The default is enable .", "required": false, "schema": { "title": "optionsIpv6Support", "type": "string" } }, { "name": "tagSpecifications", "type": "array", "info": "The tags to apply to the VPC attachment.", "required": false, "schema": { "title": "tagSpecifications", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createTransitGatewayVpcAttachment" }, "task": true }, { "name": "createTransitGatewayVpcAttachmentSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "transitGatewayId", "type": "string", "info": "The ID of the transit gateway.", "required": true, "schema": { "title": "transitGatewayId", "type": "string" } }, { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } }, { "name": "subnetIds", "type": "array", "info": "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...(description truncated)", "required": true, "schema": { "title": "subnetIds", "type": "array" } }, { "name": "optionsDnsSupport", "type": "string", "info": "Describes the options for a VPC attachment.\nEnable or disable DNS support. The default is enable .", "required": false, "schema": { "title": "optionsDnsSupport", "type": "string" } }, { "name": "optionsIpv6Support", "type": "string", "info": "Describes the options for a VPC attachment.\nEnable or disable IPv6 support. The default is enable .", "required": false, "schema": { "title": "optionsIpv6Support", "type": "string" } }, { "name": "tagSpecifications", "type": "array", "info": "The tags to apply to the VPC attachment.", "required": false, "schema": { "title": "tagSpecifications", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createTransitGatewayVpcAttachmentSTSRole" }, "task": true }, { "name": "createTransitGatewayVpcAttachments", "summary": "Attaches the specified VPCs to the specified transit gateway. ", "description": "Attaches the specified VPCs to the specified transit gateway. ", "input": [ { "name": "TransitGatewayVpcAttachmentsArray", "type": "array", "info": "An array of objects(TransitGatewayVpcAttachment parameters). transitGatewayId, vpcId, subnetIds, optionsDnsSupport, optionsIpv6Support, tagSpecifications, dryRun", "required": true, "schema": { "title": "TransitGatewayVpcAttachmentsArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createTransitGatewayVpcAttachments" }, "task": true }, { "name": "createTransitGatewayVpcAttachmentsSTSRole", "summary": "Attaches the specified VPCs to the specified transit gateway. ", "description": "Attaches the specified VPCs to the specified transit gateway. ", "input": [ { "name": "TransitGatewayVpcAttachmentsArray", "type": "array", "info": "An array of objects(TransitGatewayVpcAttachment parameters). transitGatewayId, vpcId, subnetIds, optionsDnsSupport, optionsIpv6Support, tagSpecifications, dryRun", "required": true, "schema": { "title": "TransitGatewayVpcAttachmentsArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createTransitGatewayVpcAttachmentsSTSRole" }, "task": true }, { "name": "createVolume", "summary": "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 with the Encrypted parameter. Encrypted volumes may only be attached to instances...(description truncated)", "description": "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 with the Encrypted parameter. Encrypted volumes may only be attached to instances...(description truncated)", "input": [ { "name": "availabilityZone", "type": "string", "info": "The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.", "required": true, "schema": { "title": "availabilityZone", "type": "string" } }, { "name": "encrypted", "type": "boolean", "info": "Specifies whether the volume should be encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are crea...(description truncated)", "required": false, "schema": { "title": "encrypted", "type": "boolean" } }, { "name": "iops", "type": "number", "info": "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....(description truncated)", "required": false, "schema": { "title": "iops", "type": "number" } }, { "name": "kmsKeyId", "type": "string", "info": "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 wa...(description truncated)", "required": false, "schema": { "title": "kmsKeyId", "type": "string" } }, { "name": "size", "type": "number", "info": "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 sp...(description truncated)", "required": false, "schema": { "title": "size", "type": "number" } }, { "name": "snapshotId", "type": "string", "info": "The snapshot from which to create the volume. At least one of Size or SnapshotId are required.", "required": false, "schema": { "title": "snapshotId", "type": "string" } }, { "name": "volumeType", "type": "string", "info": "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 Mag...(description truncated)", "required": false, "schema": { "title": "volumeType", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "tagSpecification", "type": "array", "info": "The tags to apply to the volume during creation.", "required": false, "schema": { "title": "tagSpecification", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVolume" }, "task": true }, { "name": "createVolumeSTSRole", "summary": "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 with the Encrypted parameter. Encrypted volumes may only be attached to instances...(description truncated)", "description": "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 with the Encrypted parameter. Encrypted volumes may only be attached to instances...(description truncated)", "input": [ { "name": "availabilityZone", "type": "string", "info": "The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.", "required": true, "schema": { "title": "availabilityZone", "type": "string" } }, { "name": "encrypted", "type": "boolean", "info": "Specifies whether the volume should be encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are crea...(description truncated)", "required": false, "schema": { "title": "encrypted", "type": "boolean" } }, { "name": "iops", "type": "number", "info": "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....(description truncated)", "required": false, "schema": { "title": "iops", "type": "number" } }, { "name": "kmsKeyId", "type": "string", "info": "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 wa...(description truncated)", "required": false, "schema": { "title": "kmsKeyId", "type": "string" } }, { "name": "size", "type": "number", "info": "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 sp...(description truncated)", "required": false, "schema": { "title": "size", "type": "number" } }, { "name": "snapshotId", "type": "string", "info": "The snapshot from which to create the volume. At least one of Size or SnapshotId are required.", "required": false, "schema": { "title": "snapshotId", "type": "string" } }, { "name": "volumeType", "type": "string", "info": "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 Mag...(description truncated)", "required": false, "schema": { "title": "volumeType", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "tagSpecification", "type": "array", "info": "The tags to apply to the volume during creation.", "required": false, "schema": { "title": "tagSpecification", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVolumeSTSRole" }, "task": true }, { "name": "createVolumes", "summary": "Creates multiple EBS volumes that can be attached to an instance in the same Availability Zone.", "description": "Creates multiple EBS volumes that can be attached to an instance in the same Availability Zone.", "input": [ { "name": "TransitGatewayVpcAttachmentssArray", "type": "array", "info": "An array of objects(Volume parameters). availabilityZone, encrypted, iops, kmsKeyId, size, snapshotId, volumeType, dryRun, tagSpecification", "required": true, "schema": { "title": "TransitGatewayVpcAttachmentssArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVolumes" }, "task": true }, { "name": "createVolumesSTSRole", "summary": "Creates multiple EBS volumes that can be attached to an instance in the same Availability Zone.", "description": "Creates multiple EBS volumes that can be attached to an instance in the same Availability Zone.", "input": [ { "name": "TransitGatewayVpcAttachmentssArray", "type": "array", "info": "An array of objects(Volume parameters). availabilityZone, encrypted, iops, kmsKeyId, size, snapshotId, volumeType, dryRun, tagSpecification", "required": true, "schema": { "title": "TransitGatewayVpcAttachmentssArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVolumesSTSRole" }, "task": true }, { "name": "createVpc", "summary": "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 can...(description truncated)", "description": "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 can...(description truncated)", "input": [ { "name": "cidrBlock", "type": "string", "info": "The IPv4 network range for the VPC, in CIDR notation. For example, 10.0.0.0/16 .", "required": true, "schema": { "title": "cidrBlock", "type": "string" } }, { "name": "amazonProvidedIpv6CidrBlock", "type": "boolean", "info": "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.", "required": false, "schema": { "title": "amazonProvidedIpv6CidrBlock", "type": "boolean" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "instanceTenancy", "type": "string", "info": "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 ...(description truncated)", "required": false, "schema": { "title": "instanceTenancy", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVpc" }, "task": true }, { "name": "createVpcSTSRole", "summary": "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 can...(description truncated)", "description": "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 can...(description truncated)", "input": [ { "name": "cidrBlock", "type": "string", "info": "The IPv4 network range for the VPC, in CIDR notation. For example, 10.0.0.0/16 .", "required": true, "schema": { "title": "cidrBlock", "type": "string" } }, { "name": "amazonProvidedIpv6CidrBlock", "type": "boolean", "info": "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.", "required": false, "schema": { "title": "amazonProvidedIpv6CidrBlock", "type": "boolean" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "instanceTenancy", "type": "string", "info": "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 ...(description truncated)", "required": false, "schema": { "title": "instanceTenancy", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVpcSTSRole" }, "task": true }, { "name": "createVpcs", "summary": "Creates VPCs 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 can...(description truncated)", "description": "Creates VPCs 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 can...(description truncated)", "input": [ { "name": "vpcArray", "type": "array", "info": "An array of objects(vpc parameters). cidrBlock, amazonProvidedIpv6CidrBlock, dryRun, instanceTenancy. ", "required": true, "schema": { "title": "vpcArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVpcs" }, "task": true }, { "name": "createVpcsSTSRole", "summary": "Creates VPCs 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 can...(description truncated)", "description": "Creates VPCs 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 can...(description truncated)", "input": [ { "name": "vpcArray", "type": "array", "info": "An array of objects(vpc parameters). cidrBlock, amazonProvidedIpv6CidrBlock, dryRun, instanceTenancy. ", "required": true, "schema": { "title": "vpcArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVpcsSTSRole" }, "task": true }, { "name": "createVpcEndpoint", "summary": "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 ...(description truncated)", "description": "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 ...(description truncated)", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "vpcEndpointType", "type": "string", "info": "The type of endpoint. Default: Gateway", "required": false, "schema": { "title": "vpcEndpointType", "type": "string" } }, { "name": "vpcId", "type": "string", "info": "The ID of the VPC in which the endpoint will be used.", "required": true, "schema": { "title": "vpcId", "type": "string" } }, { "name": "serviceName", "type": "string", "info": "The service name. To get a list of available services, use the DescribeVpcEndpointServices request, or get the name from the service provider.", "required": true, "schema": { "title": "serviceName", "type": "string" } }, { "name": "policyDocument", "type": "string", "info": "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 p...(description truncated)", "required": false, "schema": { "title": "policyDocument", "type": "string" } }, { "name": "routeTableId", "type": "array", "info": "(Gateway endpoint) One or more route table IDs.", "required": false, "schema": { "title": "routeTableId", "type": "array" } }, { "name": "subnetId", "type": "array", "info": "(Interface endpoint) The ID of one or more subnets in which to create an endpoint network interface.", "required": false, "schema": { "title": "subnetId", "type": "array" } }, { "name": "securityGroupId", "type": "array", "info": "(Interface endpoint) The ID of one or more security groups to associate with the endpoint network interface.", "required": false, "schema": { "title": "securityGroupId", "type": "array" } }, { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency .", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "privateDnsEnabled", "type": "boolean", "info": "(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...(description truncated)", "required": false, "schema": { "title": "privateDnsEnabled", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVpcEndpoint" }, "task": true }, { "name": "createVpcEndpointSTSRole", "summary": "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 ...(description truncated)", "description": "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 ...(description truncated)", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "vpcEndpointType", "type": "string", "info": "The type of endpoint. Default: Gateway", "required": false, "schema": { "title": "vpcEndpointType", "type": "string" } }, { "name": "vpcId", "type": "string", "info": "The ID of the VPC in which the endpoint will be used.", "required": true, "schema": { "title": "vpcId", "type": "string" } }, { "name": "serviceName", "type": "string", "info": "The service name. To get a list of available services, use the DescribeVpcEndpointServices request, or get the name from the service provider.", "required": true, "schema": { "title": "serviceName", "type": "string" } }, { "name": "policyDocument", "type": "string", "info": "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 p...(description truncated)", "required": false, "schema": { "title": "policyDocument", "type": "string" } }, { "name": "routeTableId", "type": "array", "info": "(Gateway endpoint) One or more route table IDs.", "required": false, "schema": { "title": "routeTableId", "type": "array" } }, { "name": "subnetId", "type": "array", "info": "(Interface endpoint) The ID of one or more subnets in which to create an endpoint network interface.", "required": false, "schema": { "title": "subnetId", "type": "array" } }, { "name": "securityGroupId", "type": "array", "info": "(Interface endpoint) The ID of one or more security groups to associate with the endpoint network interface.", "required": false, "schema": { "title": "securityGroupId", "type": "array" } }, { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency .", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "privateDnsEnabled", "type": "boolean", "info": "(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...(description truncated)", "required": false, "schema": { "title": "privateDnsEnabled", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVpcEndpointSTSRole" }, "task": true }, { "name": "createVpcEndpoints", "summary": "Creates multiple VPC endpoints for a specified service.", "description": "Creates multiple VPC endpoints for a specified service.", "input": [ { "name": "createVpcEndpointsArray", "type": "array", "info": "An array of objects(VpcEndpoint parameters). dryRun, vpcEndpointType, vpcId, serviceName, policyDocument, routeTableId, subnetId, securityGroupId, clientToken, privateDnsEnabled", "required": true, "schema": { "title": "createVpcEndpointsArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVpcEndpoints" }, "task": true }, { "name": "createVpcEndpointsSTSRole", "summary": "Creates multiple VPC endpoints for a specified service.", "description": "Creates multiple VPC endpoints for a specified service.", "input": [ { "name": "createVpcEndpointsArray", "type": "array", "info": "An array of objects(VpcEndpoint parameters). dryRun, vpcEndpointType, vpcId, serviceName, policyDocument, routeTableId, subnetId, securityGroupId, clientToken, privateDnsEnabled", "required": true, "schema": { "title": "createVpcEndpointsArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVpcEndpointsSTSRole" }, "task": true }, { "name": "createVpcEndpointConnectionNotification", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "serviceId", "type": "string", "info": "The ID of the endpoint service.", "required": false, "schema": { "title": "serviceId", "type": "string" } }, { "name": "vpcEndpointId", "type": "string", "info": "The ID of the endpoint.", "required": false, "schema": { "title": "vpcEndpointId", "type": "string" } }, { "name": "connectionNotificationArn", "type": "string", "info": "The ARN of the SNS topic for the notifications.", "required": true, "schema": { "title": "connectionNotificationArn", "type": "string" } }, { "name": "connectionEvents", "type": "array", "info": "One or more endpoint events for which to receive notifications. Valid values are Accept , Connect , Delete , and Reject .", "required": true, "schema": { "title": "connectionEvents", "type": "array" } }, { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency .", "required": false, "schema": { "title": "clientToken", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVpcEndpointConnectionNotification" }, "task": true }, { "name": "createVpcEndpointConnectionNotificationSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "serviceId", "type": "string", "info": "The ID of the endpoint service.", "required": false, "schema": { "title": "serviceId", "type": "string" } }, { "name": "vpcEndpointId", "type": "string", "info": "The ID of the endpoint.", "required": false, "schema": { "title": "vpcEndpointId", "type": "string" } }, { "name": "connectionNotificationArn", "type": "string", "info": "The ARN of the SNS topic for the notifications.", "required": true, "schema": { "title": "connectionNotificationArn", "type": "string" } }, { "name": "connectionEvents", "type": "array", "info": "One or more endpoint events for which to receive notifications. Valid values are Accept , Connect , Delete , and Reject .", "required": true, "schema": { "title": "connectionEvents", "type": "array" } }, { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency .", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVpcEndpointConnectionNotificationSTSRole" }, "task": true }, { "name": "createVpcEndpointConnectionNotifications", "summary": "Creates multiple connection notifications for a specified VPC endpoint or VPC endpoint service.", "description": "Creates multiple connection notifications for a specified VPC endpoint or VPC endpoint service.", "input": [ { "name": "createVpcEndpointConnectionNotificationsArray", "type": "array", "info": "An array of objects(VpcEndpointConnectionNotification parameters). dryRun, serviceId, vpcEndpointId, connectionNotificationArn, connectionEvents, clientToken", "required": true, "schema": { "title": "createVpcEndpointConnectionNotificationsArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVpcEndpointConnectionNotifications" }, "task": true }, { "name": "createVpcEndpointConnectionNotificationsSTSRole", "summary": "Creates multiple connection notifications for a specified VPC endpoint or VPC endpoint service.", "description": "Creates multiple connection notifications for a specified VPC endpoint or VPC endpoint service.", "input": [ { "name": "createVpcEndpointConnectionNotificationsArray", "type": "array", "info": "An array of objects(VpcEndpointConnectionNotification parameters). dryRun, serviceId, vpcEndpointId, connectionNotificationArn, connectionEvents, clientToken", "required": true, "schema": { "title": "createVpcEndpointConnectionNotificationsArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVpcEndpointConnectionNotificationsSTSRole" }, "task": true }, { "name": "createVpcEndpointServiceConfiguration", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "acceptanceRequired", "type": "boolean", "info": "Indicate whether requests from service consumers to create an endpoint to your service must be accepted. To accept a request, use AcceptVpcEndpointConnections .", "required": false, "schema": { "title": "acceptanceRequired", "type": "boolean" } }, { "name": "networkLoadBalancerArn", "type": "array", "info": "The Amazon Resource Names (ARNs) of one or more Network Load Balancers for your service.", "required": true, "schema": { "title": "networkLoadBalancerArn", "type": "array" } }, { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency .", "required": false, "schema": { "title": "clientToken", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVpcEndpointServiceConfiguration" }, "task": true }, { "name": "createVpcEndpointServiceConfigurationSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "acceptanceRequired", "type": "boolean", "info": "Indicate whether requests from service consumers to create an endpoint to your service must be accepted. To accept a request, use AcceptVpcEndpointConnections .", "required": false, "schema": { "title": "acceptanceRequired", "type": "boolean" } }, { "name": "networkLoadBalancerArn", "type": "array", "info": "The Amazon Resource Names (ARNs) of one or more Network Load Balancers for your service.", "required": true, "schema": { "title": "networkLoadBalancerArn", "type": "array" } }, { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency .", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVpcEndpointServiceConfigurationSTSRole" }, "task": true }, { "name": "createVpcEndpointServiceConfigurations", "summary": "Creates multiple VPC endpoint service configurations to which service consumers (AWS accounts, IAM users, and IAM roles) can connect.", "description": "Creates multiple VPC endpoint service configurations to which service consumers (AWS accounts, IAM users, and IAM roles) can connect.", "input": [ { "name": "createVpcEndpointServiceConfigurationsArray", "type": "array", "info": "An array of objects(VpcEndpointServiceConfiguration parameters). dryRun, acceptanceRequired, networkLoadBalancerArn, clientToken", "required": true, "schema": { "title": "createVpcEndpointServiceConfigurationsArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVpcEndpointServiceConfigurations" }, "task": true }, { "name": "createVpcEndpointServiceConfigurationsSTSRole", "summary": "Creates multiple VPC endpoint service configurations to which service consumers (AWS accounts, IAM users, and IAM roles) can connect.", "description": "Creates multiple VPC endpoint service configurations to which service consumers (AWS accounts, IAM users, and IAM roles) can connect.", "input": [ { "name": "createVpcEndpointServiceConfigurationsArray", "type": "array", "info": "An array of objects(VpcEndpointServiceConfiguration parameters). dryRun, acceptanceRequired, networkLoadBalancerArn, clientToken", "required": true, "schema": { "title": "createVpcEndpointServiceConfigurationsArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVpcEndpointServiceConfigurationsSTSRole" }, "task": true }, { "name": "createVpcPeeringConnection", "summary": "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 acc...(description truncated)", "description": "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 acc...(description truncated)", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "peerOwnerId", "type": "string", "info": "The AWS account ID of the owner of the accepter VPC. Default: Your AWS account ID", "required": false, "schema": { "title": "peerOwnerId", "type": "string" } }, { "name": "peerVpcId", "type": "string", "info": "The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request.", "required": false, "schema": { "title": "peerVpcId", "type": "string" } }, { "name": "vpcId", "type": "string", "info": "The ID of the requester VPC. You must specify this parameter in the request.", "required": false, "schema": { "title": "vpcId", "type": "string" } }, { "name": "peerRegion", "type": "string", "info": "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 ...(description truncated)", "required": false, "schema": { "title": "peerRegion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVpcPeeringConnection" }, "task": true }, { "name": "createVpcPeeringConnectionSTSRole", "summary": "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 acc...(description truncated)", "description": "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 acc...(description truncated)", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "peerOwnerId", "type": "string", "info": "The AWS account ID of the owner of the accepter VPC. Default: Your AWS account ID", "required": false, "schema": { "title": "peerOwnerId", "type": "string" } }, { "name": "peerVpcId", "type": "string", "info": "The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request.", "required": false, "schema": { "title": "peerVpcId", "type": "string" } }, { "name": "vpcId", "type": "string", "info": "The ID of the requester VPC. You must specify this parameter in the request.", "required": false, "schema": { "title": "vpcId", "type": "string" } }, { "name": "peerRegion", "type": "string", "info": "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 ...(description truncated)", "required": false, "schema": { "title": "peerRegion", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVpcPeeringConnectionSTSRole" }, "task": true }, { "name": "createVpcPeeringConnections", "summary": "Requests multiple VPC peering connections between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection.", "description": "Requests multiple VPC peering connections between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection.", "input": [ { "name": "createVpcPeeringConnectionsArray", "type": "array", "info": "An array of objects(VpcPeeringConnection parameters). dryRun, peerOwnerId, peerVpcId, vpcId, peerRegion", "required": true, "schema": { "title": "createVpcPeeringConnectionsArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVpcPeeringConnections" }, "task": true }, { "name": "createVpcPeeringConnectionsSTSRole", "summary": "Requests multiple VPC peering connections between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection.", "description": "Requests multiple VPC peering connections between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection.", "input": [ { "name": "createVpcPeeringConnectionsArray", "type": "array", "info": "An array of objects(VpcPeeringConnection parameters). dryRun, peerOwnerId, peerVpcId, vpcId, peerRegion", "required": true, "schema": { "title": "createVpcPeeringConnectionsArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVpcPeeringConnectionsSTSRole" }, "task": true }, { "name": "createVpnConnection", "summary": "Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The only supported connection type 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 ...(description truncated)", "description": "Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The only supported connection type 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 ...(description truncated)", "input": [ { "name": "customerGatewayId", "type": "string", "info": "The ID of the customer gateway.", "required": true, "schema": { "title": "customerGatewayId", "type": "string" } }, { "name": "type", "type": "string", "info": "The type of VPN connection ( ipsec.1 ).", "required": true, "schema": { "title": "type", "type": "string" } }, { "name": "vpnGatewayId", "type": "string", "info": "The ID of the virtual private gateway. If you specify a virtual private gateway, you cannot specify a transit gateway.", "required": false, "schema": { "title": "vpnGatewayId", "type": "string" } }, { "name": "transitGatewayId", "type": "string", "info": "The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private gateway.", "required": false, "schema": { "title": "transitGatewayId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "optionsStaticRoutesOnly", "type": "boolean", "info": "Describes VPN connection options.\n Indicate whether the VPN connection uses static routes only. If you are creating a VPN connection for a device that does not support BG...(description truncated)", "required": false, "schema": { "title": "optionsStaticRoutesOnly", "type": "boolean" } }, { "name": "optionsTunnelOptions", "type": "array", "info": "Describes VPN connection options.\nThe tunnel options for the VPN connection.", "required": false, "schema": { "title": "optionsTunnelOptions", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVpnConnection" }, "task": true }, { "name": "createVpnConnectionSTSRole", "summary": "Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The only supported connection type 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 ...(description truncated)", "description": "Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The only supported connection type 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 ...(description truncated)", "input": [ { "name": "customerGatewayId", "type": "string", "info": "The ID of the customer gateway.", "required": true, "schema": { "title": "customerGatewayId", "type": "string" } }, { "name": "type", "type": "string", "info": "The type of VPN connection ( ipsec.1 ).", "required": true, "schema": { "title": "type", "type": "string" } }, { "name": "vpnGatewayId", "type": "string", "info": "The ID of the virtual private gateway. If you specify a virtual private gateway, you cannot specify a transit gateway.", "required": false, "schema": { "title": "vpnGatewayId", "type": "string" } }, { "name": "transitGatewayId", "type": "string", "info": "The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private gateway.", "required": false, "schema": { "title": "transitGatewayId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "optionsStaticRoutesOnly", "type": "boolean", "info": "Describes VPN connection options.\n Indicate whether the VPN connection uses static routes only. If you are creating a VPN connection for a device that does not support BG...(description truncated)", "required": false, "schema": { "title": "optionsStaticRoutesOnly", "type": "boolean" } }, { "name": "optionsTunnelOptions", "type": "array", "info": "Describes VPN connection options.\nThe tunnel options for the VPN connection.", "required": false, "schema": { "title": "optionsTunnelOptions", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVpnConnectionSTSRole" }, "task": true }, { "name": "createVpnConnections", "summary": "Creates multiple VPN connections between an existing virtual private gateway and a VPN customer gateway. The only supported connection type is ipsec.1 .", "description": "Creates multiple VPN connections between an existing virtual private gateway and a VPN customer gateway. The only supported connection type is ipsec.1 .", "input": [ { "name": "createVpnConnectionsArray", "type": "array", "info": "An array of objects(VpnConnection parameters). customerGatewayId, type, vpnGatewayId, transitGatewayId, dryRun, optionsStaticRoutesOnly, optionsTunnelOptions", "required": true, "schema": { "title": "createVpnConnectionsArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVpnConnections" }, "task": true }, { "name": "createVpnConnectionsSTSRole", "summary": "Creates multiple VPN connections between an existing virtual private gateway and a VPN customer gateway. The only supported connection type is ipsec.1 .", "description": "Creates multiple VPN connections between an existing virtual private gateway and a VPN customer gateway. The only supported connection type is ipsec.1 .", "input": [ { "name": "createVpnConnectionsArray", "type": "array", "info": "An array of objects(VpnConnection parameters). customerGatewayId, type, vpnGatewayId, transitGatewayId, dryRun, optionsStaticRoutesOnly, optionsTunnelOptions", "required": true, "schema": { "title": "createVpnConnectionsArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVpnConnectionsSTSRole" }, "task": true }, { "name": "createVpnConnectionRoute", "summary": "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 .", "description": "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 .", "input": [ { "name": "destinationCidrBlock", "type": "string", "info": "The CIDR block associated with the local subnet of the customer network.", "required": true, "schema": { "title": "destinationCidrBlock", "type": "string" } }, { "name": "vpnConnectionId", "type": "string", "info": "The ID of the VPN connection.", "required": true, "schema": { "title": "vpnConnectionId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVpnConnectionRoute" }, "task": true }, { "name": "createVpnConnectionRouteSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "destinationCidrBlock", "type": "string", "info": "The CIDR block associated with the local subnet of the customer network.", "required": true, "schema": { "title": "destinationCidrBlock", "type": "string" } }, { "name": "vpnConnectionId", "type": "string", "info": "The ID of the VPN connection.", "required": true, "schema": { "title": "vpnConnectionId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVpnConnectionRouteSTSRole" }, "task": true }, { "name": "createVpnConnectionRoutes", "summary": "Creates multiple static routes 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.", "description": "Creates multiple static routes 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.", "input": [ { "name": "createVpnConnectionRoutesArray", "type": "array", "info": "An array of objects(VpnConnection parameters). destinationCidrBlock, vpnConnectionId", "required": true, "schema": { "title": "createVpnConnectionRoutesArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVpnConnectionRoutes" }, "task": true }, { "name": "createVpnConnectionRoutesSTSRole", "summary": "Creates multiple static routes 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.", "description": "Creates multiple static routes 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.", "input": [ { "name": "createVpnConnectionRoutesArray", "type": "array", "info": "An array of objects(VpnConnection parameters). destinationCidrBlock, vpnConnectionId", "required": true, "schema": { "title": "createVpnConnectionRoutesArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVpnConnectionRoutesSTSRole" }, "task": true }, { "name": "createVpnGateway", "summary": "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 .", "description": "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 .", "input": [ { "name": "availabilityZone", "type": "string", "info": "The Availability Zone for the virtual private gateway.", "required": false, "schema": { "title": "availabilityZone", "type": "string" } }, { "name": "type", "type": "string", "info": "The type of VPN connection this virtual private gateway supports.", "required": true, "schema": { "title": "type", "type": "string" } }, { "name": "amazonSideAsn", "type": "number", "info": "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...(description truncated)", "required": false, "schema": { "title": "amazonSideAsn", "type": "number" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVpnGateway" }, "task": true }, { "name": "createVpnGatewaySTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "availabilityZone", "type": "string", "info": "The Availability Zone for the virtual private gateway.", "required": false, "schema": { "title": "availabilityZone", "type": "string" } }, { "name": "type", "type": "string", "info": "The type of VPN connection this virtual private gateway supports.", "required": true, "schema": { "title": "type", "type": "string" } }, { "name": "amazonSideAsn", "type": "number", "info": "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...(description truncated)", "required": false, "schema": { "title": "amazonSideAsn", "type": "number" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVpnGatewaySTSRole" }, "task": true }, { "name": "createVpnGateways", "summary": "Creates multiple virtual private gateways.", "description": "Creates multiple virtual private gateways.", "input": [ { "name": "createVpnGatewaysArray", "type": "array", "info": "An array of objects(VpnConnection parameters). availabilityZone, type, amazonSideAsn, dryRun", "required": true, "schema": { "title": "createVpnGatewaysArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVpnGateways" }, "task": true }, { "name": "createVpnGatewaysSTSRole", "summary": "Creates multiple virtual private gateways.", "description": "Creates multiple virtual private gateways.", "input": [ { "name": "createVpnGatewaysArray", "type": "array", "info": "An array of objects(VpnConnection parameters). availabilityZone, type, amazonSideAsn, dryRun", "required": true, "schema": { "title": "createVpnGatewaysArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVpnGatewaysSTSRole" }, "task": true }, { "name": "deleteClientVpnEndpoint", "summary": "Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint.", "description": "Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint.", "input": [ { "name": "clientVpnEndpointId", "type": "string", "info": "The ID of the Client VPN to be deleted.", "required": true, "schema": { "title": "clientVpnEndpointId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteClientVpnEndpoint" }, "task": true }, { "name": "deleteClientVpnEndpointSTSRole", "summary": "Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint.", "description": "Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint.", "input": [ { "name": "clientVpnEndpointId", "type": "string", "info": "The ID of the Client VPN to be deleted.", "required": true, "schema": { "title": "clientVpnEndpointId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteClientVpnEndpointSTSRole" }, "task": true }, { "name": "deleteClientVpnRoute", "summary": "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.", "description": "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.", "input": [ { "name": "clientVpnEndpointId", "type": "string", "info": "The ID of the Client VPN endpoint from which the route is to be deleted.", "required": true, "schema": { "title": "clientVpnEndpointId", "type": "string" } }, { "name": "targetVpcSubnetId", "type": "string", "info": "The ID of the target subnet used by the route.", "required": false, "schema": { "title": "targetVpcSubnetId", "type": "string" } }, { "name": "destinationCidrBlock", "type": "string", "info": "The IPv4 address range, in CIDR notation, of the route to be deleted.", "required": true, "schema": { "title": "destinationCidrBlock", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteClientVpnRoute" }, "task": true }, { "name": "deleteClientVpnRouteSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "clientVpnEndpointId", "type": "string", "info": "The ID of the Client VPN endpoint from which the route is to be deleted.", "required": true, "schema": { "title": "clientVpnEndpointId", "type": "string" } }, { "name": "targetVpcSubnetId", "type": "string", "info": "The ID of the target subnet used by the route.", "required": false, "schema": { "title": "targetVpcSubnetId", "type": "string" } }, { "name": "destinationCidrBlock", "type": "string", "info": "The IPv4 address range, in CIDR notation, of the route to be deleted.", "required": true, "schema": { "title": "destinationCidrBlock", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteClientVpnRouteSTSRole" }, "task": true }, { "name": "deleteCustomerGateway", "summary": "Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.", "description": "Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.", "input": [ { "name": "customerGatewayId", "type": "string", "info": "The ID of the customer gateway.", "required": true, "schema": { "title": "customerGatewayId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteCustomerGateway" }, "task": true }, { "name": "deleteCustomerGatewaySTSRole", "summary": "Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.", "description": "Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.", "input": [ { "name": "customerGatewayId", "type": "string", "info": "The ID of the customer gateway.", "required": true, "schema": { "title": "customerGatewayId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteCustomerGatewaySTSRole" }, "task": true }, { "name": "deleteDhcpOptions", "summary": "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.", "description": "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.", "input": [ { "name": "dhcpOptionsId", "type": "string", "info": "The ID of the DHCP options set.", "required": true, "schema": { "title": "dhcpOptionsId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteDhcpOptions" }, "task": true }, { "name": "deleteDhcpOptionsSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "dhcpOptionsId", "type": "string", "info": "The ID of the DHCP options set.", "required": true, "schema": { "title": "dhcpOptionsId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteDhcpOptionsSTSRole" }, "task": true }, { "name": "deleteEgressOnlyInternetGateway", "summary": "Deletes an egress-only internet gateway.", "description": "Deletes an egress-only internet gateway.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "egressOnlyInternetGatewayId", "type": "string", "info": "The ID of the egress-only internet gateway.", "required": true, "schema": { "title": "egressOnlyInternetGatewayId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteEgressOnlyInternetGateway" }, "task": true }, { "name": "deleteEgressOnlyInternetGatewaySTSRole", "summary": "Deletes an egress-only internet gateway.", "description": "Deletes an egress-only internet gateway.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "egressOnlyInternetGatewayId", "type": "string", "info": "The ID of the egress-only internet gateway.", "required": true, "schema": { "title": "egressOnlyInternetGatewayId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteEgressOnlyInternetGatewaySTSRole" }, "task": true }, { "name": "deleteFleets", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "fleetId", "type": "array", "info": "The IDs of the EC2 Fleets.", "required": true, "schema": { "title": "fleetId", "type": "array" } }, { "name": "terminateInstances", "type": "boolean", "info": "Indicates whether to terminate instances for an EC2 Fleet if it is deleted successfully.", "required": true, "schema": { "title": "terminateInstances", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteFleets" }, "task": true }, { "name": "deleteFleetsSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "fleetId", "type": "array", "info": "The IDs of the EC2 Fleets.", "required": true, "schema": { "title": "fleetId", "type": "array" } }, { "name": "terminateInstances", "type": "boolean", "info": "Indicates whether to terminate instances for an EC2 Fleet if it is deleted successfully.", "required": true, "schema": { "title": "terminateInstances", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteFleetsSTSRole" }, "task": true }, { "name": "deleteFlowLogs", "summary": "Deletes one or more flow logs.", "description": "Deletes one or more flow logs.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "flowLogId", "type": "array", "info": "One or more flow log IDs.", "required": true, "schema": { "title": "flowLogId", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteFlowLogs" }, "task": true }, { "name": "deleteFlowLogsSTSRole", "summary": "Deletes one or more flow logs.", "description": "Deletes one or more flow logs.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "flowLogId", "type": "array", "info": "One or more flow log IDs.", "required": true, "schema": { "title": "flowLogId", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteFlowLogsSTSRole" }, "task": true }, { "name": "deleteFpgaImage", "summary": "Deletes the specified Amazon FPGA Image (AFI).", "description": "Deletes the specified Amazon FPGA Image (AFI).", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "fpgaImageId", "type": "string", "info": "The ID of the AFI.", "required": true, "schema": { "title": "fpgaImageId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteFpgaImage" }, "task": true }, { "name": "deleteFpgaImageSTSRole", "summary": "Deletes the specified Amazon FPGA Image (AFI).", "description": "Deletes the specified Amazon FPGA Image (AFI).", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "fpgaImageId", "type": "string", "info": "The ID of the AFI.", "required": true, "schema": { "title": "fpgaImageId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteFpgaImageSTSRole" }, "task": true }, { "name": "deleteInternetGateway", "summary": "Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it.", "description": "Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "internetGatewayId", "type": "string", "info": "The ID of the internet gateway.", "required": true, "schema": { "title": "internetGatewayId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteInternetGateway" }, "task": true }, { "name": "deleteInternetGatewaySTSRole", "summary": "Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it.", "description": "Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "internetGatewayId", "type": "string", "info": "The ID of the internet gateway.", "required": true, "schema": { "title": "internetGatewayId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteInternetGatewaySTSRole" }, "task": true }, { "name": "deleteInternetGateways", "summary": "Deletes multiple internet gateways. 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.", "description": "Deletes multiple internet gateways. 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.", "input": [ { "name": "internetGatewayArray", "type": "array", "info": "An array of objects. internetGatewayId, dryRun.", "required": true, "schema": { "title": "internetGatewayArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteInternetGateways" }, "task": true }, { "name": "deleteInternetGatewaysSTSRole", "summary": "Deletes multiple internet gateways. 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.", "description": "Deletes multiple internet gateways. 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.", "input": [ { "name": "internetGatewayArray", "type": "array", "info": "An array of objects. internetGatewayId, dryRun.", "required": true, "schema": { "title": "internetGatewayArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteInternetGatewaysSTSRole" }, "task": true }, { "name": "deleteKeyPair", "summary": "Deletes the specified key pair, by removing the public key from Amazon EC2.", "description": "Deletes the specified key pair, by removing the public key from Amazon EC2.", "input": [ { "name": "keyName", "type": "string", "info": "The name of the key pair.", "required": true, "schema": { "title": "keyName", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteKeyPair" }, "task": true }, { "name": "deleteKeyPairSTSRole", "summary": "Deletes the specified key pair, by removing the public key from Amazon EC2.", "description": "Deletes the specified key pair, by removing the public key from Amazon EC2.", "input": [ { "name": "keyName", "type": "string", "info": "The name of the key pair.", "required": true, "schema": { "title": "keyName", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteKeyPairSTSRole" }, "task": true }, { "name": "deleteLaunchTemplate", "summary": "Deletes a launch template. Deleting a launch template deletes all of its versions.", "description": "Deletes a launch template. Deleting a launch template deletes all of its versions.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "launchTemplateId", "type": "string", "info": "The ID of the launch template. You must specify either the launch template ID or launch template name in the request.", "required": false, "schema": { "title": "launchTemplateId", "type": "string" } }, { "name": "launchTemplateName", "type": "string", "info": "The name of the launch template. You must specify either the launch template ID or launch template name in the request.", "required": false, "schema": { "title": "launchTemplateName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteLaunchTemplate" }, "task": true }, { "name": "deleteLaunchTemplateSTSRole", "summary": "Deletes a launch template. Deleting a launch template deletes all of its versions.", "description": "Deletes a launch template. Deleting a launch template deletes all of its versions.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "launchTemplateId", "type": "string", "info": "The ID of the launch template. You must specify either the launch template ID or launch template name in the request.", "required": false, "schema": { "title": "launchTemplateId", "type": "string" } }, { "name": "launchTemplateName", "type": "string", "info": "The name of the launch template. You must specify either the launch template ID or launch template name in the request.", "required": false, "schema": { "title": "launchTemplateName", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteLaunchTemplateSTSRole" }, "task": true }, { "name": "deleteLaunchTemplateVersions", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "launchTemplateId", "type": "string", "info": "The ID of the launch template. You must specify either the launch template ID or launch template name in the request.", "required": false, "schema": { "title": "launchTemplateId", "type": "string" } }, { "name": "launchTemplateName", "type": "string", "info": "The name of the launch template. You must specify either the launch template ID or launch template name in the request.", "required": false, "schema": { "title": "launchTemplateName", "type": "string" } }, { "name": "launchTemplateVersion", "type": "array", "info": "The version numbers of one or more launch template versions to delete.", "required": true, "schema": { "title": "launchTemplateVersion", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteLaunchTemplateVersions" }, "task": true }, { "name": "deleteLaunchTemplateVersionsSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "launchTemplateId", "type": "string", "info": "The ID of the launch template. You must specify either the launch template ID or launch template name in the request.", "required": false, "schema": { "title": "launchTemplateId", "type": "string" } }, { "name": "launchTemplateName", "type": "string", "info": "The name of the launch template. You must specify either the launch template ID or launch template name in the request.", "required": false, "schema": { "title": "launchTemplateName", "type": "string" } }, { "name": "launchTemplateVersion", "type": "array", "info": "The version numbers of one or more launch template versions to delete.", "required": true, "schema": { "title": "launchTemplateVersion", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteLaunchTemplateVersionsSTSRole" }, "task": true }, { "name": "deleteNatGateway", "summary": "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.", "description": "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.", "input": [ { "name": "natGatewayId", "type": "string", "info": "The ID of the NAT gateway.", "required": true, "schema": { "title": "natGatewayId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNatGateway" }, "task": true }, { "name": "deleteNatGatewaySTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "natGatewayId", "type": "string", "info": "The ID of the NAT gateway.", "required": true, "schema": { "title": "natGatewayId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNatGatewaySTSRole" }, "task": true }, { "name": "deleteNetworkAcl", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "networkAclId", "type": "string", "info": "The ID of the network ACL.", "required": true, "schema": { "title": "networkAclId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNetworkAcl" }, "task": true }, { "name": "deleteNetworkAclSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "networkAclId", "type": "string", "info": "The ID of the network ACL.", "required": true, "schema": { "title": "networkAclId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNetworkAclSTSRole" }, "task": true }, { "name": "deleteNetworkAclEntry", "summary": "Deletes the specified ingress or egress entry (rule) from the specified network ACL.", "description": "Deletes the specified ingress or egress entry (rule) from the specified network ACL.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "egress", "type": "boolean", "info": "Indicates whether the rule is an egress rule.", "required": true, "schema": { "title": "egress", "type": "boolean" } }, { "name": "networkAclId", "type": "string", "info": "The ID of the network ACL.", "required": true, "schema": { "title": "networkAclId", "type": "string" } }, { "name": "ruleNumber", "type": "number", "info": "The rule number of the entry to delete.", "required": true, "schema": { "title": "ruleNumber", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNetworkAclEntry" }, "task": true }, { "name": "deleteNetworkAclEntrySTSRole", "summary": "Deletes the specified ingress or egress entry (rule) from the specified network ACL.", "description": "Deletes the specified ingress or egress entry (rule) from the specified network ACL.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "egress", "type": "boolean", "info": "Indicates whether the rule is an egress rule.", "required": true, "schema": { "title": "egress", "type": "boolean" } }, { "name": "networkAclId", "type": "string", "info": "The ID of the network ACL.", "required": true, "schema": { "title": "networkAclId", "type": "string" } }, { "name": "ruleNumber", "type": "number", "info": "The rule number of the entry to delete.", "required": true, "schema": { "title": "ruleNumber", "type": "number" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNetworkAclEntrySTSRole" }, "task": true }, { "name": "deleteNetworkInterface", "summary": "Deletes the specified network interface. You must detach the network interface before you can delete it.", "description": "Deletes the specified network interface. You must detach the network interface before you can delete it.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "networkInterfaceId", "type": "string", "info": "The ID of the network interface.", "required": true, "schema": { "title": "networkInterfaceId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNetworkInterface" }, "task": true }, { "name": "deleteNetworkInterfaceSTSRole", "summary": "Deletes the specified network interface. You must detach the network interface before you can delete it.", "description": "Deletes the specified network interface. You must detach the network interface before you can delete it.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "networkInterfaceId", "type": "string", "info": "The ID of the network interface.", "required": true, "schema": { "title": "networkInterfaceId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNetworkInterfaceSTSRole" }, "task": true }, { "name": "deleteNetworkInterfacePermission", "summary": "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.", "description": "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.", "input": [ { "name": "networkInterfacePermissionId", "type": "string", "info": "The ID of the network interface permission.", "required": true, "schema": { "title": "networkInterfacePermissionId", "type": "string" } }, { "name": "force", "type": "boolean", "info": "Specify true to remove the permission even if the network interface is attached to an instance.", "required": false, "schema": { "title": "force", "type": "boolean" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNetworkInterfacePermission" }, "task": true }, { "name": "deleteNetworkInterfacePermissionSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "networkInterfacePermissionId", "type": "string", "info": "The ID of the network interface permission.", "required": true, "schema": { "title": "networkInterfacePermissionId", "type": "string" } }, { "name": "force", "type": "boolean", "info": "Specify true to remove the permission even if the network interface is attached to an instance.", "required": false, "schema": { "title": "force", "type": "boolean" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNetworkInterfacePermissionSTSRole" }, "task": true }, { "name": "deletePlacementGroup", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "groupName", "type": "string", "info": "The name of the placement group.", "required": true, "schema": { "title": "groupName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deletePlacementGroup" }, "task": true }, { "name": "deletePlacementGroupSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "groupName", "type": "string", "info": "The name of the placement group.", "required": true, "schema": { "title": "groupName", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deletePlacementGroupSTSRole" }, "task": true }, { "name": "deleteRoute", "summary": "Deletes the specified route from the specified route table.", "description": "Deletes the specified route from the specified route table.", "input": [ { "name": "destinationCidrBlock", "type": "string", "info": "The IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.", "required": false, "schema": { "title": "destinationCidrBlock", "type": "string" } }, { "name": "destinationIpv6CidrBlock", "type": "string", "info": "The IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly.", "required": false, "schema": { "title": "destinationIpv6CidrBlock", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "routeTableId", "type": "string", "info": "The ID of the route table.", "required": true, "schema": { "title": "routeTableId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteRoute" }, "task": true }, { "name": "deleteRouteSTSRole", "summary": "Deletes the specified route from the specified route table.", "description": "Deletes the specified route from the specified route table.", "input": [ { "name": "destinationCidrBlock", "type": "string", "info": "The IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.", "required": false, "schema": { "title": "destinationCidrBlock", "type": "string" } }, { "name": "destinationIpv6CidrBlock", "type": "string", "info": "The IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly.", "required": false, "schema": { "title": "destinationIpv6CidrBlock", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "routeTableId", "type": "string", "info": "The ID of the route table.", "required": true, "schema": { "title": "routeTableId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteRouteSTSRole" }, "task": true }, { "name": "deleteRoutes", "summary": "Deletes multiple routes from the specified route table.", "description": "Deletes multiple routes from the specified route table.", "input": [ { "name": "routeArray", "type": "array", "info": "An array of objects. destinationCidrBlock, destinationIpv6CidrBlock, dryRun, routeTableId.", "required": true, "schema": { "title": "routeArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteRoutes" }, "task": true }, { "name": "deleteRoutesSTSRole", "summary": "Deletes multiple routes from the specified route table.", "description": "Deletes multiple routes from the specified route table.", "input": [ { "name": "routeArray", "type": "array", "info": "An array of objects. destinationCidrBlock, destinationIpv6CidrBlock, dryRun, routeTableId.", "required": true, "schema": { "title": "routeArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteRoutesSTSRole" }, "task": true }, { "name": "deleteRouteTable", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "routeTableId", "type": "string", "info": "The ID of the route table.", "required": true, "schema": { "title": "routeTableId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteRouteTable" }, "task": true }, { "name": "deleteRouteTableSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "routeTableId", "type": "string", "info": "The ID of the route table.", "required": true, "schema": { "title": "routeTableId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteRouteTableSTSRole" }, "task": true }, { "name": "deleteRouteTables", "summary": "Deletes multiple route tables from the specified route table.", "description": "Deletes multiple route tables from the specified route table.", "input": [ { "name": "routeTableArray", "type": "array", "info": "An array of objects. dryRun, routeTableId.", "required": true, "schema": { "title": "routeArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteRouteTabless" }, "task": true }, { "name": "deleteRouteTablesSTSRole", "summary": "Deletes multiple route tables from the specified route table.", "description": "Deletes multiple route tables from the specified route table.", "input": [ { "name": "routeTableArray", "type": "array", "info": "An array of objects. dryRun, routeTableId.", "required": true, "schema": { "title": "routeArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteRouteTablesSTSRole" }, "task": true }, { "name": "deleteSecurityGroup", "summary": "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.", "description": "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.", "input": [ { "name": "groupId", "type": "string", "info": "The ID of the security group. Required for a nondefault VPC.", "required": false, "schema": { "title": "groupId", "type": "string" } }, { "name": "groupName", "type": "string", "info": "[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.", "required": false, "schema": { "title": "groupName", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteSecurityGroup" }, "task": true }, { "name": "deleteSecurityGroupSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "groupId", "type": "string", "info": "The ID of the security group. Required for a nondefault VPC.", "required": false, "schema": { "title": "groupId", "type": "string" } }, { "name": "groupName", "type": "string", "info": "[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.", "required": false, "schema": { "title": "groupName", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteSecurityGroupSTSRole" }, "task": true }, { "name": "deleteSecurityGroups", "summary": "Deletes multiple security groups. 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.", "description": "Deletes multiple security groups. 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.", "input": [ { "name": "securityGroupArray", "type": "array", "info": "An array of objects. groupId, groupName, dryRun.", "required": true, "schema": { "title": "securityGroupArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteSecurityGroups" }, "task": true }, { "name": "deleteSecurityGroupsSTSRole", "summary": "Deletes multiple security groups. 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.", "description": "Deletes multiple security groups. 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.", "input": [ { "name": "securityGroupArray", "type": "array", "info": "An array of objects. groupId, groupName, dryRun.", "required": true, "schema": { "title": "securityGroupArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteSecurityGroupsSTSRole" }, "task": true }, { "name": "deleteSnapshot", "summary": "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 ...(description truncated)", "description": "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 ...(description truncated)", "input": [ { "name": "snapshotId", "type": "string", "info": "The ID of the EBS snapshot.", "required": true, "schema": { "title": "snapshotId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteSnapshot" }, "task": true }, { "name": "deleteSnapshotSTSRole", "summary": "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 ...(description truncated)", "description": "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 ...(description truncated)", "input": [ { "name": "snapshotId", "type": "string", "info": "The ID of the EBS snapshot.", "required": true, "schema": { "title": "snapshotId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteSnapshotSTSRole" }, "task": true }, { "name": "deleteSpotDatafeedSubscription", "summary": "Deletes the data feed for Spot Instances.", "description": "Deletes the data feed for Spot Instances.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteSpotDatafeedSubscription" }, "task": true }, { "name": "deleteSpotDatafeedSubscriptionSTSRole", "summary": "Deletes the data feed for Spot Instances.", "description": "Deletes the data feed for Spot Instances.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteSpotDatafeedSubscriptionSTSRole" }, "task": true }, { "name": "deleteSubnet", "summary": "Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.", "description": "Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.", "input": [ { "name": "subnetId", "type": "string", "info": "The ID of the subnet.", "required": true, "schema": { "title": "subnetId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteSubnet" }, "task": true }, { "name": "deleteSubnetSTSRole", "summary": "Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.", "description": "Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.", "input": [ { "name": "subnetId", "type": "string", "info": "The ID of the subnet.", "required": true, "schema": { "title": "subnetId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteSubnetSTSRole" }, "task": true }, { "name": "deleteSubnets", "summary": "Deletes multiple subnets. You must terminate all running instances in the subnet before you can delete the subnet.", "description": "Deletes multiple subnets. You must terminate all running instances in the subnet before you can delete the subnet.", "input": [ { "name": "subnetArray", "type": "array", "info": "An array of objects. subnetId, dryRun.", "required": true, "schema": { "title": "subnetArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteSubnets" }, "task": true }, { "name": "deleteSubnetsSTSRole", "summary": "Deletes multiple subnets. You must terminate all running instances in the subnet before you can delete the subnet.", "description": "Deletes multiple subnets. You must terminate all running instances in the subnet before you can delete the subnet.", "input": [ { "name": "subnetArray", "type": "array", "info": "An array of objects. subnetId, dryRun.", "required": true, "schema": { "title": "subnetArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteSubnetsSTSRole" }, "task": true }, { "name": "deleteTags", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "resourceId", "type": "array", "info": "The IDs of the resources, separated by spaces. Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.", "required": true, "schema": { "title": "resourceId", "type": "array" } }, { "name": "tag", "type": "array", "info": "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 re...(description truncated)", "required": false, "schema": { "title": "tag", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTags" }, "task": true }, { "name": "deleteTagsSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "resourceId", "type": "array", "info": "The IDs of the resources, separated by spaces. Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.", "required": true, "schema": { "title": "resourceId", "type": "array" } }, { "name": "tag", "type": "array", "info": "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 re...(description truncated)", "required": false, "schema": { "title": "tag", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTagsSTSRole" }, "task": true }, { "name": "deleteTransitGateway", "summary": "Deletes the specified transit gateway.", "description": "Deletes the specified transit gateway.", "input": [ { "name": "transitGatewayId", "type": "string", "info": "The ID of the transit gateway.", "required": true, "schema": { "title": "transitGatewayId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTransitGateway" }, "task": true }, { "name": "deleteTransitGatewaySTSRole", "summary": "Deletes the specified transit gateway.", "description": "Deletes the specified transit gateway.", "input": [ { "name": "transitGatewayId", "type": "string", "info": "The ID of the transit gateway.", "required": true, "schema": { "title": "transitGatewayId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTransitGatewaySTSRole" }, "task": true }, { "name": "deleteTransitGatewayRoute", "summary": "Deletes the specified route from the specified transit gateway route table.", "description": "Deletes the specified route from the specified transit gateway route table.", "input": [ { "name": "transitGatewayRouteTableId", "type": "string", "info": "The ID of the transit gateway route table.", "required": true, "schema": { "title": "transitGatewayRouteTableId", "type": "string" } }, { "name": "destinationCidrBlock", "type": "string", "info": "The CIDR range for the route. This must match the CIDR for the route exactly.", "required": true, "schema": { "title": "destinationCidrBlock", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTransitGatewayRoute" }, "task": true }, { "name": "deleteTransitGatewayRouteSTSRole", "summary": "Deletes the specified route from the specified transit gateway route table.", "description": "Deletes the specified route from the specified transit gateway route table.", "input": [ { "name": "transitGatewayRouteTableId", "type": "string", "info": "The ID of the transit gateway route table.", "required": true, "schema": { "title": "transitGatewayRouteTableId", "type": "string" } }, { "name": "destinationCidrBlock", "type": "string", "info": "The CIDR range for the route. This must match the CIDR for the route exactly.", "required": true, "schema": { "title": "destinationCidrBlock", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTransitGatewayRouteSTSRole" }, "task": true }, { "name": "deleteTransitGatewayRouteTable", "summary": "Deletes the specified transit gateway route table. You must disassociate the route table from any transit gateway route tables before you can delete it.", "description": "Deletes the specified transit gateway route table. You must disassociate the route table from any transit gateway route tables before you can delete it.", "input": [ { "name": "transitGatewayRouteTableId", "type": "string", "info": "The ID of the transit gateway route table.", "required": true, "schema": { "title": "transitGatewayRouteTableId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTransitGatewayRouteTable" }, "task": true }, { "name": "deleteTransitGatewayRouteTableSTSRole", "summary": "Deletes the specified transit gateway route table. You must disassociate the route table from any transit gateway route tables before you can delete it.", "description": "Deletes the specified transit gateway route table. You must disassociate the route table from any transit gateway route tables before you can delete it.", "input": [ { "name": "transitGatewayRouteTableId", "type": "string", "info": "The ID of the transit gateway route table.", "required": true, "schema": { "title": "transitGatewayRouteTableId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTransitGatewayRouteTableSTSRole" }, "task": true }, { "name": "deleteTransitGatewayVpcAttachment", "summary": "Deletes the specified VPC attachment.", "description": "Deletes the specified VPC attachment.", "input": [ { "name": "transitGatewayAttachmentId", "type": "string", "info": "The ID of the attachment.", "required": true, "schema": { "title": "transitGatewayAttachmentId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTransitGatewayVpcAttachment" }, "task": true }, { "name": "deleteTransitGatewayVpcAttachmentSTSRole", "summary": "Deletes the specified VPC attachment.", "description": "Deletes the specified VPC attachment.", "input": [ { "name": "transitGatewayAttachmentId", "type": "string", "info": "The ID of the attachment.", "required": true, "schema": { "title": "transitGatewayAttachmentId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTransitGatewayVpcAttachmentSTSRole" }, "task": true }, { "name": "deleteVolume", "summary": "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 .", "description": "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 .", "input": [ { "name": "volumeId", "type": "string", "info": "The ID of the volume.", "required": true, "schema": { "title": "volumeId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVolume" }, "task": true }, { "name": "deleteVolumeSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "volumeId", "type": "string", "info": "The ID of the volume.", "required": true, "schema": { "title": "volumeId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVolumeSTSRole" }, "task": true }, { "name": "deleteVpc", "summary": "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.", "description": "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.", "input": [ { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVpc" }, "task": true }, { "name": "deleteVpcSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVpcSTSRole" }, "task": true }, { "name": "deleteVpcs", "summary": "Deletes multiple VPCs. 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.", "description": "Deletes multiple VPCs. 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.", "input": [ { "name": "vpcArray", "type": "array", "info": "An array of objects. vpcId, dryRun.", "required": true, "schema": { "title": "vpcArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVpcs" }, "task": true }, { "name": "deleteVpcsSTSRole", "summary": "Deletes multiple VPCs. 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.", "description": "Deletes multiple VPCs. 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.", "input": [ { "name": "vpcArray", "type": "array", "info": "An array of objects. vpcId, dryRun.", "required": true, "schema": { "title": "vpcArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVpcsSTSRole" }, "task": true }, { "name": "deleteVpcEndpointConnectionNotifications", "summary": "Deletes one or more VPC endpoint connection notifications.", "description": "Deletes one or more VPC endpoint connection notifications.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "connectionNotificationId", "type": "array", "info": "One or more notification IDs.", "required": true, "schema": { "title": "connectionNotificationId", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVpcEndpointConnectionNotifications" }, "task": true }, { "name": "deleteVpcEndpointConnectionNotificationsSTSRole", "summary": "Deletes one or more VPC endpoint connection notifications.", "description": "Deletes one or more VPC endpoint connection notifications.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "connectionNotificationId", "type": "array", "info": "One or more notification IDs.", "required": true, "schema": { "title": "connectionNotificationId", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVpcEndpointConnectionNotificationsSTSRole" }, "task": true }, { "name": "deleteVpcEndpointServiceConfigurations", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "serviceId", "type": "array", "info": "The IDs of one or more services.", "required": true, "schema": { "title": "serviceId", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVpcEndpointServiceConfigurations" }, "task": true }, { "name": "deleteVpcEndpointServiceConfigurationsSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "serviceId", "type": "array", "info": "The IDs of one or more services.", "required": true, "schema": { "title": "serviceId", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVpcEndpointServiceConfigurationsSTSRole" }, "task": true }, { "name": "deleteVpcEndpoints", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "vpcEndpointId", "type": "array", "info": "One or more VPC endpoint IDs.", "required": true, "schema": { "title": "vpcEndpointId", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVpcEndpoints" }, "task": true }, { "name": "deleteVpcEndpointsSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "vpcEndpointId", "type": "array", "info": "One or more VPC endpoint IDs.", "required": true, "schema": { "title": "vpcEndpointId", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVpcEndpointsSTSRole" }, "task": true }, { "name": "deleteVpcPeeringConnection", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "vpcPeeringConnectionId", "type": "string", "info": "The ID of the VPC peering connection.", "required": true, "schema": { "title": "vpcPeeringConnectionId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVpcPeeringConnection" }, "task": true }, { "name": "deleteVpcPeeringConnectionSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "vpcPeeringConnectionId", "type": "string", "info": "The ID of the VPC peering connection.", "required": true, "schema": { "title": "vpcPeeringConnectionId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVpcPeeringConnectionSTSRole" }, "task": true }, { "name": "deleteVpnConnection", "summary": "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 recon...(description truncated)", "description": "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 recon...(description truncated)", "input": [ { "name": "vpnConnectionId", "type": "string", "info": "The ID of the VPN connection.", "required": true, "schema": { "title": "vpnConnectionId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVpnConnection" }, "task": true }, { "name": "deleteVpnConnectionSTSRole", "summary": "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 recon...(description truncated)", "description": "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 recon...(description truncated)", "input": [ { "name": "vpnConnectionId", "type": "string", "info": "The ID of the VPN connection.", "required": true, "schema": { "title": "vpnConnectionId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVpnConnectionSTSRole" }, "task": true }, { "name": "deleteVpnConnectionRoute", "summary": "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.", "description": "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.", "input": [ { "name": "destinationCidrBlock", "type": "string", "info": "The CIDR block associated with the local subnet of the customer network.", "required": true, "schema": { "title": "destinationCidrBlock", "type": "string" } }, { "name": "vpnConnectionId", "type": "string", "info": "The ID of the VPN connection.", "required": true, "schema": { "title": "vpnConnectionId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVpnConnectionRoute" }, "task": true }, { "name": "deleteVpnConnectionRouteSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "destinationCidrBlock", "type": "string", "info": "The CIDR block associated with the local subnet of the customer network.", "required": true, "schema": { "title": "destinationCidrBlock", "type": "string" } }, { "name": "vpnConnectionId", "type": "string", "info": "The ID of the VPN connection.", "required": true, "schema": { "title": "vpnConnectionId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVpnConnectionRouteSTSRole" }, "task": true }, { "name": "deleteVpnGateway", "summary": "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.", "description": "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.", "input": [ { "name": "vpnGatewayId", "type": "string", "info": "The ID of the virtual private gateway.", "required": true, "schema": { "title": "vpnGatewayId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVpnGateway" }, "task": true }, { "name": "deleteVpnGatewaySTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "vpnGatewayId", "type": "string", "info": "The ID of the virtual private gateway.", "required": true, "schema": { "title": "vpnGatewayId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVpnGatewaySTSRole" }, "task": true }, { "name": "deleteClientVpnEndpoints", "summary": "Deletes multiple Client Vpn Endpoints.", "description": "Deletes multiple Client Vpn Endpoints.", "input": [ { "name": "ClientVpnEndpointsArray", "type": "array", "info": "An array of objects. clientVpnEndpointId, dryRun.", "required": true, "schema": { "title": "ClientVpnEndpointsArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteClientVpnEndpoints" }, "task": true }, { "name": "deleteClientVpnEndpointsSTSRole", "summary": "Deletes multiple Client Vpn Endpoints.", "description": "Deletes multiple Client Vpn Endpoints.", "input": [ { "name": "ClientVpnEndpointsArray", "type": "array", "info": "An array of objects. clientVpnEndpointId, dryRun.", "required": true, "schema": { "title": "ClientVpnEndpointsArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteClientVpnEndpointsSTSRole" }, "task": true }, { "name": "deleteMultipleDhcpOptions", "summary": "Deletes multiple Dhcp Options.", "description": "Deletes multiple Dhcp Options.", "input": [ { "name": "MultipleDhcpOptionsArray", "type": "array", "info": "An array of objects. dhcpOptionsId, dryRun.", "required": true, "schema": { "title": "MultipleDhcpOptionsArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteMultipleDhcpOptions" }, "task": true }, { "name": "deleteMultipleDhcpOptionsSTSRole", "summary": "Deletes multiple Dhcp Options.", "description": "Deletes multiple Dhcp Options.", "input": [ { "name": "MultipleDhcpOptionsArray", "type": "array", "info": "An array of objects. dhcpOptionsId, dryRun.", "required": true, "schema": { "title": "MultipleDhcpOptionsArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteMultipleDhcpOptionsSTSRole" }, "task": true }, { "name": "deleteMultipleFleets", "summary": "Deletes multiple Multiple Fleets.", "description": "Deletes multiple Multiple Fleets.", "input": [ { "name": "MultipleFleetsArray", "type": "array", "info": "An array of objects. dryRun, fleetId, terminateInstances.", "required": true, "schema": { "title": "MultipleFleetsArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteMultipleFleets" }, "task": true }, { "name": "deleteMultipleFleetsSTSRole", "summary": "Deletes multiple Multiple Fleets.", "description": "Deletes multiple Multiple Fleets.", "input": [ { "name": "MultipleFleetsArray", "type": "array", "info": "An array of objects. dryRun, fleetId, terminateInstances.", "required": true, "schema": { "title": "MultipleFleetsArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteMultipleFleetsSTSRole" }, "task": true }, { "name": "deleteMultipleFlowLogs", "summary": "Deletes multiple Multiple Flow Logs.", "description": "Deletes multiple Multiple Flow Logs.", "input": [ { "name": "MultipleFlowLogsArray", "type": "array", "info": "An array of objects. dryRun, flowLogId.", "required": true, "schema": { "title": "MultipleFlowLogsArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteMultipleFlowLogs" }, "task": true }, { "name": "deleteMultipleFlowLogsSTSRole", "summary": "Deletes multiple Multiple Flow Logs.", "description": "Deletes multiple Multiple Flow Logs.", "input": [ { "name": "MultipleFlowLogsArray", "type": "array", "info": "An array of objects. dryRun, flowLogId.", "required": true, "schema": { "title": "MultipleFlowLogsArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteMultipleFlowLogsSTSRole" }, "task": true }, { "name": "deleteClientVpnRoutes", "summary": "Deletes multiple Client Vpn Routes.", "description": "Deletes multiple Client Vpn Routes.", "input": [ { "name": "ClientVpnRoutesArray", "type": "array", "info": "An array of objects. clientVpnEndpointId, targetVpcSubnetId, destinationCidrBlock, dryRun.", "required": true, "schema": { "title": "ClientVpnRoutesArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteClientVpnRoutes" }, "task": true }, { "name": "deleteClientVpnRoutesSTSRole", "summary": "Deletes multiple Client Vpn Routes.", "description": "Deletes multiple Client Vpn Routes.", "input": [ { "name": "ClientVpnRoutesArray", "type": "array", "info": "An array of objects. clientVpnEndpointId, targetVpcSubnetId, destinationCidrBlock, dryRun.", "required": true, "schema": { "title": "ClientVpnRoutesArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteClientVpnRoutesSTSRole" }, "task": true }, { "name": "deleteKeyPairs", "summary": "Deletes multiple Key Pairs.", "description": "Deletes multiple Key Pairs.", "input": [ { "name": "KeyPairsArray", "type": "array", "info": "An array of objects. keyName, dryRun.", "required": true, "schema": { "title": "KeyPairsArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteKeyPairs" }, "task": true }, { "name": "deleteKeyPairsSTSRole", "summary": "Deletes multiple Key Pairs.", "description": "Deletes multiple Key Pairs.", "input": [ { "name": "KeyPairsArray", "type": "array", "info": "An array of objects. keyName, dryRun.", "required": true, "schema": { "title": "KeyPairsArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteKeyPairsSTSRole" }, "task": true }, { "name": "deleteLaunchTemplates", "summary": "Deletes multiple Launch Templates.", "description": "Deletes multiple Launch Templates.", "input": [ { "name": "LaunchTemplatesArray", "type": "array", "info": "An array of objects. dryRun, launchTemplateId, launchTemplateName.", "required": true, "schema": { "title": "LaunchTemplatesArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteLaunchTemplates" }, "task": true }, { "name": "deleteLaunchTemplatesSTSRole", "summary": "Deletes multiple Launch Templates.", "description": "Deletes multiple Launch Templates.", "input": [ { "name": "LaunchTemplatesArray", "type": "array", "info": "An array of objects. dryRun, launchTemplateId, launchTemplateName.", "required": true, "schema": { "title": "LaunchTemplatesArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteLaunchTemplatesSTSRole" }, "task": true }, { "name": "deleteMultipleLaunchTemplateVersions", "summary": "Deletes multiple Multiple Launch Template Versions.", "description": "Deletes multiple Multiple Launch Template Versions.", "input": [ { "name": "MultipleLaunchTemplateVersionsArray", "type": "array", "info": "An array of objects. dryRun, launchTemplateId, launchTemplateName, launchTemplateVersion.", "required": true, "schema": { "title": "MultipleLaunchTemplateVersionsArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteMultipleLaunchTemplateVersions" }, "task": true }, { "name": "deleteMultipleLaunchTemplateVersionsSTSRole", "summary": "Deletes multiple Multiple Launch Template Versions.", "description": "Deletes multiple Multiple Launch Template Versions.", "input": [ { "name": "MultipleLaunchTemplateVersionsArray", "type": "array", "info": "An array of objects. dryRun, launchTemplateId, launchTemplateName, launchTemplateVersion.", "required": true, "schema": { "title": "MultipleLaunchTemplateVersionsArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteMultipleLaunchTemplateVersionsSTSRole" }, "task": true }, { "name": "deleteNatGateways", "summary": "Deletes multiple Nat Gateways.", "description": "Deletes multiple Nat Gateways.", "input": [ { "name": "NatGatewaysArray", "type": "array", "info": "An array of objects. natGatewayId.", "required": true, "schema": { "title": "NatGatewaysArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNatGateways" }, "task": true }, { "name": "deleteNatGatewaysSTSRole", "summary": "Deletes multiple Nat Gateways.", "description": "Deletes multiple Nat Gateways.", "input": [ { "name": "NatGatewaysArray", "type": "array", "info": "An array of objects. natGatewayId.", "required": true, "schema": { "title": "NatGatewaysArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNatGatewaysSTSRole" }, "task": true }, { "name": "deleteNetworkAcls", "summary": "Deletes multiple Network Acls.", "description": "Deletes multiple Network Acls.", "input": [ { "name": "NetworkAclsArray", "type": "array", "info": "An array of objects. dryRun, networkAclId.", "required": true, "schema": { "title": "NetworkAclsArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNetworkAcls" }, "task": true }, { "name": "deleteNetworkAclsSTSRole", "summary": "Deletes multiple Network Acls.", "description": "Deletes multiple Network Acls.", "input": [ { "name": "NetworkAclsArray", "type": "array", "info": "An array of objects. dryRun, networkAclId.", "required": true, "schema": { "title": "NetworkAclsArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNetworkAclsSTSRole" }, "task": true }, { "name": "deleteNetworkAclEntries", "summary": "Deletes multiple Network Acl Entries.", "description": "Deletes multiple Network Acl Entries.", "input": [ { "name": "NetworkAclEntriesArray", "type": "array", "info": "An array of objects. dryRun, egress, networkAclId, ruleNumber.", "required": true, "schema": { "title": "NetworkAclEntriesArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNetworkAclEntries" }, "task": true }, { "name": "deleteNetworkAclEntriesSTSRole", "summary": "Deletes multiple Network Acl Entries.", "description": "Deletes multiple Network Acl Entries.", "input": [ { "name": "NetworkAclEntriesArray", "type": "array", "info": "An array of objects. dryRun, egress, networkAclId, ruleNumber.", "required": true, "schema": { "title": "NetworkAclEntriesArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNetworkAclEntriesSTSRole" }, "task": true }, { "name": "deleteNetworkInterfaces", "summary": "Deletes multiple Network Interfaces.", "description": "Deletes multiple Network Interfaces.", "input": [ { "name": "NetworkInterfacesArray", "type": "array", "info": "An array of objects. dryRun, networkInterfaceId.", "required": true, "schema": { "title": "NetworkInterfacesArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNetworkInterfaces" }, "task": true }, { "name": "deleteNetworkInterfacesSTSRole", "summary": "Deletes multiple Network Interfaces.", "description": "Deletes multiple Network Interfaces.", "input": [ { "name": "NetworkInterfacesArray", "type": "array", "info": "An array of objects. dryRun, networkInterfaceId.", "required": true, "schema": { "title": "NetworkInterfacesArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNetworkInterfacesSTSRole" }, "task": true }, { "name": "deleteCustomerGateways", "summary": "Deletes multiple Customer Gateways.", "description": "Deletes multiple Customer Gateways.", "input": [ { "name": "CustomerGatewaysArray", "type": "array", "info": "An array of objects. customerGatewayId, dryRun.", "required": true, "schema": { "title": "CustomerGatewaysArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteCustomerGateways" }, "task": true }, { "name": "deleteCustomerGatewaysSTSRole", "summary": "Deletes multiple Customer Gateways.", "description": "Deletes multiple Customer Gateways.", "input": [ { "name": "CustomerGatewaysArray", "type": "array", "info": "An array of objects. customerGatewayId, dryRun.", "required": true, "schema": { "title": "CustomerGatewaysArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteCustomerGatewaysSTSRole" }, "task": true }, { "name": "deletePlacementGroups", "summary": "Deletes multiple Placement Groups.", "description": "Deletes multiple Placement Groups.", "input": [ { "name": "PlacementGroupsArray", "type": "array", "info": "An array of objects. dryRun, groupName.", "required": true, "schema": { "title": "PlacementGroupsArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deletePlacementGroups" }, "task": true }, { "name": "deletePlacementGroupsSTSRole", "summary": "Deletes multiple Placement Groups.", "description": "Deletes multiple Placement Groups.", "input": [ { "name": "PlacementGroupsArray", "type": "array", "info": "An array of objects. dryRun, groupName.", "required": true, "schema": { "title": "PlacementGroupsArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deletePlacementGroupsSTSRole" }, "task": true }, { "name": "deleteSnapshots", "summary": "Deletes multiple Snapshots.", "description": "Deletes multiple Snapshots.", "input": [ { "name": "SnapshotsArray", "type": "array", "info": "An array of objects. snapshotId, dryRun.", "required": true, "schema": { "title": "SnapshotsArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteSnapshots" }, "task": true }, { "name": "deleteSnapshotsSTSRole", "summary": "Deletes multiple Snapshots.", "description": "Deletes multiple Snapshots.", "input": [ { "name": "SnapshotsArray", "type": "array", "info": "An array of objects. snapshotId, dryRun.", "required": true, "schema": { "title": "SnapshotsArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteSnapshotsSTSRole" }, "task": true }, { "name": "deleteTransitGatewayRoutes", "summary": "Deletes multiple Transit Gateway Routes.", "description": "Deletes multiple Transit Gateway Routes.", "input": [ { "name": "TransitGatewayRoutesArray", "type": "array", "info": "An array of objects. transitGatewayRouteTableId, destinationCidrBlock, dryRun.", "required": true, "schema": { "title": "TransitGatewayRoutesArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTransitGatewayRoutes" }, "task": true }, { "name": "deleteTransitGatewayRoutesSTSRole", "summary": "Deletes multiple Transit Gateway Routes.", "description": "Deletes multiple Transit Gateway Routes.", "input": [ { "name": "TransitGatewayRoutesArray", "type": "array", "info": "An array of objects. transitGatewayRouteTableId, destinationCidrBlock, dryRun.", "required": true, "schema": { "title": "TransitGatewayRoutesArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTransitGatewayRoutesSTSRole" }, "task": true }, { "name": "deleteTransitGateways", "summary": "Deletes multiple Transit Gateways.", "description": "Deletes multiple Transit Gateways.", "input": [ { "name": "TransitGatewaysArray", "type": "array", "info": "An array of objects. transitGatewayId, dryRun.", "required": true, "schema": { "title": "TransitGatewaysArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTransitGateways" }, "task": true }, { "name": "deleteTransitGatewaysSTSRole", "summary": "Deletes multiple Transit Gateways.", "description": "Deletes multiple Transit Gateways.", "input": [ { "name": "TransitGatewaysArray", "type": "array", "info": "An array of objects. transitGatewayId, dryRun.", "required": true, "schema": { "title": "TransitGatewaysArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTransitGatewaysSTSRole" }, "task": true }, { "name": "deleteFpgaImages", "summary": "Deletes multiple Fpga Images.", "description": "Deletes multiple Fpga Images.", "input": [ { "name": "FpgaImagesArray", "type": "array", "info": "An array of objects. dryRun, fpgaImageId.", "required": true, "schema": { "title": "FpgaImagesArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteFpgaImages" }, "task": true }, { "name": "deleteFpgaImagesSTSRole", "summary": "Deletes multiple Fpga Images.", "description": "Deletes multiple Fpga Images.", "input": [ { "name": "FpgaImagesArray", "type": "array", "info": "An array of objects. dryRun, fpgaImageId.", "required": true, "schema": { "title": "FpgaImagesArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteFpgaImagesSTSRole" }, "task": true }, { "name": "deleteTransitGatewayRouteTables", "summary": "Deletes multiple Transit Gateway Route Tables.", "description": "Deletes multiple Transit Gateway Route Tables.", "input": [ { "name": "TransitGatewayRouteTablesArray", "type": "array", "info": "An array of objects. transitGatewayRouteTableId, dryRun.", "required": true, "schema": { "title": "TransitGatewayRouteTablesArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTransitGatewayRouteTables" }, "task": true }, { "name": "deleteTransitGatewayRouteTablesSTSRole", "summary": "Deletes multiple Transit Gateway Route Tables.", "description": "Deletes multiple Transit Gateway Route Tables.", "input": [ { "name": "TransitGatewayRouteTablesArray", "type": "array", "info": "An array of objects. transitGatewayRouteTableId, dryRun.", "required": true, "schema": { "title": "TransitGatewayRouteTablesArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTransitGatewayRouteTablesSTSRole" }, "task": true }, { "name": "deleteMultipleTags", "summary": "Deletes multiple Multiple Tags.", "description": "Deletes multiple Multiple Tags.", "input": [ { "name": "MultipleTagsArray", "type": "array", "info": "An array of objects. dryRun, resourceId, tag.", "required": true, "schema": { "title": "MultipleTagsArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteMultipleTags" }, "task": true }, { "name": "deleteMultipleTagsSTSRole", "summary": "Deletes multiple Multiple Tags.", "description": "Deletes multiple Multiple Tags.", "input": [ { "name": "MultipleTagsArray", "type": "array", "info": "An array of objects. dryRun, resourceId, tag.", "required": true, "schema": { "title": "MultipleTagsArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteMultipleTagsSTSRole" }, "task": true }, { "name": "deleteTransitGatewayVpcAttachments", "summary": "Deletes multiple Transit Gateway Vpc Attachments.", "description": "Deletes multiple Transit Gateway Vpc Attachments.", "input": [ { "name": "TransitGatewayVpcAttachmentsArray", "type": "array", "info": "An array of objects. transitGatewayAttachmentId, dryRun.", "required": true, "schema": { "title": "TransitGatewayVpcAttachmentsArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTransitGatewayVpcAttachments" }, "task": true }, { "name": "deleteTransitGatewayVpcAttachmentsSTSRole", "summary": "Deletes multiple Transit Gateway Vpc Attachments.", "description": "Deletes multiple Transit Gateway Vpc Attachments.", "input": [ { "name": "TransitGatewayVpcAttachmentsArray", "type": "array", "info": "An array of objects. transitGatewayAttachmentId, dryRun.", "required": true, "schema": { "title": "TransitGatewayVpcAttachmentsArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTransitGatewayVpcAttachmentsSTSRole" }, "task": true }, { "name": "deleteVolumes", "summary": "Deletes multiple Volumes.", "description": "Deletes multiple Volumes.", "input": [ { "name": "VolumesArray", "type": "array", "info": "An array of objects. volumeId, dryRun.", "required": true, "schema": { "title": "VolumesArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVolumes" }, "task": true }, { "name": "deleteVolumesSTSRole", "summary": "Deletes multiple Volumes.", "description": "Deletes multiple Volumes.", "input": [ { "name": "VolumesArray", "type": "array", "info": "An array of objects. volumeId, dryRun.", "required": true, "schema": { "title": "VolumesArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVolumesSTSRole" }, "task": true }, { "name": "deleteMultipleVpcEndpointConnectionNotifications", "summary": "Deletes multiple Multiple Vpc Endpoint Connection Notifications.", "description": "Deletes multiple Multiple Vpc Endpoint Connection Notifications.", "input": [ { "name": "MultipleVpcEndpointConnectionNotificationsArray", "type": "array", "info": "An array of objects. dryRun, connectionNotificationId.", "required": true, "schema": { "title": "MultipleVpcEndpointConnectionNotificationsArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteMultipleVpcEndpointConnectionNotifications" }, "task": true }, { "name": "deleteMultipleVpcEndpointConnectionNotificationsSTSRole", "summary": "Deletes multiple Multiple Vpc Endpoint Connection Notifications.", "description": "Deletes multiple Multiple Vpc Endpoint Connection Notifications.", "input": [ { "name": "MultipleVpcEndpointConnectionNotificationsArray", "type": "array", "info": "An array of objects. dryRun, connectionNotificationId.", "required": true, "schema": { "title": "MultipleVpcEndpointConnectionNotificationsArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteMultipleVpcEndpointConnectionNotificationsSTSRole" }, "task": true }, { "name": "deleteSpotDatafeedSubscriptions", "summary": "Deletes multiple Spot Datafeed Subscriptions.", "description": "Deletes multiple Spot Datafeed Subscriptions.", "input": [ { "name": "SpotDatafeedSubscriptionsArray", "type": "array", "info": "An array of objects. dryRun.", "required": true, "schema": { "title": "SpotDatafeedSubscriptionsArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteSpotDatafeedSubscriptions" }, "task": true }, { "name": "deleteSpotDatafeedSubscriptionsSTSRole", "summary": "Deletes multiple Spot Datafeed Subscriptions.", "description": "Deletes multiple Spot Datafeed Subscriptions.", "input": [ { "name": "SpotDatafeedSubscriptionsArray", "type": "array", "info": "An array of objects. dryRun.", "required": true, "schema": { "title": "SpotDatafeedSubscriptionsArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteSpotDatafeedSubscriptionsSTSRole" }, "task": true }, { "name": "deleteMultipleVpcEndpoints", "summary": "Deletes multiple Multiple Vpc Endpoints.", "description": "Deletes multiple Multiple Vpc Endpoints.", "input": [ { "name": "MultipleVpcEndpointsArray", "type": "array", "info": "An array of objects. dryRun, vpcEndpointId.", "required": true, "schema": { "title": "MultipleVpcEndpointsArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteMultipleVpcEndpoints" }, "task": true }, { "name": "deleteMultipleVpcEndpointsSTSRole", "summary": "Deletes multiple Multiple Vpc Endpoints.", "description": "Deletes multiple Multiple Vpc Endpoints.", "input": [ { "name": "MultipleVpcEndpointsArray", "type": "array", "info": "An array of objects. dryRun, vpcEndpointId.", "required": true, "schema": { "title": "MultipleVpcEndpointsArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteMultipleVpcEndpointsSTSRole" }, "task": true }, { "name": "deleteVpcPeeringConnections", "summary": "Deletes multiple Vpc Peering Connections.", "description": "Deletes multiple Vpc Peering Connections.", "input": [ { "name": "VpcPeeringConnectionsArray", "type": "array", "info": "An array of objects. dryRun, vpcPeeringConnectionId.", "required": true, "schema": { "title": "VpcPeeringConnectionsArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVpcPeeringConnections" }, "task": true }, { "name": "deleteVpcPeeringConnectionsSTSRole", "summary": "Deletes multiple Vpc Peering Connections.", "description": "Deletes multiple Vpc Peering Connections.", "input": [ { "name": "VpcPeeringConnectionsArray", "type": "array", "info": "An array of objects. dryRun, vpcPeeringConnectionId.", "required": true, "schema": { "title": "VpcPeeringConnectionsArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVpcPeeringConnectionsSTSRole" }, "task": true }, { "name": "deleteVpnConnections", "summary": "Deletes multiple Vpn Connections.", "description": "Deletes multiple Vpn Connections.", "input": [ { "name": "VpnConnectionsArray", "type": "array", "info": "An array of objects. vpnConnectionId, dryRun.", "required": true, "schema": { "title": "VpnConnectionsArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVpnConnections" }, "task": true }, { "name": "deleteVpnConnectionsSTSRole", "summary": "Deletes multiple Vpn Connections.", "description": "Deletes multiple Vpn Connections.", "input": [ { "name": "VpnConnectionsArray", "type": "array", "info": "An array of objects. vpnConnectionId, dryRun.", "required": true, "schema": { "title": "VpnConnectionsArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVpnConnectionsSTSRole" }, "task": true }, { "name": "deleteVpnConnectionRoutes", "summary": "Deletes multiple Vpn Connection Routes.", "description": "Deletes multiple Vpn Connection Routes.", "input": [ { "name": "VpnConnectionRoutesArray", "type": "array", "info": "An array of objects. destinationCidrBlock, vpnConnectionId.", "required": true, "schema": { "title": "VpnConnectionRoutesArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVpnConnectionRoutes" }, "task": true }, { "name": "deleteVpnConnectionRoutesSTSRole", "summary": "Deletes multiple Vpn Connection Routes.", "description": "Deletes multiple Vpn Connection Routes.", "input": [ { "name": "VpnConnectionRoutesArray", "type": "array", "info": "An array of objects. destinationCidrBlock, vpnConnectionId.", "required": true, "schema": { "title": "VpnConnectionRoutesArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVpnConnectionRoutesSTSRole" }, "task": true }, { "name": "deleteVpnGateways", "summary": "Deletes multiple Vpn Gateways.", "description": "Deletes multiple Vpn Gateways.", "input": [ { "name": "VpnGatewaysArray", "type": "array", "info": "An array of objects. vpnGatewayId, dryRun.", "required": true, "schema": { "title": "VpnGatewaysArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVpnGateways" }, "task": true }, { "name": "deleteVpnGatewaysSTSRole", "summary": "Deletes multiple Vpn Gateways.", "description": "Deletes multiple Vpn Gateways.", "input": [ { "name": "VpnGatewaysArray", "type": "array", "info": "An array of objects. vpnGatewayId, dryRun.", "required": true, "schema": { "title": "VpnGatewaysArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVpnGatewaysSTSRole" }, "task": true }, { "name": "deleteMultipleVpcEndpointServiceConfigurations", "summary": "Deletes multiple Multiple Vpc Endpoint Service Configurations.", "description": "Deletes multiple Multiple Vpc Endpoint Service Configurations.", "input": [ { "name": "MultipleVpcEndpointServiceConfigurationsArray", "type": "array", "info": "An array of objects. dryRun, serviceId.", "required": true, "schema": { "title": "MultipleVpcEndpointServiceConfigurationsArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteMultipleVpcEndpointServiceConfigurations" }, "task": true }, { "name": "deleteMultipleVpcEndpointServiceConfigurationsSTSRole", "summary": "Deletes multiple Multiple Vpc Endpoint Service Configurations.", "description": "Deletes multiple Multiple Vpc Endpoint Service Configurations.", "input": [ { "name": "MultipleVpcEndpointServiceConfigurationsArray", "type": "array", "info": "An array of objects. dryRun, serviceId.", "required": true, "schema": { "title": "MultipleVpcEndpointServiceConfigurationsArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteMultipleVpcEndpointServiceConfigurationsSTSRole" }, "task": true }, { "name": "deleteNetworkInterfacePermissions", "summary": "Deletes multiple Network Interface Permissions.", "description": "Deletes multiple Network Interface Permissions.", "input": [ { "name": "NetworkInterfacePermissionsArray", "type": "array", "info": "An array of objects. networkInterfacePermissionId, force, dryRun.", "required": true, "schema": { "title": "NetworkInterfacePermissionsArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNetworkInterfacePermissions" }, "task": true }, { "name": "deleteNetworkInterfacePermissionsSTSRole", "summary": "Deletes multiple Network Interface Permissions.", "description": "Deletes multiple Network Interface Permissions.", "input": [ { "name": "NetworkInterfacePermissionsArray", "type": "array", "info": "An array of objects. networkInterfacePermissionId, force, dryRun.", "required": true, "schema": { "title": "NetworkInterfacePermissionsArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNetworkInterfacePermissionsSTSRole" }, "task": true }, { "name": "deleteEgressOnlyInternetGateways", "summary": "Deletes multiple Egress Only Internet Gateways.", "description": "Deletes multiple Egress Only Internet Gateways.", "input": [ { "name": "EgressOnlyInternetGatewaysArray", "type": "array", "info": "An array of objects. dryRun, egressOnlyInternetGatewayId.", "required": true, "schema": { "title": "EgressOnlyInternetGatewaysArray", "type": "array" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteEgressOnlyInternetGateways" }, "task": true }, { "name": "deleteEgressOnlyInternetGatewaysSTSRole", "summary": "Deletes multiple Egress Only Internet Gateways.", "description": "Deletes multiple Egress Only Internet Gateways.", "input": [ { "name": "EgressOnlyInternetGatewaysArray", "type": "array", "info": "An array of objects. dryRun, egressOnlyInternetGatewayId.", "required": true, "schema": { "title": "EgressOnlyInternetGatewaysArray", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "An array containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteEgressOnlyInternetGatewaysSTSRole" }, "task": true }, { "name": "deprovisionByoipCidr", "summary": "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.", "description": "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.", "input": [ { "name": "cidr", "type": "string", "info": "The public IPv4 address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range.", "required": true, "schema": { "title": "cidr", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deprovisionByoipCidr" }, "task": true }, { "name": "deprovisionByoipCidrSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "cidr", "type": "string", "info": "The public IPv4 address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range.", "required": true, "schema": { "title": "cidr", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deprovisionByoipCidrSTSRole" }, "task": true }, { "name": "deregisterImage", "summary": "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 affe...(description truncated)", "description": "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 affe...(description truncated)", "input": [ { "name": "imageId", "type": "string", "info": "The ID of the AMI.", "required": true, "schema": { "title": "imageId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deregisterImage" }, "task": true }, { "name": "deregisterImageSTSRole", "summary": "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 affe...(description truncated)", "description": "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 affe...(description truncated)", "input": [ { "name": "imageId", "type": "string", "info": "The ID of the AMI.", "required": true, "schema": { "title": "imageId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deregisterImageSTSRole" }, "task": true }, { "name": "describeAccountAttributes", "summary": "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...(description truncated)", "description": "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...(description truncated)", "input": [ { "name": "attributeName", "type": "array", "info": "The account attribute names.", "required": false, "schema": { "title": "attributeName", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeAccountAttributes" }, "task": true }, { "name": "describeAccountAttributesSTSRole", "summary": "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...(description truncated)", "description": "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...(description truncated)", "input": [ { "name": "attributeName", "type": "array", "info": "The account attribute names.", "required": false, "schema": { "title": "attributeName", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeAccountAttributesSTSRole" }, "task": true }, { "name": "describeAddresses", "summary": "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 .", "description": "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 .", "input": [ { "name": "filter", "type": "array", "info": "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...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "publicIp", "type": "array", "info": "One or more Elastic IP addresses. Default: Describes all your Elastic IP addresses.", "required": false, "schema": { "title": "publicIp", "type": "array" } }, { "name": "allocationId", "type": "array", "info": "[EC2-VPC] Information about the allocation IDs.", "required": false, "schema": { "title": "allocationId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeAddresses" }, "task": true }, { "name": "describeAddressesSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "filter", "type": "array", "info": "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...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "publicIp", "type": "array", "info": "One or more Elastic IP addresses. Default: Describes all your Elastic IP addresses.", "required": false, "schema": { "title": "publicIp", "type": "array" } }, { "name": "allocationId", "type": "array", "info": "[EC2-VPC] Information about the allocation IDs.", "required": false, "schema": { "title": "allocationId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeAddressesSTSRole" }, "task": true }, { "name": "describeAggregateIdFormat", "summary": "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-tas...(description truncated)", "description": "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-tas...(description truncated)", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeAggregateIdFormat" }, "task": true }, { "name": "describeAggregateIdFormatSTSRole", "summary": "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-tas...(description truncated)", "description": "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-tas...(description truncated)", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeAggregateIdFormatSTSRole" }, "task": true }, { "name": "describeAvailabilityZones", "summary": "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 .", "description": "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 .", "input": [ { "name": "filter", "type": "array", "info": "The filters. message - Information about the Availability Zone. region-name - The name of the Region for the Availability Zone (for example, us-east-1...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "zoneName", "type": "array", "info": "The names of the Availability Zones.", "required": false, "schema": { "title": "zoneName", "type": "array" } }, { "name": "zoneId", "type": "array", "info": "The IDs of the Availability Zones.", "required": false, "schema": { "title": "zoneId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeAvailabilityZones" }, "task": true }, { "name": "describeAvailabilityZonesSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "filter", "type": "array", "info": "The filters. message - Information about the Availability Zone. region-name - The name of the Region for the Availability Zone (for example, us-east-1...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "zoneName", "type": "array", "info": "The names of the Availability Zones.", "required": false, "schema": { "title": "zoneName", "type": "array" } }, { "name": "zoneId", "type": "array", "info": "The IDs of the Availability Zones.", "required": false, "schema": { "title": "zoneId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeAvailabilityZonesSTSRole" }, "task": true }, { "name": "describeBundleTasks", "summary": "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.", "description": "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.", "input": [ { "name": "bundleId", "type": "array", "info": "The bundle task IDs. Default: Describes all your bundle tasks.", "required": false, "schema": { "title": "bundleId", "type": "array" } }, { "name": "filter", "type": "array", "info": "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 fail...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeBundleTasks" }, "task": true }, { "name": "describeBundleTasksSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "bundleId", "type": "array", "info": "The bundle task IDs. Default: Describes all your bundle tasks.", "required": false, "schema": { "title": "bundleId", "type": "array" } }, { "name": "filter", "type": "array", "info": "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 fail...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeBundleTasksSTSRole" }, "task": true }, { "name": "describeByoipCidrs", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": true, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeByoipCidrs" }, "task": true }, { "name": "describeByoipCidrsSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": true, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeByoipCidrsSTSRole" }, "task": true }, { "name": "describeCapacityReservations", "summary": "Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the AWS Region that you're currently using.", "description": "Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the AWS Region that you're currently using.", "input": [ { "name": "capacityReservationId", "type": "array", "info": "The ID of the Capacity Reservation.", "required": false, "schema": { "title": "capacityReservationId", "type": "array" } }, { "name": "nextToken", "type": "string", "info": "The token to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "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.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "filter", "type": "array", "info": "One or more filters.", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeCapacityReservations" }, "task": true }, { "name": "describeCapacityReservationsSTSRole", "summary": "Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the AWS Region that you're currently using.", "description": "Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the AWS Region that you're currently using.", "input": [ { "name": "capacityReservationId", "type": "array", "info": "The ID of the Capacity Reservation.", "required": false, "schema": { "title": "capacityReservationId", "type": "array" } }, { "name": "nextToken", "type": "string", "info": "The token to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "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.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "filter", "type": "array", "info": "One or more filters.", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeCapacityReservationsSTSRole" }, "task": true }, { "name": "describeClassicLinkInstances", "summary": "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.", "description": "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.", "input": [ { "name": "filter", "type": "array", "info": "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 :...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "instanceId", "type": "array", "info": "One or more instance IDs. Must be instances linked to a VPC through ClassicLink.", "required": false, "schema": { "title": "instanceId", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "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 th...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeClassicLinkInstances" }, "task": true }, { "name": "describeClassicLinkInstancesSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "filter", "type": "array", "info": "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 :...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "instanceId", "type": "array", "info": "One or more instance IDs. Must be instances linked to a VPC through ClassicLink.", "required": false, "schema": { "title": "instanceId", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "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 th...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeClassicLinkInstancesSTSRole" }, "task": true }, { "name": "describeClientVpnAuthorizationRules", "summary": "Describes the authorization rules for a specified Client VPN endpoint.", "description": "Describes the authorization rules for a specified Client VPN endpoint.", "input": [ { "name": "clientVpnEndpointId", "type": "string", "info": "The ID of the Client VPN endpoint.", "required": true, "schema": { "title": "clientVpnEndpointId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "nextToken", "type": "string", "info": "The token to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "filter", "type": "array", "info": "One or more filters. Filter names and values are case-sensitive.", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "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.", "required": false, "schema": { "title": "maxResults", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeClientVpnAuthorizationRules" }, "task": true }, { "name": "describeClientVpnAuthorizationRulesSTSRole", "summary": "Describes the authorization rules for a specified Client VPN endpoint.", "description": "Describes the authorization rules for a specified Client VPN endpoint.", "input": [ { "name": "clientVpnEndpointId", "type": "string", "info": "The ID of the Client VPN endpoint.", "required": true, "schema": { "title": "clientVpnEndpointId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "nextToken", "type": "string", "info": "The token to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "filter", "type": "array", "info": "One or more filters. Filter names and values are case-sensitive.", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "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.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeClientVpnAuthorizationRulesSTSRole" }, "task": true }, { "name": "describeClientVpnConnections", "summary": "Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint.", "description": "Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint.", "input": [ { "name": "clientVpnEndpointId", "type": "string", "info": "The ID of the Client VPN endpoint.", "required": true, "schema": { "title": "clientVpnEndpointId", "type": "string" } }, { "name": "filter", "type": "array", "info": "One or more filters. Filter names and values are case-sensitive.", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "nextToken", "type": "string", "info": "The token to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "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.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeClientVpnConnections" }, "task": true }, { "name": "describeClientVpnConnectionsSTSRole", "summary": "Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint.", "description": "Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint.", "input": [ { "name": "clientVpnEndpointId", "type": "string", "info": "The ID of the Client VPN endpoint.", "required": true, "schema": { "title": "clientVpnEndpointId", "type": "string" } }, { "name": "filter", "type": "array", "info": "One or more filters. Filter names and values are case-sensitive.", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "nextToken", "type": "string", "info": "The token to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "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.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeClientVpnConnectionsSTSRole" }, "task": true }, { "name": "describeClientVpnEndpoints", "summary": "Describes one or more Client VPN endpoints in the account.", "description": "Describes one or more Client VPN endpoints in the account.", "input": [ { "name": "clientVpnEndpointId", "type": "array", "info": "The ID of the Client VPN endpoint.", "required": false, "schema": { "title": "clientVpnEndpointId", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "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.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "filter", "type": "array", "info": "One or more filters. Filter names and values are case-sensitive.", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeClientVpnEndpoints" }, "task": true }, { "name": "describeClientVpnEndpointsSTSRole", "summary": "Describes one or more Client VPN endpoints in the account.", "description": "Describes one or more Client VPN endpoints in the account.", "input": [ { "name": "clientVpnEndpointId", "type": "array", "info": "The ID of the Client VPN endpoint.", "required": false, "schema": { "title": "clientVpnEndpointId", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "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.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "filter", "type": "array", "info": "One or more filters. Filter names and values are case-sensitive.", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeClientVpnEndpointsSTSRole" }, "task": true }, { "name": "describeClientVpnRoutes", "summary": "Describes the routes for the specified Client VPN endpoint.", "description": "Describes the routes for the specified Client VPN endpoint.", "input": [ { "name": "clientVpnEndpointId", "type": "string", "info": "The ID of the Client VPN endpoint.", "required": true, "schema": { "title": "clientVpnEndpointId", "type": "string" } }, { "name": "filter", "type": "array", "info": "One or more filters. Filter names and values are case-sensitive.", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "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.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeClientVpnRoutes" }, "task": true }, { "name": "describeClientVpnRoutesSTSRole", "summary": "Describes the routes for the specified Client VPN endpoint.", "description": "Describes the routes for the specified Client VPN endpoint.", "input": [ { "name": "clientVpnEndpointId", "type": "string", "info": "The ID of the Client VPN endpoint.", "required": true, "schema": { "title": "clientVpnEndpointId", "type": "string" } }, { "name": "filter", "type": "array", "info": "One or more filters. Filter names and values are case-sensitive.", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "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.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeClientVpnRoutesSTSRole" }, "task": true }, { "name": "describeClientVpnTargetNetworks", "summary": "Describes the target networks associated with the specified Client VPN endpoint.", "description": "Describes the target networks associated with the specified Client VPN endpoint.", "input": [ { "name": "clientVpnEndpointId", "type": "string", "info": "The ID of the Client VPN endpoint.", "required": true, "schema": { "title": "clientVpnEndpointId", "type": "string" } }, { "name": "associationIds", "type": "array", "info": "The IDs of the target network associations.", "required": false, "schema": { "title": "associationIds", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "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.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "filter", "type": "array", "info": "One or more filters. Filter names and values are case-sensitive.", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeClientVpnTargetNetworks" }, "task": true }, { "name": "describeClientVpnTargetNetworksSTSRole", "summary": "Describes the target networks associated with the specified Client VPN endpoint.", "description": "Describes the target networks associated with the specified Client VPN endpoint.", "input": [ { "name": "clientVpnEndpointId", "type": "string", "info": "The ID of the Client VPN endpoint.", "required": true, "schema": { "title": "clientVpnEndpointId", "type": "string" } }, { "name": "associationIds", "type": "array", "info": "The IDs of the target network associations.", "required": false, "schema": { "title": "associationIds", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "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.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "filter", "type": "array", "info": "One or more filters. Filter names and values are case-sensitive.", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeClientVpnTargetNetworksSTSRole" }, "task": true }, { "name": "describeConversionTasks", "summary": "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 .", "description": "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 .", "input": [ { "name": "conversionTaskId", "type": "array", "info": "The conversion task IDs.", "required": false, "schema": { "title": "conversionTaskId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeConversionTasks" }, "task": true }, { "name": "describeConversionTasksSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "conversionTaskId", "type": "array", "info": "The conversion task IDs.", "required": false, "schema": { "title": "conversionTaskId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeConversionTasksSTSRole" }, "task": true }, { "name": "describeCustomerGateways", "summary": "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 .", "description": "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 .", "input": [ { "name": "customerGatewayId", "type": "array", "info": "One or more customer gateway IDs. Default: Describes all your customer gateways.", "required": false, "schema": { "title": "customerGatewayId", "type": "array" } }, { "name": "filter", "type": "array", "info": "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...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeCustomerGateways" }, "task": true }, { "name": "describeCustomerGatewaysSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "customerGatewayId", "type": "array", "info": "One or more customer gateway IDs. Default: Describes all your customer gateways.", "required": false, "schema": { "title": "customerGatewayId", "type": "array" } }, { "name": "filter", "type": "array", "info": "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...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeCustomerGatewaysSTSRole" }, "task": true }, { "name": "describeDhcpOptions", "summary": "Describes one or more of your DHCP options sets. For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide .", "description": "Describes one or more of your DHCP options sets. For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide .", "input": [ { "name": "dhcpOptionsId", "type": "array", "info": "The IDs of one or more DHCP options sets. Default: Describes all your DHCP options sets.", "required": false, "schema": { "title": "dhcpOptionsId", "type": "array" } }, { "name": "filter", "type": "array", "info": "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 ...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeDhcpOptions" }, "task": true }, { "name": "describeDhcpOptionsSTSRole", "summary": "Describes one or more of your DHCP options sets. For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide .", "description": "Describes one or more of your DHCP options sets. For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide .", "input": [ { "name": "dhcpOptionsId", "type": "array", "info": "The IDs of one or more DHCP options sets. Default: Describes all your DHCP options sets.", "required": false, "schema": { "title": "dhcpOptionsId", "type": "array" } }, { "name": "filter", "type": "array", "info": "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 ...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeDhcpOptionsSTSRole" }, "task": true }, { "name": "describeEgressOnlyInternetGateways", "summary": "Describes one or more of your egress-only internet gateways.", "description": "Describes one or more of your egress-only internet gateways.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "egressOnlyInternetGatewayId", "type": "array", "info": "One or more egress-only internet gateway IDs.", "required": false, "schema": { "title": "egressOnlyInternetGatewayId", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeEgressOnlyInternetGateways" }, "task": true }, { "name": "describeEgressOnlyInternetGatewaysSTSRole", "summary": "Describes one or more of your egress-only internet gateways.", "description": "Describes one or more of your egress-only internet gateways.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "egressOnlyInternetGatewayId", "type": "array", "info": "One or more egress-only internet gateway IDs.", "required": false, "schema": { "title": "egressOnlyInternetGatewayId", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeEgressOnlyInternetGatewaysSTSRole" }, "task": true }, { "name": "describeElasticGpus", "summary": "Describes the Elastic Graphics accelerator associated with your instances. For more information about Elastic Graphics, see Amazon Elastic Graphics .", "description": "Describes the Elastic Graphics accelerator associated with your instances. For more information about Elastic Graphics, see Amazon Elastic Graphics .", "input": [ { "name": "elasticGpuId", "type": "array", "info": "The Elastic Graphics accelerator IDs.", "required": false, "schema": { "title": "elasticGpuId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "filter", "type": "array", "info": "The filters. availability-zone - The Availability Zone in which the Elastic Graphics accelerator resides. elastic-gpu-health - The status of the Elasti...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "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 betw...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to request the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeElasticGpus" }, "task": true }, { "name": "describeElasticGpusSTSRole", "summary": "Describes the Elastic Graphics accelerator associated with your instances. For more information about Elastic Graphics, see Amazon Elastic Graphics .", "description": "Describes the Elastic Graphics accelerator associated with your instances. For more information about Elastic Graphics, see Amazon Elastic Graphics .", "input": [ { "name": "elasticGpuId", "type": "array", "info": "The Elastic Graphics accelerator IDs.", "required": false, "schema": { "title": "elasticGpuId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "filter", "type": "array", "info": "The filters. availability-zone - The Availability Zone in which the Elastic Graphics accelerator resides. elastic-gpu-health - The status of the Elasti...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "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 betw...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to request the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeElasticGpusSTSRole" }, "task": true }, { "name": "describeExportTasks", "summary": "Describes the specified export tasks or all your export tasks.", "description": "Describes the specified export tasks or all your export tasks.", "input": [ { "name": "exportTaskId", "type": "array", "info": "The export task IDs.", "required": false, "schema": { "title": "exportTaskId", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeExportTasks" }, "task": true }, { "name": "describeExportTasksSTSRole", "summary": "Describes the specified export tasks or all your export tasks.", "description": "Describes the specified export tasks or all your export tasks.", "input": [ { "name": "exportTaskId", "type": "array", "info": "The export task IDs.", "required": false, "schema": { "title": "exportTaskId", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeExportTasksSTSRole" }, "task": true }, { "name": "describeFleetHistory", "summary": "Describes the events for the specified EC2 Fleet during the specified time.", "description": "Describes the events for the specified EC2 Fleet during the specified time.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "eventType", "type": "string", "info": "The type of events to describe. By default, all events are described.", "required": false, "schema": { "title": "eventType", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "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 c...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next set of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "fleetId", "type": "string", "info": "The ID of the EC2 Fleet.", "required": true, "schema": { "title": "fleetId", "type": "string" } }, { "name": "startTime", "type": "string", "info": "The start date and time for the events, in UTC format (for example, YYYY - MM - DD T HH : MM : SS Z).", "required": true, "schema": { "title": "startTime", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeFleetHistory" }, "task": true }, { "name": "describeFleetHistorySTSRole", "summary": "Describes the events for the specified EC2 Fleet during the specified time.", "description": "Describes the events for the specified EC2 Fleet during the specified time.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "eventType", "type": "string", "info": "The type of events to describe. By default, all events are described.", "required": false, "schema": { "title": "eventType", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "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 c...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next set of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "fleetId", "type": "string", "info": "The ID of the EC2 Fleet.", "required": true, "schema": { "title": "fleetId", "type": "string" } }, { "name": "startTime", "type": "string", "info": "The start date and time for the events, in UTC format (for example, YYYY - MM - DD T HH : MM : SS Z).", "required": true, "schema": { "title": "startTime", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeFleetHistorySTSRole" }, "task": true }, { "name": "describeFleetInstances", "summary": "Describes the running instances for the specified EC2 Fleet.", "description": "Describes the running instances for the specified EC2 Fleet.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "maxResults", "type": "number", "info": "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 c...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next set of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "fleetId", "type": "string", "info": "The ID of the EC2 Fleet.", "required": true, "schema": { "title": "fleetId", "type": "string" } }, { "name": "filter", "type": "array", "info": "The filters. instance-type - The instance type.", "required": false, "schema": { "title": "filter", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeFleetInstances" }, "task": true }, { "name": "describeFleetInstancesSTSRole", "summary": "Describes the running instances for the specified EC2 Fleet.", "description": "Describes the running instances for the specified EC2 Fleet.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "maxResults", "type": "number", "info": "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 c...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next set of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "fleetId", "type": "string", "info": "The ID of the EC2 Fleet.", "required": true, "schema": { "title": "fleetId", "type": "string" } }, { "name": "filter", "type": "array", "info": "The filters. instance-type - The instance type.", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeFleetInstancesSTSRole" }, "task": true }, { "name": "describeFleets", "summary": "Describes the specified EC2 Fleets or all your EC2 Fleets.", "description": "Describes the specified EC2 Fleets or all your EC2 Fleets.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "maxResults", "type": "number", "info": "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 c...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next set of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "fleetId", "type": "array", "info": "The ID of the EC2 Fleets.", "required": false, "schema": { "title": "fleetId", "type": "array" } }, { "name": "filter", "type": "array", "info": "The filters. activity-status - The progress of the EC2 Fleet ( error | pending-fulfillment | pending-termination | fulfilled ). excess-capacity-t...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeFleets" }, "task": true }, { "name": "describeFleetsSTSRole", "summary": "Describes the specified EC2 Fleets or all your EC2 Fleets.", "description": "Describes the specified EC2 Fleets or all your EC2 Fleets.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "maxResults", "type": "number", "info": "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 c...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next set of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "fleetId", "type": "array", "info": "The ID of the EC2 Fleets.", "required": false, "schema": { "title": "fleetId", "type": "array" } }, { "name": "filter", "type": "array", "info": "The filters. activity-status - The progress of the EC2 Fleet ( error | pending-fulfillment | pending-termination | fulfilled ). excess-capacity-t...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeFleetsSTSRole" }, "task": true }, { "name": "describeFlowLogs", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "filter", "type": "array", "info": "One or more filters. deliver-log-status - The status of the logs delivery ( SUCCESS | FAILED ). log-destination-type - The type of destination to whi...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "flowLogId", "type": "array", "info": "One or more flow log IDs.", "required": false, "schema": { "title": "flowLogId", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeFlowLogs" }, "task": true }, { "name": "describeFlowLogsSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "filter", "type": "array", "info": "One or more filters. deliver-log-status - The status of the logs delivery ( SUCCESS | FAILED ). log-destination-type - The type of destination to whi...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "flowLogId", "type": "array", "info": "One or more flow log IDs.", "required": false, "schema": { "title": "flowLogId", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeFlowLogsSTSRole" }, "task": true }, { "name": "describeFpgaImageAttribute", "summary": "Describes the specified attribute of the specified Amazon FPGA Image (AFI).", "description": "Describes the specified attribute of the specified Amazon FPGA Image (AFI).", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "fpgaImageId", "type": "string", "info": "The ID of the AFI.", "required": true, "schema": { "title": "fpgaImageId", "type": "string" } }, { "name": "attribute", "type": "string", "info": "The AFI attribute.", "required": true, "schema": { "title": "attribute", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeFpgaImageAttribute" }, "task": true }, { "name": "describeFpgaImageAttributeSTSRole", "summary": "Describes the specified attribute of the specified Amazon FPGA Image (AFI).", "description": "Describes the specified attribute of the specified Amazon FPGA Image (AFI).", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "fpgaImageId", "type": "string", "info": "The ID of the AFI.", "required": true, "schema": { "title": "fpgaImageId", "type": "string" } }, { "name": "attribute", "type": "string", "info": "The AFI attribute.", "required": true, "schema": { "title": "attribute", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeFpgaImageAttributeSTSRole" }, "task": true }, { "name": "describeFpgaImages", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "fpgaImageId", "type": "array", "info": "The AFI IDs.", "required": false, "schema": { "title": "fpgaImageId", "type": "array" } }, { "name": "owner", "type": "array", "info": "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 ).", "required": false, "schema": { "title": "owner", "type": "array" } }, { "name": "filter", "type": "array", "info": "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...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "nextToken", "type": "string", "info": "The token to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return in a single call.", "required": false, "schema": { "title": "maxResults", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeFpgaImages" }, "task": true }, { "name": "describeFpgaImagesSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "fpgaImageId", "type": "array", "info": "The AFI IDs.", "required": false, "schema": { "title": "fpgaImageId", "type": "array" } }, { "name": "owner", "type": "array", "info": "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 ).", "required": false, "schema": { "title": "owner", "type": "array" } }, { "name": "filter", "type": "array", "info": "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...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "nextToken", "type": "string", "info": "The token to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return in a single call.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeFpgaImagesSTSRole" }, "task": true }, { "name": "describeHostReservationOfferings", "summary": "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 Ela...(description truncated)", "description": "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 Ela...(description truncated)", "input": [ { "name": "filter", "type": "array", "info": "The filters. instance-family - The instance family of the offering (for example, m4 ). payment-option - The payment option ( NoUpfront | PartialUpfr...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxDuration", "type": "number", "info": "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 spec...(description truncated)", "required": false, "schema": { "title": "maxDuration", "type": "number" } }, { "name": "maxResults", "type": "number", "info": "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...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "minDuration", "type": "number", "info": "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 s...(description truncated)", "required": false, "schema": { "title": "minDuration", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to use to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "offeringId", "type": "string", "info": "The ID of the reservation offering.", "required": false, "schema": { "title": "offeringId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeHostReservationOfferings" }, "task": true }, { "name": "describeHostReservationOfferingsSTSRole", "summary": "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 Ela...(description truncated)", "description": "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 Ela...(description truncated)", "input": [ { "name": "filter", "type": "array", "info": "The filters. instance-family - The instance family of the offering (for example, m4 ). payment-option - The payment option ( NoUpfront | PartialUpfr...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxDuration", "type": "number", "info": "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 spec...(description truncated)", "required": false, "schema": { "title": "maxDuration", "type": "number" } }, { "name": "maxResults", "type": "number", "info": "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...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "minDuration", "type": "number", "info": "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 s...(description truncated)", "required": false, "schema": { "title": "minDuration", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to use to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "offeringId", "type": "string", "info": "The ID of the reservation offering.", "required": false, "schema": { "title": "offeringId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeHostReservationOfferingsSTSRole" }, "task": true }, { "name": "describeHostReservations", "summary": "Describes reservations that are associated with Dedicated Hosts in your account.", "description": "Describes reservations that are associated with Dedicated Hosts in your account.", "input": [ { "name": "filter", "type": "array", "info": "The filters. instance-family - The instance family (for example, m4 ). payment-option - The payment option ( NoUpfront | PartialUpfront | AllUpfro...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "hostReservationIdSet", "type": "array", "info": "The host reservation IDs.", "required": false, "schema": { "title": "hostReservationIdSet", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "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...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to use to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeHostReservations" }, "task": true }, { "name": "describeHostReservationsSTSRole", "summary": "Describes reservations that are associated with Dedicated Hosts in your account.", "description": "Describes reservations that are associated with Dedicated Hosts in your account.", "input": [ { "name": "filter", "type": "array", "info": "The filters. instance-family - The instance family (for example, m4 ). payment-option - The payment option ( NoUpfront | PartialUpfront | AllUpfro...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "hostReservationIdSet", "type": "array", "info": "The host reservation IDs.", "required": false, "schema": { "title": "hostReservationIdSet", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "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...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to use to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeHostReservationsSTSRole" }, "task": true }, { "name": "describeHosts", "summary": "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 .", "description": "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 .", "input": [ { "name": "filter", "type": "array", "info": "The filters. auto-placement - Whether auto-placement is enabled or disabled ( on | off ). availability-zone - The Availability Zone of the host. ...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "hostId", "type": "array", "info": "The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.", "required": false, "schema": { "title": "hostId", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "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...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeHosts" }, "task": true }, { "name": "describeHostsSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "filter", "type": "array", "info": "The filters. auto-placement - Whether auto-placement is enabled or disabled ( on | off ). availability-zone - The Availability Zone of the host. ...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "hostId", "type": "array", "info": "The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.", "required": false, "schema": { "title": "hostId", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "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...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeHostsSTSRole" }, "task": true }, { "name": "describeIamInstanceProfileAssociations", "summary": "Describes your IAM instance profile associations.", "description": "Describes your IAM instance profile associations.", "input": [ { "name": "associationId", "type": "array", "info": "The IAM instance profile associations.", "required": false, "schema": { "title": "associationId", "type": "array" } }, { "name": "filter", "type": "array", "info": "The filters. instance-id - The ID of the instance. state - The state of the association ( associating | associated | disassociating | disassociat...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to request the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeIamInstanceProfileAssociations" }, "task": true }, { "name": "describeIamInstanceProfileAssociationsSTSRole", "summary": "Describes your IAM instance profile associations.", "description": "Describes your IAM instance profile associations.", "input": [ { "name": "associationId", "type": "array", "info": "The IAM instance profile associations.", "required": false, "schema": { "title": "associationId", "type": "array" } }, { "name": "filter", "type": "array", "info": "The filters. instance-id - The ID of the instance. state - The state of the association ( associating | associated | disassociating | disassociat...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to request the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeIamInstanceProfileAssociationsSTSRole" }, "task": true }, { "name": "describeIdFormat", "summary": "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 | ...(description truncated)", "description": "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 | ...(description truncated)", "input": [ { "name": "resource", "type": "string", "info": "The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log ...(description truncated)", "required": false, "schema": { "title": "resource", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeIdFormat" }, "task": true }, { "name": "describeIdFormatSTSRole", "summary": "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 | ...(description truncated)", "description": "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 | ...(description truncated)", "input": [ { "name": "resource", "type": "string", "info": "The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log ...(description truncated)", "required": false, "schema": { "title": "resource", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeIdFormatSTSRole" }, "task": true }, { "name": "describeIdentityIdFormat", "summary": "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...(description truncated)", "description": "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...(description truncated)", "input": [ { "name": "principalArn", "type": "string", "info": "The ARN of the principal, which can be an IAM role, IAM user, or the root user.", "required": true, "schema": { "title": "principalArn", "type": "string" } }, { "name": "resource", "type": "string", "info": "The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log ...(description truncated)", "required": false, "schema": { "title": "resource", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeIdentityIdFormat" }, "task": true }, { "name": "describeIdentityIdFormatSTSRole", "summary": "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...(description truncated)", "description": "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...(description truncated)", "input": [ { "name": "principalArn", "type": "string", "info": "The ARN of the principal, which can be an IAM role, IAM user, or the root user.", "required": true, "schema": { "title": "principalArn", "type": "string" } }, { "name": "resource", "type": "string", "info": "The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log ...(description truncated)", "required": false, "schema": { "title": "resource", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeIdentityIdFormatSTSRole" }, "task": true }, { "name": "describeImageAttribute", "summary": "Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.", "description": "Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.", "input": [ { "name": "attribute", "type": "string", "info": "The AMI attribute. Note : Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use Des...(description truncated)", "required": true, "schema": { "title": "attribute", "type": "string" } }, { "name": "imageId", "type": "string", "info": "The ID of the AMI.", "required": true, "schema": { "title": "imageId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeImageAttribute" }, "task": true }, { "name": "describeImageAttributeSTSRole", "summary": "Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.", "description": "Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.", "input": [ { "name": "attribute", "type": "string", "info": "The AMI attribute. Note : Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use Des...(description truncated)", "required": true, "schema": { "title": "attribute", "type": "string" } }, { "name": "imageId", "type": "string", "info": "The ID of the AMI.", "required": true, "schema": { "title": "imageId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeImageAttributeSTSRole" }, "task": true }, { "name": "describeImages", "summary": "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 ima...(description truncated)", "description": "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 ima...(description truncated)", "input": [ { "name": "executableBy", "type": "array", "info": "Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).", "required": false, "schema": { "title": "executableBy", "type": "array" } }, { "name": "filter", "type": "array", "info": "The filters. architecture - The image architecture ( i386 | x86_64 ). block-device-mapping.delete-on-termination - A Boolean value that indicates whe...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "imageId", "type": "array", "info": "The image IDs. Default: Describes all images available to you.", "required": false, "schema": { "title": "imageId", "type": "array" } }, { "name": "owner", "type": "array", "info": "Filters the images by the owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketpla...(description truncated)", "required": false, "schema": { "title": "owner", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeImages" }, "task": true }, { "name": "describeImagesSTSRole", "summary": "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 ima...(description truncated)", "description": "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 ima...(description truncated)", "input": [ { "name": "executableBy", "type": "array", "info": "Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).", "required": false, "schema": { "title": "executableBy", "type": "array" } }, { "name": "filter", "type": "array", "info": "The filters. architecture - The image architecture ( i386 | x86_64 ). block-device-mapping.delete-on-termination - A Boolean value that indicates whe...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "imageId", "type": "array", "info": "The image IDs. Default: Describes all images available to you.", "required": false, "schema": { "title": "imageId", "type": "array" } }, { "name": "owner", "type": "array", "info": "Filters the images by the owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketpla...(description truncated)", "required": false, "schema": { "title": "owner", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeImagesSTSRole" }, "task": true }, { "name": "describeImagesSTSRoleAdditionalOptions", "summary": "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 ima...(description truncated)", "description": "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 ima...(description truncated)", "input": [ { "name": "executableBy", "type": "array", "info": "Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).", "required": false, "schema": { "title": "executableBy", "type": "array" } }, { "name": "filter", "type": "array", "info": "The filters. architecture - The image architecture ( i386 | x86_64 ). block-device-mapping.delete-on-termination - A Boolean value that indicates whe...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "imageId", "type": "array", "info": "The image IDs. Default: Describes all images available to you.", "required": false, "schema": { "title": "imageId", "type": "array" } }, { "name": "owner", "type": "array", "info": "Filters the images by the owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketpla...(description truncated)", "required": false, "schema": { "title": "owner", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } }, { "name": "includeDeprecated", "type": "boolean", "info": "Specifies whether to include deprecated AMIs.", "required": false, "schema": { "title": "includeDeprecated", "type": "boolean" } }, { "name": "includeDisabled", "type": "boolean", "info": "Specifies whether to include disabled AMIs.", "required": false, "schema": { "title": "includeDisabled", "type": "boolean" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of items to return for this reques", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "he token returned from a previous paginated request.", "required": false, "schema": { "title": "nextToken", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeImagesSTSRoleAdditionalOptions" }, "task": true }, { "name": "describeImportImageTasks", "summary": "Displays details about an import virtual machine or import snapshot tasks that are already created.", "description": "Displays details about an import virtual machine or import snapshot tasks that are already created.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "filters", "type": "array", "info": "Filter tasks using the task-state filter and one of the following values: active, completed, deleting, deleted.", "required": false, "schema": { "title": "filters", "type": "array" } }, { "name": "importTaskId", "type": "array", "info": "A list of import image task IDs.", "required": false, "schema": { "title": "importTaskId", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "A token that indicates the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeImportImageTasks" }, "task": true }, { "name": "describeImportImageTasksSTSRole", "summary": "Displays details about an import virtual machine or import snapshot tasks that are already created.", "description": "Displays details about an import virtual machine or import snapshot tasks that are already created.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "filters", "type": "array", "info": "Filter tasks using the task-state filter and one of the following values: active, completed, deleting, deleted.", "required": false, "schema": { "title": "filters", "type": "array" } }, { "name": "importTaskId", "type": "array", "info": "A list of import image task IDs.", "required": false, "schema": { "title": "importTaskId", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "A token that indicates the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeImportImageTasksSTSRole" }, "task": true }, { "name": "describeImportSnapshotTasks", "summary": "Describes your import snapshot tasks.", "description": "Describes your import snapshot tasks.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "filters", "type": "array", "info": "The filters.", "required": false, "schema": { "title": "filters", "type": "array" } }, { "name": "importTaskId", "type": "array", "info": "A list of import snapshot task IDs.", "required": false, "schema": { "title": "importTaskId", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "A token that indicates the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeImportSnapshotTasks" }, "task": true }, { "name": "describeImportSnapshotTasksSTSRole", "summary": "Describes your import snapshot tasks.", "description": "Describes your import snapshot tasks.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "filters", "type": "array", "info": "The filters.", "required": false, "schema": { "title": "filters", "type": "array" } }, { "name": "importTaskId", "type": "array", "info": "A list of import snapshot task IDs.", "required": false, "schema": { "title": "importTaskId", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "A token that indicates the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeImportSnapshotTasksSTSRole" }, "task": true }, { "name": "describeInstanceAttribute", "summary": "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", "description": "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", "input": [ { "name": "attribute", "type": "string", "info": "The instance attribute. Note: The enaSupport attribute is not supported at this time.", "required": true, "schema": { "title": "attribute", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "instanceId", "type": "string", "info": "The ID of the instance.", "required": true, "schema": { "title": "instanceId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeInstanceAttribute" }, "task": true }, { "name": "describeInstanceAttributeSTSRole", "summary": "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", "description": "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", "input": [ { "name": "attribute", "type": "string", "info": "The instance attribute. Note: The enaSupport attribute is not supported at this time.", "required": true, "schema": { "title": "attribute", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "instanceId", "type": "string", "info": "The ID of the instance.", "required": true, "schema": { "title": "instanceId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeInstanceAttributeSTSRole" }, "task": true }, { "name": "describeInstanceCreditSpecifications", "summary": "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 ...(description truncated)", "description": "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 ...(description truncated)", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "filter", "type": "array", "info": "The filters. instance-id - The ID of the instance.", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "instanceId", "type": "array", "info": "The instance IDs. Default: Describes all your instances. Constraints: Maximum 1000 explicitly specified instance IDs.", "required": false, "schema": { "title": "instanceId", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "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 betw...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeInstanceCreditSpecifications" }, "task": true }, { "name": "describeInstanceCreditSpecificationsSTSRole", "summary": "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 ...(description truncated)", "description": "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 ...(description truncated)", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "filter", "type": "array", "info": "The filters. instance-id - The ID of the instance.", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "instanceId", "type": "array", "info": "The instance IDs. Default: Describes all your instances. Constraints: Maximum 1000 explicitly specified instance IDs.", "required": false, "schema": { "title": "instanceId", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "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 betw...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeInstanceCreditSpecificationsSTSRole" }, "task": true }, { "name": "describeInstanceStatus", "summary": "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 th...(description truncated)", "description": "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 th...(description truncated)", "input": [ { "name": "filter", "type": "array", "info": "The filters. availability-zone - The Availability Zone of the instance. event.code - The code for the scheduled event ( instance-reboot | system-rebo...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "instanceId", "type": "array", "info": "The instance IDs. Default: Describes all your instances. Constraints: Maximum 100 explicitly specified instance IDs.", "required": false, "schema": { "title": "instanceId", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "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 betw...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "includeAllInstances", "type": "boolean", "info": "When true , includes the health status for all instances. When false , includes the health status for running instances only. Default: false", "required": false, "schema": { "title": "includeAllInstances", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeInstanceStatus" }, "task": true }, { "name": "describeInstanceStatusSTSRole", "summary": "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 th...(description truncated)", "description": "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 th...(description truncated)", "input": [ { "name": "filter", "type": "array", "info": "The filters. availability-zone - The Availability Zone of the instance. event.code - The code for the scheduled event ( instance-reboot | system-rebo...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "instanceId", "type": "array", "info": "The instance IDs. Default: Describes all your instances. Constraints: Maximum 100 explicitly specified instance IDs.", "required": false, "schema": { "title": "instanceId", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "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 betw...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "includeAllInstances", "type": "boolean", "info": "When true , includes the health status for all instances. When false , includes the health status for running instances only. Default: false", "required": false, "schema": { "title": "includeAllInstances", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeInstanceStatusSTSRole" }, "task": true }, { "name": "describeInstances", "summary": "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...(description truncated)", "description": "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...(description truncated)", "input": [ { "name": "filter", "type": "array", "info": "The filters. affinity - The affinity setting for an instance running on a Dedicated Host ( default | host ). architecture - The instance architecture...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "instanceId", "type": "array", "info": "The instance IDs. Default: Describes all your instances.", "required": false, "schema": { "title": "instanceId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "maxResults", "type": "number", "info": "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 betw...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to request the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeInstances" }, "task": true }, { "name": "describeInstancesSTSRole", "summary": "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...(description truncated)", "description": "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...(description truncated)", "input": [ { "name": "filter", "type": "array", "info": "The filters. affinity - The affinity setting for an instance running on a Dedicated Host ( default | host ). architecture - The instance architecture...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "instanceId", "type": "array", "info": "The instance IDs. Default: Describes all your instances.", "required": false, "schema": { "title": "instanceId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "maxResults", "type": "number", "info": "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 betw...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to request the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeInstancesSTSRole" }, "task": true }, { "name": "describeInternetGateways", "summary": "Describes one or more of your internet gateways.", "description": "Describes one or more of your internet gateways.", "input": [ { "name": "filter", "type": "array", "info": "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. ...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "internetGatewayId", "type": "array", "info": "One or more internet gateway IDs. Default: Describes all your internet gateways.", "required": false, "schema": { "title": "internetGatewayId", "type": "array" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeInternetGateways" }, "task": true }, { "name": "describeInternetGatewaysSTSRole", "summary": "Describes one or more of your internet gateways.", "description": "Describes one or more of your internet gateways.", "input": [ { "name": "filter", "type": "array", "info": "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. ...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "internetGatewayId", "type": "array", "info": "One or more internet gateway IDs. Default: Describes all your internet gateways.", "required": false, "schema": { "title": "internetGatewayId", "type": "array" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeInternetGatewaysSTSRole" }, "task": true }, { "name": "describeKeyPairs", "summary": "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 .", "description": "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 .", "input": [ { "name": "filter", "type": "array", "info": "The filters. fingerprint - The fingerprint of the key pair. key-name - The name of the key pair.", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "keyName", "type": "array", "info": "The key pair names. Default: Describes all your key pairs.", "required": false, "schema": { "title": "keyName", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeKeyPairs" }, "task": true }, { "name": "describeKeyPairsSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "filter", "type": "array", "info": "The filters. fingerprint - The fingerprint of the key pair. key-name - The name of the key pair.", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "keyName", "type": "array", "info": "The key pair names. Default: Describes all your key pairs.", "required": false, "schema": { "title": "keyName", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeKeyPairsSTSRole" }, "task": true }, { "name": "describeLaunchTemplateVersions", "summary": "Describes one or more versions of a specified launch template. You can describe all versions, individual versions, or a range of versions.", "description": "Describes one or more versions of a specified launch template. You can describe all versions, individual versions, or a range of versions.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "launchTemplateId", "type": "string", "info": "The ID of the launch template. You must specify either the launch template ID or launch template name in the request.", "required": false, "schema": { "title": "launchTemplateId", "type": "string" } }, { "name": "launchTemplateName", "type": "string", "info": "The name of the launch template. You must specify either the launch template ID or launch template name in the request.", "required": false, "schema": { "title": "launchTemplateName", "type": "string" } }, { "name": "launchTemplateVersion", "type": "array", "info": "One or more versions of the launch template.", "required": false, "schema": { "title": "launchTemplateVersion", "type": "array" } }, { "name": "minVersion", "type": "string", "info": "The version number after which to describe launch template versions.", "required": false, "schema": { "title": "minVersion", "type": "string" } }, { "name": "maxVersion", "type": "string", "info": "The version number up to which to describe launch template versions.", "required": false, "schema": { "title": "maxVersion", "type": "string" } }, { "name": "nextToken", "type": "string", "info": "The token to request the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "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 betw...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "filter", "type": "array", "info": "One or more filters. create-time - The time the launch template version was created. ebs-optimized - A boolean that indicates whether the instance is o...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeLaunchTemplateVersions" }, "task": true }, { "name": "describeLaunchTemplateVersionsSTSRole", "summary": "Describes one or more versions of a specified launch template. You can describe all versions, individual versions, or a range of versions.", "description": "Describes one or more versions of a specified launch template. You can describe all versions, individual versions, or a range of versions.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "launchTemplateId", "type": "string", "info": "The ID of the launch template. You must specify either the launch template ID or launch template name in the request.", "required": false, "schema": { "title": "launchTemplateId", "type": "string" } }, { "name": "launchTemplateName", "type": "string", "info": "The name of the launch template. You must specify either the launch template ID or launch template name in the request.", "required": false, "schema": { "title": "launchTemplateName", "type": "string" } }, { "name": "launchTemplateVersion", "type": "array", "info": "One or more versions of the launch template.", "required": false, "schema": { "title": "launchTemplateVersion", "type": "array" } }, { "name": "minVersion", "type": "string", "info": "The version number after which to describe launch template versions.", "required": false, "schema": { "title": "minVersion", "type": "string" } }, { "name": "maxVersion", "type": "string", "info": "The version number up to which to describe launch template versions.", "required": false, "schema": { "title": "maxVersion", "type": "string" } }, { "name": "nextToken", "type": "string", "info": "The token to request the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "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 betw...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "filter", "type": "array", "info": "One or more filters. create-time - The time the launch template version was created. ebs-optimized - A boolean that indicates whether the instance is o...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeLaunchTemplateVersionsSTSRole" }, "task": true }, { "name": "describeLaunchTemplates", "summary": "Describes one or more launch templates.", "description": "Describes one or more launch templates.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "launchTemplateId", "type": "array", "info": "One or more launch template IDs.", "required": false, "schema": { "title": "launchTemplateId", "type": "array" } }, { "name": "launchTemplateName", "type": "array", "info": "One or more launch template names.", "required": false, "schema": { "title": "launchTemplateName", "type": "array" } }, { "name": "filter", "type": "array", "info": "One or more filters. create-time - The time the launch template was created. launch-template-name - The name of the launch template. tag :<k...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "nextToken", "type": "string", "info": "The token to request the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "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 betw...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeLaunchTemplates" }, "task": true }, { "name": "describeLaunchTemplatesSTSRole", "summary": "Describes one or more launch templates.", "description": "Describes one or more launch templates.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "launchTemplateId", "type": "array", "info": "One or more launch template IDs.", "required": false, "schema": { "title": "launchTemplateId", "type": "array" } }, { "name": "launchTemplateName", "type": "array", "info": "One or more launch template names.", "required": false, "schema": { "title": "launchTemplateName", "type": "array" } }, { "name": "filter", "type": "array", "info": "One or more filters. create-time - The time the launch template was created. launch-template-name - The name of the launch template. tag :<k...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "nextToken", "type": "string", "info": "The token to request the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "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 betw...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeLaunchTemplatesSTSRole" }, "task": true }, { "name": "describeMovingAddresses", "summary": "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.", "description": "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.", "input": [ { "name": "filter", "type": "array", "info": "One or more filters. moving-status - The status of the Elastic IP address ( MovingToVpc | RestoringToClassic ).", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "maxResults", "type": "number", "info": "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 re...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "publicIp", "type": "array", "info": "One or more Elastic IP addresses.", "required": false, "schema": { "title": "publicIp", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeMovingAddresses" }, "task": true }, { "name": "describeMovingAddressesSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "filter", "type": "array", "info": "One or more filters. moving-status - The status of the Elastic IP address ( MovingToVpc | RestoringToClassic ).", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "maxResults", "type": "number", "info": "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 re...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "publicIp", "type": "array", "info": "One or more Elastic IP addresses.", "required": false, "schema": { "title": "publicIp", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeMovingAddressesSTSRole" }, "task": true }, { "name": "describeNatGateways", "summary": "Describes one or more of your NAT gateways.", "description": "Describes one or more of your NAT gateways.", "input": [ { "name": "filter", "type": "array", "info": "One or more filters. nat-gateway-id - The ID of the NAT gateway. state - The state of the NAT gateway ( pending | failed | available | deleting ...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "natGatewayId", "type": "array", "info": "One or more NAT gateway IDs.", "required": false, "schema": { "title": "natGatewayId", "type": "array" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeNatGateways" }, "task": true }, { "name": "describeNatGatewaysSTSRole", "summary": "Describes one or more of your NAT gateways.", "description": "Describes one or more of your NAT gateways.", "input": [ { "name": "filter", "type": "array", "info": "One or more filters. nat-gateway-id - The ID of the NAT gateway. state - The state of the NAT gateway ( pending | failed | available | deleting ...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "natGatewayId", "type": "array", "info": "One or more NAT gateway IDs.", "required": false, "schema": { "title": "natGatewayId", "type": "array" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeNatGatewaysSTSRole" }, "task": true }, { "name": "describeNetworkAcls", "summary": "Describes one or more of your network ACLs. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide .", "description": "Describes one or more of your network ACLs. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide .", "input": [ { "name": "filter", "type": "array", "info": "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 invol...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "networkAclId", "type": "array", "info": "One or more network ACL IDs. Default: Describes all your network ACLs.", "required": false, "schema": { "title": "networkAclId", "type": "array" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeNetworkAcls" }, "task": true }, { "name": "describeNetworkAclsSTSRole", "summary": "Describes one or more of your network ACLs. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide .", "description": "Describes one or more of your network ACLs. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide .", "input": [ { "name": "filter", "type": "array", "info": "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 invol...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "networkAclId", "type": "array", "info": "One or more network ACL IDs. Default: Describes all your network ACLs.", "required": false, "schema": { "title": "networkAclId", "type": "array" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeNetworkAclsSTSRole" }, "task": true }, { "name": "describeNetworkInterfaceAttribute", "summary": "Describes a network interface attribute. You can specify only one attribute at a time.", "description": "Describes a network interface attribute. You can specify only one attribute at a time.", "input": [ { "name": "attribute", "type": "string", "info": "The attribute of the network interface. This parameter is required.", "required": false, "schema": { "title": "attribute", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "networkInterfaceId", "type": "string", "info": "The ID of the network interface.", "required": true, "schema": { "title": "networkInterfaceId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeNetworkInterfaceAttribute" }, "task": true }, { "name": "describeNetworkInterfaceAttributeSTSRole", "summary": "Describes a network interface attribute. You can specify only one attribute at a time.", "description": "Describes a network interface attribute. You can specify only one attribute at a time.", "input": [ { "name": "attribute", "type": "string", "info": "The attribute of the network interface. This parameter is required.", "required": false, "schema": { "title": "attribute", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "networkInterfaceId", "type": "string", "info": "The ID of the network interface.", "required": true, "schema": { "title": "networkInterfaceId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeNetworkInterfaceAttributeSTSRole" }, "task": true }, { "name": "describeNetworkInterfacePermissions", "summary": "Describes the permissions for your network interfaces.", "description": "Describes the permissions for your network interfaces.", "input": [ { "name": "networkInterfacePermissionId", "type": "array", "info": "One or more network interface permission IDs.", "required": false, "schema": { "title": "networkInterfacePermissionId", "type": "array" } }, { "name": "filter", "type": "array", "info": "One or more filters. network-interface-permission.network-interface-permission-id - The ID of the permission. network-interface-permission.network-inter...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "nextToken", "type": "string", "info": "The token to request the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "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 n...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeNetworkInterfacePermissions" }, "task": true }, { "name": "describeNetworkInterfacePermissionsSTSRole", "summary": "Describes the permissions for your network interfaces.", "description": "Describes the permissions for your network interfaces.", "input": [ { "name": "networkInterfacePermissionId", "type": "array", "info": "One or more network interface permission IDs.", "required": false, "schema": { "title": "networkInterfacePermissionId", "type": "array" } }, { "name": "filter", "type": "array", "info": "One or more filters. network-interface-permission.network-interface-permission-id - The ID of the permission. network-interface-permission.network-inter...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "nextToken", "type": "string", "info": "The token to request the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "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 n...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeNetworkInterfacePermissionsSTSRole" }, "task": true }, { "name": "describeNetworkInterfaces", "summary": "Describes one or more of your network interfaces.", "description": "Describes one or more of your network interfaces.", "input": [ { "name": "filter", "type": "array", "info": "One or more filters. addresses.private-ip-address - The private IPv4 addresses associated with the network interface. addresses.primary - Whether the p...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "networkInterfaceId", "type": "array", "info": "One or more network interface IDs. Default: Describes all your network interfaces.", "required": false, "schema": { "title": "networkInterfaceId", "type": "array" } }, { "name": "nextToken", "type": "string", "info": "The token to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "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.", "required": false, "schema": { "title": "maxResults", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeNetworkInterfaces" }, "task": true }, { "name": "describeNetworkInterfacesSTSRole", "summary": "Describes one or more of your network interfaces.", "description": "Describes one or more of your network interfaces.", "input": [ { "name": "filter", "type": "array", "info": "One or more filters. addresses.private-ip-address - The private IPv4 addresses associated with the network interface. addresses.primary - Whether the p...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "networkInterfaceId", "type": "array", "info": "One or more network interface IDs. Default: Describes all your network interfaces.", "required": false, "schema": { "title": "networkInterfaceId", "type": "array" } }, { "name": "nextToken", "type": "string", "info": "The token to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "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.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeNetworkInterfacesSTSRole" }, "task": true }, { "name": "describePlacementGroups", "summary": "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 .", "description": "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 .", "input": [ { "name": "filter", "type": "array", "info": "The filters. group-name - The name of the placement group. state - The state of the placement group ( pending | available | deleting | deleted )....(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "groupName", "type": "array", "info": "The names of the placement groups. Default: Describes all your placement groups, or only those otherwise specified.", "required": false, "schema": { "title": "groupName", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describePlacementGroups" }, "task": true }, { "name": "describePlacementGroupsSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "filter", "type": "array", "info": "The filters. group-name - The name of the placement group. state - The state of the placement group ( pending | available | deleting | deleted )....(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "groupName", "type": "array", "info": "The names of the placement groups. Default: Describes all your placement groups, or only those otherwise specified.", "required": false, "schema": { "title": "groupName", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describePlacementGroupsSTSRole" }, "task": true }, { "name": "describePrefixLists", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "filter", "type": "array", "info": "One or more filters. prefix-list-id : The ID of a prefix list. prefix-list-name : The name of a prefix list.", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "prefixListId", "type": "array", "info": "One or more prefix list IDs.", "required": false, "schema": { "title": "prefixListId", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describePrefixLists" }, "task": true }, { "name": "describePrefixListsSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "filter", "type": "array", "info": "One or more filters. prefix-list-id : The ID of a prefix list. prefix-list-name : The name of a prefix list.", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "prefixListId", "type": "array", "info": "One or more prefix list IDs.", "required": false, "schema": { "title": "prefixListId", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describePrefixListsSTSRole" }, "task": true }, { "name": "describePrincipalIdFormat", "summary": "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 | custom...(description truncated)", "description": "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 | custom...(description truncated)", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "resource", "type": "array", "info": "The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log ...(description truncated)", "required": false, "schema": { "title": "resource", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to request the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describePrincipalIdFormat" }, "task": true }, { "name": "describePrincipalIdFormatSTSRole", "summary": "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 | custom...(description truncated)", "description": "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 | custom...(description truncated)", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "resource", "type": "array", "info": "The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log ...(description truncated)", "required": false, "schema": { "title": "resource", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to request the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describePrincipalIdFormatSTSRole" }, "task": true }, { "name": "describePublicIpv4Pools", "summary": "Describes the specified IPv4 address pools.", "description": "Describes the specified IPv4 address pools.", "input": [ { "name": "poolId", "type": "array", "info": "The IDs of the address pools.", "required": false, "schema": { "title": "poolId", "type": "array" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describePublicIpv4Pools" }, "task": true }, { "name": "describePublicIpv4PoolsSTSRole", "summary": "Describes the specified IPv4 address pools.", "description": "Describes the specified IPv4 address pools.", "input": [ { "name": "poolId", "type": "array", "info": "The IDs of the address pools.", "required": false, "schema": { "title": "poolId", "type": "array" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describePublicIpv4PoolsSTSRole" }, "task": true }, { "name": "describeRegions", "summary": "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 .", "description": "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 .", "input": [ { "name": "filter", "type": "array", "info": "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...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "regionName", "type": "array", "info": "The names of the Regions.", "required": false, "schema": { "title": "regionName", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeRegions" }, "task": true }, { "name": "describeRegionsSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "filter", "type": "array", "info": "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...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "regionName", "type": "array", "info": "The names of the Regions.", "required": false, "schema": { "title": "regionName", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeRegionsSTSRole" }, "task": true }, { "name": "describeReservedInstances", "summary": "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 .", "description": "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 .", "input": [ { "name": "filter", "type": "array", "info": "One or more filters. availability-zone - The Availability Zone where the Reserved Instance can be used. duration - The duration of the Reserved Instanc...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "offeringClass", "type": "string", "info": "Describes whether the Reserved Instance is Standard or Convertible.", "required": false, "schema": { "title": "offeringClass", "type": "string" } }, { "name": "reservedInstancesId", "type": "array", "info": "One or more Reserved Instance IDs. Default: Describes all your Reserved Instances, or only those otherwise specified.", "required": false, "schema": { "title": "reservedInstancesId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "offeringType", "type": "string", "info": "The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance of...(description truncated)", "required": false, "schema": { "title": "offeringType", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeReservedInstances" }, "task": true }, { "name": "describeReservedInstancesSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "filter", "type": "array", "info": "One or more filters. availability-zone - The Availability Zone where the Reserved Instance can be used. duration - The duration of the Reserved Instanc...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "offeringClass", "type": "string", "info": "Describes whether the Reserved Instance is Standard or Convertible.", "required": false, "schema": { "title": "offeringClass", "type": "string" } }, { "name": "reservedInstancesId", "type": "array", "info": "One or more Reserved Instance IDs. Default: Describes all your Reserved Instances, or only those otherwise specified.", "required": false, "schema": { "title": "reservedInstancesId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "offeringType", "type": "string", "info": "The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance of...(description truncated)", "required": false, "schema": { "title": "offeringType", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeReservedInstancesSTSRole" }, "task": true }, { "name": "describeReservedInstancesListings", "summary": "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 rece...(description truncated)", "description": "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 rece...(description truncated)", "input": [ { "name": "filter", "type": "array", "info": "One or more filters. reserved-instances-id - The ID of the Reserved Instances. reserved-instances-listing-id - The ID of the Reserved Instances listing...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "reservedInstancesId", "type": "string", "info": "One or more Reserved Instance IDs.", "required": false, "schema": { "title": "reservedInstancesId", "type": "string" } }, { "name": "reservedInstancesListingId", "type": "string", "info": "One or more Reserved Instance listing IDs.", "required": false, "schema": { "title": "reservedInstancesListingId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeReservedInstancesListings" }, "task": true }, { "name": "describeReservedInstancesListingsSTSRole", "summary": "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 rece...(description truncated)", "description": "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 rece...(description truncated)", "input": [ { "name": "filter", "type": "array", "info": "One or more filters. reserved-instances-id - The ID of the Reserved Instances. reserved-instances-listing-id - The ID of the Reserved Instances listing...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "reservedInstancesId", "type": "string", "info": "One or more Reserved Instance IDs.", "required": false, "schema": { "title": "reservedInstancesId", "type": "string" } }, { "name": "reservedInstancesListingId", "type": "string", "info": "One or more Reserved Instance listing IDs.", "required": false, "schema": { "title": "reservedInstancesListingId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeReservedInstancesListingsSTSRole" }, "task": true }, { "name": "describeReservedInstancesModifications", "summary": "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.", "description": "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.", "input": [ { "name": "filter", "type": "array", "info": "One or more filters. client-token - The idempotency token for the modification request. create-date - The time when the modification request was create...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "reservedInstancesModificationId", "type": "array", "info": "IDs for the submitted modification request.", "required": false, "schema": { "title": "reservedInstancesModificationId", "type": "array" } }, { "name": "nextToken", "type": "string", "info": "The token to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeReservedInstancesModifications" }, "task": true }, { "name": "describeReservedInstancesModificationsSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "filter", "type": "array", "info": "One or more filters. client-token - The idempotency token for the modification request. create-date - The time when the modification request was create...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "reservedInstancesModificationId", "type": "array", "info": "IDs for the submitted modification request.", "required": false, "schema": { "title": "reservedInstancesModificationId", "type": "array" } }, { "name": "nextToken", "type": "string", "info": "The token to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeReservedInstancesModificationsSTSRole" }, "task": true }, { "name": "describeReservedInstancesOfferings", "summary": "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 ...(description truncated)", "description": "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 ...(description truncated)", "input": [ { "name": "availabilityZone", "type": "string", "info": "The Availability Zone in which the Reserved Instance can be used.", "required": false, "schema": { "title": "availabilityZone", "type": "string" } }, { "name": "filter", "type": "array", "info": "One or more filters. availability-zone - The Availability Zone where the Reserved Instance can be used. duration - The duration of the Reserved Instanc...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "includeMarketplace", "type": "boolean", "info": "Include Reserved Instance Marketplace offerings in the response.", "required": false, "schema": { "title": "includeMarketplace", "type": "boolean" } }, { "name": "instanceType", "type": "string", "info": "The instance type that the reservation will cover (for example, m1.small ). For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide .", "required": false, "schema": { "title": "instanceType", "type": "string" } }, { "name": "maxDuration", "type": "number", "info": "The maximum duration (in seconds) to filter when searching for offerings. Default: 94608000 (3 years)", "required": false, "schema": { "title": "maxDuration", "type": "number" } }, { "name": "maxInstanceCount", "type": "number", "info": "The maximum number of instances to filter when searching for offerings. Default: 20", "required": false, "schema": { "title": "maxInstanceCount", "type": "number" } }, { "name": "minDuration", "type": "number", "info": "The minimum duration (in seconds) to filter when searching for offerings. Default: 2592000 (1 month)", "required": false, "schema": { "title": "minDuration", "type": "number" } }, { "name": "offeringClass", "type": "string", "info": "The offering class of the Reserved Instance. Can be standard or convertible .", "required": false, "schema": { "title": "offeringClass", "type": "string" } }, { "name": "productDescription", "type": "string", "info": "The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.", "required": false, "schema": { "title": "productDescription", "type": "string" } }, { "name": "reservedInstancesOfferingId", "type": "array", "info": "One or more Reserved Instances offering IDs.", "required": false, "schema": { "title": "reservedInstancesOfferingId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "instanceTenancy", "type": "string", "info": "The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant har...(description truncated)", "required": false, "schema": { "title": "instanceTenancy", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "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 re...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "offeringType", "type": "string", "info": "The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance of...(description truncated)", "required": false, "schema": { "title": "offeringType", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeReservedInstancesOfferings" }, "task": true }, { "name": "describeReservedInstancesOfferingsSTSRole", "summary": "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 ...(description truncated)", "description": "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 ...(description truncated)", "input": [ { "name": "availabilityZone", "type": "string", "info": "The Availability Zone in which the Reserved Instance can be used.", "required": false, "schema": { "title": "availabilityZone", "type": "string" } }, { "name": "filter", "type": "array", "info": "One or more filters. availability-zone - The Availability Zone where the Reserved Instance can be used. duration - The duration of the Reserved Instanc...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "includeMarketplace", "type": "boolean", "info": "Include Reserved Instance Marketplace offerings in the response.", "required": false, "schema": { "title": "includeMarketplace", "type": "boolean" } }, { "name": "instanceType", "type": "string", "info": "The instance type that the reservation will cover (for example, m1.small ). For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide .", "required": false, "schema": { "title": "instanceType", "type": "string" } }, { "name": "maxDuration", "type": "number", "info": "The maximum duration (in seconds) to filter when searching for offerings. Default: 94608000 (3 years)", "required": false, "schema": { "title": "maxDuration", "type": "number" } }, { "name": "maxInstanceCount", "type": "number", "info": "The maximum number of instances to filter when searching for offerings. Default: 20", "required": false, "schema": { "title": "maxInstanceCount", "type": "number" } }, { "name": "minDuration", "type": "number", "info": "The minimum duration (in seconds) to filter when searching for offerings. Default: 2592000 (1 month)", "required": false, "schema": { "title": "minDuration", "type": "number" } }, { "name": "offeringClass", "type": "string", "info": "The offering class of the Reserved Instance. Can be standard or convertible .", "required": false, "schema": { "title": "offeringClass", "type": "string" } }, { "name": "productDescription", "type": "string", "info": "The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.", "required": false, "schema": { "title": "productDescription", "type": "string" } }, { "name": "reservedInstancesOfferingId", "type": "array", "info": "One or more Reserved Instances offering IDs.", "required": false, "schema": { "title": "reservedInstancesOfferingId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "instanceTenancy", "type": "string", "info": "The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant har...(description truncated)", "required": false, "schema": { "title": "instanceTenancy", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "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 re...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "offeringType", "type": "string", "info": "The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance of...(description truncated)", "required": false, "schema": { "title": "offeringType", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeReservedInstancesOfferingsSTSRole" }, "task": true }, { "name": "describeRouteTables", "summary": "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 .", "description": "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 .", "input": [ { "name": "filter", "type": "array", "info": "One or more filters. association.route-table-association-id - The ID of an association ID for the route table. association.route-table-id - The ID of t...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "routeTableId", "type": "array", "info": "One or more route table IDs. Default: Describes all your route tables.", "required": false, "schema": { "title": "routeTableId", "type": "array" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeRouteTables" }, "task": true }, { "name": "describeRouteTablesSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "filter", "type": "array", "info": "One or more filters. association.route-table-association-id - The ID of an association ID for the route table. association.route-table-id - The ID of t...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "routeTableId", "type": "array", "info": "One or more route table IDs. Default: Describes all your route tables.", "required": false, "schema": { "title": "routeTableId", "type": "array" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeRouteTablesSTSRole" }, "task": true }, { "name": "describeScheduledInstanceAvailability", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "filter", "type": "array", "info": "The filters. availability-zone - The Availability Zone (for example, us-west-2a ). instance-type - The instance type (for example, c4.large ). ...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "firstSlotStartTimeRangeEarliestTime", "type": "string", "info": "Describes the time period for a Scheduled Instance to start its first schedule. The time period must span less than one day.\nThe earliest date and time, in UTC, for the S...(description truncated)", "required": false, "schema": { "title": "firstSlotStartTimeRangeEarliestTime", "type": "string" } }, { "name": "firstSlotStartTimeRangeLatestTime", "type": "string", "info": "Describes the time period for a Scheduled Instance to start its first schedule. The time period must span less than one day.\nThe latest date and time, in UTC, for the Sch...(description truncated)", "required": false, "schema": { "title": "firstSlotStartTimeRangeLatestTime", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 300. To retrieve the remaining results, make another c...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "maxSlotDurationInHours", "type": "number", "info": "The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours and less than 1,720.", "required": false, "schema": { "title": "maxSlotDurationInHours", "type": "number" } }, { "name": "minSlotDurationInHours", "type": "number", "info": "The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly sc...(description truncated)", "required": false, "schema": { "title": "minSlotDurationInHours", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next set of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "recurrenceFrequency", "type": "string", "info": "Describes the recurring schedule for a Scheduled Instance.\nThe frequency ( Daily , Weekly , or Monthly ).", "required": false, "schema": { "title": "recurrenceFrequency", "type": "string" } }, { "name": "recurrenceInterval", "type": "string", "info": "Describes the recurring schedule for a Scheduled Instance.\nThe interval quantity. The interval unit depends on the value of Frequency . For example, every 2 weeks or eve...(description truncated)", "required": false, "schema": { "title": "recurrenceInterval", "type": "string" } }, { "name": "recurrenceOccurrenceDays", "type": "array", "info": "Describes the recurring schedule for a Scheduled Instance.\nThe days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is ...(description truncated)", "required": false, "schema": { "title": "recurrenceOccurrenceDays", "type": "array" } }, { "name": "recurrenceOccurrenceRelativeToEnd", "type": "string", "info": "Describes the recurring schedule for a Scheduled Instance.\nIndicates whether the occurrence is relative to the end of the specified week or month. You can't specify this ...(description truncated)", "required": false, "schema": { "title": "recurrenceOccurrenceRelativeToEnd", "type": "string" } }, { "name": "recurrenceOccurrenceUnit", "type": "string", "info": "Describes the recurring schedule for a Scheduled Instance.\nThe unit for OccurrenceDays ( DayOfWeek or DayOfMonth ). This value is required for a monthly schedule. You...(description truncated)", "required": false, "schema": { "title": "recurrenceOccurrenceUnit", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeScheduledInstanceAvailability" }, "task": true }, { "name": "describeScheduledInstanceAvailabilitySTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "filter", "type": "array", "info": "The filters. availability-zone - The Availability Zone (for example, us-west-2a ). instance-type - The instance type (for example, c4.large ). ...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "firstSlotStartTimeRangeEarliestTime", "type": "string", "info": "Describes the time period for a Scheduled Instance to start its first schedule. The time period must span less than one day.\nThe earliest date and time, in UTC, for the S...(description truncated)", "required": false, "schema": { "title": "firstSlotStartTimeRangeEarliestTime", "type": "string" } }, { "name": "firstSlotStartTimeRangeLatestTime", "type": "string", "info": "Describes the time period for a Scheduled Instance to start its first schedule. The time period must span less than one day.\nThe latest date and time, in UTC, for the Sch...(description truncated)", "required": false, "schema": { "title": "firstSlotStartTimeRangeLatestTime", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 300. To retrieve the remaining results, make another c...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "maxSlotDurationInHours", "type": "number", "info": "The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours and less than 1,720.", "required": false, "schema": { "title": "maxSlotDurationInHours", "type": "number" } }, { "name": "minSlotDurationInHours", "type": "number", "info": "The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly sc...(description truncated)", "required": false, "schema": { "title": "minSlotDurationInHours", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next set of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "recurrenceFrequency", "type": "string", "info": "Describes the recurring schedule for a Scheduled Instance.\nThe frequency ( Daily , Weekly , or Monthly ).", "required": false, "schema": { "title": "recurrenceFrequency", "type": "string" } }, { "name": "recurrenceInterval", "type": "string", "info": "Describes the recurring schedule for a Scheduled Instance.\nThe interval quantity. The interval unit depends on the value of Frequency . For example, every 2 weeks or eve...(description truncated)", "required": false, "schema": { "title": "recurrenceInterval", "type": "string" } }, { "name": "recurrenceOccurrenceDays", "type": "array", "info": "Describes the recurring schedule for a Scheduled Instance.\nThe days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is ...(description truncated)", "required": false, "schema": { "title": "recurrenceOccurrenceDays", "type": "array" } }, { "name": "recurrenceOccurrenceRelativeToEnd", "type": "string", "info": "Describes the recurring schedule for a Scheduled Instance.\nIndicates whether the occurrence is relative to the end of the specified week or month. You can't specify this ...(description truncated)", "required": false, "schema": { "title": "recurrenceOccurrenceRelativeToEnd", "type": "string" } }, { "name": "recurrenceOccurrenceUnit", "type": "string", "info": "Describes the recurring schedule for a Scheduled Instance.\nThe unit for OccurrenceDays ( DayOfWeek or DayOfMonth ). This value is required for a monthly schedule. You...(description truncated)", "required": false, "schema": { "title": "recurrenceOccurrenceUnit", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeScheduledInstanceAvailabilitySTSRole" }, "task": true }, { "name": "describeScheduledInstances", "summary": "Describes the specified Scheduled Instances or all your Scheduled Instances.", "description": "Describes the specified Scheduled Instances or all your Scheduled Instances.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "filter", "type": "array", "info": "The filters. availability-zone - The Availability Zone (for example, us-west-2a ). instance-type - The instance type (for example, c4.large ). ...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 100. To retrieve the remaining results, make another c...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next set of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "scheduledInstanceId", "type": "array", "info": "The Scheduled Instance IDs.", "required": false, "schema": { "title": "scheduledInstanceId", "type": "array" } }, { "name": "slotStartTimeRangeEarliestTime", "type": "string", "info": "Describes the time period for a Scheduled Instance to start its first schedule.\nThe earliest date and time, in UTC, for the Scheduled Instance to start.", "required": false, "schema": { "title": "slotStartTimeRangeEarliestTime", "type": "string" } }, { "name": "slotStartTimeRangeLatestTime", "type": "string", "info": "Describes the time period for a Scheduled Instance to start its first schedule.\nThe latest date and time, in UTC, for the Scheduled Instance to start.", "required": false, "schema": { "title": "slotStartTimeRangeLatestTime", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeScheduledInstances" }, "task": true }, { "name": "describeScheduledInstancesSTSRole", "summary": "Describes the specified Scheduled Instances or all your Scheduled Instances.", "description": "Describes the specified Scheduled Instances or all your Scheduled Instances.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "filter", "type": "array", "info": "The filters. availability-zone - The Availability Zone (for example, us-west-2a ). instance-type - The instance type (for example, c4.large ). ...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 100. To retrieve the remaining results, make another c...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next set of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "scheduledInstanceId", "type": "array", "info": "The Scheduled Instance IDs.", "required": false, "schema": { "title": "scheduledInstanceId", "type": "array" } }, { "name": "slotStartTimeRangeEarliestTime", "type": "string", "info": "Describes the time period for a Scheduled Instance to start its first schedule.\nThe earliest date and time, in UTC, for the Scheduled Instance to start.", "required": false, "schema": { "title": "slotStartTimeRangeEarliestTime", "type": "string" } }, { "name": "slotStartTimeRangeLatestTime", "type": "string", "info": "Describes the time period for a Scheduled Instance to start its first schedule.\nThe latest date and time, in UTC, for the Scheduled Instance to start.", "required": false, "schema": { "title": "slotStartTimeRangeLatestTime", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeScheduledInstancesSTSRole" }, "task": true }, { "name": "describeSecurityGroupReferences", "summary": "[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.", "description": "[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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "groupId", "type": "array", "info": "The IDs of the security groups in your account.", "required": true, "schema": { "title": "groupId", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeSecurityGroupReferences" }, "task": true }, { "name": "describeSecurityGroupReferencesSTSRole", "summary": "[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.", "description": "[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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "groupId", "type": "array", "info": "The IDs of the security groups in your account.", "required": true, "schema": { "title": "groupId", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeSecurityGroupReferencesSTSRole" }, "task": true }, { "name": "describeSecurityGroups", "summary": "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 .", "description": "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 .", "input": [ { "name": "filter", "type": "array", "info": "The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filt...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "groupId", "type": "array", "info": "The IDs of the security groups. Required for security groups in a nondefault VPC. Default: Describes all your security groups.", "required": false, "schema": { "title": "groupId", "type": "array" } }, { "name": "groupName", "type": "array", "info": "[EC2-Classic and default VPC only] The names of the security groups. You can specify either the security group name or the security group ID. For security groups in a no...(description truncated)", "required": false, "schema": { "title": "groupName", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "nextToken", "type": "string", "info": "The token to request the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value. This value can be b...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeSecurityGroups" }, "task": true }, { "name": "describeSecurityGroupsSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "filter", "type": "array", "info": "The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filt...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "groupId", "type": "array", "info": "The IDs of the security groups. Required for security groups in a nondefault VPC. Default: Describes all your security groups.", "required": false, "schema": { "title": "groupId", "type": "array" } }, { "name": "groupName", "type": "array", "info": "[EC2-Classic and default VPC only] The names of the security groups. You can specify either the security group name or the security group ID. For security groups in a no...(description truncated)", "required": false, "schema": { "title": "groupName", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "nextToken", "type": "string", "info": "The token to request the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value. This value can be b...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeSecurityGroupsSTSRole" }, "task": true }, { "name": "describeSnapshotAttribute", "summary": "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 .", "description": "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 .", "input": [ { "name": "attribute", "type": "string", "info": "The snapshot attribute you would like to view.", "required": true, "schema": { "title": "attribute", "type": "string" } }, { "name": "snapshotId", "type": "string", "info": "The ID of the EBS snapshot.", "required": true, "schema": { "title": "snapshotId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeSnapshotAttribute" }, "task": true }, { "name": "describeSnapshotAttributeSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "attribute", "type": "string", "info": "The snapshot attribute you would like to view.", "required": true, "schema": { "title": "attribute", "type": "string" } }, { "name": "snapshotId", "type": "string", "info": "The ID of the EBS snapshot.", "required": true, "schema": { "title": "snapshotId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeSnapshotAttributeSTSRole" }, "task": true }, { "name": "describeSnapshots", "summary": "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 hav...(description truncated)", "description": "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 hav...(description truncated)", "input": [ { "name": "filter", "type": "array", "info": "The filters. description - A description of the snapshot. encrypted - Indicates whether the snapshot is encrypted ( true | false ) owner-alia...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots only returns MaxResults res...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pag...(description truncated)", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "owner", "type": "array", "info": "Describes the snapshots owned by these owners.", "required": false, "schema": { "title": "owner", "type": "array" } }, { "name": "restorableBy", "type": "array", "info": "The IDs of the AWS accounts that can create volumes from the snapshot.", "required": false, "schema": { "title": "restorableBy", "type": "array" } }, { "name": "snapshotId", "type": "array", "info": "The snapshot IDs. Default: Describes the snapshots for which you have create volume permissions.", "required": false, "schema": { "title": "snapshotId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeSnapshots" }, "task": true }, { "name": "describeSnapshotsSTSRole", "summary": "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 hav...(description truncated)", "description": "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 hav...(description truncated)", "input": [ { "name": "filter", "type": "array", "info": "The filters. description - A description of the snapshot. encrypted - Indicates whether the snapshot is encrypted ( true | false ) owner-alia...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots only returns MaxResults res...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pag...(description truncated)", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "owner", "type": "array", "info": "Describes the snapshots owned by these owners.", "required": false, "schema": { "title": "owner", "type": "array" } }, { "name": "restorableBy", "type": "array", "info": "The IDs of the AWS accounts that can create volumes from the snapshot.", "required": false, "schema": { "title": "restorableBy", "type": "array" } }, { "name": "snapshotId", "type": "array", "info": "The snapshot IDs. Default: Describes the snapshots for which you have create volume permissions.", "required": false, "schema": { "title": "snapshotId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeSnapshotsSTSRole" }, "task": true }, { "name": "describeSpotDatafeedSubscription", "summary": "Describes the data feed for Spot Instances. For more information, see Spot Instance Data Feed in the Amazon EC2 User Guide for Linux Instances .", "description": "Describes the data feed for Spot Instances. For more information, see Spot Instance Data Feed in the Amazon EC2 User Guide for Linux Instances .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeSpotDatafeedSubscription" }, "task": true }, { "name": "describeSpotDatafeedSubscriptionSTSRole", "summary": "Describes the data feed for Spot Instances. For more information, see Spot Instance Data Feed in the Amazon EC2 User Guide for Linux Instances .", "description": "Describes the data feed for Spot Instances. For more information, see Spot Instance Data Feed in the Amazon EC2 User Guide for Linux Instances .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeSpotDatafeedSubscriptionSTSRole" }, "task": true }, { "name": "describeSpotFleetInstances", "summary": "Describes the running instances for the specified Spot Fleet.", "description": "Describes the running instances for the specified Spot Fleet.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "maxResults", "type": "number", "info": "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 c...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next set of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "spotFleetRequestId", "type": "string", "info": "The ID of the Spot Fleet request.", "required": true, "schema": { "title": "spotFleetRequestId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeSpotFleetInstances" }, "task": true }, { "name": "describeSpotFleetInstancesSTSRole", "summary": "Describes the running instances for the specified Spot Fleet.", "description": "Describes the running instances for the specified Spot Fleet.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "maxResults", "type": "number", "info": "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 c...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next set of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "spotFleetRequestId", "type": "string", "info": "The ID of the Spot Fleet request.", "required": true, "schema": { "title": "spotFleetRequestId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeSpotFleetInstancesSTSRole" }, "task": true }, { "name": "describeSpotFleetRequestHistory", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "eventType", "type": "string", "info": "The type of events to describe. By default, all events are described.", "required": false, "schema": { "title": "eventType", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "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 c...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next set of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "spotFleetRequestId", "type": "string", "info": "The ID of the Spot Fleet request.", "required": true, "schema": { "title": "spotFleetRequestId", "type": "string" } }, { "name": "startTime", "type": "string", "info": "The starting date and time for the events, in UTC format (for example, YYYY - MM - DD T HH : MM : SS Z).", "required": true, "schema": { "title": "startTime", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeSpotFleetRequestHistory" }, "task": true }, { "name": "describeSpotFleetRequestHistorySTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "eventType", "type": "string", "info": "The type of events to describe. By default, all events are described.", "required": false, "schema": { "title": "eventType", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "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 c...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next set of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "spotFleetRequestId", "type": "string", "info": "The ID of the Spot Fleet request.", "required": true, "schema": { "title": "spotFleetRequestId", "type": "string" } }, { "name": "startTime", "type": "string", "info": "The starting date and time for the events, in UTC format (for example, YYYY - MM - DD T HH : MM : SS Z).", "required": true, "schema": { "title": "startTime", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeSpotFleetRequestHistorySTSRole" }, "task": true }, { "name": "describeSpotFleetRequests", "summary": "Describes your Spot Fleet requests. Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.", "description": "Describes your Spot Fleet requests. Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "maxResults", "type": "number", "info": "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 c...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next set of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "spotFleetRequestId", "type": "array", "info": "The IDs of the Spot Fleet requests.", "required": false, "schema": { "title": "spotFleetRequestId", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeSpotFleetRequests" }, "task": true }, { "name": "describeSpotFleetRequestsSTSRole", "summary": "Describes your Spot Fleet requests. Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.", "description": "Describes your Spot Fleet requests. Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "maxResults", "type": "number", "info": "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 c...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next set of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "spotFleetRequestId", "type": "array", "info": "The IDs of the Spot Fleet requests.", "required": false, "schema": { "title": "spotFleetRequestId", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeSpotFleetRequestsSTSRole" }, "task": true }, { "name": "describeSpotInstanceRequests", "summary": "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 numb...(description truncated)", "description": "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 numb...(description truncated)", "input": [ { "name": "filter", "type": "array", "info": "One or more filters. availability-zone-group - The Availability Zone group. create-time - The time stamp when the Spot Instance request was created. ...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "spotInstanceRequestId", "type": "array", "info": "One or more Spot Instance request IDs.", "required": false, "schema": { "title": "spotInstanceRequestId", "type": "array" } }, { "name": "nextToken", "type": "string", "info": "The token to request the next set of results. This value is null when there are no more results to return.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return in a single call. Specify a value between 5 and 1000. To retrieve the remaining results, make another call with the returned Next...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeSpotInstanceRequests" }, "task": true }, { "name": "describeSpotInstanceRequestsSTSRole", "summary": "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 numb...(description truncated)", "description": "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 numb...(description truncated)", "input": [ { "name": "filter", "type": "array", "info": "One or more filters. availability-zone-group - The Availability Zone group. create-time - The time stamp when the Spot Instance request was created. ...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "spotInstanceRequestId", "type": "array", "info": "One or more Spot Instance request IDs.", "required": false, "schema": { "title": "spotInstanceRequestId", "type": "array" } }, { "name": "nextToken", "type": "string", "info": "The token to request the next set of results. This value is null when there are no more results to return.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return in a single call. Specify a value between 5 and 1000. To retrieve the remaining results, make another call with the returned Next...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeSpotInstanceRequestsSTSRole" }, "task": true }, { "name": "describeSpotPriceHistory", "summary": "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.", "description": "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.", "input": [ { "name": "filter", "type": "array", "info": "One or more filters. availability-zone - The Availability Zone for which prices should be returned. instance-type - The type of instance (for example, ...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "availabilityZone", "type": "string", "info": "Filters the results by the specified Availability Zone.", "required": false, "schema": { "title": "availabilityZone", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "endTime", "type": "string", "info": "The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY - MM - DD T HH : MM : SS Z).", "required": false, "schema": { "title": "endTime", "type": "string" } }, { "name": "instanceType", "type": "array", "info": "Filters the results by the specified instance types.", "required": false, "schema": { "title": "instanceType", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "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 c...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next set of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "productDescription", "type": "array", "info": "Filters the results by the specified basic product descriptions.", "required": false, "schema": { "title": "productDescription", "type": "array" } }, { "name": "startTime", "type": "string", "info": "The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY - MM - DD T HH : MM : SS Z).", "required": false, "schema": { "title": "startTime", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeSpotPriceHistory" }, "task": true }, { "name": "describeSpotPriceHistorySTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "filter", "type": "array", "info": "One or more filters. availability-zone - The Availability Zone for which prices should be returned. instance-type - The type of instance (for example, ...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "availabilityZone", "type": "string", "info": "Filters the results by the specified Availability Zone.", "required": false, "schema": { "title": "availabilityZone", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "endTime", "type": "string", "info": "The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY - MM - DD T HH : MM : SS Z).", "required": false, "schema": { "title": "endTime", "type": "string" } }, { "name": "instanceType", "type": "array", "info": "Filters the results by the specified instance types.", "required": false, "schema": { "title": "instanceType", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "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 c...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next set of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "productDescription", "type": "array", "info": "Filters the results by the specified basic product descriptions.", "required": false, "schema": { "title": "productDescription", "type": "array" } }, { "name": "startTime", "type": "string", "info": "The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY - MM - DD T HH : MM : SS Z).", "required": false, "schema": { "title": "startTime", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeSpotPriceHistorySTSRole" }, "task": true }, { "name": "describeStaleSecurityGroups", "summary": "[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.", "description": "[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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "maxResults", "type": "number", "info": "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.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next set of items to return. (You received this token from a prior call.)", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeStaleSecurityGroups" }, "task": true }, { "name": "describeStaleSecurityGroupsSTSRole", "summary": "[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.", "description": "[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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "maxResults", "type": "number", "info": "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.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next set of items to return. (You received this token from a prior call.)", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeStaleSecurityGroupsSTSRole" }, "task": true }, { "name": "describeSubnets", "summary": "Describes one or more of your subnets. For more information, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide .", "description": "Describes one or more of your subnets. For more information, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide .", "input": [ { "name": "filter", "type": "array", "info": "One or more filters. availability-zone - The Availability Zone for the subnet. You can also use availabilityZone as the filter name. availability-zone...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "subnetId", "type": "array", "info": "One or more subnet IDs. Default: Describes all your subnets.", "required": false, "schema": { "title": "subnetId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeSubnets" }, "task": true }, { "name": "describeSubnetsSTSRole", "summary": "Describes one or more of your subnets. For more information, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide .", "description": "Describes one or more of your subnets. For more information, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide .", "input": [ { "name": "filter", "type": "array", "info": "One or more filters. availability-zone - The Availability Zone for the subnet. You can also use availabilityZone as the filter name. availability-zone...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "subnetId", "type": "array", "info": "One or more subnet IDs. Default: Describes all your subnets.", "required": false, "schema": { "title": "subnetId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeSubnetsSTSRole" }, "task": true }, { "name": "describeTags", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "filter", "type": "array", "info": "The filters. key - The tag key. resource-id - The ID of the resource. resource-type - The resource type ( customer-gateway | dedicated-host ...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return in a single call. This value can be between 5 and 1000. To retrieve the remaining results, make another call with the returned Ne...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeTags" }, "task": true }, { "name": "describeTagsSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "filter", "type": "array", "info": "The filters. key - The tag key. resource-id - The ID of the resource. resource-type - The resource type ( customer-gateway | dedicated-host ...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return in a single call. This value can be between 5 and 1000. To retrieve the remaining results, make another call with the returned Ne...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeTagsSTSRole" }, "task": true }, { "name": "describeTransitGatewayAttachments", "summary": "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.", "description": "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.", "input": [ { "name": "transitGatewayAttachmentIds", "type": "array", "info": "The IDs of the attachments.", "required": false, "schema": { "title": "transitGatewayAttachmentIds", "type": "array" } }, { "name": "filter", "type": "array", "info": "One or more filters. The possible values are: association.state - The state of the association ( associating | associated | disassociating ). associ...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeTransitGatewayAttachments" }, "task": true }, { "name": "describeTransitGatewayAttachmentsSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "transitGatewayAttachmentIds", "type": "array", "info": "The IDs of the attachments.", "required": false, "schema": { "title": "transitGatewayAttachmentIds", "type": "array" } }, { "name": "filter", "type": "array", "info": "One or more filters. The possible values are: association.state - The state of the association ( associating | associated | disassociating ). associ...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeTransitGatewayAttachmentsSTSRole" }, "task": true }, { "name": "describeTransitGatewayRouteTables", "summary": "Describes one or more transit gateway route tables. By default, all transit gateway route tables are described. Alternatively, you can filter the results.", "description": "Describes one or more transit gateway route tables. By default, all transit gateway route tables are described. Alternatively, you can filter the results.", "input": [ { "name": "transitGatewayRouteTableIds", "type": "array", "info": "The IDs of the transit gateway route tables.", "required": false, "schema": { "title": "transitGatewayRouteTableIds", "type": "array" } }, { "name": "filter", "type": "array", "info": "One or more filters. The possible values are: default-association-route-table - Indicates whether this is the default association route table for the transit ga...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeTransitGatewayRouteTables" }, "task": true }, { "name": "describeTransitGatewayRouteTablesSTSRole", "summary": "Describes one or more transit gateway route tables. By default, all transit gateway route tables are described. Alternatively, you can filter the results.", "description": "Describes one or more transit gateway route tables. By default, all transit gateway route tables are described. Alternatively, you can filter the results.", "input": [ { "name": "transitGatewayRouteTableIds", "type": "array", "info": "The IDs of the transit gateway route tables.", "required": false, "schema": { "title": "transitGatewayRouteTableIds", "type": "array" } }, { "name": "filter", "type": "array", "info": "One or more filters. The possible values are: default-association-route-table - Indicates whether this is the default association route table for the transit ga...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeTransitGatewayRouteTablesSTSRole" }, "task": true }, { "name": "describeTransitGatewayVpcAttachments", "summary": "Describes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results.", "description": "Describes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results.", "input": [ { "name": "transitGatewayAttachmentIds", "type": "array", "info": "The IDs of the attachments.", "required": false, "schema": { "title": "transitGatewayAttachmentIds", "type": "array" } }, { "name": "filter", "type": "array", "info": "One or more filters. The possible values are: state - The state of the attachment ( available | deleted | deleting | failed | modifying | pendingAccep...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeTransitGatewayVpcAttachments" }, "task": true }, { "name": "describeTransitGatewayVpcAttachmentsSTSRole", "summary": "Describes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results.", "description": "Describes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results.", "input": [ { "name": "transitGatewayAttachmentIds", "type": "array", "info": "The IDs of the attachments.", "required": false, "schema": { "title": "transitGatewayAttachmentIds", "type": "array" } }, { "name": "filter", "type": "array", "info": "One or more filters. The possible values are: state - The state of the attachment ( available | deleted | deleting | failed | modifying | pendingAccep...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeTransitGatewayVpcAttachmentsSTSRole" }, "task": true }, { "name": "describeTransitGateways", "summary": "Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results.", "description": "Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results.", "input": [ { "name": "transitGatewayIds", "type": "array", "info": "The IDs of the transit gateways.", "required": false, "schema": { "title": "transitGatewayIds", "type": "array" } }, { "name": "filter", "type": "array", "info": "One or more filters. The possible values are: options.propagation-default-route-table-id - The ID of the default propagation route table. options.amazon...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeTransitGateways" }, "task": true }, { "name": "describeTransitGatewaysSTSRole", "summary": "Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results.", "description": "Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results.", "input": [ { "name": "transitGatewayIds", "type": "array", "info": "The IDs of the transit gateways.", "required": false, "schema": { "title": "transitGatewayIds", "type": "array" } }, { "name": "filter", "type": "array", "info": "One or more filters. The possible values are: options.propagation-default-route-table-id - The ID of the default propagation route table. options.amazon...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeTransitGatewaysSTSRole" }, "task": true }, { "name": "describeVolumeAttribute", "summary": "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 .", "description": "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 .", "input": [ { "name": "attribute", "type": "string", "info": "The attribute of the volume. This parameter is required.", "required": true, "schema": { "title": "attribute", "type": "string" } }, { "name": "volumeId", "type": "string", "info": "The ID of the volume.", "required": true, "schema": { "title": "volumeId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVolumeAttribute" }, "task": true }, { "name": "describeVolumeAttributeSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "attribute", "type": "string", "info": "The attribute of the volume. This parameter is required.", "required": true, "schema": { "title": "attribute", "type": "string" } }, { "name": "volumeId", "type": "string", "info": "The ID of the volume.", "required": true, "schema": { "title": "volumeId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVolumeAttributeSTSRole" }, "task": true }, { "name": "describeVolumeStatus", "summary": "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 ...(description truncated)", "description": "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 ...(description truncated)", "input": [ { "name": "filter", "type": "array", "info": "The filters. action.code - The action code for the event (for example, enable-volume-io ). action.description - A description of the action. a...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of volume results returned by DescribeVolumeStatus in paginated output. When this parameter is used, the request only returns MaxResults results in...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults , this value can be used to retrieve the n...(description truncated)", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "volumeId", "type": "array", "info": "The IDs of the volumes. Default: Describes all your volumes.", "required": false, "schema": { "title": "volumeId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVolumeStatus" }, "task": true }, { "name": "describeVolumeStatusSTSRole", "summary": "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 ...(description truncated)", "description": "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 ...(description truncated)", "input": [ { "name": "filter", "type": "array", "info": "The filters. action.code - The action code for the event (for example, enable-volume-io ). action.description - A description of the action. a...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of volume results returned by DescribeVolumeStatus in paginated output. When this parameter is used, the request only returns MaxResults results in...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults , this value can be used to retrieve the n...(description truncated)", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "volumeId", "type": "array", "info": "The IDs of the volumes. Default: Describes all your volumes.", "required": false, "schema": { "title": "volumeId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVolumeStatusSTSRole" }, "task": true }, { "name": "describeVolumes", "summary": "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 in...(description truncated)", "description": "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 in...(description truncated)", "input": [ { "name": "filter", "type": "array", "info": "The filters. attachment.attach-time - The time stamp when the attachment initiated. attachment.delete-on-termination - Whether the volume is deleted on...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "volumeId", "type": "array", "info": "The volume IDs.", "required": false, "schema": { "title": "volumeId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results i...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagin...(description truncated)", "required": false, "schema": { "title": "nextToken", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVolumes" }, "task": true }, { "name": "describeVolumesSTSRole", "summary": "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 in...(description truncated)", "description": "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 in...(description truncated)", "input": [ { "name": "filter", "type": "array", "info": "The filters. attachment.attach-time - The time stamp when the attachment initiated. attachment.delete-on-termination - Whether the volume is deleted on...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "volumeId", "type": "array", "info": "The volume IDs.", "required": false, "schema": { "title": "volumeId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results i...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagin...(description truncated)", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVolumesSTSRole" }, "task": true }, { "name": "describeVolumesModifications", "summary": "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 o...(description truncated)", "description": "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 o...(description truncated)", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "volumeId", "type": "array", "info": "The IDs of the volumes for which in-progress modifications will be described.", "required": false, "schema": { "title": "volumeId", "type": "array" } }, { "name": "filter", "type": "array", "info": "The filters. Supported filters: volume-id , modification-state , target-size , target-iops , target-volume-type , original-size , original-iops , original-volume-...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "nextToken", "type": "string", "info": "The nextToken value returned by a previous paginated request.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results (up to a limit of 500) to be returned in a paginated request.", "required": false, "schema": { "title": "maxResults", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVolumesModifications" }, "task": true }, { "name": "describeVolumesModificationsSTSRole", "summary": "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 o...(description truncated)", "description": "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 o...(description truncated)", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "volumeId", "type": "array", "info": "The IDs of the volumes for which in-progress modifications will be described.", "required": false, "schema": { "title": "volumeId", "type": "array" } }, { "name": "filter", "type": "array", "info": "The filters. Supported filters: volume-id , modification-state , target-size , target-iops , target-volume-type , original-size , original-iops , original-volume-...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "nextToken", "type": "string", "info": "The nextToken value returned by a previous paginated request.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results (up to a limit of 500) to be returned in a paginated request.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVolumesModificationsSTSRole" }, "task": true }, { "name": "describeVpcAttribute", "summary": "Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.", "description": "Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.", "input": [ { "name": "attribute", "type": "string", "info": "The VPC attribute.", "required": true, "schema": { "title": "attribute", "type": "string" } }, { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVpcAttribute" }, "task": true }, { "name": "describeVpcAttributeSTSRole", "summary": "Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.", "description": "Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.", "input": [ { "name": "attribute", "type": "string", "info": "The VPC attribute.", "required": true, "schema": { "title": "attribute", "type": "string" } }, { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVpcAttributeSTSRole" }, "task": true }, { "name": "describeVpcClassicLink", "summary": "Describes the ClassicLink status of one or more VPCs.", "description": "Describes the ClassicLink status of one or more VPCs.", "input": [ { "name": "filter", "type": "array", "info": "One or more filters. is-classic-link-enabled - Whether the VPC is enabled for ClassicLink ( true | false ). tag :<key> - The key/value combinati...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "vpcId", "type": "array", "info": "One or more VPCs for which you want to describe the ClassicLink status.", "required": false, "schema": { "title": "vpcId", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVpcClassicLink" }, "task": true }, { "name": "describeVpcClassicLinkSTSRole", "summary": "Describes the ClassicLink status of one or more VPCs.", "description": "Describes the ClassicLink status of one or more VPCs.", "input": [ { "name": "filter", "type": "array", "info": "One or more filters. is-classic-link-enabled - Whether the VPC is enabled for ClassicLink ( true | false ). tag :<key> - The key/value combinati...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "vpcId", "type": "array", "info": "One or more VPCs for which you want to describe the ClassicLink status.", "required": false, "schema": { "title": "vpcId", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVpcClassicLinkSTSRole" }, "task": true }, { "name": "describeVpcClassicLinkDnsSupport", "summary": "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 .", "description": "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 .", "input": [ { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "vpcIds", "type": "array", "info": "One or more VPC IDs.", "required": false, "schema": { "title": "vpcIds", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVpcClassicLinkDnsSupport" }, "task": true }, { "name": "describeVpcClassicLinkDnsSupportSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "vpcIds", "type": "array", "info": "One or more VPC IDs.", "required": false, "schema": { "title": "vpcIds", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVpcClassicLinkDnsSupportSTSRole" }, "task": true }, { "name": "describeVpcEndpointConnectionNotifications", "summary": "Describes the connection notifications for VPC endpoints and VPC endpoint services.", "description": "Describes the connection notifications for VPC endpoints and VPC endpoint services.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "connectionNotificationId", "type": "string", "info": "The ID of the notification.", "required": false, "schema": { "title": "connectionNotificationId", "type": "string" } }, { "name": "filter", "type": "array", "info": "One or more filters. connection-notification-arn - The ARN of SNS topic for the notification. connection-notification-id - The ID of the notification. ...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to request the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVpcEndpointConnectionNotifications" }, "task": true }, { "name": "describeVpcEndpointConnectionNotificationsSTSRole", "summary": "Describes the connection notifications for VPC endpoints and VPC endpoint services.", "description": "Describes the connection notifications for VPC endpoints and VPC endpoint services.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "connectionNotificationId", "type": "string", "info": "The ID of the notification.", "required": false, "schema": { "title": "connectionNotificationId", "type": "string" } }, { "name": "filter", "type": "array", "info": "One or more filters. connection-notification-arn - The ARN of SNS topic for the notification. connection-notification-id - The ID of the notification. ...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to request the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVpcEndpointConnectionNotificationsSTSRole" }, "task": true }, { "name": "describeVpcEndpointConnections", "summary": "Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.", "description": "Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "filter", "type": "array", "info": "One or more filters. service-id - The ID of the service. vpc-endpoint-owner - The AWS account number of the owner of the endpoint. vpc-endpoint...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "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 ret...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVpcEndpointConnections" }, "task": true }, { "name": "describeVpcEndpointConnectionsSTSRole", "summary": "Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.", "description": "Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "filter", "type": "array", "info": "One or more filters. service-id - The ID of the service. vpc-endpoint-owner - The AWS account number of the owner of the endpoint. vpc-endpoint...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "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 ret...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVpcEndpointConnectionsSTSRole" }, "task": true }, { "name": "describeVpcEndpointServiceConfigurations", "summary": "Describes the VPC endpoint service configurations in your account (your services).", "description": "Describes the VPC endpoint service configurations in your account (your services).", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "serviceId", "type": "array", "info": "The IDs of one or more services.", "required": false, "schema": { "title": "serviceId", "type": "array" } }, { "name": "filter", "type": "array", "info": "One or more filters. service-name - The name of the service. service-id - The ID of the service. service-state - The state of the service ( Pe...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "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 ret...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVpcEndpointServiceConfigurations" }, "task": true }, { "name": "describeVpcEndpointServiceConfigurationsSTSRole", "summary": "Describes the VPC endpoint service configurations in your account (your services).", "description": "Describes the VPC endpoint service configurations in your account (your services).", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "serviceId", "type": "array", "info": "The IDs of one or more services.", "required": false, "schema": { "title": "serviceId", "type": "array" } }, { "name": "filter", "type": "array", "info": "One or more filters. service-name - The name of the service. service-id - The ID of the service. service-state - The state of the service ( Pe...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "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 ret...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVpcEndpointServiceConfigurationsSTSRole" }, "task": true }, { "name": "describeVpcEndpointServicePermissions", "summary": "Describes the principals (service consumers) that are permitted to discover your VPC endpoint service.", "description": "Describes the principals (service consumers) that are permitted to discover your VPC endpoint service.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "serviceId", "type": "string", "info": "The ID of the service.", "required": true, "schema": { "title": "serviceId", "type": "string" } }, { "name": "filter", "type": "array", "info": "One or more filters. principal - The ARN of the principal. principal-type - The principal type ( All | Service | OrganizationUnit | Account | U...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "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 ret...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVpcEndpointServicePermissions" }, "task": true }, { "name": "describeVpcEndpointServicePermissionsSTSRole", "summary": "Describes the principals (service consumers) that are permitted to discover your VPC endpoint service.", "description": "Describes the principals (service consumers) that are permitted to discover your VPC endpoint service.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "serviceId", "type": "string", "info": "The ID of the service.", "required": true, "schema": { "title": "serviceId", "type": "string" } }, { "name": "filter", "type": "array", "info": "One or more filters. principal - The ARN of the principal. principal-type - The principal type ( All | Service | OrganizationUnit | Account | U...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "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 ret...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token to retrieve the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVpcEndpointServicePermissionsSTSRole" }, "task": true }, { "name": "describeVpcEndpointServices", "summary": "Describes available services to which you can create a VPC endpoint.", "description": "Describes available services to which you can create a VPC endpoint.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "serviceName", "type": "array", "info": "One or more service names.", "required": false, "schema": { "title": "serviceName", "type": "array" } }, { "name": "filter", "type": "array", "info": "One or more filters. service-name : The name of the service. tag :<key> - The key/value combination of a tag assigned to the resource. Use the tag ...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "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. Constrain...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next set of items to return. (You received this token from a prior call.)", "required": false, "schema": { "title": "nextToken", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVpcEndpointServices" }, "task": true }, { "name": "describeVpcEndpointServicesSTSRole", "summary": "Describes available services to which you can create a VPC endpoint.", "description": "Describes available services to which you can create a VPC endpoint.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "serviceName", "type": "array", "info": "One or more service names.", "required": false, "schema": { "title": "serviceName", "type": "array" } }, { "name": "filter", "type": "array", "info": "One or more filters. service-name : The name of the service. tag :<key> - The key/value combination of a tag assigned to the resource. Use the tag ...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "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. Constrain...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next set of items to return. (You received this token from a prior call.)", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVpcEndpointServicesSTSRole" }, "task": true }, { "name": "describeVpcEndpoints", "summary": "Describes one or more of your VPC endpoints.", "description": "Describes one or more of your VPC endpoints.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "vpcEndpointId", "type": "array", "info": "One or more endpoint IDs.", "required": false, "schema": { "title": "vpcEndpointId", "type": "array" } }, { "name": "filter", "type": "array", "info": "One or more filters. service-name : The name of the service. vpc-id : The ID of the VPC in which the endpoint resides. vpc-endpoint-id : The ID o...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "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. Constrain...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next set of items to return. (You received this token from a prior call.)", "required": false, "schema": { "title": "nextToken", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVpcEndpoints" }, "task": true }, { "name": "describeVpcEndpointsSTSRole", "summary": "Describes one or more of your VPC endpoints.", "description": "Describes one or more of your VPC endpoints.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "vpcEndpointId", "type": "array", "info": "One or more endpoint IDs.", "required": false, "schema": { "title": "vpcEndpointId", "type": "array" } }, { "name": "filter", "type": "array", "info": "One or more filters. service-name : The name of the service. vpc-id : The ID of the VPC in which the endpoint resides. vpc-endpoint-id : The ID o...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "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. Constrain...(description truncated)", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next set of items to return. (You received this token from a prior call.)", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVpcEndpointsSTSRole" }, "task": true }, { "name": "describeVpcPeeringConnections", "summary": "Describes one or more of your VPC peering connections.", "description": "Describes one or more of your VPC peering connections.", "input": [ { "name": "filter", "type": "array", "info": "One or more filters. accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter VPC. accepter-vpc-info.owner-id - The AWS account ID of the own...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "vpcPeeringConnectionId", "type": "array", "info": "One or more VPC peering connection IDs. Default: Describes all your VPC peering connections.", "required": false, "schema": { "title": "vpcPeeringConnectionId", "type": "array" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVpcPeeringConnections" }, "task": true }, { "name": "describeVpcPeeringConnectionsSTSRole", "summary": "Describes one or more of your VPC peering connections.", "description": "Describes one or more of your VPC peering connections.", "input": [ { "name": "filter", "type": "array", "info": "One or more filters. accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter VPC. accepter-vpc-info.owner-id - The AWS account ID of the own...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "vpcPeeringConnectionId", "type": "array", "info": "One or more VPC peering connection IDs. Default: Describes all your VPC peering connections.", "required": false, "schema": { "title": "vpcPeeringConnectionId", "type": "array" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVpcPeeringConnectionsSTSRole" }, "task": true }, { "name": "describeVpcs", "summary": "Describes one or more of your VPCs.", "description": "Describes one or more of your VPCs.", "input": [ { "name": "filter", "type": "array", "info": "One or more filters. cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be ret...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "vpcId", "type": "array", "info": "One or more VPC IDs. Default: Describes all your VPCs.", "required": false, "schema": { "title": "vpcId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVpcs" }, "task": true }, { "name": "describeVpcsSTSRole", "summary": "Describes one or more of your VPCs.", "description": "Describes one or more of your VPCs.", "input": [ { "name": "filter", "type": "array", "info": "One or more filters. cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be ret...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "vpcId", "type": "array", "info": "One or more VPC IDs. Default: Describes all your VPCs.", "required": false, "schema": { "title": "vpcId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVpcsSTSRole" }, "task": true }, { "name": "describeVpcDetails", "summary": "Describes all the VPC details associated with a vpc-id.", "description": "Describes all the VPC details associated with a vpc-id.", "input": [ { "name": "vpcId", "type": "string", "info": "A vpc id", "required": false, "schema": { "title": "vpcId", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVpcDetails" }, "task": true }, { "name": "describeVpcDetailsSTSRole", "summary": "Describes all the VPC details associated with a vpc-id.", "description": "Describes all the VPC details associated with a vpc-id.", "input": [ { "name": "vpcId", "type": "string", "info": "A vpc id", "required": false, "schema": { "title": "vpcId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVpcDetailsSTSRole" }, "task": true }, { "name": "describeVpnConnections", "summary": "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 .", "description": "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 .", "input": [ { "name": "filter", "type": "array", "info": "One or more filters. customer-gateway-configuration - The configuration information for the customer gateway. customer-gateway-id - The ID of a custome...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "vpnConnectionId", "type": "array", "info": "One or more VPN connection IDs. Default: Describes your VPN connections.", "required": false, "schema": { "title": "vpnConnectionId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVpnConnections" }, "task": true }, { "name": "describeVpnConnectionsSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "filter", "type": "array", "info": "One or more filters. customer-gateway-configuration - The configuration information for the customer gateway. customer-gateway-id - The ID of a custome...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "vpnConnectionId", "type": "array", "info": "One or more VPN connection IDs. Default: Describes your VPN connections.", "required": false, "schema": { "title": "vpnConnectionId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVpnConnectionsSTSRole" }, "task": true }, { "name": "describeVpnGateways", "summary": "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 .", "description": "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 .", "input": [ { "name": "filter", "type": "array", "info": "One or more filters. amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of the gateway. attachment.state - The current state of t...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "vpnGatewayId", "type": "array", "info": "One or more virtual private gateway IDs. Default: Describes all your virtual private gateways.", "required": false, "schema": { "title": "vpnGatewayId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVpnGateways" }, "task": true }, { "name": "describeVpnGatewaysSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "filter", "type": "array", "info": "One or more filters. amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of the gateway. attachment.state - The current state of t...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "vpnGatewayId", "type": "array", "info": "One or more virtual private gateway IDs. Default: Describes all your virtual private gateways.", "required": false, "schema": { "title": "vpnGatewayId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/describeVpnGatewaysSTSRole" }, "task": true }, { "name": "detachClassicLinkVpc", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "instanceId", "type": "string", "info": "The ID of the instance to unlink from the VPC.", "required": true, "schema": { "title": "instanceId", "type": "string" } }, { "name": "vpcId", "type": "string", "info": "The ID of the VPC to which the instance is linked.", "required": true, "schema": { "title": "vpcId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/detachClassicLinkVpc" }, "task": true }, { "name": "detachClassicLinkVpcSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "instanceId", "type": "string", "info": "The ID of the instance to unlink from the VPC.", "required": true, "schema": { "title": "instanceId", "type": "string" } }, { "name": "vpcId", "type": "string", "info": "The ID of the VPC to which the instance is linked.", "required": true, "schema": { "title": "vpcId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/detachClassicLinkVpcSTSRole" }, "task": true }, { "name": "detachInternetGateway", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "internetGatewayId", "type": "string", "info": "The ID of the internet gateway.", "required": true, "schema": { "title": "internetGatewayId", "type": "string" } }, { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/detachInternetGateway" }, "task": true }, { "name": "detachInternetGatewaySTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "internetGatewayId", "type": "string", "info": "The ID of the internet gateway.", "required": true, "schema": { "title": "internetGatewayId", "type": "string" } }, { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/detachInternetGatewaySTSRole" }, "task": true }, { "name": "detachNetworkInterface", "summary": "Detaches a network interface from an instance.", "description": "Detaches a network interface from an instance.", "input": [ { "name": "attachmentId", "type": "string", "info": "The ID of the attachment.", "required": true, "schema": { "title": "attachmentId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "force", "type": "boolean", "info": "Specifies whether to force a detachment.", "required": false, "schema": { "title": "force", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/detachNetworkInterface" }, "task": true }, { "name": "detachNetworkInterfaceSTSRole", "summary": "Detaches a network interface from an instance.", "description": "Detaches a network interface from an instance.", "input": [ { "name": "attachmentId", "type": "string", "info": "The ID of the attachment.", "required": true, "schema": { "title": "attachmentId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "force", "type": "boolean", "info": "Specifies whether to force a detachment.", "required": false, "schema": { "title": "force", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/detachNetworkInterfaceSTSRole" }, "task": true }, { "name": "detachVolume", "summary": "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 t...(description truncated)", "description": "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 t...(description truncated)", "input": [ { "name": "device", "type": "string", "info": "The device name.", "required": false, "schema": { "title": "device", "type": "string" } }, { "name": "force", "type": "boolean", "info": "Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This op...(description truncated)", "required": false, "schema": { "title": "force", "type": "boolean" } }, { "name": "instanceId", "type": "string", "info": "The ID of the instance.", "required": false, "schema": { "title": "instanceId", "type": "string" } }, { "name": "volumeId", "type": "string", "info": "The ID of the volume.", "required": true, "schema": { "title": "volumeId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/detachVolume" }, "task": true }, { "name": "detachVolumeSTSRole", "summary": "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 t...(description truncated)", "description": "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 t...(description truncated)", "input": [ { "name": "device", "type": "string", "info": "The device name.", "required": false, "schema": { "title": "device", "type": "string" } }, { "name": "force", "type": "boolean", "info": "Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This op...(description truncated)", "required": false, "schema": { "title": "force", "type": "boolean" } }, { "name": "instanceId", "type": "string", "info": "The ID of the instance.", "required": false, "schema": { "title": "instanceId", "type": "string" } }, { "name": "volumeId", "type": "string", "info": "The ID of the volume.", "required": true, "schema": { "title": "volumeId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/detachVolumeSTSRole" }, "task": true }, { "name": "detachVpnGateway", "summary": "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.", "description": "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.", "input": [ { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } }, { "name": "vpnGatewayId", "type": "string", "info": "The ID of the virtual private gateway.", "required": true, "schema": { "title": "vpnGatewayId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/detachVpnGateway" }, "task": true }, { "name": "detachVpnGatewaySTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } }, { "name": "vpnGatewayId", "type": "string", "info": "The ID of the virtual private gateway.", "required": true, "schema": { "title": "vpnGatewayId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/detachVpnGatewaySTSRole" }, "task": true }, { "name": "disableTransitGatewayRouteTablePropagation", "summary": "Disables the specified resource attachment from propagating routes to the specified propagation route table.", "description": "Disables the specified resource attachment from propagating routes to the specified propagation route table.", "input": [ { "name": "transitGatewayRouteTableId", "type": "string", "info": "The ID of the propagation route table.", "required": true, "schema": { "title": "transitGatewayRouteTableId", "type": "string" } }, { "name": "transitGatewayAttachmentId", "type": "string", "info": "The ID of the attachment.", "required": true, "schema": { "title": "transitGatewayAttachmentId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/disableTransitGatewayRouteTablePropagation" }, "task": true }, { "name": "disableTransitGatewayRouteTablePropagationSTSRole", "summary": "Disables the specified resource attachment from propagating routes to the specified propagation route table.", "description": "Disables the specified resource attachment from propagating routes to the specified propagation route table.", "input": [ { "name": "transitGatewayRouteTableId", "type": "string", "info": "The ID of the propagation route table.", "required": true, "schema": { "title": "transitGatewayRouteTableId", "type": "string" } }, { "name": "transitGatewayAttachmentId", "type": "string", "info": "The ID of the attachment.", "required": true, "schema": { "title": "transitGatewayAttachmentId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/disableTransitGatewayRouteTablePropagationSTSRole" }, "task": true }, { "name": "disableVgwRoutePropagation", "summary": "Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.", "description": "Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.", "input": [ { "name": "gatewayId", "type": "string", "info": "The ID of the virtual private gateway.", "required": true, "schema": { "title": "gatewayId", "type": "string" } }, { "name": "routeTableId", "type": "string", "info": "The ID of the route table.", "required": true, "schema": { "title": "routeTableId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/disableVgwRoutePropagation" }, "task": true }, { "name": "disableVgwRoutePropagationSTSRole", "summary": "Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.", "description": "Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.", "input": [ { "name": "gatewayId", "type": "string", "info": "The ID of the virtual private gateway.", "required": true, "schema": { "title": "gatewayId", "type": "string" } }, { "name": "routeTableId", "type": "string", "info": "The ID of the route table.", "required": true, "schema": { "title": "routeTableId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/disableVgwRoutePropagationSTSRole" }, "task": true }, { "name": "disableVpcClassicLink", "summary": "Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.", "description": "Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/disableVpcClassicLink" }, "task": true }, { "name": "disableVpcClassicLinkSTSRole", "summary": "Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.", "description": "Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/disableVpcClassicLinkSTSRole" }, "task": true }, { "name": "disableVpcClassicLinkDnsSupport", "summary": "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 .", "description": "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 .", "input": [ { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": false, "schema": { "title": "vpcId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/disableVpcClassicLinkDnsSupport" }, "task": true }, { "name": "disableVpcClassicLinkDnsSupportSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": false, "schema": { "title": "vpcId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/disableVpcClassicLinkDnsSupportSTSRole" }, "task": true }, { "name": "disassociateAddress", "summary": "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.", "description": "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.", "input": [ { "name": "associationId", "type": "string", "info": "[EC2-VPC] The association ID. Required for EC2-VPC.", "required": false, "schema": { "title": "associationId", "type": "string" } }, { "name": "publicIp", "type": "string", "info": "[EC2-Classic] The Elastic IP address. Required for EC2-Classic.", "required": false, "schema": { "title": "publicIp", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/disassociateAddress" }, "task": true }, { "name": "disassociateAddressSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "associationId", "type": "string", "info": "[EC2-VPC] The association ID. Required for EC2-VPC.", "required": false, "schema": { "title": "associationId", "type": "string" } }, { "name": "publicIp", "type": "string", "info": "[EC2-Classic] The Elastic IP address. Required for EC2-Classic.", "required": false, "schema": { "title": "publicIp", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/disassociateAddressSTSRole" }, "task": true }, { "name": "disassociateClientVpnTargetNetwork", "summary": "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", "description": "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", "input": [ { "name": "clientVpnEndpointId", "type": "string", "info": "The ID of the Client VPN endpoint from which to disassociate the target network.", "required": true, "schema": { "title": "clientVpnEndpointId", "type": "string" } }, { "name": "associationId", "type": "string", "info": "The ID of the target network association.", "required": true, "schema": { "title": "associationId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/disassociateClientVpnTargetNetwork" }, "task": true }, { "name": "disassociateClientVpnTargetNetworkSTSRole", "summary": "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", "description": "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", "input": [ { "name": "clientVpnEndpointId", "type": "string", "info": "The ID of the Client VPN endpoint from which to disassociate the target network.", "required": true, "schema": { "title": "clientVpnEndpointId", "type": "string" } }, { "name": "associationId", "type": "string", "info": "The ID of the target network association.", "required": true, "schema": { "title": "associationId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/disassociateClientVpnTargetNetworkSTSRole" }, "task": true }, { "name": "disassociateIamInstanceProfile", "summary": "Disassociates an IAM instance profile from a running or stopped instance. Use DescribeIamInstanceProfileAssociations to get the association ID.", "description": "Disassociates an IAM instance profile from a running or stopped instance. Use DescribeIamInstanceProfileAssociations to get the association ID.", "input": [ { "name": "associationId", "type": "string", "info": "The ID of the IAM instance profile association.", "required": true, "schema": { "title": "associationId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/disassociateIamInstanceProfile" }, "task": true }, { "name": "disassociateIamInstanceProfileSTSRole", "summary": "Disassociates an IAM instance profile from a running or stopped instance. Use DescribeIamInstanceProfileAssociations to get the association ID.", "description": "Disassociates an IAM instance profile from a running or stopped instance. Use DescribeIamInstanceProfileAssociations to get the association ID.", "input": [ { "name": "associationId", "type": "string", "info": "The ID of the IAM instance profile association.", "required": true, "schema": { "title": "associationId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/disassociateIamInstanceProfileSTSRole" }, "task": true }, { "name": "disassociateRouteTable", "summary": "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 .", "description": "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 .", "input": [ { "name": "associationId", "type": "string", "info": "The association ID representing the current association between the route table and subnet.", "required": true, "schema": { "title": "associationId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/disassociateRouteTable" }, "task": true }, { "name": "disassociateRouteTableSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "associationId", "type": "string", "info": "The association ID representing the current association between the route table and subnet.", "required": true, "schema": { "title": "associationId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/disassociateRouteTableSTSRole" }, "task": true }, { "name": "disassociateSubnetCidrBlock", "summary": "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.", "description": "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.", "input": [ { "name": "associationId", "type": "string", "info": "The association ID for the CIDR block.", "required": true, "schema": { "title": "associationId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDisassociateSubnetCidrBlock" }, "task": true }, { "name": "disassociateSubnetCidrBlockSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "associationId", "type": "string", "info": "The association ID for the CIDR block.", "required": true, "schema": { "title": "associationId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/disassociateSubnetCidrBlockSTSRole" }, "task": true }, { "name": "disassociateTransitGatewayRouteTable", "summary": "Disassociates a resource attachment from a transit gateway route table.", "description": "Disassociates a resource attachment from a transit gateway route table.", "input": [ { "name": "transitGatewayRouteTableId", "type": "string", "info": "The ID of the transit gateway route table.", "required": true, "schema": { "title": "transitGatewayRouteTableId", "type": "string" } }, { "name": "transitGatewayAttachmentId", "type": "string", "info": "The ID of the attachment.", "required": true, "schema": { "title": "transitGatewayAttachmentId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/disassociateTransitGatewayRouteTable" }, "task": true }, { "name": "disassociateTransitGatewayRouteTableSTSRole", "summary": "Disassociates a resource attachment from a transit gateway route table.", "description": "Disassociates a resource attachment from a transit gateway route table.", "input": [ { "name": "transitGatewayRouteTableId", "type": "string", "info": "The ID of the transit gateway route table.", "required": true, "schema": { "title": "transitGatewayRouteTableId", "type": "string" } }, { "name": "transitGatewayAttachmentId", "type": "string", "info": "The ID of the attachment.", "required": true, "schema": { "title": "transitGatewayAttachmentId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/disassociateTransitGatewayRouteTableSTSRole" }, "task": true }, { "name": "disassociateVpcCidrBlock", "summary": "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).", "description": "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).", "input": [ { "name": "associationId", "type": "string", "info": "The association ID for the CIDR block.", "required": true, "schema": { "title": "associationId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/disassociateVpcCidrBlock" }, "task": true }, { "name": "disassociateVpcCidrBlockSTSRole", "summary": "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).", "description": "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).", "input": [ { "name": "associationId", "type": "string", "info": "The association ID for the CIDR block.", "required": true, "schema": { "title": "associationId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/disassociateVpcCidrBlockSTSRole" }, "task": true }, { "name": "enableTransitGatewayRouteTablePropagation", "summary": "Enables the specified attachment to propagate routes to the specified propagation route table.", "description": "Enables the specified attachment to propagate routes to the specified propagation route table.", "input": [ { "name": "transitGatewayRouteTableId", "type": "string", "info": "The ID of the propagation route table.", "required": true, "schema": { "title": "transitGatewayRouteTableId", "type": "string" } }, { "name": "transitGatewayAttachmentId", "type": "string", "info": "The ID of the attachment.", "required": true, "schema": { "title": "transitGatewayAttachmentId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/enableTransitGatewayRouteTablePropagation" }, "task": true }, { "name": "enableTransitGatewayRouteTablePropagationSTSRole", "summary": "Enables the specified attachment to propagate routes to the specified propagation route table.", "description": "Enables the specified attachment to propagate routes to the specified propagation route table.", "input": [ { "name": "transitGatewayRouteTableId", "type": "string", "info": "The ID of the propagation route table.", "required": true, "schema": { "title": "transitGatewayRouteTableId", "type": "string" } }, { "name": "transitGatewayAttachmentId", "type": "string", "info": "The ID of the attachment.", "required": true, "schema": { "title": "transitGatewayAttachmentId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/enableTransitGatewayRouteTablePropagationSTSRole" }, "task": true }, { "name": "enableVgwRoutePropagation", "summary": "Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.", "description": "Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.", "input": [ { "name": "gatewayId", "type": "string", "info": "The ID of the virtual private gateway that is attached to a VPC. The virtual private gateway must be attached to the same VPC that the routing tables are associated with....(description truncated)", "required": true, "schema": { "title": "gatewayId", "type": "string" } }, { "name": "routeTableId", "type": "string", "info": "The ID of the route table. The routing table must be associated with the same VPC that the virtual private gateway is attached to.", "required": true, "schema": { "title": "routeTableId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/enableVgwRoutePropagation" }, "task": true }, { "name": "enableVgwRoutePropagationSTSRole", "summary": "Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.", "description": "Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.", "input": [ { "name": "gatewayId", "type": "string", "info": "The ID of the virtual private gateway that is attached to a VPC. The virtual private gateway must be attached to the same VPC that the routing tables are associated with....(description truncated)", "required": true, "schema": { "title": "gatewayId", "type": "string" } }, { "name": "routeTableId", "type": "string", "info": "The ID of the route table. The routing table must be associated with the same VPC that the virtual private gateway is attached to.", "required": true, "schema": { "title": "routeTableId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/enableVgwRoutePropagationSTSRole" }, "task": true }, { "name": "enableVolumeIO", "summary": "Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.", "description": "Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "volumeId", "type": "string", "info": "The ID of the volume.", "required": true, "schema": { "title": "volumeId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/enableVolumeIO" }, "task": true }, { "name": "enableVolumeIOSTSRole", "summary": "Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.", "description": "Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "volumeId", "type": "string", "info": "The ID of the volume.", "required": true, "schema": { "title": "volumeId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/enableVolumeIOSTSRole" }, "task": true }, { "name": "enableVpcClassicLink", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/enableVpcClassicLink" }, "task": true }, { "name": "enableVpcClassicLinkSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/enableVpcClassicLinkSTSRole" }, "task": true }, { "name": "enableVpcClassicLinkDnsSupport", "summary": "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 .", "description": "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 .", "input": [ { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": false, "schema": { "title": "vpcId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/enableVpcClassicLinkDnsSupport" }, "task": true }, { "name": "enableVpcClassicLinkDnsSupportSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": false, "schema": { "title": "vpcId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/enableVpcClassicLinkDnsSupportSTSRole" }, "task": true }, { "name": "exportClientVpnClientCertificateRevocationList", "summary": "Downloads the client certificate revocation list for the specified Client VPN endpoint.", "description": "Downloads the client certificate revocation list for the specified Client VPN endpoint.", "input": [ { "name": "clientVpnEndpointId", "type": "string", "info": "The ID of the Client VPN endpoint.", "required": true, "schema": { "title": "clientVpnEndpointId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/exportClientVpnClientCertificateRevocationList" }, "task": true }, { "name": "exportClientVpnClientCertificateRevocationListSTSRole", "summary": "Downloads the client certificate revocation list for the specified Client VPN endpoint.", "description": "Downloads the client certificate revocation list for the specified Client VPN endpoint.", "input": [ { "name": "clientVpnEndpointId", "type": "string", "info": "The ID of the Client VPN endpoint.", "required": true, "schema": { "title": "clientVpnEndpointId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/exportClientVpnClientCertificateRevocationListSTSRole" }, "task": true }, { "name": "exportClientVpnClientConfiguration", "summary": "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.", "description": "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.", "input": [ { "name": "clientVpnEndpointId", "type": "string", "info": "The ID of the Client VPN endpoint.", "required": true, "schema": { "title": "clientVpnEndpointId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/exportClientVpnClientConfiguration" }, "task": true }, { "name": "exportClientVpnClientConfigurationSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "clientVpnEndpointId", "type": "string", "info": "The ID of the Client VPN endpoint.", "required": true, "schema": { "title": "clientVpnEndpointId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/exportClientVpnClientConfigurationSTSRole" }, "task": true }, { "name": "exportTransitGatewayRoutes", "summary": "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.", "description": "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.", "input": [ { "name": "transitGatewayRouteTableId", "type": "string", "info": "The ID of the route table.", "required": true, "schema": { "title": "transitGatewayRouteTableId", "type": "string" } }, { "name": "filter", "type": "array", "info": "One or more filters. The possible values are: attachment.transit-gateway-attachment-id - The id of the transit gateway attachment. attachment.resource-id...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "s3Bucket", "type": "string", "info": "The name of the S3 bucket.", "required": true, "schema": { "title": "s3Bucket", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/exportTransitGatewayRoutes" }, "task": true }, { "name": "exportTransitGatewayRoutesSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "transitGatewayRouteTableId", "type": "string", "info": "The ID of the route table.", "required": true, "schema": { "title": "transitGatewayRouteTableId", "type": "string" } }, { "name": "filter", "type": "array", "info": "One or more filters. The possible values are: attachment.transit-gateway-attachment-id - The id of the transit gateway attachment. attachment.resource-id...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "s3Bucket", "type": "string", "info": "The name of the S3 bucket.", "required": true, "schema": { "title": "s3Bucket", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/exportTransitGatewayRoutesSTSRole" }, "task": true }, { "name": "getConsoleOutput", "summary": "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 availab...(description truncated)", "description": "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 availab...(description truncated)", "input": [ { "name": "instanceId", "type": "string", "info": "The ID of the instance.", "required": true, "schema": { "title": "instanceId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "latest", "type": "boolean", "info": "When enabled, retrieves the latest console output for the instance. Default: disabled ( false )", "required": false, "schema": { "title": "latest", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getConsoleOutput" }, "task": true }, { "name": "getConsoleOutputSTSRole", "summary": "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 availab...(description truncated)", "description": "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 availab...(description truncated)", "input": [ { "name": "instanceId", "type": "string", "info": "The ID of the instance.", "required": true, "schema": { "title": "instanceId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "latest", "type": "boolean", "info": "When enabled, retrieves the latest console output for the instance. Default: disabled ( false )", "required": false, "schema": { "title": "latest", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getConsoleOutputSTSRole" }, "task": true }, { "name": "getConsoleScreenshot", "summary": "Retrieve a JPG-format screenshot of a running instance to help with troubleshooting. The returned content is Base64-encoded.", "description": "Retrieve a JPG-format screenshot of a running instance to help with troubleshooting. The returned content is Base64-encoded.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "instanceId", "type": "string", "info": "The ID of the instance.", "required": true, "schema": { "title": "instanceId", "type": "string" } }, { "name": "wakeUp", "type": "boolean", "info": "When set to true , acts as keystroke input and wakes up an instance that's in standby or \"sleep\" mode.", "required": false, "schema": { "title": "wakeUp", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getConsoleScreenshot" }, "task": true }, { "name": "getConsoleScreenshotSTSRole", "summary": "Retrieve a JPG-format screenshot of a running instance to help with troubleshooting. The returned content is Base64-encoded.", "description": "Retrieve a JPG-format screenshot of a running instance to help with troubleshooting. The returned content is Base64-encoded.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "instanceId", "type": "string", "info": "The ID of the instance.", "required": true, "schema": { "title": "instanceId", "type": "string" } }, { "name": "wakeUp", "type": "boolean", "info": "When set to true , acts as keystroke input and wakes up an instance that's in standby or \"sleep\" mode.", "required": false, "schema": { "title": "wakeUp", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getConsoleScreenshotSTSRole" }, "task": true }, { "name": "getHostReservationPurchasePreview", "summary": "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.", "description": "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.", "input": [ { "name": "hostIdSet", "type": "array", "info": "The IDs of the Dedicated Hosts with which the reservation is associated.", "required": true, "schema": { "title": "hostIdSet", "type": "array" } }, { "name": "offeringId", "type": "string", "info": "The offering ID of the reservation.", "required": true, "schema": { "title": "offeringId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getHostReservationPurchasePreview" }, "task": true }, { "name": "getHostReservationPurchasePreviewSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "hostIdSet", "type": "array", "info": "The IDs of the Dedicated Hosts with which the reservation is associated.", "required": true, "schema": { "title": "hostIdSet", "type": "array" } }, { "name": "offeringId", "type": "string", "info": "The offering ID of the reservation.", "required": true, "schema": { "title": "offeringId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getHostReservationPurchasePreviewSTSRole" }, "task": true }, { "name": "getLaunchTemplateData", "summary": "Retrieves the configuration data of the specified instance. You can use this data to create a launch template.", "description": "Retrieves the configuration data of the specified instance. You can use this data to create a launch template.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "instanceId", "type": "string", "info": "The ID of the instance.", "required": true, "schema": { "title": "instanceId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getLaunchTemplateData" }, "task": true }, { "name": "getLaunchTemplateDataSTSRole", "summary": "Retrieves the configuration data of the specified instance. You can use this data to create a launch template.", "description": "Retrieves the configuration data of the specified instance. You can use this data to create a launch template.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "instanceId", "type": "string", "info": "The ID of the instance.", "required": true, "schema": { "title": "instanceId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getLaunchTemplateDataSTSRole" }, "task": true }, { "name": "getPasswordData", "summary": "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 bun...(description truncated)", "description": "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 bun...(description truncated)", "input": [ { "name": "instanceId", "type": "string", "info": "The ID of the Windows instance.", "required": true, "schema": { "title": "instanceId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getPasswordData" }, "task": true }, { "name": "getPasswordDataSTSRole", "summary": "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 bun...(description truncated)", "description": "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 bun...(description truncated)", "input": [ { "name": "instanceId", "type": "string", "info": "The ID of the Windows instance.", "required": true, "schema": { "title": "instanceId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getPasswordDataSTSRole" }, "task": true }, { "name": "getReservedInstancesExchangeQuote", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "reservedInstanceId", "type": "array", "info": "The IDs of the Convertible Reserved Instances to exchange.", "required": true, "schema": { "title": "reservedInstanceId", "type": "array" } }, { "name": "targetConfiguration", "type": "array", "info": "The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.", "required": false, "schema": { "title": "targetConfiguration", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReservedInstancesExchangeQuote" }, "task": true }, { "name": "getReservedInstancesExchangeQuoteSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "reservedInstanceId", "type": "array", "info": "The IDs of the Convertible Reserved Instances to exchange.", "required": true, "schema": { "title": "reservedInstanceId", "type": "array" } }, { "name": "targetConfiguration", "type": "array", "info": "The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.", "required": false, "schema": { "title": "targetConfiguration", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReservedInstancesExchangeQuoteSTSRole" }, "task": true }, { "name": "getTransitGatewayAttachmentPropagations", "summary": "Lists the route tables to which the specified resource attachment propagates routes.", "description": "Lists the route tables to which the specified resource attachment propagates routes.", "input": [ { "name": "transitGatewayAttachmentId", "type": "string", "info": "The ID of the attachment.", "required": true, "schema": { "title": "transitGatewayAttachmentId", "type": "string" } }, { "name": "filter", "type": "array", "info": "One or more filters. The possible values are: transit-gateway-route-table-id - The ID of the transit gateway route table.", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getTransitGatewayAttachmentPropagations" }, "task": true }, { "name": "getTransitGatewayAttachmentPropagationsSTSRole", "summary": "Lists the route tables to which the specified resource attachment propagates routes.", "description": "Lists the route tables to which the specified resource attachment propagates routes.", "input": [ { "name": "transitGatewayAttachmentId", "type": "string", "info": "The ID of the attachment.", "required": true, "schema": { "title": "transitGatewayAttachmentId", "type": "string" } }, { "name": "filter", "type": "array", "info": "One or more filters. The possible values are: transit-gateway-route-table-id - The ID of the transit gateway route table.", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getTransitGatewayAttachmentPropagationsSTSRole" }, "task": true }, { "name": "getTransitGatewayRouteTableAssociations", "summary": "Gets information about the associations for the specified transit gateway route table.", "description": "Gets information about the associations for the specified transit gateway route table.", "input": [ { "name": "transitGatewayRouteTableId", "type": "string", "info": "The ID of the transit gateway route table.", "required": true, "schema": { "title": "transitGatewayRouteTableId", "type": "string" } }, { "name": "filter", "type": "array", "info": "One or more filters. The possible values are: resource-id - The ID of the resource. resource-type - The resource type ( vpc | vpn ). transit-...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getTransitGatewayRouteTableAssociations" }, "task": true }, { "name": "getTransitGatewayRouteTableAssociationsSTSRole", "summary": "Gets information about the associations for the specified transit gateway route table.", "description": "Gets information about the associations for the specified transit gateway route table.", "input": [ { "name": "transitGatewayRouteTableId", "type": "string", "info": "The ID of the transit gateway route table.", "required": true, "schema": { "title": "transitGatewayRouteTableId", "type": "string" } }, { "name": "filter", "type": "array", "info": "One or more filters. The possible values are: resource-id - The ID of the resource. resource-type - The resource type ( vpc | vpn ). transit-...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getTransitGatewayRouteTableAssociationsSTSRole" }, "task": true }, { "name": "getTransitGatewayRouteTablePropagations", "summary": "Gets information about the route table propagations for the specified transit gateway route table.", "description": "Gets information about the route table propagations for the specified transit gateway route table.", "input": [ { "name": "transitGatewayRouteTableId", "type": "string", "info": "The ID of the transit gateway route table.", "required": true, "schema": { "title": "transitGatewayRouteTableId", "type": "string" } }, { "name": "filter", "type": "array", "info": "One or more filters. The possible values are: resource-id - The ID of the resource. resource-type - The resource type ( vpc | vpn ). transit-...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getTransitGatewayRouteTablePropagations" }, "task": true }, { "name": "getTransitGatewayRouteTablePropagationsSTSRole", "summary": "Gets information about the route table propagations for the specified transit gateway route table.", "description": "Gets information about the route table propagations for the specified transit gateway route table.", "input": [ { "name": "transitGatewayRouteTableId", "type": "string", "info": "The ID of the transit gateway route table.", "required": true, "schema": { "title": "transitGatewayRouteTableId", "type": "string" } }, { "name": "filter", "type": "array", "info": "One or more filters. The possible values are: resource-id - The ID of the resource. resource-type - The resource type ( vpc | vpn ). transit-...(description truncated)", "required": false, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "nextToken", "type": "string", "info": "The token for the next page of results.", "required": false, "schema": { "title": "nextToken", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getTransitGatewayRouteTablePropagationsSTSRole" }, "task": true }, { "name": "importClientVpnClientCertificateRevocationList", "summary": "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.", "description": "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.", "input": [ { "name": "clientVpnEndpointId", "type": "string", "info": "The ID of the Client VPN endpoint to which the client certificate revocation list applies.", "required": true, "schema": { "title": "clientVpnEndpointId", "type": "string" } }, { "name": "certificateRevocationList", "type": "string", "info": "The client certificate revocation list file. For more information, see Generate a Client Certificate Revocation List in the AWS Client VPN Administrator Guide .", "required": true, "schema": { "title": "certificateRevocationList", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/importClientVpnClientCertificateRevocationList" }, "task": true }, { "name": "importClientVpnClientCertificateRevocationListSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "clientVpnEndpointId", "type": "string", "info": "The ID of the Client VPN endpoint to which the client certificate revocation list applies.", "required": true, "schema": { "title": "clientVpnEndpointId", "type": "string" } }, { "name": "certificateRevocationList", "type": "string", "info": "The client certificate revocation list file. For more information, see Generate a Client Certificate Revocation List in the AWS Client VPN Administrator Guide .", "required": true, "schema": { "title": "certificateRevocationList", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/importClientVpnClientCertificateRevocationListSTSRole" }, "task": true }, { "name": "importImage", "summary": "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 .", "description": "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 .", "input": [ { "name": "architecture", "type": "string", "info": "The architecture of the virtual machine. Valid values: i386 | x86_64", "required": false, "schema": { "title": "architecture", "type": "string" } }, { "name": "clientDataComment", "type": "string", "info": "Describes the client-specific data.\nA user-defined comment about the disk upload.", "required": false, "schema": { "title": "clientDataComment", "type": "string" } }, { "name": "clientDataUploadEnd", "type": "string", "info": "Describes the client-specific data.\nThe time that the disk upload ends.", "required": false, "schema": { "title": "clientDataUploadEnd", "type": "string" } }, { "name": "clientDataUploadSize", "type": "string", "info": "Describes the client-specific data.\nThe size of the uploaded disk image, in GiB.", "required": false, "schema": { "title": "clientDataUploadSize", "type": "string" } }, { "name": "clientDataUploadStart", "type": "string", "info": "Describes the client-specific data.\nThe time that the disk upload starts.", "required": false, "schema": { "title": "clientDataUploadStart", "type": "string" } }, { "name": "clientToken", "type": "string", "info": "The token to enable idempotency for VM import requests.", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "description", "type": "string", "info": "A description string for the import image task.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "diskContainer", "type": "array", "info": "Information about the disk containers.", "required": false, "schema": { "title": "diskContainer", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "encrypted", "type": "boolean", "info": "Specifies whether the destination AMI of the imported image should be encrypted. The default CMK for EBS is used unless you specify a non-default AWS Key Management Servi...(description truncated)", "required": false, "schema": { "title": "encrypted", "type": "boolean" } }, { "name": "hypervisor", "type": "string", "info": "The target hypervisor platform. Valid values: xen", "required": false, "schema": { "title": "hypervisor", "type": "string" } }, { "name": "kmsKeyId", "type": "string", "info": "An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted AMI. This parameter is only required if you want ...(description truncated)", "required": false, "schema": { "title": "kmsKeyId", "type": "string" } }, { "name": "licenseType", "type": "string", "info": "The license type to be used for the Amazon Machine Image (AMI) after importing. Note: You may only use BYOL if you have existing licenses with rights to use these l...(description truncated)", "required": false, "schema": { "title": "licenseType", "type": "string" } }, { "name": "platform", "type": "string", "info": "The operating system of the virtual machine. Valid values: Windows | Linux", "required": false, "schema": { "title": "platform", "type": "string" } }, { "name": "roleName", "type": "string", "info": "The name of the role to use when not using the default role, 'vmimport'.", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/importImage" }, "task": true }, { "name": "importImageSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "architecture", "type": "string", "info": "The architecture of the virtual machine. Valid values: i386 | x86_64", "required": false, "schema": { "title": "architecture", "type": "string" } }, { "name": "clientDataComment", "type": "string", "info": "Describes the client-specific data.\nA user-defined comment about the disk upload.", "required": false, "schema": { "title": "clientDataComment", "type": "string" } }, { "name": "clientDataUploadEnd", "type": "string", "info": "Describes the client-specific data.\nThe time that the disk upload ends.", "required": false, "schema": { "title": "clientDataUploadEnd", "type": "string" } }, { "name": "clientDataUploadSize", "type": "string", "info": "Describes the client-specific data.\nThe size of the uploaded disk image, in GiB.", "required": false, "schema": { "title": "clientDataUploadSize", "type": "string" } }, { "name": "clientDataUploadStart", "type": "string", "info": "Describes the client-specific data.\nThe time that the disk upload starts.", "required": false, "schema": { "title": "clientDataUploadStart", "type": "string" } }, { "name": "clientToken", "type": "string", "info": "The token to enable idempotency for VM import requests.", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "description", "type": "string", "info": "A description string for the import image task.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "diskContainer", "type": "array", "info": "Information about the disk containers.", "required": false, "schema": { "title": "diskContainer", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "encrypted", "type": "boolean", "info": "Specifies whether the destination AMI of the imported image should be encrypted. The default CMK for EBS is used unless you specify a non-default AWS Key Management Servi...(description truncated)", "required": false, "schema": { "title": "encrypted", "type": "boolean" } }, { "name": "hypervisor", "type": "string", "info": "The target hypervisor platform. Valid values: xen", "required": false, "schema": { "title": "hypervisor", "type": "string" } }, { "name": "kmsKeyId", "type": "string", "info": "An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted AMI. This parameter is only required if you want ...(description truncated)", "required": false, "schema": { "title": "kmsKeyId", "type": "string" } }, { "name": "licenseType", "type": "string", "info": "The license type to be used for the Amazon Machine Image (AMI) after importing. Note: You may only use BYOL if you have existing licenses with rights to use these l...(description truncated)", "required": false, "schema": { "title": "licenseType", "type": "string" } }, { "name": "platform", "type": "string", "info": "The operating system of the virtual machine. Valid values: Windows | Linux", "required": false, "schema": { "title": "platform", "type": "string" } }, { "name": "roleName", "type": "string", "info": "The name of the role to use when not using the default role, 'vmimport'.", "required": false, "schema": { "title": "roleName", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/importImageSTSRole" }, "task": true }, { "name": "importInstance", "summary": "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 .", "description": "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 .", "input": [ { "name": "description", "type": "string", "info": "A description for the instance being imported.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "diskImage", "type": "array", "info": "The disk image.", "required": false, "schema": { "title": "diskImage", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "launchSpecificationAdditionalInfo", "type": "string", "info": "Describes the launch specification for VM import.\nReserved.", "required": false, "schema": { "title": "launchSpecificationAdditionalInfo", "type": "string" } }, { "name": "launchSpecificationArchitecture", "type": "string", "info": "Describes the launch specification for VM import.\nThe architecture of the instance.", "required": false, "schema": { "title": "launchSpecificationArchitecture", "type": "string" } }, { "name": "launchSpecificationGroupIds", "type": "array", "info": "Describes the launch specification for VM import.\nThe security group IDs.", "required": false, "schema": { "title": "launchSpecificationGroupIds", "type": "array" } }, { "name": "launchSpecificationGroupNames", "type": "array", "info": "Describes the launch specification for VM import.\nThe security group names.", "required": false, "schema": { "title": "launchSpecificationGroupNames", "type": "array" } }, { "name": "launchSpecificationInstanceInitiatedShutdownBehavior", "type": "string", "info": "Describes the launch specification for VM import.\nIndicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating syst...(description truncated)", "required": false, "schema": { "title": "launchSpecificationInstanceInitiatedShutdownBehavior", "type": "string" } }, { "name": "launchSpecificationInstanceType", "type": "string", "info": "Describes the launch specification for VM import.\nThe instance type. For more information about the instance types that you can import, see Instance Types in the VM Imp...(description truncated)", "required": false, "schema": { "title": "launchSpecificationInstanceType", "type": "string" } }, { "name": "launchSpecificationMonitoring", "type": "string", "info": "Describes the launch specification for VM import.\nIndicates whether monitoring is enabled.", "required": false, "schema": { "title": "launchSpecificationMonitoring", "type": "string" } }, { "name": "launchSpecificationPlacement", "type": "string", "info": "Describes the launch specification for VM import.\nThe placement information for the instance.", "required": false, "schema": { "title": "launchSpecificationPlacement", "type": "string" } }, { "name": "launchSpecificationPrivateIpAddress", "type": "string", "info": "Describes the launch specification for VM import.\n[EC2-VPC] An available IP address from the IP address range of the subnet.", "required": false, "schema": { "title": "launchSpecificationPrivateIpAddress", "type": "string" } }, { "name": "launchSpecificationSubnetId", "type": "string", "info": "Describes the launch specification for VM import.\n[EC2-VPC] The ID of the subnet in which to launch the instance.", "required": false, "schema": { "title": "launchSpecificationSubnetId", "type": "string" } }, { "name": "launchSpecificationUserData", "type": "string", "info": "Describes the launch specification for VM import.\nThe Base64-encoded user data to make available to the instance.", "required": false, "schema": { "title": "launchSpecificationUserData", "type": "string" } }, { "name": "platform", "type": "string", "info": "The instance operating system.", "required": true, "schema": { "title": "platform", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/importInstance" }, "task": true }, { "name": "importInstanceSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "description", "type": "string", "info": "A description for the instance being imported.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "diskImage", "type": "array", "info": "The disk image.", "required": false, "schema": { "title": "diskImage", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "launchSpecificationAdditionalInfo", "type": "string", "info": "Describes the launch specification for VM import.\nReserved.", "required": false, "schema": { "title": "launchSpecificationAdditionalInfo", "type": "string" } }, { "name": "launchSpecificationArchitecture", "type": "string", "info": "Describes the launch specification for VM import.\nThe architecture of the instance.", "required": false, "schema": { "title": "launchSpecificationArchitecture", "type": "string" } }, { "name": "launchSpecificationGroupIds", "type": "array", "info": "Describes the launch specification for VM import.\nThe security group IDs.", "required": false, "schema": { "title": "launchSpecificationGroupIds", "type": "array" } }, { "name": "launchSpecificationGroupNames", "type": "array", "info": "Describes the launch specification for VM import.\nThe security group names.", "required": false, "schema": { "title": "launchSpecificationGroupNames", "type": "array" } }, { "name": "launchSpecificationInstanceInitiatedShutdownBehavior", "type": "string", "info": "Describes the launch specification for VM import.\nIndicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating syst...(description truncated)", "required": false, "schema": { "title": "launchSpecificationInstanceInitiatedShutdownBehavior", "type": "string" } }, { "name": "launchSpecificationInstanceType", "type": "string", "info": "Describes the launch specification for VM import.\nThe instance type. For more information about the instance types that you can import, see Instance Types in the VM Imp...(description truncated)", "required": false, "schema": { "title": "launchSpecificationInstanceType", "type": "string" } }, { "name": "launchSpecificationMonitoring", "type": "string", "info": "Describes the launch specification for VM import.\nIndicates whether monitoring is enabled.", "required": false, "schema": { "title": "launchSpecificationMonitoring", "type": "string" } }, { "name": "launchSpecificationPlacement", "type": "string", "info": "Describes the launch specification for VM import.\nThe placement information for the instance.", "required": false, "schema": { "title": "launchSpecificationPlacement", "type": "string" } }, { "name": "launchSpecificationPrivateIpAddress", "type": "string", "info": "Describes the launch specification for VM import.\n[EC2-VPC] An available IP address from the IP address range of the subnet.", "required": false, "schema": { "title": "launchSpecificationPrivateIpAddress", "type": "string" } }, { "name": "launchSpecificationSubnetId", "type": "string", "info": "Describes the launch specification for VM import.\n[EC2-VPC] The ID of the subnet in which to launch the instance.", "required": false, "schema": { "title": "launchSpecificationSubnetId", "type": "string" } }, { "name": "launchSpecificationUserData", "type": "string", "info": "Describes the launch specification for VM import.\nThe Base64-encoded user data to make available to the instance.", "required": false, "schema": { "title": "launchSpecificationUserData", "type": "string" } }, { "name": "platform", "type": "string", "info": "The instance operating system.", "required": true, "schema": { "title": "platform", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/importInstanceSTSRole" }, "task": true }, { "name": "importKeyPair", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "keyName", "type": "string", "info": "A unique name for the key pair.", "required": true, "schema": { "title": "keyName", "type": "string" } }, { "name": "publicKeyMaterial", "type": "string", "info": "The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.", "required": true, "schema": { "title": "publicKeyMaterial", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/importKeyPair" }, "task": true }, { "name": "importKeyPairSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "keyName", "type": "string", "info": "A unique name for the key pair.", "required": true, "schema": { "title": "keyName", "type": "string" } }, { "name": "publicKeyMaterial", "type": "string", "info": "The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.", "required": true, "schema": { "title": "publicKeyMaterial", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/importKeyPairSTSRole" }, "task": true }, { "name": "importSnapshot", "summary": "Imports a disk into an EBS snapshot.", "description": "Imports a disk into an EBS snapshot.", "input": [ { "name": "clientDataComment", "type": "string", "info": "Describes the client-specific data.\nA user-defined comment about the disk upload.", "required": false, "schema": { "title": "clientDataComment", "type": "string" } }, { "name": "clientDataUploadEnd", "type": "string", "info": "Describes the client-specific data.\nThe time that the disk upload ends.", "required": false, "schema": { "title": "clientDataUploadEnd", "type": "string" } }, { "name": "clientDataUploadSize", "type": "string", "info": "Describes the client-specific data.\nThe size of the uploaded disk image, in GiB.", "required": false, "schema": { "title": "clientDataUploadSize", "type": "string" } }, { "name": "clientDataUploadStart", "type": "string", "info": "Describes the client-specific data.\nThe time that the disk upload starts.", "required": false, "schema": { "title": "clientDataUploadStart", "type": "string" } }, { "name": "clientToken", "type": "string", "info": "Token to enable idempotency for VM import requests.", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "description", "type": "string", "info": "The description string for the import snapshot task.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "diskContainerDescription", "type": "string", "info": "The disk container object for the import snapshot request.\nThe description of the disk image being imported.", "required": false, "schema": { "title": "diskContainerDescription", "type": "string" } }, { "name": "diskContainerFormat", "type": "string", "info": "The disk container object for the import snapshot request.\n The format of the disk image being imported. Valid values: VHD | VMDK", "required": false, "schema": { "title": "diskContainerFormat", "type": "string" } }, { "name": "diskContainerUrl", "type": "string", "info": "The disk container object for the import snapshot request.\nThe URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazo...(description truncated)", "required": false, "schema": { "title": "diskContainerUrl", "type": "string" } }, { "name": "diskContainerUserBucket", "type": "string", "info": "The disk container object for the import snapshot request.\nThe S3 bucket for the disk image.", "required": false, "schema": { "title": "diskContainerUserBucket", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "encrypted", "type": "boolean", "info": "Specifies whether the destination snapshot of the imported image should be encrypted. The default CMK for EBS is used unless you specify a non-default AWS Key Management ...(description truncated)", "required": false, "schema": { "title": "encrypted", "type": "boolean" } }, { "name": "kmsKeyId", "type": "string", "info": "An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted snapshot. This parameter is only required if you ...(description truncated)", "required": false, "schema": { "title": "kmsKeyId", "type": "string" } }, { "name": "roleName", "type": "string", "info": "The name of the role to use when not using the default role, 'vmimport'.", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/importSnapshot" }, "task": true }, { "name": "importSnapshotSTSRole", "summary": "Imports a disk into an EBS snapshot.", "description": "Imports a disk into an EBS snapshot.", "input": [ { "name": "clientDataComment", "type": "string", "info": "Describes the client-specific data.\nA user-defined comment about the disk upload.", "required": false, "schema": { "title": "clientDataComment", "type": "string" } }, { "name": "clientDataUploadEnd", "type": "string", "info": "Describes the client-specific data.\nThe time that the disk upload ends.", "required": false, "schema": { "title": "clientDataUploadEnd", "type": "string" } }, { "name": "clientDataUploadSize", "type": "string", "info": "Describes the client-specific data.\nThe size of the uploaded disk image, in GiB.", "required": false, "schema": { "title": "clientDataUploadSize", "type": "string" } }, { "name": "clientDataUploadStart", "type": "string", "info": "Describes the client-specific data.\nThe time that the disk upload starts.", "required": false, "schema": { "title": "clientDataUploadStart", "type": "string" } }, { "name": "clientToken", "type": "string", "info": "Token to enable idempotency for VM import requests.", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "description", "type": "string", "info": "The description string for the import snapshot task.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "diskContainerDescription", "type": "string", "info": "The disk container object for the import snapshot request.\nThe description of the disk image being imported.", "required": false, "schema": { "title": "diskContainerDescription", "type": "string" } }, { "name": "diskContainerFormat", "type": "string", "info": "The disk container object for the import snapshot request.\n The format of the disk image being imported. Valid values: VHD | VMDK", "required": false, "schema": { "title": "diskContainerFormat", "type": "string" } }, { "name": "diskContainerUrl", "type": "string", "info": "The disk container object for the import snapshot request.\nThe URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazo...(description truncated)", "required": false, "schema": { "title": "diskContainerUrl", "type": "string" } }, { "name": "diskContainerUserBucket", "type": "string", "info": "The disk container object for the import snapshot request.\nThe S3 bucket for the disk image.", "required": false, "schema": { "title": "diskContainerUserBucket", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "encrypted", "type": "boolean", "info": "Specifies whether the destination snapshot of the imported image should be encrypted. The default CMK for EBS is used unless you specify a non-default AWS Key Management ...(description truncated)", "required": false, "schema": { "title": "encrypted", "type": "boolean" } }, { "name": "kmsKeyId", "type": "string", "info": "An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted snapshot. This parameter is only required if you ...(description truncated)", "required": false, "schema": { "title": "kmsKeyId", "type": "string" } }, { "name": "roleName", "type": "string", "info": "The name of the role to use when not using the default role, 'vmimport'.", "required": false, "schema": { "title": "roleName", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/importSnapshotSTSRole" }, "task": true }, { "name": "importVolume", "summary": "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 .", "description": "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 .", "input": [ { "name": "availabilityZone", "type": "string", "info": "The Availability Zone for the resulting EBS volume.", "required": true, "schema": { "title": "availabilityZone", "type": "string" } }, { "name": "description", "type": "string", "info": "A description of the volume.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "imageBytes", "type": "string", "info": "Describes a disk image.\nThe size of the disk image, in GiB.", "required": false, "schema": { "title": "imageBytes", "type": "string" } }, { "name": "imageFormat", "type": "string", "info": "Describes a disk image.\nThe disk image format.", "required": false, "schema": { "title": "imageFormat", "type": "string" } }, { "name": "imageImportManifestUrl", "type": "string", "info": "Describes a disk image.\n A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a pr...(description truncated)", "required": false, "schema": { "title": "imageImportManifestUrl", "type": "string" } }, { "name": "volumeSize", "type": "string", "info": "Describes an EBS volume.\nThe size of the volume, in GiB.", "required": false, "schema": { "title": "volumeSize", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/importVolume" }, "task": true }, { "name": "importVolumeSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "availabilityZone", "type": "string", "info": "The Availability Zone for the resulting EBS volume.", "required": true, "schema": { "title": "availabilityZone", "type": "string" } }, { "name": "description", "type": "string", "info": "A description of the volume.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "imageBytes", "type": "string", "info": "Describes a disk image.\nThe size of the disk image, in GiB.", "required": false, "schema": { "title": "imageBytes", "type": "string" } }, { "name": "imageFormat", "type": "string", "info": "Describes a disk image.\nThe disk image format.", "required": false, "schema": { "title": "imageFormat", "type": "string" } }, { "name": "imageImportManifestUrl", "type": "string", "info": "Describes a disk image.\n A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a pr...(description truncated)", "required": false, "schema": { "title": "imageImportManifestUrl", "type": "string" } }, { "name": "volumeSize", "type": "string", "info": "Describes an EBS volume.\nThe size of the volume, in GiB.", "required": false, "schema": { "title": "volumeSize", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/importVolumeSTSRole" }, "task": true }, { "name": "modifyCapacityReservation", "summary": "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.", "description": "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.", "input": [ { "name": "capacityReservationId", "type": "string", "info": "The ID of the Capacity Reservation.", "required": true, "schema": { "title": "capacityReservationId", "type": "string" } }, { "name": "instanceCount", "type": "number", "info": "The number of instances for which to reserve capacity.", "required": false, "schema": { "title": "instanceCount", "type": "number" } }, { "name": "endDate", "type": "string", "info": "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 instance...(description truncated)", "required": false, "schema": { "title": "endDate", "type": "string" } }, { "name": "endDateType", "type": "string", "info": "Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types: unlimited - The Capacity Reservation r...(description truncated)", "required": false, "schema": { "title": "endDateType", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyCapacityReservation" }, "task": true }, { "name": "modifyCapacityReservationSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "capacityReservationId", "type": "string", "info": "The ID of the Capacity Reservation.", "required": true, "schema": { "title": "capacityReservationId", "type": "string" } }, { "name": "instanceCount", "type": "number", "info": "The number of instances for which to reserve capacity.", "required": false, "schema": { "title": "instanceCount", "type": "number" } }, { "name": "endDate", "type": "string", "info": "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 instance...(description truncated)", "required": false, "schema": { "title": "endDate", "type": "string" } }, { "name": "endDateType", "type": "string", "info": "Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types: unlimited - The Capacity Reservation r...(description truncated)", "required": false, "schema": { "title": "endDateType", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyCapacityReservationSTSRole" }, "task": true }, { "name": "modifyClientVpnEndpoint", "summary": "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.", "description": "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.", "input": [ { "name": "clientVpnEndpointId", "type": "string", "info": "The ID of the Client VPN endpoint to modify.", "required": true, "schema": { "title": "clientVpnEndpointId", "type": "string" } }, { "name": "serverCertificateArn", "type": "string", "info": "The ARN of the server certificate to be used. The server certificate must be provisioned in AWS Certificate Manager (ACM).", "required": false, "schema": { "title": "serverCertificateArn", "type": "string" } }, { "name": "connectionLogOptionsEnabled", "type": "string", "info": "Describes the client connection logging options for the Client VPN endpoint.\nIndicates whether connection logging is enabled.", "required": false, "schema": { "title": "connectionLogOptionsEnabled", "type": "string" } }, { "name": "connectionLogOptionsCloudwatchLogGroup", "type": "string", "info": "Describes the client connection logging options for the Client VPN endpoint.\nThe name of the CloudWatch Logs log group.", "required": false, "schema": { "title": "connectionLogOptionsCloudwatchLogGroup", "type": "string" } }, { "name": "connectionLogOptionsCloudwatchLogStream", "type": "string", "info": "Describes the client connection logging options for the Client VPN endpoint.\nThe name of the CloudWatch Logs log stream to which the connection data is published.", "required": false, "schema": { "title": "connectionLogOptionsCloudwatchLogStream", "type": "string" } }, { "name": "dnsServersCustomDnsServers", "type": "array", "info": "Information about the DNS server to be used.\nThe IPv4 address range, in CIDR notation, of the DNS servers to be used. You can specify up to two DNS servers. Ensure that t...(description truncated)", "required": false, "schema": { "title": "dnsServersCustomDnsServers", "type": "array" } }, { "name": "dnsServersEnabled", "type": "string", "info": "Information about the DNS server to be used.\nIndicates whether DNS servers should be used. Specify False to delete the existing DNS servers.", "required": false, "schema": { "title": "dnsServersEnabled", "type": "string" } }, { "name": "description", "type": "string", "info": "A brief description of the Client VPN endpoint.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyClientVpnEndpoint" }, "task": true }, { "name": "modifyClientVpnEndpointSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "clientVpnEndpointId", "type": "string", "info": "The ID of the Client VPN endpoint to modify.", "required": true, "schema": { "title": "clientVpnEndpointId", "type": "string" } }, { "name": "serverCertificateArn", "type": "string", "info": "The ARN of the server certificate to be used. The server certificate must be provisioned in AWS Certificate Manager (ACM).", "required": false, "schema": { "title": "serverCertificateArn", "type": "string" } }, { "name": "connectionLogOptionsEnabled", "type": "string", "info": "Describes the client connection logging options for the Client VPN endpoint.\nIndicates whether connection logging is enabled.", "required": false, "schema": { "title": "connectionLogOptionsEnabled", "type": "string" } }, { "name": "connectionLogOptionsCloudwatchLogGroup", "type": "string", "info": "Describes the client connection logging options for the Client VPN endpoint.\nThe name of the CloudWatch Logs log group.", "required": false, "schema": { "title": "connectionLogOptionsCloudwatchLogGroup", "type": "string" } }, { "name": "connectionLogOptionsCloudwatchLogStream", "type": "string", "info": "Describes the client connection logging options for the Client VPN endpoint.\nThe name of the CloudWatch Logs log stream to which the connection data is published.", "required": false, "schema": { "title": "connectionLogOptionsCloudwatchLogStream", "type": "string" } }, { "name": "dnsServersCustomDnsServers", "type": "array", "info": "Information about the DNS server to be used.\nThe IPv4 address range, in CIDR notation, of the DNS servers to be used. You can specify up to two DNS servers. Ensure that t...(description truncated)", "required": false, "schema": { "title": "dnsServersCustomDnsServers", "type": "array" } }, { "name": "dnsServersEnabled", "type": "string", "info": "Information about the DNS server to be used.\nIndicates whether DNS servers should be used. Specify False to delete the existing DNS servers.", "required": false, "schema": { "title": "dnsServersEnabled", "type": "string" } }, { "name": "description", "type": "string", "info": "A brief description of the Client VPN endpoint.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyClientVpnEndpointSTSRole" }, "task": true }, { "name": "modifyFleet", "summary": "Modifies the specified EC2 Fleet. While the EC2 Fleet is being modified, it is in the modifying state.", "description": "Modifies the specified EC2 Fleet. While the EC2 Fleet is being modified, it is in the modifying state.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "excessCapacityTerminationPolicy", "type": "string", "info": "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.", "required": false, "schema": { "title": "excessCapacityTerminationPolicy", "type": "string" } }, { "name": "fleetId", "type": "string", "info": "The ID of the EC2 Fleet.", "required": true, "schema": { "title": "fleetId", "type": "string" } }, { "name": "targetCapacitySpecificationTotalTargetCapacity", "type": "string", "info": "The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application work...(description truncated)", "required": false, "schema": { "title": "targetCapacitySpecificationTotalTargetCapacity", "type": "string" } }, { "name": "targetCapacitySpecificationOnDemandTargetCapacity", "type": "string", "info": "The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application work...(description truncated)", "required": false, "schema": { "title": "targetCapacitySpecificationOnDemandTargetCapacity", "type": "string" } }, { "name": "targetCapacitySpecificationSpotTargetCapacity", "type": "string", "info": "The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application work...(description truncated)", "required": false, "schema": { "title": "targetCapacitySpecificationSpotTargetCapacity", "type": "string" } }, { "name": "targetCapacitySpecificationDefaultTargetCapacityType", "type": "string", "info": "The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application work...(description truncated)", "required": false, "schema": { "title": "targetCapacitySpecificationDefaultTargetCapacityType", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyFleet" }, "task": true }, { "name": "modifyFleetSTSRole", "summary": "Modifies the specified EC2 Fleet. While the EC2 Fleet is being modified, it is in the modifying state.", "description": "Modifies the specified EC2 Fleet. While the EC2 Fleet is being modified, it is in the modifying state.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "excessCapacityTerminationPolicy", "type": "string", "info": "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.", "required": false, "schema": { "title": "excessCapacityTerminationPolicy", "type": "string" } }, { "name": "fleetId", "type": "string", "info": "The ID of the EC2 Fleet.", "required": true, "schema": { "title": "fleetId", "type": "string" } }, { "name": "targetCapacitySpecificationTotalTargetCapacity", "type": "string", "info": "The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application work...(description truncated)", "required": false, "schema": { "title": "targetCapacitySpecificationTotalTargetCapacity", "type": "string" } }, { "name": "targetCapacitySpecificationOnDemandTargetCapacity", "type": "string", "info": "The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application work...(description truncated)", "required": false, "schema": { "title": "targetCapacitySpecificationOnDemandTargetCapacity", "type": "string" } }, { "name": "targetCapacitySpecificationSpotTargetCapacity", "type": "string", "info": "The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application work...(description truncated)", "required": false, "schema": { "title": "targetCapacitySpecificationSpotTargetCapacity", "type": "string" } }, { "name": "targetCapacitySpecificationDefaultTargetCapacityType", "type": "string", "info": "The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application work...(description truncated)", "required": false, "schema": { "title": "targetCapacitySpecificationDefaultTargetCapacityType", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyFleetSTSRole" }, "task": true }, { "name": "modifyFpgaImageAttribute", "summary": "Modifies the specified attribute of the specified Amazon FPGA Image (AFI).", "description": "Modifies the specified attribute of the specified Amazon FPGA Image (AFI).", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "fpgaImageId", "type": "string", "info": "The ID of the AFI.", "required": true, "schema": { "title": "fpgaImageId", "type": "string" } }, { "name": "attribute", "type": "string", "info": "The name of the attribute.", "required": false, "schema": { "title": "attribute", "type": "string" } }, { "name": "operationType", "type": "string", "info": "The operation type.", "required": false, "schema": { "title": "operationType", "type": "string" } }, { "name": "userId", "type": "array", "info": "The AWS account IDs. This parameter is valid only when modifying the loadPermission attribute.", "required": false, "schema": { "title": "userId", "type": "array" } }, { "name": "userGroup", "type": "array", "info": "The user groups. This parameter is valid only when modifying the loadPermission attribute.", "required": false, "schema": { "title": "userGroup", "type": "array" } }, { "name": "productCode", "type": "array", "info": "The product codes. After you add a product code to an AFI, it can't be removed. This parameter is valid only when modifying the productCodes attribute.", "required": false, "schema": { "title": "productCode", "type": "array" } }, { "name": "loadPermissionAdd", "type": "array", "info": "Describes modifications to the load permissions of an Amazon FPGA image (AFI).\nThe load permissions to add.", "required": false, "schema": { "title": "loadPermissionAdd", "type": "array" } }, { "name": "loadPermissionRemove", "type": "array", "info": "Describes modifications to the load permissions of an Amazon FPGA image (AFI).\nThe load permissions to remove.", "required": false, "schema": { "title": "loadPermissionRemove", "type": "array" } }, { "name": "description", "type": "string", "info": "A description for the AFI.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "name", "type": "string", "info": "A name for the AFI.", "required": false, "schema": { "title": "name", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyFpgaImageAttribute" }, "task": true }, { "name": "modifyFpgaImageAttributeSTSRole", "summary": "Modifies the specified attribute of the specified Amazon FPGA Image (AFI).", "description": "Modifies the specified attribute of the specified Amazon FPGA Image (AFI).", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "fpgaImageId", "type": "string", "info": "The ID of the AFI.", "required": true, "schema": { "title": "fpgaImageId", "type": "string" } }, { "name": "attribute", "type": "string", "info": "The name of the attribute.", "required": false, "schema": { "title": "attribute", "type": "string" } }, { "name": "operationType", "type": "string", "info": "The operation type.", "required": false, "schema": { "title": "operationType", "type": "string" } }, { "name": "userId", "type": "array", "info": "The AWS account IDs. This parameter is valid only when modifying the loadPermission attribute.", "required": false, "schema": { "title": "userId", "type": "array" } }, { "name": "userGroup", "type": "array", "info": "The user groups. This parameter is valid only when modifying the loadPermission attribute.", "required": false, "schema": { "title": "userGroup", "type": "array" } }, { "name": "productCode", "type": "array", "info": "The product codes. After you add a product code to an AFI, it can't be removed. This parameter is valid only when modifying the productCodes attribute.", "required": false, "schema": { "title": "productCode", "type": "array" } }, { "name": "loadPermissionAdd", "type": "array", "info": "Describes modifications to the load permissions of an Amazon FPGA image (AFI).\nThe load permissions to add.", "required": false, "schema": { "title": "loadPermissionAdd", "type": "array" } }, { "name": "loadPermissionRemove", "type": "array", "info": "Describes modifications to the load permissions of an Amazon FPGA image (AFI).\nThe load permissions to remove.", "required": false, "schema": { "title": "loadPermissionRemove", "type": "array" } }, { "name": "description", "type": "string", "info": "A description for the AFI.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "name", "type": "string", "info": "A name for the AFI.", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyFpgaImageAttributeSTSRole" }, "task": true }, { "name": "modifyHosts", "summary": "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.", "description": "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.", "input": [ { "name": "autoPlacement", "type": "string", "info": "Specify whether to enable or disable auto-placement.", "required": true, "schema": { "title": "autoPlacement", "type": "string" } }, { "name": "hostId", "type": "array", "info": "The IDs of the Dedicated Hosts to modify.", "required": true, "schema": { "title": "hostId", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyHosts" }, "task": true }, { "name": "modifyHostsSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "autoPlacement", "type": "string", "info": "Specify whether to enable or disable auto-placement.", "required": true, "schema": { "title": "autoPlacement", "type": "string" } }, { "name": "hostId", "type": "array", "info": "The IDs of the Dedicated Hosts to modify.", "required": true, "schema": { "title": "hostId", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyHostsSTSRole" }, "task": true }, { "name": "modifyIdFormat", "summary": "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 |...(description truncated)", "description": "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 |...(description truncated)", "input": [ { "name": "resource", "type": "string", "info": "The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log...(description truncated)", "required": true, "schema": { "title": "resource", "type": "string" } }, { "name": "useLongIds", "type": "boolean", "info": "Indicate whether the resource should use longer IDs (17-character IDs).", "required": true, "schema": { "title": "useLongIds", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyIdFormat" }, "task": true }, { "name": "modifyIdFormatSTSRole", "summary": "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 |...(description truncated)", "description": "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 |...(description truncated)", "input": [ { "name": "resource", "type": "string", "info": "The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log...(description truncated)", "required": true, "schema": { "title": "resource", "type": "string" } }, { "name": "useLongIds", "type": "boolean", "info": "Indicate whether the resource should use longer IDs (17-character IDs).", "required": true, "schema": { "title": "useLongIds", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyIdFormatSTSRole" }, "task": true }, { "name": "modifyIdentityIdFormat", "summary": "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-optio...(description truncated)", "description": "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-optio...(description truncated)", "input": [ { "name": "principalArn", "type": "string", "info": "The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify all to modify the ID format for all IAM users, IAM roles, and the root user of t...(description truncated)", "required": true, "schema": { "title": "principalArn", "type": "string" } }, { "name": "resource", "type": "string", "info": "The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log...(description truncated)", "required": true, "schema": { "title": "resource", "type": "string" } }, { "name": "useLongIds", "type": "boolean", "info": "Indicates whether the resource should use longer IDs (17-character IDs)", "required": true, "schema": { "title": "useLongIds", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyIdentityIdFormat" }, "task": true }, { "name": "modifyIdentityIdFormatSTSRole", "summary": "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-optio...(description truncated)", "description": "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-optio...(description truncated)", "input": [ { "name": "principalArn", "type": "string", "info": "The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify all to modify the ID format for all IAM users, IAM roles, and the root user of t...(description truncated)", "required": true, "schema": { "title": "principalArn", "type": "string" } }, { "name": "resource", "type": "string", "info": "The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log...(description truncated)", "required": true, "schema": { "title": "resource", "type": "string" } }, { "name": "useLongIds", "type": "boolean", "info": "Indicates whether the resource should use longer IDs (17-character IDs)", "required": true, "schema": { "title": "useLongIds", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyIdentityIdFormatSTSRole" }, "task": true }, { "name": "modifyImageAttribute", "summary": "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 ...(description truncated)", "description": "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 ...(description truncated)", "input": [ { "name": "attribute", "type": "string", "info": "The name of the attribute to modify. The valid values are description , launchPermission , and productCodes .", "required": false, "schema": { "title": "attribute", "type": "string" } }, { "name": "descriptionValue", "type": "string", "info": "Describes a value for a resource attribute that is a String.\nThe attribute value. The value is case-sensitive.", "required": false, "schema": { "title": "descriptionValue", "type": "string" } }, { "name": "imageId", "type": "string", "info": "The ID of the AMI.", "required": true, "schema": { "title": "imageId", "type": "string" } }, { "name": "launchPermissionAdd", "type": "array", "info": "Describes a launch permission modification.\nThe AWS account ID to add to the list of launch permissions for the AMI.", "required": false, "schema": { "title": "launchPermissionAdd", "type": "array" } }, { "name": "launchPermissionRemove", "type": "array", "info": "Describes a launch permission modification.\nThe AWS account ID to remove from the list of launch permissions for the AMI.", "required": false, "schema": { "title": "launchPermissionRemove", "type": "array" } }, { "name": "operationType", "type": "string", "info": "The operation type. This parameter can be used only when the Attribute parameter is launchPermission .", "required": false, "schema": { "title": "operationType", "type": "string" } }, { "name": "productCode", "type": "array", "info": "The DevPay product codes. After you add a product code to an AMI, it can't be removed.", "required": false, "schema": { "title": "productCode", "type": "array" } }, { "name": "userGroup", "type": "array", "info": "The user groups. This parameter can be used only when the Attribute parameter is launchPermission .", "required": false, "schema": { "title": "userGroup", "type": "array" } }, { "name": "userId", "type": "array", "info": "The AWS account IDs. This parameter can be used only when the Attribute parameter is launchPermission .", "required": false, "schema": { "title": "userId", "type": "array" } }, { "name": "value", "type": "string", "info": "The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description or productCodes .", "required": false, "schema": { "title": "value", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyImageAttribute" }, "task": true }, { "name": "modifyImageAttributeSTSRole", "summary": "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 ...(description truncated)", "description": "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 ...(description truncated)", "input": [ { "name": "attribute", "type": "string", "info": "The name of the attribute to modify. The valid values are description , launchPermission , and productCodes .", "required": false, "schema": { "title": "attribute", "type": "string" } }, { "name": "descriptionValue", "type": "string", "info": "Describes a value for a resource attribute that is a String.\nThe attribute value. The value is case-sensitive.", "required": false, "schema": { "title": "descriptionValue", "type": "string" } }, { "name": "imageId", "type": "string", "info": "The ID of the AMI.", "required": true, "schema": { "title": "imageId", "type": "string" } }, { "name": "launchPermissionAdd", "type": "array", "info": "Describes a launch permission modification.\nThe AWS account ID to add to the list of launch permissions for the AMI.", "required": false, "schema": { "title": "launchPermissionAdd", "type": "array" } }, { "name": "launchPermissionRemove", "type": "array", "info": "Describes a launch permission modification.\nThe AWS account ID to remove from the list of launch permissions for the AMI.", "required": false, "schema": { "title": "launchPermissionRemove", "type": "array" } }, { "name": "operationType", "type": "string", "info": "The operation type. This parameter can be used only when the Attribute parameter is launchPermission .", "required": false, "schema": { "title": "operationType", "type": "string" } }, { "name": "productCode", "type": "array", "info": "The DevPay product codes. After you add a product code to an AMI, it can't be removed.", "required": false, "schema": { "title": "productCode", "type": "array" } }, { "name": "userGroup", "type": "array", "info": "The user groups. This parameter can be used only when the Attribute parameter is launchPermission .", "required": false, "schema": { "title": "userGroup", "type": "array" } }, { "name": "userId", "type": "array", "info": "The AWS account IDs. This parameter can be used only when the Attribute parameter is launchPermission .", "required": false, "schema": { "title": "userId", "type": "array" } }, { "name": "value", "type": "string", "info": "The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description or productCodes .", "required": false, "schema": { "title": "value", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyImageAttributeSTSRole" }, "task": true }, { "name": "modifyInstanceAttribute", "summary": "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 som...(description truncated)", "description": "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 som...(description truncated)", "input": [ { "name": "sourceDestCheckValue", "type": "string", "info": "Describes a value for a resource attribute that is a Boolean value.\nThe attribute value. The valid values are true or false .", "required": false, "schema": { "title": "sourceDestCheckValue", "type": "string" } }, { "name": "attribute", "type": "string", "info": "The name of the attribute.", "required": false, "schema": { "title": "attribute", "type": "string" } }, { "name": "blockDeviceMapping", "type": "array", "info": "Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermi...(description truncated)", "required": false, "schema": { "title": "blockDeviceMapping", "type": "array" } }, { "name": "disableApiTerminationValue", "type": "string", "info": "Describes a value for a resource attribute that is a Boolean value.\nThe attribute value. The valid values are true or false .", "required": false, "schema": { "title": "disableApiTerminationValue", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "ebsOptimizedValue", "type": "string", "info": "Describes a value for a resource attribute that is a Boolean value.\nThe attribute value. The valid values are true or false .", "required": false, "schema": { "title": "ebsOptimizedValue", "type": "string" } }, { "name": "enaSupportValue", "type": "string", "info": "Describes a value for a resource attribute that is a Boolean value.\nThe attribute value. The valid values are true or false .", "required": false, "schema": { "title": "enaSupportValue", "type": "string" } }, { "name": "groupId", "type": "array", "info": "[EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it's just the default security group for the VPC. You must sp...(description truncated)", "required": false, "schema": { "title": "groupId", "type": "array" } }, { "name": "instanceId", "type": "string", "info": "The ID of the instance.", "required": true, "schema": { "title": "instanceId", "type": "string" } }, { "name": "instanceInitiatedShutdownBehaviorValue", "type": "string", "info": "Describes a value for a resource attribute that is a String.\nThe attribute value. The value is case-sensitive.", "required": false, "schema": { "title": "instanceInitiatedShutdownBehaviorValue", "type": "string" } }, { "name": "instanceTypeValue", "type": "string", "info": "Describes a value for a resource attribute that is a String.\nThe attribute value. The value is case-sensitive.", "required": false, "schema": { "title": "instanceTypeValue", "type": "string" } }, { "name": "kernelValue", "type": "string", "info": "Describes a value for a resource attribute that is a String.\nThe attribute value. The value is case-sensitive.", "required": false, "schema": { "title": "kernelValue", "type": "string" } }, { "name": "ramdiskValue", "type": "string", "info": "Describes a value for a resource attribute that is a String.\nThe attribute value. The value is case-sensitive.", "required": false, "schema": { "title": "ramdiskValue", "type": "string" } }, { "name": "sriovNetSupportValue", "type": "string", "info": "Describes a value for a resource attribute that is a String.\nThe attribute value. The value is case-sensitive.", "required": false, "schema": { "title": "sriovNetSupportValue", "type": "string" } }, { "name": "userDataValue", "type": "string", "info": "Changes the instance's user data to the specified value. If you are using an AWS SDK or command line tool, base64-encoding is performed for you, and you can load the text...(description truncated)", "required": false, "schema": { "title": "userDataValue", "type": "string" } }, { "name": "value", "type": "string", "info": "A new value for the attribute. Use only with the kernel , ramdisk , userData , disableApiTermination , or instanceInitiatedShutdownBehavior attribute.", "required": false, "schema": { "title": "value", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyInstanceAttribute" }, "task": true }, { "name": "modifyInstanceAttributeSTSRole", "summary": "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 som...(description truncated)", "description": "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 som...(description truncated)", "input": [ { "name": "sourceDestCheckValue", "type": "string", "info": "Describes a value for a resource attribute that is a Boolean value.\nThe attribute value. The valid values are true or false .", "required": false, "schema": { "title": "sourceDestCheckValue", "type": "string" } }, { "name": "attribute", "type": "string", "info": "The name of the attribute.", "required": false, "schema": { "title": "attribute", "type": "string" } }, { "name": "blockDeviceMapping", "type": "array", "info": "Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermi...(description truncated)", "required": false, "schema": { "title": "blockDeviceMapping", "type": "array" } }, { "name": "disableApiTerminationValue", "type": "string", "info": "Describes a value for a resource attribute that is a Boolean value.\nThe attribute value. The valid values are true or false .", "required": false, "schema": { "title": "disableApiTerminationValue", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "ebsOptimizedValue", "type": "string", "info": "Describes a value for a resource attribute that is a Boolean value.\nThe attribute value. The valid values are true or false .", "required": false, "schema": { "title": "ebsOptimizedValue", "type": "string" } }, { "name": "enaSupportValue", "type": "string", "info": "Describes a value for a resource attribute that is a Boolean value.\nThe attribute value. The valid values are true or false .", "required": false, "schema": { "title": "enaSupportValue", "type": "string" } }, { "name": "groupId", "type": "array", "info": "[EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it's just the default security group for the VPC. You must sp...(description truncated)", "required": false, "schema": { "title": "groupId", "type": "array" } }, { "name": "instanceId", "type": "string", "info": "The ID of the instance.", "required": true, "schema": { "title": "instanceId", "type": "string" } }, { "name": "instanceInitiatedShutdownBehaviorValue", "type": "string", "info": "Describes a value for a resource attribute that is a String.\nThe attribute value. The value is case-sensitive.", "required": false, "schema": { "title": "instanceInitiatedShutdownBehaviorValue", "type": "string" } }, { "name": "instanceTypeValue", "type": "string", "info": "Describes a value for a resource attribute that is a String.\nThe attribute value. The value is case-sensitive.", "required": false, "schema": { "title": "instanceTypeValue", "type": "string" } }, { "name": "kernelValue", "type": "string", "info": "Describes a value for a resource attribute that is a String.\nThe attribute value. The value is case-sensitive.", "required": false, "schema": { "title": "kernelValue", "type": "string" } }, { "name": "ramdiskValue", "type": "string", "info": "Describes a value for a resource attribute that is a String.\nThe attribute value. The value is case-sensitive.", "required": false, "schema": { "title": "ramdiskValue", "type": "string" } }, { "name": "sriovNetSupportValue", "type": "string", "info": "Describes a value for a resource attribute that is a String.\nThe attribute value. The value is case-sensitive.", "required": false, "schema": { "title": "sriovNetSupportValue", "type": "string" } }, { "name": "userDataValue", "type": "string", "info": "Changes the instance's user data to the specified value. If you are using an AWS SDK or command line tool, base64-encoding is performed for you, and you can load the text...(description truncated)", "required": false, "schema": { "title": "userDataValue", "type": "string" } }, { "name": "value", "type": "string", "info": "A new value for the attribute. Use only with the kernel , ramdisk , userData , disableApiTermination , or instanceInitiatedShutdownBehavior attribute.", "required": false, "schema": { "title": "value", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyInstanceAttributeSTSRole" }, "task": true }, { "name": "modifyInstanceCapacityReservationAttributes", "summary": "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.", "description": "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.", "input": [ { "name": "instanceId", "type": "string", "info": "The ID of the instance to be modified.", "required": true, "schema": { "title": "instanceId", "type": "string" } }, { "name": "capacityReservationSpecificationCapacityReservationPreference", "type": "string", "info": "Describes an instance's Capacity Reservation targeting option. You can specify only one parameter at a time. If you specify CapacityReservationPreference and Capacity...(description truncated)", "required": false, "schema": { "title": "capacityReservationSpecificationCapacityReservationPreference", "type": "string" } }, { "name": "capacityReservationSpecificationCapacityReservationTarget", "type": "string", "info": "Describes an instance's Capacity Reservation targeting option. You can specify only one parameter at a time. If you specify CapacityReservationPreference and Capacity...(description truncated)", "required": false, "schema": { "title": "capacityReservationSpecificationCapacityReservationTarget", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyInstanceCapacityReservationAttributes" }, "task": true }, { "name": "modifyInstanceCapacityReservationAttributesSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "instanceId", "type": "string", "info": "The ID of the instance to be modified.", "required": true, "schema": { "title": "instanceId", "type": "string" } }, { "name": "capacityReservationSpecificationCapacityReservationPreference", "type": "string", "info": "Describes an instance's Capacity Reservation targeting option. You can specify only one parameter at a time. If you specify CapacityReservationPreference and Capacity...(description truncated)", "required": false, "schema": { "title": "capacityReservationSpecificationCapacityReservationPreference", "type": "string" } }, { "name": "capacityReservationSpecificationCapacityReservationTarget", "type": "string", "info": "Describes an instance's Capacity Reservation targeting option. You can specify only one parameter at a time. If you specify CapacityReservationPreference and Capacity...(description truncated)", "required": false, "schema": { "title": "capacityReservationSpecificationCapacityReservationTarget", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyInstanceCapacityReservationAttributesSTSRole" }, "task": true }, { "name": "modifyInstanceCreditSpecification", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "clientToken", "type": "string", "info": "A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency .", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "instanceCreditSpecification", "type": "array", "info": "Information about the credit option for CPU usage.", "required": true, "schema": { "title": "instanceCreditSpecification", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyInstanceCreditSpecification" }, "task": true }, { "name": "modifyInstanceCreditSpecificationSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "clientToken", "type": "string", "info": "A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency .", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "instanceCreditSpecification", "type": "array", "info": "Information about the credit option for CPU usage.", "required": true, "schema": { "title": "instanceCreditSpecification", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyInstanceCreditSpecificationSTSRole" }, "task": true }, { "name": "modifyInstanceEventStartTime", "summary": "Modifies the start time for a scheduled Amazon EC2 instance event.", "description": "Modifies the start time for a scheduled Amazon EC2 instance event.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "instanceId", "type": "string", "info": "The ID of the instance with the scheduled event.", "required": true, "schema": { "title": "instanceId", "type": "string" } }, { "name": "instanceEventId", "type": "string", "info": "The ID of the event whose date and time you are modifying.", "required": true, "schema": { "title": "instanceEventId", "type": "string" } }, { "name": "notBefore", "type": "string", "info": "The new date and time when the event will take place.", "required": true, "schema": { "title": "notBefore", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyInstanceEventStartTime" }, "task": true }, { "name": "modifyInstanceEventStartTimeSTSRole", "summary": "Modifies the start time for a scheduled Amazon EC2 instance event.", "description": "Modifies the start time for a scheduled Amazon EC2 instance event.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "instanceId", "type": "string", "info": "The ID of the instance with the scheduled event.", "required": true, "schema": { "title": "instanceId", "type": "string" } }, { "name": "instanceEventId", "type": "string", "info": "The ID of the event whose date and time you are modifying.", "required": true, "schema": { "title": "instanceEventId", "type": "string" } }, { "name": "notBefore", "type": "string", "info": "The new date and time when the event will take place.", "required": true, "schema": { "title": "notBefore", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyInstanceEventStartTimeSTSRole" }, "task": true }, { "name": "modifyInstancePlacement", "summary": "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. ...(description truncated)", "description": "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. ...(description truncated)", "input": [ { "name": "affinity", "type": "string", "info": "The affinity setting for the instance.", "required": false, "schema": { "title": "affinity", "type": "string" } }, { "name": "groupName", "type": "string", "info": "The name of the placement group in which to place the instance. For spread placement groups, the instance must have a tenancy of default . For cluster and partition pla...(description truncated)", "required": false, "schema": { "title": "groupName", "type": "string" } }, { "name": "hostId", "type": "string", "info": "The ID of the Dedicated Host with which to associate the instance.", "required": false, "schema": { "title": "hostId", "type": "string" } }, { "name": "instanceId", "type": "string", "info": "The ID of the instance that you are modifying.", "required": true, "schema": { "title": "instanceId", "type": "string" } }, { "name": "tenancy", "type": "string", "info": "The tenancy for the instance.", "required": false, "schema": { "title": "tenancy", "type": "string" } }, { "name": "partitionNumber", "type": "number", "info": "Reserved for future use.", "required": false, "schema": { "title": "partitionNumber", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyInstancePlacement" }, "task": true }, { "name": "modifyInstancePlacementSTSRole", "summary": "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. ...(description truncated)", "description": "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. ...(description truncated)", "input": [ { "name": "affinity", "type": "string", "info": "The affinity setting for the instance.", "required": false, "schema": { "title": "affinity", "type": "string" } }, { "name": "groupName", "type": "string", "info": "The name of the placement group in which to place the instance. For spread placement groups, the instance must have a tenancy of default . For cluster and partition pla...(description truncated)", "required": false, "schema": { "title": "groupName", "type": "string" } }, { "name": "hostId", "type": "string", "info": "The ID of the Dedicated Host with which to associate the instance.", "required": false, "schema": { "title": "hostId", "type": "string" } }, { "name": "instanceId", "type": "string", "info": "The ID of the instance that you are modifying.", "required": true, "schema": { "title": "instanceId", "type": "string" } }, { "name": "tenancy", "type": "string", "info": "The tenancy for the instance.", "required": false, "schema": { "title": "tenancy", "type": "string" } }, { "name": "partitionNumber", "type": "number", "info": "Reserved for future use.", "required": false, "schema": { "title": "partitionNumber", "type": "number" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyInstancePlacementSTSRole" }, "task": true }, { "name": "modifyLaunchTemplate", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency . Constraint: Maximum 128 ASCII...(description truncated)", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "launchTemplateId", "type": "string", "info": "The ID of the launch template. You must specify either the launch template ID or launch template name in the request.", "required": false, "schema": { "title": "launchTemplateId", "type": "string" } }, { "name": "launchTemplateName", "type": "string", "info": "The name of the launch template. You must specify either the launch template ID or launch template name in the request.", "required": false, "schema": { "title": "launchTemplateName", "type": "string" } }, { "name": "setDefaultVersion", "type": "string", "info": "The version number of the launch template to set as the default version.", "required": false, "schema": { "title": "setDefaultVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyLaunchTemplate" }, "task": true }, { "name": "modifyLaunchTemplateSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency . Constraint: Maximum 128 ASCII...(description truncated)", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "launchTemplateId", "type": "string", "info": "The ID of the launch template. You must specify either the launch template ID or launch template name in the request.", "required": false, "schema": { "title": "launchTemplateId", "type": "string" } }, { "name": "launchTemplateName", "type": "string", "info": "The name of the launch template. You must specify either the launch template ID or launch template name in the request.", "required": false, "schema": { "title": "launchTemplateName", "type": "string" } }, { "name": "setDefaultVersion", "type": "string", "info": "The version number of the launch template to set as the default version.", "required": false, "schema": { "title": "setDefaultVersion", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyLaunchTemplateSTSRole" }, "task": true }, { "name": "modifyNetworkInterfaceAttribute", "summary": "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.", "description": "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.", "input": [ { "name": "attachmentAttachmentId", "type": "string", "info": "Describes an attachment change.\nThe ID of the network interface attachment.", "required": false, "schema": { "title": "attachmentAttachmentId", "type": "string" } }, { "name": "attachmentDeleteOnTermination", "type": "string", "info": "Describes an attachment change.\nIndicates whether the network interface is deleted when the instance is terminated.", "required": false, "schema": { "title": "attachmentDeleteOnTermination", "type": "string" } }, { "name": "descriptionValue", "type": "string", "info": "Describes a value for a resource attribute that is a String.\nThe attribute value. The value is case-sensitive.", "required": false, "schema": { "title": "descriptionValue", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "securityGroupId", "type": "array", "info": "Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just ...(description truncated)", "required": false, "schema": { "title": "securityGroupId", "type": "array" } }, { "name": "networkInterfaceId", "type": "string", "info": "The ID of the network interface.", "required": true, "schema": { "title": "networkInterfaceId", "type": "string" } }, { "name": "sourceDestCheckValue", "type": "string", "info": "Describes a value for a resource attribute that is a Boolean value.\nThe attribute value. The valid values are true or false .", "required": false, "schema": { "title": "sourceDestCheckValue", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyNetworkInterfaceAttribute" }, "task": true }, { "name": "modifyNetworkInterfaceAttributeSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "attachmentAttachmentId", "type": "string", "info": "Describes an attachment change.\nThe ID of the network interface attachment.", "required": false, "schema": { "title": "attachmentAttachmentId", "type": "string" } }, { "name": "attachmentDeleteOnTermination", "type": "string", "info": "Describes an attachment change.\nIndicates whether the network interface is deleted when the instance is terminated.", "required": false, "schema": { "title": "attachmentDeleteOnTermination", "type": "string" } }, { "name": "descriptionValue", "type": "string", "info": "Describes a value for a resource attribute that is a String.\nThe attribute value. The value is case-sensitive.", "required": false, "schema": { "title": "descriptionValue", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "securityGroupId", "type": "array", "info": "Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just ...(description truncated)", "required": false, "schema": { "title": "securityGroupId", "type": "array" } }, { "name": "networkInterfaceId", "type": "string", "info": "The ID of the network interface.", "required": true, "schema": { "title": "networkInterfaceId", "type": "string" } }, { "name": "sourceDestCheckValue", "type": "string", "info": "Describes a value for a resource attribute that is a Boolean value.\nThe attribute value. The valid values are true or false .", "required": false, "schema": { "title": "sourceDestCheckValue", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyNetworkInterfaceAttributeSTSRole" }, "task": true }, { "name": "modifyReservedInstances", "summary": "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.", "description": "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.", "input": [ { "name": "reservedInstancesId", "type": "array", "info": "The IDs of the Reserved Instances to modify.", "required": true, "schema": { "title": "reservedInstancesId", "type": "array" } }, { "name": "clientToken", "type": "string", "info": "A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency .", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "reservedInstancesConfigurationSetItemType", "type": "array", "info": "The configuration settings for the Reserved Instances to modify.", "required": true, "schema": { "title": "reservedInstancesConfigurationSetItemType", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyReservedInstances" }, "task": true }, { "name": "modifyReservedInstancesSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "reservedInstancesId", "type": "array", "info": "The IDs of the Reserved Instances to modify.", "required": true, "schema": { "title": "reservedInstancesId", "type": "array" } }, { "name": "clientToken", "type": "string", "info": "A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency .", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "reservedInstancesConfigurationSetItemType", "type": "array", "info": "The configuration settings for the Reserved Instances to modify.", "required": true, "schema": { "title": "reservedInstancesConfigurationSetItemType", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyReservedInstancesSTSRole" }, "task": true }, { "name": "modifySnapshotAttribute", "summary": "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 API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls. 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 informat...(description truncated)", "description": "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 API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls. 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 informat...(description truncated)", "input": [ { "name": "attribute", "type": "string", "info": "The snapshot attribute to modify. Only volume creation permissions can be modified.", "required": false, "schema": { "title": "attribute", "type": "string" } }, { "name": "createVolumePermissionAdd", "type": "array", "info": "Describes modifications to the list of create volume permissions for a volume.\nAdds the specified AWS account ID or group to the list.", "required": false, "schema": { "title": "createVolumePermissionAdd", "type": "array" } }, { "name": "createVolumePermissionRemove", "type": "array", "info": "Describes modifications to the list of create volume permissions for a volume.\nRemoves the specified AWS account ID or group from the list.", "required": false, "schema": { "title": "createVolumePermissionRemove", "type": "array" } }, { "name": "userGroup", "type": "array", "info": "The group to modify for the snapshot.", "required": false, "schema": { "title": "userGroup", "type": "array" } }, { "name": "operationType", "type": "string", "info": "The type of operation to perform to the attribute.", "required": false, "schema": { "title": "operationType", "type": "string" } }, { "name": "snapshotId", "type": "string", "info": "The ID of the snapshot.", "required": true, "schema": { "title": "snapshotId", "type": "string" } }, { "name": "userId", "type": "array", "info": "The account ID to modify for the snapshot.", "required": false, "schema": { "title": "userId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifySnapshotAttribute" }, "task": true }, { "name": "modifySnapshotAttributeSTSRole", "summary": "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 API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls. 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 informat...(description truncated)", "description": "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 API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls. 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 informat...(description truncated)", "input": [ { "name": "attribute", "type": "string", "info": "The snapshot attribute to modify. Only volume creation permissions can be modified.", "required": false, "schema": { "title": "attribute", "type": "string" } }, { "name": "createVolumePermissionAdd", "type": "array", "info": "Describes modifications to the list of create volume permissions for a volume.\nAdds the specified AWS account ID or group to the list.", "required": false, "schema": { "title": "createVolumePermissionAdd", "type": "array" } }, { "name": "createVolumePermissionRemove", "type": "array", "info": "Describes modifications to the list of create volume permissions for a volume.\nRemoves the specified AWS account ID or group from the list.", "required": false, "schema": { "title": "createVolumePermissionRemove", "type": "array" } }, { "name": "userGroup", "type": "array", "info": "The group to modify for the snapshot.", "required": false, "schema": { "title": "userGroup", "type": "array" } }, { "name": "operationType", "type": "string", "info": "The type of operation to perform to the attribute.", "required": false, "schema": { "title": "operationType", "type": "string" } }, { "name": "snapshotId", "type": "string", "info": "The ID of the snapshot.", "required": true, "schema": { "title": "snapshotId", "type": "string" } }, { "name": "userId", "type": "array", "info": "The account ID to modify for the snapshot.", "required": false, "schema": { "title": "userId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifySnapshotAttributeSTSRole" }, "task": true }, { "name": "modifySpotFleetRequest", "summary": "Modifies the specified Spot Fleet request. 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 ...(description truncated)", "description": "Modifies the specified Spot Fleet request. 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 ...(description truncated)", "input": [ { "name": "excessCapacityTerminationPolicy", "type": "string", "info": "Indicates whether running Spot Instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet.", "required": false, "schema": { "title": "excessCapacityTerminationPolicy", "type": "string" } }, { "name": "spotFleetRequestId", "type": "string", "info": "The ID of the Spot Fleet request.", "required": true, "schema": { "title": "spotFleetRequestId", "type": "string" } }, { "name": "targetCapacity", "type": "number", "info": "The size of the fleet.", "required": false, "schema": { "title": "targetCapacity", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifySpotFleetRequest" }, "task": true }, { "name": "modifySpotFleetRequestSTSRole", "summary": "Modifies the specified Spot Fleet request. 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 ...(description truncated)", "description": "Modifies the specified Spot Fleet request. 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 ...(description truncated)", "input": [ { "name": "excessCapacityTerminationPolicy", "type": "string", "info": "Indicates whether running Spot Instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet.", "required": false, "schema": { "title": "excessCapacityTerminationPolicy", "type": "string" } }, { "name": "spotFleetRequestId", "type": "string", "info": "The ID of the Spot Fleet request.", "required": true, "schema": { "title": "spotFleetRequestId", "type": "string" } }, { "name": "targetCapacity", "type": "number", "info": "The size of the fleet.", "required": false, "schema": { "title": "targetCapacity", "type": "number" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifySpotFleetRequestSTSRole" }, "task": true }, { "name": "modifySubnetAttribute", "summary": "Modifies a subnet attribute. You can only modify one attribute at a time.", "description": "Modifies a subnet attribute. You can only modify one attribute at a time.", "input": [ { "name": "assignIpv6AddressOnCreationValue", "type": "string", "info": "Describes a value for a resource attribute that is a Boolean value.\nThe attribute value. The valid values are true or false .", "required": false, "schema": { "title": "assignIpv6AddressOnCreationValue", "type": "string" } }, { "name": "mapPublicIpOnLaunchValue", "type": "string", "info": "Describes a value for a resource attribute that is a Boolean value.\nThe attribute value. The valid values are true or false .", "required": false, "schema": { "title": "mapPublicIpOnLaunchValue", "type": "string" } }, { "name": "subnetId", "type": "string", "info": "The ID of the subnet.", "required": true, "schema": { "title": "subnetId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifySubnetAttribute" }, "task": true }, { "name": "modifySubnetAttributeSTSRole", "summary": "Modifies a subnet attribute. You can only modify one attribute at a time.", "description": "Modifies a subnet attribute. You can only modify one attribute at a time.", "input": [ { "name": "assignIpv6AddressOnCreationValue", "type": "string", "info": "Describes a value for a resource attribute that is a Boolean value.\nThe attribute value. The valid values are true or false .", "required": false, "schema": { "title": "assignIpv6AddressOnCreationValue", "type": "string" } }, { "name": "mapPublicIpOnLaunchValue", "type": "string", "info": "Describes a value for a resource attribute that is a Boolean value.\nThe attribute value. The valid values are true or false .", "required": false, "schema": { "title": "mapPublicIpOnLaunchValue", "type": "string" } }, { "name": "subnetId", "type": "string", "info": "The ID of the subnet.", "required": true, "schema": { "title": "subnetId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifySubnetAttributeSTSRole" }, "task": true }, { "name": "modifyTransitGatewayVpcAttachment", "summary": "Modifies the specified VPC attachment.", "description": "Modifies the specified VPC attachment.", "input": [ { "name": "transitGatewayAttachmentId", "type": "string", "info": "The ID of the attachment.", "required": true, "schema": { "title": "transitGatewayAttachmentId", "type": "string" } }, { "name": "addSubnetIds", "type": "array", "info": "The IDs of one or more subnets to add. You can specify at most one subnet per Availability Zone.", "required": false, "schema": { "title": "addSubnetIds", "type": "array" } }, { "name": "removeSubnetIds", "type": "array", "info": "The IDs of one or more subnets to remove.", "required": false, "schema": { "title": "removeSubnetIds", "type": "array" } }, { "name": "optionsDnsSupport", "type": "string", "info": "Describes the options for a VPC attachment.\nEnable or disable DNS support. The default is enable .", "required": false, "schema": { "title": "optionsDnsSupport", "type": "string" } }, { "name": "optionsIpv6Support", "type": "string", "info": "Describes the options for a VPC attachment.\nEnable or disable IPv6 support. The default is enable .", "required": false, "schema": { "title": "optionsIpv6Support", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyTransitGatewayVpcAttachment" }, "task": true }, { "name": "modifyTransitGatewayVpcAttachmentSTSRole", "summary": "Modifies the specified VPC attachment.", "description": "Modifies the specified VPC attachment.", "input": [ { "name": "transitGatewayAttachmentId", "type": "string", "info": "The ID of the attachment.", "required": true, "schema": { "title": "transitGatewayAttachmentId", "type": "string" } }, { "name": "addSubnetIds", "type": "array", "info": "The IDs of one or more subnets to add. You can specify at most one subnet per Availability Zone.", "required": false, "schema": { "title": "addSubnetIds", "type": "array" } }, { "name": "removeSubnetIds", "type": "array", "info": "The IDs of one or more subnets to remove.", "required": false, "schema": { "title": "removeSubnetIds", "type": "array" } }, { "name": "optionsDnsSupport", "type": "string", "info": "Describes the options for a VPC attachment.\nEnable or disable DNS support. The default is enable .", "required": false, "schema": { "title": "optionsDnsSupport", "type": "string" } }, { "name": "optionsIpv6Support", "type": "string", "info": "Describes the options for a VPC attachment.\nEnable or disable IPv6 support. The default is enable .", "required": false, "schema": { "title": "optionsIpv6Support", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyTransitGatewayVpcAttachmentSTSRole" }, "task": true }, { "name": "modifyVolume", "summary": "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 M...(description truncated)", "description": "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 M...(description truncated)", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "volumeId", "type": "string", "info": "The ID of the volume.", "required": true, "schema": { "title": "volumeId", "type": "string" } }, { "name": "size", "type": "number", "info": "The target size of the volume, in GiB. The target volume size must be greater than or equal to than the existing size of the volume. For information about available EBS ...(description truncated)", "required": false, "schema": { "title": "size", "type": "number" } }, { "name": "volumeType", "type": "string", "info": "The target EBS volume type of the volume. Default: If no type is specified, the existing type is retained.", "required": false, "schema": { "title": "volumeType", "type": "string" } }, { "name": "iops", "type": "number", "info": "The target IOPS rate of the volume. This is only valid for Provisioned IOPS SSD ( io1 ) volumes. For more information, see Provisioned IOPS SSD (io1) Volumes . Defa...(description truncated)", "required": false, "schema": { "title": "iops", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyVolume" }, "task": true }, { "name": "modifyVolumeSTSRole", "summary": "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 M...(description truncated)", "description": "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 M...(description truncated)", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "volumeId", "type": "string", "info": "The ID of the volume.", "required": true, "schema": { "title": "volumeId", "type": "string" } }, { "name": "size", "type": "number", "info": "The target size of the volume, in GiB. The target volume size must be greater than or equal to than the existing size of the volume. For information about available EBS ...(description truncated)", "required": false, "schema": { "title": "size", "type": "number" } }, { "name": "volumeType", "type": "string", "info": "The target EBS volume type of the volume. Default: If no type is specified, the existing type is retained.", "required": false, "schema": { "title": "volumeType", "type": "string" } }, { "name": "iops", "type": "number", "info": "The target IOPS rate of the volume. This is only valid for Provisioned IOPS SSD ( io1 ) volumes. For more information, see Provisioned IOPS SSD (io1) Volumes . Defa...(description truncated)", "required": false, "schema": { "title": "iops", "type": "number" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyVolumeSTSRole" }, "task": true }, { "name": "modifyVolumeAttribute", "summary": "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 ...(description truncated)", "description": "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 ...(description truncated)", "input": [ { "name": "autoEnableIOValue", "type": "string", "info": "Describes a value for a resource attribute that is a Boolean value.\nThe attribute value. The valid values are true or false .", "required": false, "schema": { "title": "autoEnableIOValue", "type": "string" } }, { "name": "volumeId", "type": "string", "info": "The ID of the volume.", "required": true, "schema": { "title": "volumeId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyVolumeAttribute" }, "task": true }, { "name": "modifyVolumeAttributeSTSRole", "summary": "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 ...(description truncated)", "description": "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 ...(description truncated)", "input": [ { "name": "autoEnableIOValue", "type": "string", "info": "Describes a value for a resource attribute that is a Boolean value.\nThe attribute value. The valid values are true or false .", "required": false, "schema": { "title": "autoEnableIOValue", "type": "string" } }, { "name": "volumeId", "type": "string", "info": "The ID of the volume.", "required": true, "schema": { "title": "volumeId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyVolumeAttributeSTSRole" }, "task": true }, { "name": "modifyVpcAttribute", "summary": "Modifies the specified attribute of the specified VPC.", "description": "Modifies the specified attribute of the specified VPC.", "input": [ { "name": "enableDnsHostnamesValue", "type": "string", "info": "Describes a value for a resource attribute that is a Boolean value.\nThe attribute value. The valid values are true or false .", "required": false, "schema": { "title": "enableDnsHostnamesValue", "type": "string" } }, { "name": "enableDnsSupportValue", "type": "string", "info": "Describes a value for a resource attribute that is a Boolean value.\nThe attribute value. The valid values are true or false .", "required": false, "schema": { "title": "enableDnsSupportValue", "type": "string" } }, { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyVpcAttribute" }, "task": true }, { "name": "modifyVpcAttributeSTSRole", "summary": "Modifies the specified attribute of the specified VPC.", "description": "Modifies the specified attribute of the specified VPC.", "input": [ { "name": "enableDnsHostnamesValue", "type": "string", "info": "Describes a value for a resource attribute that is a Boolean value.\nThe attribute value. The valid values are true or false .", "required": false, "schema": { "title": "enableDnsHostnamesValue", "type": "string" } }, { "name": "enableDnsSupportValue", "type": "string", "info": "Describes a value for a resource attribute that is a Boolean value.\nThe attribute value. The valid values are true or false .", "required": false, "schema": { "title": "enableDnsSupportValue", "type": "string" } }, { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyVpcAttributeSTSRole" }, "task": true }, { "name": "modifyVpcEndpoint", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "vpcEndpointId", "type": "string", "info": "The ID of the endpoint.", "required": true, "schema": { "title": "vpcEndpointId", "type": "string" } }, { "name": "resetPolicy", "type": "boolean", "info": "(Gateway endpoint) Specify true to reset the policy document to the default policy. The default policy allows full access to the service.", "required": false, "schema": { "title": "resetPolicy", "type": "boolean" } }, { "name": "policyDocument", "type": "string", "info": "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 p...(description truncated)", "required": false, "schema": { "title": "policyDocument", "type": "string" } }, { "name": "addRouteTableId", "type": "array", "info": "(Gateway endpoint) One or more route tables IDs to associate with the endpoint.", "required": false, "schema": { "title": "addRouteTableId", "type": "array" } }, { "name": "removeRouteTableId", "type": "array", "info": "(Gateway endpoint) One or more route table IDs to disassociate from the endpoint.", "required": false, "schema": { "title": "removeRouteTableId", "type": "array" } }, { "name": "addSubnetId", "type": "array", "info": "(Interface endpoint) One or more subnet IDs in which to serve the endpoint.", "required": false, "schema": { "title": "addSubnetId", "type": "array" } }, { "name": "removeSubnetId", "type": "array", "info": "(Interface endpoint) One or more subnets IDs in which to remove the endpoint.", "required": false, "schema": { "title": "removeSubnetId", "type": "array" } }, { "name": "addSecurityGroupId", "type": "array", "info": "(Interface endpoint) One or more security group IDs to associate with the network interface.", "required": false, "schema": { "title": "addSecurityGroupId", "type": "array" } }, { "name": "removeSecurityGroupId", "type": "array", "info": "(Interface endpoint) One or more security group IDs to disassociate from the network interface.", "required": false, "schema": { "title": "removeSecurityGroupId", "type": "array" } }, { "name": "privateDnsEnabled", "type": "boolean", "info": "(Interface endpoint) Indicate whether a private hosted zone is associated with the VPC.", "required": false, "schema": { "title": "privateDnsEnabled", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyVpcEndpoint" }, "task": true }, { "name": "modifyVpcEndpointSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "vpcEndpointId", "type": "string", "info": "The ID of the endpoint.", "required": true, "schema": { "title": "vpcEndpointId", "type": "string" } }, { "name": "resetPolicy", "type": "boolean", "info": "(Gateway endpoint) Specify true to reset the policy document to the default policy. The default policy allows full access to the service.", "required": false, "schema": { "title": "resetPolicy", "type": "boolean" } }, { "name": "policyDocument", "type": "string", "info": "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 p...(description truncated)", "required": false, "schema": { "title": "policyDocument", "type": "string" } }, { "name": "addRouteTableId", "type": "array", "info": "(Gateway endpoint) One or more route tables IDs to associate with the endpoint.", "required": false, "schema": { "title": "addRouteTableId", "type": "array" } }, { "name": "removeRouteTableId", "type": "array", "info": "(Gateway endpoint) One or more route table IDs to disassociate from the endpoint.", "required": false, "schema": { "title": "removeRouteTableId", "type": "array" } }, { "name": "addSubnetId", "type": "array", "info": "(Interface endpoint) One or more subnet IDs in which to serve the endpoint.", "required": false, "schema": { "title": "addSubnetId", "type": "array" } }, { "name": "removeSubnetId", "type": "array", "info": "(Interface endpoint) One or more subnets IDs in which to remove the endpoint.", "required": false, "schema": { "title": "removeSubnetId", "type": "array" } }, { "name": "addSecurityGroupId", "type": "array", "info": "(Interface endpoint) One or more security group IDs to associate with the network interface.", "required": false, "schema": { "title": "addSecurityGroupId", "type": "array" } }, { "name": "removeSecurityGroupId", "type": "array", "info": "(Interface endpoint) One or more security group IDs to disassociate from the network interface.", "required": false, "schema": { "title": "removeSecurityGroupId", "type": "array" } }, { "name": "privateDnsEnabled", "type": "boolean", "info": "(Interface endpoint) Indicate whether a private hosted zone is associated with the VPC.", "required": false, "schema": { "title": "privateDnsEnabled", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyVpcEndpointSTSRole" }, "task": true }, { "name": "modifyVpcEndpointConnectionNotification", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "connectionNotificationId", "type": "string", "info": "The ID of the notification.", "required": true, "schema": { "title": "connectionNotificationId", "type": "string" } }, { "name": "connectionNotificationArn", "type": "string", "info": "The ARN for the SNS topic for the notification.", "required": false, "schema": { "title": "connectionNotificationArn", "type": "string" } }, { "name": "connectionEvents", "type": "array", "info": "One or more events for the endpoint. Valid values are Accept , Connect , Delete , and Reject .", "required": false, "schema": { "title": "connectionEvents", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyVpcEndpointConnectionNotification" }, "task": true }, { "name": "modifyVpcEndpointConnectionNotificationSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "connectionNotificationId", "type": "string", "info": "The ID of the notification.", "required": true, "schema": { "title": "connectionNotificationId", "type": "string" } }, { "name": "connectionNotificationArn", "type": "string", "info": "The ARN for the SNS topic for the notification.", "required": false, "schema": { "title": "connectionNotificationArn", "type": "string" } }, { "name": "connectionEvents", "type": "array", "info": "One or more events for the endpoint. Valid values are Accept , Connect , Delete , and Reject .", "required": false, "schema": { "title": "connectionEvents", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyVpcEndpointConnectionNotificationSTSRole" }, "task": true }, { "name": "modifyVpcEndpointServiceConfiguration", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "serviceId", "type": "string", "info": "The ID of the service.", "required": true, "schema": { "title": "serviceId", "type": "string" } }, { "name": "acceptanceRequired", "type": "boolean", "info": "Indicate whether requests to create an endpoint to your service must be accepted.", "required": false, "schema": { "title": "acceptanceRequired", "type": "boolean" } }, { "name": "addNetworkLoadBalancerArn", "type": "array", "info": "The Amazon Resource Names (ARNs) of Network Load Balancers to add to your service configuration.", "required": false, "schema": { "title": "addNetworkLoadBalancerArn", "type": "array" } }, { "name": "removeNetworkLoadBalancerArn", "type": "array", "info": "The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service configuration.", "required": false, "schema": { "title": "removeNetworkLoadBalancerArn", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyVpcEndpointServiceConfiguration" }, "task": true }, { "name": "modifyVpcEndpointServiceConfigurationSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "serviceId", "type": "string", "info": "The ID of the service.", "required": true, "schema": { "title": "serviceId", "type": "string" } }, { "name": "acceptanceRequired", "type": "boolean", "info": "Indicate whether requests to create an endpoint to your service must be accepted.", "required": false, "schema": { "title": "acceptanceRequired", "type": "boolean" } }, { "name": "addNetworkLoadBalancerArn", "type": "array", "info": "The Amazon Resource Names (ARNs) of Network Load Balancers to add to your service configuration.", "required": false, "schema": { "title": "addNetworkLoadBalancerArn", "type": "array" } }, { "name": "removeNetworkLoadBalancerArn", "type": "array", "info": "The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service configuration.", "required": false, "schema": { "title": "removeNetworkLoadBalancerArn", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyVpcEndpointServiceConfigurationSTSRole" }, "task": true }, { "name": "modifyVpcEndpointServicePermissions", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "serviceId", "type": "string", "info": "The ID of the service.", "required": true, "schema": { "title": "serviceId", "type": "string" } }, { "name": "addAllowedPrincipals", "type": "array", "info": "The Amazon Resource Names (ARN) of one or more principals. Permissions are granted to the principals in this list. To grant permissions to all principals, specify an aste...(description truncated)", "required": false, "schema": { "title": "addAllowedPrincipals", "type": "array" } }, { "name": "removeAllowedPrincipals", "type": "array", "info": "The Amazon Resource Names (ARN) of one or more principals. Permissions are revoked for principals in this list.", "required": false, "schema": { "title": "removeAllowedPrincipals", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyVpcEndpointServicePermissions" }, "task": true }, { "name": "modifyVpcEndpointServicePermissionsSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "serviceId", "type": "string", "info": "The ID of the service.", "required": true, "schema": { "title": "serviceId", "type": "string" } }, { "name": "addAllowedPrincipals", "type": "array", "info": "The Amazon Resource Names (ARN) of one or more principals. Permissions are granted to the principals in this list. To grant permissions to all principals, specify an aste...(description truncated)", "required": false, "schema": { "title": "addAllowedPrincipals", "type": "array" } }, { "name": "removeAllowedPrincipals", "type": "array", "info": "The Amazon Resource Names (ARN) of one or more principals. Permissions are revoked for principals in this list.", "required": false, "schema": { "title": "removeAllowedPrincipals", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyVpcEndpointServicePermissionsSTSRole" }, "task": true }, { "name": "modifyVpcPeeringConnectionOptions", "summary": "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...(description truncated)", "description": "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...(description truncated)", "input": [ { "name": "accepterPeeringConnectionOptionsAllowDnsResolutionFromRemoteVpc", "type": "string", "info": "The VPC peering connection options.\nIf true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.", "required": false, "schema": { "title": "accepterPeeringConnectionOptionsAllowDnsResolutionFromRemoteVpc", "type": "string" } }, { "name": "accepterPeeringConnectionOptionsAllowEgressFromLocalClassicLinkToRemoteVpc", "type": "string", "info": "The VPC peering connection options.\nIf true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC using ClassicLink to instances in a ...(description truncated)", "required": false, "schema": { "title": "accepterPeeringConnectionOptionsAllowEgressFromLocalClassicLinkToRemoteVpc", "type": "string" } }, { "name": "accepterPeeringConnectionOptionsAllowEgressFromLocalVpcToRemoteClassicLink", "type": "string", "info": "The VPC peering connection options.\nIf true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC using Cla...(description truncated)", "required": false, "schema": { "title": "accepterPeeringConnectionOptionsAllowEgressFromLocalVpcToRemoteClassicLink", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "requesterPeeringConnectionOptionsAllowDnsResolutionFromRemoteVpc", "type": "string", "info": "The VPC peering connection options.\nIf true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.", "required": false, "schema": { "title": "requesterPeeringConnectionOptionsAllowDnsResolutionFromRemoteVpc", "type": "string" } }, { "name": "requesterPeeringConnectionOptionsAllowEgressFromLocalClassicLinkToRemoteVpc", "type": "string", "info": "The VPC peering connection options.\nIf true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC using ClassicLink to instances in a ...(description truncated)", "required": false, "schema": { "title": "requesterPeeringConnectionOptionsAllowEgressFromLocalClassicLinkToRemoteVpc", "type": "string" } }, { "name": "requesterPeeringConnectionOptionsAllowEgressFromLocalVpcToRemoteClassicLink", "type": "string", "info": "The VPC peering connection options.\nIf true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC using Cla...(description truncated)", "required": false, "schema": { "title": "requesterPeeringConnectionOptionsAllowEgressFromLocalVpcToRemoteClassicLink", "type": "string" } }, { "name": "vpcPeeringConnectionId", "type": "string", "info": "The ID of the VPC peering connection.", "required": true, "schema": { "title": "vpcPeeringConnectionId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyVpcPeeringConnectionOptions" }, "task": true }, { "name": "modifyVpcPeeringConnectionOptionsSTSRole", "summary": "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...(description truncated)", "description": "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...(description truncated)", "input": [ { "name": "accepterPeeringConnectionOptionsAllowDnsResolutionFromRemoteVpc", "type": "string", "info": "The VPC peering connection options.\nIf true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.", "required": false, "schema": { "title": "accepterPeeringConnectionOptionsAllowDnsResolutionFromRemoteVpc", "type": "string" } }, { "name": "accepterPeeringConnectionOptionsAllowEgressFromLocalClassicLinkToRemoteVpc", "type": "string", "info": "The VPC peering connection options.\nIf true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC using ClassicLink to instances in a ...(description truncated)", "required": false, "schema": { "title": "accepterPeeringConnectionOptionsAllowEgressFromLocalClassicLinkToRemoteVpc", "type": "string" } }, { "name": "accepterPeeringConnectionOptionsAllowEgressFromLocalVpcToRemoteClassicLink", "type": "string", "info": "The VPC peering connection options.\nIf true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC using Cla...(description truncated)", "required": false, "schema": { "title": "accepterPeeringConnectionOptionsAllowEgressFromLocalVpcToRemoteClassicLink", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "requesterPeeringConnectionOptionsAllowDnsResolutionFromRemoteVpc", "type": "string", "info": "The VPC peering connection options.\nIf true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.", "required": false, "schema": { "title": "requesterPeeringConnectionOptionsAllowDnsResolutionFromRemoteVpc", "type": "string" } }, { "name": "requesterPeeringConnectionOptionsAllowEgressFromLocalClassicLinkToRemoteVpc", "type": "string", "info": "The VPC peering connection options.\nIf true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC using ClassicLink to instances in a ...(description truncated)", "required": false, "schema": { "title": "requesterPeeringConnectionOptionsAllowEgressFromLocalClassicLinkToRemoteVpc", "type": "string" } }, { "name": "requesterPeeringConnectionOptionsAllowEgressFromLocalVpcToRemoteClassicLink", "type": "string", "info": "The VPC peering connection options.\nIf true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC using Cla...(description truncated)", "required": false, "schema": { "title": "requesterPeeringConnectionOptionsAllowEgressFromLocalVpcToRemoteClassicLink", "type": "string" } }, { "name": "vpcPeeringConnectionId", "type": "string", "info": "The ID of the VPC peering connection.", "required": true, "schema": { "title": "vpcPeeringConnectionId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyVpcPeeringConnectionOptionsSTSRole" }, "task": true }, { "name": "modifyVpcTenancy", "summary": "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 Elas...(description truncated)", "description": "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 Elas...(description truncated)", "input": [ { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } }, { "name": "instanceTenancy", "type": "string", "info": "The instance tenancy attribute for the VPC.", "required": true, "schema": { "title": "instanceTenancy", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyVpcTenancy" }, "task": true }, { "name": "modifyVpcTenancySTSRole", "summary": "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 Elas...(description truncated)", "description": "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 Elas...(description truncated)", "input": [ { "name": "vpcId", "type": "string", "info": "The ID of the VPC.", "required": true, "schema": { "title": "vpcId", "type": "string" } }, { "name": "instanceTenancy", "type": "string", "info": "The instance tenancy attribute for the VPC.", "required": true, "schema": { "title": "instanceTenancy", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyVpcTenancySTSRole" }, "task": true }, { "name": "modifyVpnConnection", "summary": "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 creat...(description truncated)", "description": "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 creat...(description truncated)", "input": [ { "name": "vpnConnectionId", "type": "string", "info": "The ID of the VPN connection.", "required": true, "schema": { "title": "vpnConnectionId", "type": "string" } }, { "name": "transitGatewayId", "type": "string", "info": "The ID of the transit gateway.", "required": false, "schema": { "title": "transitGatewayId", "type": "string" } }, { "name": "vpnGatewayId", "type": "string", "info": "The ID of the virtual private gateway at the AWS side of the VPN connection.", "required": false, "schema": { "title": "vpnGatewayId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyVpnConnection" }, "task": true }, { "name": "modifyVpnConnectionSTSRole", "summary": "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 creat...(description truncated)", "description": "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 creat...(description truncated)", "input": [ { "name": "vpnConnectionId", "type": "string", "info": "The ID of the VPN connection.", "required": true, "schema": { "title": "vpnConnectionId", "type": "string" } }, { "name": "transitGatewayId", "type": "string", "info": "The ID of the transit gateway.", "required": false, "schema": { "title": "transitGatewayId", "type": "string" } }, { "name": "vpnGatewayId", "type": "string", "info": "The ID of the virtual private gateway at the AWS side of the VPN connection.", "required": false, "schema": { "title": "vpnGatewayId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyVpnConnectionSTSRole" }, "task": true }, { "name": "monitorInstances", "summary": "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 .", "description": "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 .", "input": [ { "name": "instanceId", "type": "array", "info": "The IDs of the instances.", "required": true, "schema": { "title": "instanceId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/monitorInstances" }, "task": true }, { "name": "monitorInstancesSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "instanceId", "type": "array", "info": "The IDs of the instances.", "required": true, "schema": { "title": "instanceId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/monitorInstancesSTSRole" }, "task": true }, { "name": "moveAddressToVpc", "summary": "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-Classi...(description truncated)", "description": "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-Classi...(description truncated)", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "publicIp", "type": "string", "info": "The Elastic IP address.", "required": true, "schema": { "title": "publicIp", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/moveAddressToVpc" }, "task": true }, { "name": "moveAddressToVpcSTSRole", "summary": "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-Classi...(description truncated)", "description": "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-Classi...(description truncated)", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "publicIp", "type": "string", "info": "The Elastic IP address.", "required": true, "schema": { "title": "publicIp", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/moveAddressToVpcSTSRole" }, "task": true }, { "name": "provisionByoipCidr", "summary": "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...(description truncated)", "description": "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...(description truncated)", "input": [ { "name": "cidr", "type": "string", "info": "The public IPv4 address range, in CIDR notation. The most specific prefix that you can specify is /24. The address range cannot overlap with another address range that yo...(description truncated)", "required": true, "schema": { "title": "cidr", "type": "string" } }, { "name": "cidrAuthorizationContextMessage", "type": "string", "info": "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 Pre...(description truncated)", "required": false, "schema": { "title": "cidrAuthorizationContextMessage", "type": "string" } }, { "name": "cidrAuthorizationContextSignature", "type": "string", "info": "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 Pre...(description truncated)", "required": false, "schema": { "title": "cidrAuthorizationContextSignature", "type": "string" } }, { "name": "description", "type": "string", "info": "A description for the address range and the address pool.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/provisionByoipCidr" }, "task": true }, { "name": "provisionByoipCidrSTSRole", "summary": "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...(description truncated)", "description": "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...(description truncated)", "input": [ { "name": "cidr", "type": "string", "info": "The public IPv4 address range, in CIDR notation. The most specific prefix that you can specify is /24. The address range cannot overlap with another address range that yo...(description truncated)", "required": true, "schema": { "title": "cidr", "type": "string" } }, { "name": "cidrAuthorizationContextMessage", "type": "string", "info": "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 Pre...(description truncated)", "required": false, "schema": { "title": "cidrAuthorizationContextMessage", "type": "string" } }, { "name": "cidrAuthorizationContextSignature", "type": "string", "info": "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 Pre...(description truncated)", "required": false, "schema": { "title": "cidrAuthorizationContextSignature", "type": "string" } }, { "name": "description", "type": "string", "info": "A description for the address range and the address pool.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/provisionByoipCidrSTSRole" }, "task": true }, { "name": "purchaseHostReservation", "summary": "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.", "description": "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.", "input": [ { "name": "clientToken", "type": "string", "info": "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 C...(description truncated)", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "currencyCode", "type": "string", "info": "The currency in which the totalUpfrontPrice , LimitPrice , and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD .", "required": false, "schema": { "title": "currencyCode", "type": "string" } }, { "name": "hostIdSet", "type": "array", "info": "The IDs of the Dedicated Hosts with which the reservation will be associated.", "required": true, "schema": { "title": "hostIdSet", "type": "array" } }, { "name": "limitPrice", "type": "string", "info": "The specified limit is checked against the total upfront cost of the reservation (calculated as the offering's upfront cost multiplied by the host count). If the total up...(description truncated)", "required": false, "schema": { "title": "limitPrice", "type": "string" } }, { "name": "offeringId", "type": "string", "info": "The ID of the offering.", "required": true, "schema": { "title": "offeringId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/purchaseHostReservation" }, "task": true }, { "name": "purchaseHostReservationSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "clientToken", "type": "string", "info": "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 C...(description truncated)", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "currencyCode", "type": "string", "info": "The currency in which the totalUpfrontPrice , LimitPrice , and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD .", "required": false, "schema": { "title": "currencyCode", "type": "string" } }, { "name": "hostIdSet", "type": "array", "info": "The IDs of the Dedicated Hosts with which the reservation will be associated.", "required": true, "schema": { "title": "hostIdSet", "type": "array" } }, { "name": "limitPrice", "type": "string", "info": "The specified limit is checked against the total upfront cost of the reservation (calculated as the offering's upfront cost multiplied by the host count). If the total up...(description truncated)", "required": false, "schema": { "title": "limitPrice", "type": "string" } }, { "name": "offeringId", "type": "string", "info": "The ID of the offering.", "required": true, "schema": { "title": "offeringId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/purchaseHostReservationSTSRole" }, "task": true }, { "name": "purchaseReservedInstancesOffering", "summary": "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 Elasti...(description truncated)", "description": "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 Elasti...(description truncated)", "input": [ { "name": "instanceCount", "type": "number", "info": "The number of Reserved Instances to purchase.", "required": true, "schema": { "title": "instanceCount", "type": "number" } }, { "name": "reservedInstancesOfferingId", "type": "string", "info": "The ID of the Reserved Instance offering to purchase.", "required": true, "schema": { "title": "reservedInstancesOfferingId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "limitPriceAmount", "type": "string", "info": "Describes the limit price of a Reserved Instance offering.\nUsed for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount *...(description truncated)", "required": false, "schema": { "title": "limitPriceAmount", "type": "string" } }, { "name": "limitPriceCurrencyCode", "type": "string", "info": "Describes the limit price of a Reserved Instance offering.\nThe currency in which the limitPrice amount is specified. At this time, the only supported currency is USD .", "required": false, "schema": { "title": "limitPriceCurrencyCode", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/purchaseReservedInstancesOffering" }, "task": true }, { "name": "purchaseReservedInstancesOfferingSTSRole", "summary": "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 Elasti...(description truncated)", "description": "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 Elasti...(description truncated)", "input": [ { "name": "instanceCount", "type": "number", "info": "The number of Reserved Instances to purchase.", "required": true, "schema": { "title": "instanceCount", "type": "number" } }, { "name": "reservedInstancesOfferingId", "type": "string", "info": "The ID of the Reserved Instance offering to purchase.", "required": true, "schema": { "title": "reservedInstancesOfferingId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "limitPriceAmount", "type": "string", "info": "Describes the limit price of a Reserved Instance offering.\nUsed for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount *...(description truncated)", "required": false, "schema": { "title": "limitPriceAmount", "type": "string" } }, { "name": "limitPriceCurrencyCode", "type": "string", "info": "Describes the limit price of a Reserved Instance offering.\nThe currency in which the limitPrice amount is specified. At this time, the only supported currency is USD .", "required": false, "schema": { "title": "limitPriceCurrencyCode", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/purchaseReservedInstancesOfferingSTSRole" }, "task": true }, { "name": "purchaseScheduledInstances", "summary": "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 c...(description truncated)", "description": "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 c...(description truncated)", "input": [ { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency .", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "purchaseRequest", "type": "array", "info": "The purchase requests.", "required": true, "schema": { "title": "purchaseRequest", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/purchaseScheduledInstances" }, "task": true }, { "name": "purchaseScheduledInstancesSTSRole", "summary": "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 c...(description truncated)", "description": "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 c...(description truncated)", "input": [ { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency .", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "purchaseRequest", "type": "array", "info": "The purchase requests.", "required": true, "schema": { "title": "purchaseRequest", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/purchaseScheduledInstancesSTSRole" }, "task": true }, { "name": "rebootInstances", "summary": "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 Use...(description truncated)", "description": "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 Use...(description truncated)", "input": [ { "name": "instanceId", "type": "array", "info": "The instance IDs.", "required": true, "schema": { "title": "instanceId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rebootInstances" }, "task": true }, { "name": "rebootInstancesSTSRole", "summary": "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 Use...(description truncated)", "description": "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 Use...(description truncated)", "input": [ { "name": "instanceId", "type": "array", "info": "The instance IDs.", "required": true, "schema": { "title": "instanceId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rebootInstancesSTSRole" }, "task": true }, { "name": "registerImage", "summary": "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 snapsho...(description truncated)", "description": "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 snapsho...(description truncated)", "input": [ { "name": "imageLocation", "type": "string", "info": "The full path to your AMI manifest in Amazon S3 storage.", "required": false, "schema": { "title": "imageLocation", "type": "string" } }, { "name": "architecture", "type": "string", "info": "The architecture of the AMI. Default: For Amazon EBS-backed AMIs, i386 . For instance store-backed AMIs, the architecture specified in the manifest file.", "required": false, "schema": { "title": "architecture", "type": "string" } }, { "name": "blockDeviceMapping", "type": "array", "info": "The block device mapping entries.", "required": false, "schema": { "title": "blockDeviceMapping", "type": "array" } }, { "name": "description", "type": "string", "info": "A description for your AMI.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "enaSupport", "type": "boolean", "info": "Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI. This option is supported only for HVM AMIs. Specifying...(description truncated)", "required": false, "schema": { "title": "enaSupport", "type": "boolean" } }, { "name": "kernelId", "type": "string", "info": "The ID of the kernel.", "required": false, "schema": { "title": "kernelId", "type": "string" } }, { "name": "name", "type": "string", "info": "A name for your AMI. Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quote...(description truncated)", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "billingProduct", "type": "array", "info": "The billing product codes. Your account must be authorized to specify billing product codes. Otherwise, you can use the AWS Marketplace to bill for the use of an AMI.", "required": false, "schema": { "title": "billingProduct", "type": "array" } }, { "name": "ramdiskId", "type": "string", "info": "The ID of the RAM disk.", "required": false, "schema": { "title": "ramdiskId", "type": "string" } }, { "name": "rootDeviceName", "type": "string", "info": "The device name of the root device volume (for example, /dev/sda1 ).", "required": false, "schema": { "title": "rootDeviceName", "type": "string" } }, { "name": "sriovNetSupport", "type": "string", "info": "Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI. There is no w...(description truncated)", "required": false, "schema": { "title": "sriovNetSupport", "type": "string" } }, { "name": "virtualizationType", "type": "string", "info": "The type of virtualization ( hvm | paravirtual ). Default: paravirtual", "required": false, "schema": { "title": "virtualizationType", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/registerImage" }, "task": true }, { "name": "registerImageSTSRole", "summary": "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 snapsho...(description truncated)", "description": "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 snapsho...(description truncated)", "input": [ { "name": "imageLocation", "type": "string", "info": "The full path to your AMI manifest in Amazon S3 storage.", "required": false, "schema": { "title": "imageLocation", "type": "string" } }, { "name": "architecture", "type": "string", "info": "The architecture of the AMI. Default: For Amazon EBS-backed AMIs, i386 . For instance store-backed AMIs, the architecture specified in the manifest file.", "required": false, "schema": { "title": "architecture", "type": "string" } }, { "name": "blockDeviceMapping", "type": "array", "info": "The block device mapping entries.", "required": false, "schema": { "title": "blockDeviceMapping", "type": "array" } }, { "name": "description", "type": "string", "info": "A description for your AMI.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "enaSupport", "type": "boolean", "info": "Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI. This option is supported only for HVM AMIs. Specifying...(description truncated)", "required": false, "schema": { "title": "enaSupport", "type": "boolean" } }, { "name": "kernelId", "type": "string", "info": "The ID of the kernel.", "required": false, "schema": { "title": "kernelId", "type": "string" } }, { "name": "name", "type": "string", "info": "A name for your AMI. Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quote...(description truncated)", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "billingProduct", "type": "array", "info": "The billing product codes. Your account must be authorized to specify billing product codes. Otherwise, you can use the AWS Marketplace to bill for the use of an AMI.", "required": false, "schema": { "title": "billingProduct", "type": "array" } }, { "name": "ramdiskId", "type": "string", "info": "The ID of the RAM disk.", "required": false, "schema": { "title": "ramdiskId", "type": "string" } }, { "name": "rootDeviceName", "type": "string", "info": "The device name of the root device volume (for example, /dev/sda1 ).", "required": false, "schema": { "title": "rootDeviceName", "type": "string" } }, { "name": "sriovNetSupport", "type": "string", "info": "Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI. There is no w...(description truncated)", "required": false, "schema": { "title": "sriovNetSupport", "type": "string" } }, { "name": "virtualizationType", "type": "string", "info": "The type of virtualization ( hvm | paravirtual ). Default: paravirtual", "required": false, "schema": { "title": "virtualizationType", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/registerImageSTSRole" }, "task": true }, { "name": "rejectTransitGatewayVpcAttachment", "summary": "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.", "description": "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.", "input": [ { "name": "transitGatewayAttachmentId", "type": "string", "info": "The ID of the attachment.", "required": true, "schema": { "title": "transitGatewayAttachmentId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rejectTransitGatewayVpcAttachment" }, "task": true }, { "name": "rejectTransitGatewayVpcAttachmentSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "transitGatewayAttachmentId", "type": "string", "info": "The ID of the attachment.", "required": true, "schema": { "title": "transitGatewayAttachmentId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rejectTransitGatewayVpcAttachmentSTSRole" }, "task": true }, { "name": "rejectVpcEndpointConnections", "summary": "Rejects one or more VPC endpoint connection requests to your VPC endpoint service.", "description": "Rejects one or more VPC endpoint connection requests to your VPC endpoint service.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "serviceId", "type": "string", "info": "The ID of the service.", "required": true, "schema": { "title": "serviceId", "type": "string" } }, { "name": "vpcEndpointId", "type": "array", "info": "The IDs of one or more VPC endpoints.", "required": true, "schema": { "title": "vpcEndpointId", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rejectVpcEndpointConnections" }, "task": true }, { "name": "rejectVpcEndpointConnectionsSTSRole", "summary": "Rejects one or more VPC endpoint connection requests to your VPC endpoint service.", "description": "Rejects one or more VPC endpoint connection requests to your VPC endpoint service.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "serviceId", "type": "string", "info": "The ID of the service.", "required": true, "schema": { "title": "serviceId", "type": "string" } }, { "name": "vpcEndpointId", "type": "array", "info": "The IDs of one or more VPC endpoints.", "required": true, "schema": { "title": "vpcEndpointId", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rejectVpcEndpointConnectionsSTSRole" }, "task": true }, { "name": "rejectVpcPeeringConnection", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "vpcPeeringConnectionId", "type": "string", "info": "The ID of the VPC peering connection.", "required": true, "schema": { "title": "vpcPeeringConnectionId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rejectVpcPeeringConnection" }, "task": true }, { "name": "rejectVpcPeeringConnectionSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "vpcPeeringConnectionId", "type": "string", "info": "The ID of the VPC peering connection.", "required": true, "schema": { "title": "vpcPeeringConnectionId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rejectVpcPeeringConnectionSTSRole" }, "task": true }, { "name": "releaseAddress", "summary": "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 i...(description truncated)", "description": "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 i...(description truncated)", "input": [ { "name": "allocationId", "type": "string", "info": "[EC2-VPC] The allocation ID. Required for EC2-VPC.", "required": false, "schema": { "title": "allocationId", "type": "string" } }, { "name": "publicIp", "type": "string", "info": "[EC2-Classic] The Elastic IP address. Required for EC2-Classic.", "required": false, "schema": { "title": "publicIp", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/releaseAddress" }, "task": true }, { "name": "releaseAddressSTSRole", "summary": "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 i...(description truncated)", "description": "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 i...(description truncated)", "input": [ { "name": "allocationId", "type": "string", "info": "[EC2-VPC] The allocation ID. Required for EC2-VPC.", "required": false, "schema": { "title": "allocationId", "type": "string" } }, { "name": "publicIp", "type": "string", "info": "[EC2-Classic] The Elastic IP address. Required for EC2-Classic.", "required": false, "schema": { "title": "publicIp", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/releaseAddressSTSRole" }, "task": true }, { "name": "releaseHosts", "summary": "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 error...(description truncated)", "description": "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 error...(description truncated)", "input": [ { "name": "hostId", "type": "array", "info": "The IDs of the Dedicated Hosts to release.", "required": true, "schema": { "title": "hostId", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/releaseHosts" }, "task": true }, { "name": "releaseHostsSTSRole", "summary": "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 error...(description truncated)", "description": "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 error...(description truncated)", "input": [ { "name": "hostId", "type": "array", "info": "The IDs of the Dedicated Hosts to release.", "required": true, "schema": { "title": "hostId", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/releaseHostsSTSRole" }, "task": true }, { "name": "replaceIamInstanceProfileAssociation", "summary": "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.", "description": "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.", "input": [ { "name": "iamInstanceProfileArn", "type": "string", "info": "Describes an IAM instance profile.\nThe Amazon Resource Name (ARN) of the instance profile.", "required": false, "schema": { "title": "iamInstanceProfileArn", "type": "string" } }, { "name": "iamInstanceProfileName", "type": "string", "info": "Describes an IAM instance profile.\nThe name of the instance profile.", "required": false, "schema": { "title": "iamInstanceProfileName", "type": "string" } }, { "name": "associationId", "type": "string", "info": "The ID of the existing IAM instance profile association.", "required": true, "schema": { "title": "associationId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/replaceIamInstanceProfileAssociation" }, "task": true }, { "name": "replaceIamInstanceProfileAssociationSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "iamInstanceProfileArn", "type": "string", "info": "Describes an IAM instance profile.\nThe Amazon Resource Name (ARN) of the instance profile.", "required": false, "schema": { "title": "iamInstanceProfileArn", "type": "string" } }, { "name": "iamInstanceProfileName", "type": "string", "info": "Describes an IAM instance profile.\nThe name of the instance profile.", "required": false, "schema": { "title": "iamInstanceProfileName", "type": "string" } }, { "name": "associationId", "type": "string", "info": "The ID of the existing IAM instance profile association.", "required": true, "schema": { "title": "associationId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/replaceIamInstanceProfileAssociationSTSRole" }, "task": true }, { "name": "replaceNetworkAclAssociation", "summary": "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.", "description": "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.", "input": [ { "name": "associationId", "type": "string", "info": "The ID of the current association between the original network ACL and the subnet.", "required": true, "schema": { "title": "associationId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "networkAclId", "type": "string", "info": "The ID of the new network ACL to associate with the subnet.", "required": true, "schema": { "title": "networkAclId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/replaceNetworkAclAssociation" }, "task": true }, { "name": "replaceNetworkAclAssociationSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "associationId", "type": "string", "info": "The ID of the current association between the original network ACL and the subnet.", "required": true, "schema": { "title": "associationId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "networkAclId", "type": "string", "info": "The ID of the new network ACL to associate with the subnet.", "required": true, "schema": { "title": "networkAclId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/replaceNetworkAclAssociationSTSRole" }, "task": true }, { "name": "replaceNetworkAclEntry", "summary": "Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide .", "description": "Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide .", "input": [ { "name": "cidrBlock", "type": "string", "info": "The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24 ).", "required": false, "schema": { "title": "cidrBlock", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "egress", "type": "boolean", "info": "Indicates whether to replace the egress rule. Default: If no value is specified, we replace the ingress rule.", "required": true, "schema": { "title": "egress", "type": "boolean" } }, { "name": "icmpCode", "type": "string", "info": "Describes the ICMP type and code.\nThe ICMP code. A value of -1 means all codes for the specified ICMP type.", "required": false, "schema": { "title": "icmpCode", "type": "string" } }, { "name": "icmpType", "type": "string", "info": "Describes the ICMP type and code.\nThe ICMP type. A value of -1 means all types.", "required": false, "schema": { "title": "icmpType", "type": "string" } }, { "name": "ipv6CidrBlock", "type": "string", "info": "The IPv6 network range to allow or deny, in CIDR notation (for example 2001:bd8:1234:1a00::/64 ).", "required": false, "schema": { "title": "ipv6CidrBlock", "type": "string" } }, { "name": "networkAclId", "type": "string", "info": "The ID of the ACL.", "required": true, "schema": { "title": "networkAclId", "type": "string" } }, { "name": "portRangeFrom", "type": "string", "info": "Describes a range of ports.\nThe first port in the range.", "required": false, "schema": { "title": "portRangeFrom", "type": "string" } }, { "name": "portRangeTo", "type": "string", "info": "Describes a range of ports.\nThe last port in the range.", "required": false, "schema": { "title": "portRangeTo", "type": "string" } }, { "name": "protocol", "type": "string", "info": "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 i...(description truncated)", "required": true, "schema": { "title": "protocol", "type": "string" } }, { "name": "ruleAction", "type": "string", "info": "Indicates whether to allow or deny the traffic that matches the rule.", "required": true, "schema": { "title": "ruleAction", "type": "string" } }, { "name": "ruleNumber", "type": "number", "info": "The rule number of the entry to replace.", "required": true, "schema": { "title": "ruleNumber", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/replaceNetworkAclEntry" }, "task": true }, { "name": "replaceNetworkAclEntrySTSRole", "summary": "Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide .", "description": "Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide .", "input": [ { "name": "cidrBlock", "type": "string", "info": "The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24 ).", "required": false, "schema": { "title": "cidrBlock", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "egress", "type": "boolean", "info": "Indicates whether to replace the egress rule. Default: If no value is specified, we replace the ingress rule.", "required": true, "schema": { "title": "egress", "type": "boolean" } }, { "name": "icmpCode", "type": "string", "info": "Describes the ICMP type and code.\nThe ICMP code. A value of -1 means all codes for the specified ICMP type.", "required": false, "schema": { "title": "icmpCode", "type": "string" } }, { "name": "icmpType", "type": "string", "info": "Describes the ICMP type and code.\nThe ICMP type. A value of -1 means all types.", "required": false, "schema": { "title": "icmpType", "type": "string" } }, { "name": "ipv6CidrBlock", "type": "string", "info": "The IPv6 network range to allow or deny, in CIDR notation (for example 2001:bd8:1234:1a00::/64 ).", "required": false, "schema": { "title": "ipv6CidrBlock", "type": "string" } }, { "name": "networkAclId", "type": "string", "info": "The ID of the ACL.", "required": true, "schema": { "title": "networkAclId", "type": "string" } }, { "name": "portRangeFrom", "type": "string", "info": "Describes a range of ports.\nThe first port in the range.", "required": false, "schema": { "title": "portRangeFrom", "type": "string" } }, { "name": "portRangeTo", "type": "string", "info": "Describes a range of ports.\nThe last port in the range.", "required": false, "schema": { "title": "portRangeTo", "type": "string" } }, { "name": "protocol", "type": "string", "info": "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 i...(description truncated)", "required": true, "schema": { "title": "protocol", "type": "string" } }, { "name": "ruleAction", "type": "string", "info": "Indicates whether to allow or deny the traffic that matches the rule.", "required": true, "schema": { "title": "ruleAction", "type": "string" } }, { "name": "ruleNumber", "type": "number", "info": "The rule number of the entry to replace.", "required": true, "schema": { "title": "ruleNumber", "type": "number" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/replaceNetworkAclEntrySTSRole" }, "task": true }, { "name": "replaceRoute", "summary": "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 .", "description": "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 .", "input": [ { "name": "destinationCidrBlock", "type": "string", "info": "The IPv4 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.", "required": false, "schema": { "title": "destinationCidrBlock", "type": "string" } }, { "name": "destinationIpv6CidrBlock", "type": "string", "info": "The IPv6 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.", "required": false, "schema": { "title": "destinationIpv6CidrBlock", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "egressOnlyInternetGatewayId", "type": "string", "info": "[IPv6 traffic only] The ID of an egress-only internet gateway.", "required": false, "schema": { "title": "egressOnlyInternetGatewayId", "type": "string" } }, { "name": "gatewayId", "type": "string", "info": "The ID of an internet gateway or virtual private gateway.", "required": false, "schema": { "title": "gatewayId", "type": "string" } }, { "name": "instanceId", "type": "string", "info": "The ID of a NAT instance in your VPC.", "required": false, "schema": { "title": "instanceId", "type": "string" } }, { "name": "natGatewayId", "type": "string", "info": "[IPv4 traffic only] The ID of a NAT gateway.", "required": false, "schema": { "title": "natGatewayId", "type": "string" } }, { "name": "transitGatewayId", "type": "string", "info": "The ID of a transit gateway.", "required": false, "schema": { "title": "transitGatewayId", "type": "string" } }, { "name": "networkInterfaceId", "type": "string", "info": "The ID of a network interface.", "required": false, "schema": { "title": "networkInterfaceId", "type": "string" } }, { "name": "routeTableId", "type": "string", "info": "The ID of the route table.", "required": true, "schema": { "title": "routeTableId", "type": "string" } }, { "name": "vpcPeeringConnectionId", "type": "string", "info": "The ID of a VPC peering connection.", "required": false, "schema": { "title": "vpcPeeringConnectionId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/replaceRoute" }, "task": true }, { "name": "replaceRouteSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "destinationCidrBlock", "type": "string", "info": "The IPv4 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.", "required": false, "schema": { "title": "destinationCidrBlock", "type": "string" } }, { "name": "destinationIpv6CidrBlock", "type": "string", "info": "The IPv6 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.", "required": false, "schema": { "title": "destinationIpv6CidrBlock", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "egressOnlyInternetGatewayId", "type": "string", "info": "[IPv6 traffic only] The ID of an egress-only internet gateway.", "required": false, "schema": { "title": "egressOnlyInternetGatewayId", "type": "string" } }, { "name": "gatewayId", "type": "string", "info": "The ID of an internet gateway or virtual private gateway.", "required": false, "schema": { "title": "gatewayId", "type": "string" } }, { "name": "instanceId", "type": "string", "info": "The ID of a NAT instance in your VPC.", "required": false, "schema": { "title": "instanceId", "type": "string" } }, { "name": "natGatewayId", "type": "string", "info": "[IPv4 traffic only] The ID of a NAT gateway.", "required": false, "schema": { "title": "natGatewayId", "type": "string" } }, { "name": "transitGatewayId", "type": "string", "info": "The ID of a transit gateway.", "required": false, "schema": { "title": "transitGatewayId", "type": "string" } }, { "name": "networkInterfaceId", "type": "string", "info": "The ID of a network interface.", "required": false, "schema": { "title": "networkInterfaceId", "type": "string" } }, { "name": "routeTableId", "type": "string", "info": "The ID of the route table.", "required": true, "schema": { "title": "routeTableId", "type": "string" } }, { "name": "vpcPeeringConnectionId", "type": "string", "info": "The ID of a VPC peering connection.", "required": false, "schema": { "title": "vpcPeeringConnectionId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/replaceRouteSTSRole" }, "task": true }, { "name": "replaceRouteTableAssociation", "summary": "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.", "description": "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.", "input": [ { "name": "associationId", "type": "string", "info": "The association ID.", "required": true, "schema": { "title": "associationId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "routeTableId", "type": "string", "info": "The ID of the new route table to associate with the subnet.", "required": true, "schema": { "title": "routeTableId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/replaceRouteTableAssociation" }, "task": true }, { "name": "replaceRouteTableAssociationSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "associationId", "type": "string", "info": "The association ID.", "required": true, "schema": { "title": "associationId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "routeTableId", "type": "string", "info": "The ID of the new route table to associate with the subnet.", "required": true, "schema": { "title": "routeTableId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/replaceRouteTableAssociationSTSRole" }, "task": true }, { "name": "replaceTransitGatewayRoute", "summary": "Replaces the specified route in the specified transit gateway route table.", "description": "Replaces the specified route in the specified transit gateway route table.", "input": [ { "name": "destinationCidrBlock", "type": "string", "info": "The CIDR range used for the destination match. Routing decisions are based on the most specific match.", "required": true, "schema": { "title": "destinationCidrBlock", "type": "string" } }, { "name": "transitGatewayRouteTableId", "type": "string", "info": "The ID of the route table.", "required": true, "schema": { "title": "transitGatewayRouteTableId", "type": "string" } }, { "name": "transitGatewayAttachmentId", "type": "string", "info": "The ID of the attachment.", "required": false, "schema": { "title": "transitGatewayAttachmentId", "type": "string" } }, { "name": "blackhole", "type": "boolean", "info": "Indicates whether traffic matching this route is to be dropped.", "required": false, "schema": { "title": "blackhole", "type": "boolean" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/replaceTransitGatewayRoute" }, "task": true }, { "name": "replaceTransitGatewayRouteSTSRole", "summary": "Replaces the specified route in the specified transit gateway route table.", "description": "Replaces the specified route in the specified transit gateway route table.", "input": [ { "name": "destinationCidrBlock", "type": "string", "info": "The CIDR range used for the destination match. Routing decisions are based on the most specific match.", "required": true, "schema": { "title": "destinationCidrBlock", "type": "string" } }, { "name": "transitGatewayRouteTableId", "type": "string", "info": "The ID of the route table.", "required": true, "schema": { "title": "transitGatewayRouteTableId", "type": "string" } }, { "name": "transitGatewayAttachmentId", "type": "string", "info": "The ID of the attachment.", "required": false, "schema": { "title": "transitGatewayAttachmentId", "type": "string" } }, { "name": "blackhole", "type": "boolean", "info": "Indicates whether traffic matching this route is to be dropped.", "required": false, "schema": { "title": "blackhole", "type": "boolean" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/replaceTransitGatewayRouteSTSRole" }, "task": true }, { "name": "reportInstanceStatus", "summary": "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 .", "description": "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 .", "input": [ { "name": "description", "type": "string", "info": "Descriptive text about the health state of your instance.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "endTime", "type": "string", "info": "The time at which the reported instance health state ended.", "required": false, "schema": { "title": "endTime", "type": "string" } }, { "name": "instanceId", "type": "array", "info": "The instances.", "required": true, "schema": { "title": "instanceId", "type": "array" } }, { "name": "reasonCode", "type": "array", "info": "The reason codes that describe the health state of your instance. instance-stuck-in-state : My instance is stuck in a state. unresponsive : My instance i...(description truncated)", "required": true, "schema": { "title": "reasonCode", "type": "array" } }, { "name": "startTime", "type": "string", "info": "The time at which the reported instance health state began.", "required": false, "schema": { "title": "startTime", "type": "string" } }, { "name": "status", "type": "string", "info": "The status of all instances listed.", "required": true, "schema": { "title": "status", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reportInstanceStatus" }, "task": true }, { "name": "reportInstanceStatusSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "description", "type": "string", "info": "Descriptive text about the health state of your instance.", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "endTime", "type": "string", "info": "The time at which the reported instance health state ended.", "required": false, "schema": { "title": "endTime", "type": "string" } }, { "name": "instanceId", "type": "array", "info": "The instances.", "required": true, "schema": { "title": "instanceId", "type": "array" } }, { "name": "reasonCode", "type": "array", "info": "The reason codes that describe the health state of your instance. instance-stuck-in-state : My instance is stuck in a state. unresponsive : My instance i...(description truncated)", "required": true, "schema": { "title": "reasonCode", "type": "array" } }, { "name": "startTime", "type": "string", "info": "The time at which the reported instance health state began.", "required": false, "schema": { "title": "startTime", "type": "string" } }, { "name": "status", "type": "string", "info": "The status of all instances listed.", "required": true, "schema": { "title": "status", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/reportInstanceStatusSTSRole" }, "task": true }, { "name": "requestSpotFleet", "summary": "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...(description truncated)", "description": "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...(description truncated)", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "spotFleetRequestConfigAllocationStrategy", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\nIndicates how to allocate the target capacity across the Spot pools specified by the Spot Fleet request. The default ...(description truncated)", "required": false, "schema": { "title": "spotFleetRequestConfigAllocationStrategy", "type": "string" } }, { "name": "spotFleetRequestConfigOnDemandAllocationStrategy", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\nThe order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowestPrice , Spo...(description truncated)", "required": false, "schema": { "title": "spotFleetRequestConfigOnDemandAllocationStrategy", "type": "string" } }, { "name": "spotFleetRequestConfigClientToken", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\nA unique, case-sensitive identifier that you provide to ensure the idempotency of your listings. This helps to avoid ...(description truncated)", "required": false, "schema": { "title": "spotFleetRequestConfigClientToken", "type": "string" } }, { "name": "spotFleetRequestConfigExcessCapacityTerminationPolicy", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\nIndicates whether running Spot Instances should be terminated if you decrease the target capacity of the Spot Fleet r...(description truncated)", "required": false, "schema": { "title": "spotFleetRequestConfigExcessCapacityTerminationPolicy", "type": "string" } }, { "name": "spotFleetRequestConfigFulfilledCapacity", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\nThe number of units fulfilled by this request compared to the set target capacity. You cannot set this value.", "required": false, "schema": { "title": "spotFleetRequestConfigFulfilledCapacity", "type": "string" } }, { "name": "spotFleetRequestConfigOnDemandFulfilledCapacity", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\nThe number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity.", "required": false, "schema": { "title": "spotFleetRequestConfigOnDemandFulfilledCapacity", "type": "string" } }, { "name": "spotFleetRequestConfigIamFleetRole", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\nThe Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that grants the Spot Fleet the per...(description truncated)", "required": false, "schema": { "title": "spotFleetRequestConfigIamFleetRole", "type": "string" } }, { "name": "spotFleetRequestConfigLaunchSpecifications", "type": "array", "info": "Describes the configuration of a Spot Fleet request.\nThe launch specifications for the Spot Fleet request. If you specify LaunchSpecifications , you can't specify Launc...(description truncated)", "required": false, "schema": { "title": "spotFleetRequestConfigLaunchSpecifications", "type": "array" } }, { "name": "spotFleetRequestConfigLaunchTemplateConfigs", "type": "array", "info": "Describes the configuration of a Spot Fleet request.\nThe launch template and overrides. If you specify LaunchTemplateConfigs , you can't specify LaunchSpecifications . ...(description truncated)", "required": false, "schema": { "title": "spotFleetRequestConfigLaunchTemplateConfigs", "type": "array" } }, { "name": "spotFleetRequestConfigSpotPrice", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\nThe maximum price per unit hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.", "required": false, "schema": { "title": "spotFleetRequestConfigSpotPrice", "type": "string" } }, { "name": "spotFleetRequestConfigTargetCapacity", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\nThe number of units to request for the Spot Fleet. You can choose to set the target capacity in terms of instances or...(description truncated)", "required": false, "schema": { "title": "spotFleetRequestConfigTargetCapacity", "type": "string" } }, { "name": "spotFleetRequestConfigOnDemandTargetCapacity", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\nThe number of On-Demand units to request. You can choose to set the target capacity in terms of instances or a perfor...(description truncated)", "required": false, "schema": { "title": "spotFleetRequestConfigOnDemandTargetCapacity", "type": "string" } }, { "name": "spotFleetRequestConfigTerminateInstancesWithExpiration", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\nIndicates whether running Spot Instances are terminated when the Spot Fleet request expires.", "required": false, "schema": { "title": "spotFleetRequestConfigTerminateInstancesWithExpiration", "type": "string" } }, { "name": "spotFleetRequestConfigType", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\nThe type of request. Indicates whether the Spot Fleet only requests the target capacity or also attempts to maintain ...(description truncated)", "required": false, "schema": { "title": "spotFleetRequestConfigType", "type": "string" } }, { "name": "spotFleetRequestConfigValidFrom", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\nThe start date and time of the request, in UTC format ( YYYY - MM - DD T HH : MM : SS Z). By default, Amazon EC2 star...(description truncated)", "required": false, "schema": { "title": "spotFleetRequestConfigValidFrom", "type": "string" } }, { "name": "spotFleetRequestConfigValidUntil", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\nThe end date and time of the request, in UTC format ( YYYY - MM - DD T HH : MM : SS Z). After the end date and time, ...(description truncated)", "required": false, "schema": { "title": "spotFleetRequestConfigValidUntil", "type": "string" } }, { "name": "spotFleetRequestConfigReplaceUnhealthyInstances", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\nIndicates whether Spot Fleet should replace unhealthy instances.", "required": false, "schema": { "title": "spotFleetRequestConfigReplaceUnhealthyInstances", "type": "string" } }, { "name": "spotFleetRequestConfigInstanceInterruptionBehavior", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\nThe behavior when a Spot Instance is interrupted. The default is terminate .", "required": false, "schema": { "title": "spotFleetRequestConfigInstanceInterruptionBehavior", "type": "string" } }, { "name": "spotFleetRequestConfigLoadBalancersConfig", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\n One or more Classic Load Balancers and target groups to attach to the Spot Fleet request. Spot Fleet registers the r...(description truncated)", "required": false, "schema": { "title": "spotFleetRequestConfigLoadBalancersConfig", "type": "string" } }, { "name": "spotFleetRequestConfigInstancePoolsToUseCount", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\nThe number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot AllocationStrategy...(description truncated)", "required": false, "schema": { "title": "spotFleetRequestConfigInstancePoolsToUseCount", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/requestSpotFleet" }, "task": true }, { "name": "requestSpotFleetSTSRole", "summary": "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...(description truncated)", "description": "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...(description truncated)", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "spotFleetRequestConfigAllocationStrategy", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\nIndicates how to allocate the target capacity across the Spot pools specified by the Spot Fleet request. The default ...(description truncated)", "required": false, "schema": { "title": "spotFleetRequestConfigAllocationStrategy", "type": "string" } }, { "name": "spotFleetRequestConfigOnDemandAllocationStrategy", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\nThe order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowestPrice , Spo...(description truncated)", "required": false, "schema": { "title": "spotFleetRequestConfigOnDemandAllocationStrategy", "type": "string" } }, { "name": "spotFleetRequestConfigClientToken", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\nA unique, case-sensitive identifier that you provide to ensure the idempotency of your listings. This helps to avoid ...(description truncated)", "required": false, "schema": { "title": "spotFleetRequestConfigClientToken", "type": "string" } }, { "name": "spotFleetRequestConfigExcessCapacityTerminationPolicy", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\nIndicates whether running Spot Instances should be terminated if you decrease the target capacity of the Spot Fleet r...(description truncated)", "required": false, "schema": { "title": "spotFleetRequestConfigExcessCapacityTerminationPolicy", "type": "string" } }, { "name": "spotFleetRequestConfigFulfilledCapacity", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\nThe number of units fulfilled by this request compared to the set target capacity. You cannot set this value.", "required": false, "schema": { "title": "spotFleetRequestConfigFulfilledCapacity", "type": "string" } }, { "name": "spotFleetRequestConfigOnDemandFulfilledCapacity", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\nThe number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity.", "required": false, "schema": { "title": "spotFleetRequestConfigOnDemandFulfilledCapacity", "type": "string" } }, { "name": "spotFleetRequestConfigIamFleetRole", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\nThe Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that grants the Spot Fleet the per...(description truncated)", "required": false, "schema": { "title": "spotFleetRequestConfigIamFleetRole", "type": "string" } }, { "name": "spotFleetRequestConfigLaunchSpecifications", "type": "array", "info": "Describes the configuration of a Spot Fleet request.\nThe launch specifications for the Spot Fleet request. If you specify LaunchSpecifications , you can't specify Launc...(description truncated)", "required": false, "schema": { "title": "spotFleetRequestConfigLaunchSpecifications", "type": "array" } }, { "name": "spotFleetRequestConfigLaunchTemplateConfigs", "type": "array", "info": "Describes the configuration of a Spot Fleet request.\nThe launch template and overrides. If you specify LaunchTemplateConfigs , you can't specify LaunchSpecifications . ...(description truncated)", "required": false, "schema": { "title": "spotFleetRequestConfigLaunchTemplateConfigs", "type": "array" } }, { "name": "spotFleetRequestConfigSpotPrice", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\nThe maximum price per unit hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.", "required": false, "schema": { "title": "spotFleetRequestConfigSpotPrice", "type": "string" } }, { "name": "spotFleetRequestConfigTargetCapacity", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\nThe number of units to request for the Spot Fleet. You can choose to set the target capacity in terms of instances or...(description truncated)", "required": false, "schema": { "title": "spotFleetRequestConfigTargetCapacity", "type": "string" } }, { "name": "spotFleetRequestConfigOnDemandTargetCapacity", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\nThe number of On-Demand units to request. You can choose to set the target capacity in terms of instances or a perfor...(description truncated)", "required": false, "schema": { "title": "spotFleetRequestConfigOnDemandTargetCapacity", "type": "string" } }, { "name": "spotFleetRequestConfigTerminateInstancesWithExpiration", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\nIndicates whether running Spot Instances are terminated when the Spot Fleet request expires.", "required": false, "schema": { "title": "spotFleetRequestConfigTerminateInstancesWithExpiration", "type": "string" } }, { "name": "spotFleetRequestConfigType", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\nThe type of request. Indicates whether the Spot Fleet only requests the target capacity or also attempts to maintain ...(description truncated)", "required": false, "schema": { "title": "spotFleetRequestConfigType", "type": "string" } }, { "name": "spotFleetRequestConfigValidFrom", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\nThe start date and time of the request, in UTC format ( YYYY - MM - DD T HH : MM : SS Z). By default, Amazon EC2 star...(description truncated)", "required": false, "schema": { "title": "spotFleetRequestConfigValidFrom", "type": "string" } }, { "name": "spotFleetRequestConfigValidUntil", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\nThe end date and time of the request, in UTC format ( YYYY - MM - DD T HH : MM : SS Z). After the end date and time, ...(description truncated)", "required": false, "schema": { "title": "spotFleetRequestConfigValidUntil", "type": "string" } }, { "name": "spotFleetRequestConfigReplaceUnhealthyInstances", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\nIndicates whether Spot Fleet should replace unhealthy instances.", "required": false, "schema": { "title": "spotFleetRequestConfigReplaceUnhealthyInstances", "type": "string" } }, { "name": "spotFleetRequestConfigInstanceInterruptionBehavior", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\nThe behavior when a Spot Instance is interrupted. The default is terminate .", "required": false, "schema": { "title": "spotFleetRequestConfigInstanceInterruptionBehavior", "type": "string" } }, { "name": "spotFleetRequestConfigLoadBalancersConfig", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\n One or more Classic Load Balancers and target groups to attach to the Spot Fleet request. Spot Fleet registers the r...(description truncated)", "required": false, "schema": { "title": "spotFleetRequestConfigLoadBalancersConfig", "type": "string" } }, { "name": "spotFleetRequestConfigInstancePoolsToUseCount", "type": "string", "info": "Describes the configuration of a Spot Fleet request.\nThe number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot AllocationStrategy...(description truncated)", "required": false, "schema": { "title": "spotFleetRequestConfigInstancePoolsToUseCount", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/requestSpotFleetSTSRole" }, "task": true }, { "name": "requestSpotInstances", "summary": "Creates a Spot Instance request. For more information, see Spot Instance Requests in the Amazon EC2 User Guide for Linux Instances .", "description": "Creates a Spot Instance request. For more information, see Spot Instance Requests in the Amazon EC2 User Guide for Linux Instances .", "input": [ { "name": "availabilityZoneGroup", "type": "string", "info": "The user-specified name for a logical grouping of requests. When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request a...(description truncated)", "required": false, "schema": { "title": "availabilityZoneGroup", "type": "string" } }, { "name": "blockDurationMinutes", "type": "number", "info": "The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360). The duratio...(description truncated)", "required": false, "schema": { "title": "blockDurationMinutes", "type": "number" } }, { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon EC2 User...(description truncated)", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "instanceCount", "type": "number", "info": "The maximum number of Spot Instances to launch. Default: 1", "required": false, "schema": { "title": "instanceCount", "type": "number" } }, { "name": "launchGroup", "type": "string", "info": "The instance launch group. Launch groups are Spot Instances that launch together and terminate together. Default: Instances are launched and terminated individually", "required": false, "schema": { "title": "launchGroup", "type": "string" } }, { "name": "launchSpecificationSecurityGroupIds", "type": "array", "info": "Describes the launch specification for an instance.\nOne or more security group IDs.", "required": false, "schema": { "title": "launchSpecificationSecurityGroupIds", "type": "array" } }, { "name": "launchSpecificationSecurityGroups", "type": "array", "info": "Describes the launch specification for an instance.\nOne or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When...(description truncated)", "required": false, "schema": { "title": "launchSpecificationSecurityGroups", "type": "array" } }, { "name": "launchSpecificationAddressingType", "type": "string", "info": "Describes the launch specification for an instance.\nDeprecated.", "required": false, "schema": { "title": "launchSpecificationAddressingType", "type": "string" } }, { "name": "launchSpecificationBlockDeviceMappings", "type": "array", "info": "Describes the launch specification for an instance.\nOne or more block device mapping entries. You can't specify both a snapshot ID and an encryption value. This is becaus...(description truncated)", "required": false, "schema": { "title": "launchSpecificationBlockDeviceMappings", "type": "array" } }, { "name": "launchSpecificationEbsOptimized", "type": "string", "info": "Describes the launch specification for an instance.\n Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EB...(description truncated)", "required": false, "schema": { "title": "launchSpecificationEbsOptimized", "type": "string" } }, { "name": "launchSpecificationIamInstanceProfile", "type": "string", "info": "Describes the launch specification for an instance.\nThe IAM instance profile.", "required": false, "schema": { "title": "launchSpecificationIamInstanceProfile", "type": "string" } }, { "name": "launchSpecificationImageId", "type": "string", "info": "Describes the launch specification for an instance.\nThe ID of the AMI.", "required": false, "schema": { "title": "launchSpecificationImageId", "type": "string" } }, { "name": "launchSpecificationInstanceType", "type": "string", "info": "Describes the launch specification for an instance.\nThe instance type.", "required": false, "schema": { "title": "launchSpecificationInstanceType", "type": "string" } }, { "name": "launchSpecificationKernelId", "type": "string", "info": "Describes the launch specification for an instance.\nThe ID of the kernel.", "required": false, "schema": { "title": "launchSpecificationKernelId", "type": "string" } }, { "name": "launchSpecificationKeyName", "type": "string", "info": "Describes the launch specification for an instance.\nThe name of the key pair.", "required": false, "schema": { "title": "launchSpecificationKeyName", "type": "string" } }, { "name": "launchSpecificationMonitoring", "type": "string", "info": "Describes the launch specification for an instance.\n Indicates whether basic or detailed monitoring is enabled for the instance. Default: Disabled", "required": false, "schema": { "title": "launchSpecificationMonitoring", "type": "string" } }, { "name": "launchSpecificationNetworkInterfaces", "type": "array", "info": "Describes the launch specification for an instance.\nOne or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs...(description truncated)", "required": false, "schema": { "title": "launchSpecificationNetworkInterfaces", "type": "array" } }, { "name": "launchSpecificationPlacement", "type": "string", "info": "Describes the launch specification for an instance.\nThe placement information for the instance.", "required": false, "schema": { "title": "launchSpecificationPlacement", "type": "string" } }, { "name": "launchSpecificationRamdiskId", "type": "string", "info": "Describes the launch specification for an instance.\nThe ID of the RAM disk.", "required": false, "schema": { "title": "launchSpecificationRamdiskId", "type": "string" } }, { "name": "launchSpecificationSubnetId", "type": "string", "info": "Describes the launch specification for an instance.\nThe ID of the subnet in which to launch the instance.", "required": false, "schema": { "title": "launchSpecificationSubnetId", "type": "string" } }, { "name": "launchSpecificationUserData", "type": "string", "info": "Describes the launch specification for an instance.\nThe Base64-encoded user data for the instance. User data is limited to 16 KB.", "required": false, "schema": { "title": "launchSpecificationUserData", "type": "string" } }, { "name": "spotPrice", "type": "string", "info": "The maximum price per hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.", "required": false, "schema": { "title": "spotPrice", "type": "string" } }, { "name": "type", "type": "string", "info": "The Spot Instance request type. Default: one-time", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "validFrom", "type": "string", "info": "The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request ...(description truncated)", "required": false, "schema": { "title": "validFrom", "type": "string" } }, { "name": "validUntil", "type": "string", "info": "The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If th...(description truncated)", "required": false, "schema": { "title": "validUntil", "type": "string" } }, { "name": "instanceInterruptionBehavior", "type": "string", "info": "The behavior when a Spot Instance is interrupted. The default is terminate .", "required": false, "schema": { "title": "instanceInterruptionBehavior", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/requestSpotInstances" }, "task": true }, { "name": "requestSpotInstancesSTSRole", "summary": "Creates a Spot Instance request. For more information, see Spot Instance Requests in the Amazon EC2 User Guide for Linux Instances .", "description": "Creates a Spot Instance request. For more information, see Spot Instance Requests in the Amazon EC2 User Guide for Linux Instances .", "input": [ { "name": "availabilityZoneGroup", "type": "string", "info": "The user-specified name for a logical grouping of requests. When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request a...(description truncated)", "required": false, "schema": { "title": "availabilityZoneGroup", "type": "string" } }, { "name": "blockDurationMinutes", "type": "number", "info": "The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360). The duratio...(description truncated)", "required": false, "schema": { "title": "blockDurationMinutes", "type": "number" } }, { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon EC2 User...(description truncated)", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "instanceCount", "type": "number", "info": "The maximum number of Spot Instances to launch. Default: 1", "required": false, "schema": { "title": "instanceCount", "type": "number" } }, { "name": "launchGroup", "type": "string", "info": "The instance launch group. Launch groups are Spot Instances that launch together and terminate together. Default: Instances are launched and terminated individually", "required": false, "schema": { "title": "launchGroup", "type": "string" } }, { "name": "launchSpecificationSecurityGroupIds", "type": "array", "info": "Describes the launch specification for an instance.\nOne or more security group IDs.", "required": false, "schema": { "title": "launchSpecificationSecurityGroupIds", "type": "array" } }, { "name": "launchSpecificationSecurityGroups", "type": "array", "info": "Describes the launch specification for an instance.\nOne or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When...(description truncated)", "required": false, "schema": { "title": "launchSpecificationSecurityGroups", "type": "array" } }, { "name": "launchSpecificationAddressingType", "type": "string", "info": "Describes the launch specification for an instance.\nDeprecated.", "required": false, "schema": { "title": "launchSpecificationAddressingType", "type": "string" } }, { "name": "launchSpecificationBlockDeviceMappings", "type": "array", "info": "Describes the launch specification for an instance.\nOne or more block device mapping entries. You can't specify both a snapshot ID and an encryption value. This is becaus...(description truncated)", "required": false, "schema": { "title": "launchSpecificationBlockDeviceMappings", "type": "array" } }, { "name": "launchSpecificationEbsOptimized", "type": "string", "info": "Describes the launch specification for an instance.\n Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EB...(description truncated)", "required": false, "schema": { "title": "launchSpecificationEbsOptimized", "type": "string" } }, { "name": "launchSpecificationIamInstanceProfile", "type": "string", "info": "Describes the launch specification for an instance.\nThe IAM instance profile.", "required": false, "schema": { "title": "launchSpecificationIamInstanceProfile", "type": "string" } }, { "name": "launchSpecificationImageId", "type": "string", "info": "Describes the launch specification for an instance.\nThe ID of the AMI.", "required": false, "schema": { "title": "launchSpecificationImageId", "type": "string" } }, { "name": "launchSpecificationInstanceType", "type": "string", "info": "Describes the launch specification for an instance.\nThe instance type.", "required": false, "schema": { "title": "launchSpecificationInstanceType", "type": "string" } }, { "name": "launchSpecificationKernelId", "type": "string", "info": "Describes the launch specification for an instance.\nThe ID of the kernel.", "required": false, "schema": { "title": "launchSpecificationKernelId", "type": "string" } }, { "name": "launchSpecificationKeyName", "type": "string", "info": "Describes the launch specification for an instance.\nThe name of the key pair.", "required": false, "schema": { "title": "launchSpecificationKeyName", "type": "string" } }, { "name": "launchSpecificationMonitoring", "type": "string", "info": "Describes the launch specification for an instance.\n Indicates whether basic or detailed monitoring is enabled for the instance. Default: Disabled", "required": false, "schema": { "title": "launchSpecificationMonitoring", "type": "string" } }, { "name": "launchSpecificationNetworkInterfaces", "type": "array", "info": "Describes the launch specification for an instance.\nOne or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs...(description truncated)", "required": false, "schema": { "title": "launchSpecificationNetworkInterfaces", "type": "array" } }, { "name": "launchSpecificationPlacement", "type": "string", "info": "Describes the launch specification for an instance.\nThe placement information for the instance.", "required": false, "schema": { "title": "launchSpecificationPlacement", "type": "string" } }, { "name": "launchSpecificationRamdiskId", "type": "string", "info": "Describes the launch specification for an instance.\nThe ID of the RAM disk.", "required": false, "schema": { "title": "launchSpecificationRamdiskId", "type": "string" } }, { "name": "launchSpecificationSubnetId", "type": "string", "info": "Describes the launch specification for an instance.\nThe ID of the subnet in which to launch the instance.", "required": false, "schema": { "title": "launchSpecificationSubnetId", "type": "string" } }, { "name": "launchSpecificationUserData", "type": "string", "info": "Describes the launch specification for an instance.\nThe Base64-encoded user data for the instance. User data is limited to 16 KB.", "required": false, "schema": { "title": "launchSpecificationUserData", "type": "string" } }, { "name": "spotPrice", "type": "string", "info": "The maximum price per hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.", "required": false, "schema": { "title": "spotPrice", "type": "string" } }, { "name": "type", "type": "string", "info": "The Spot Instance request type. Default: one-time", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "validFrom", "type": "string", "info": "The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request ...(description truncated)", "required": false, "schema": { "title": "validFrom", "type": "string" } }, { "name": "validUntil", "type": "string", "info": "The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If th...(description truncated)", "required": false, "schema": { "title": "validUntil", "type": "string" } }, { "name": "instanceInterruptionBehavior", "type": "string", "info": "The behavior when a Spot Instance is interrupted. The default is terminate .", "required": false, "schema": { "title": "instanceInterruptionBehavior", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/requestSpotInstancesSTSRole" }, "task": true }, { "name": "resetFpgaImageAttribute", "summary": "Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value. You can only reset the load permission attribute.", "description": "Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value. You can only reset the load permission attribute.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "fpgaImageId", "type": "string", "info": "The ID of the AFI.", "required": true, "schema": { "title": "fpgaImageId", "type": "string" } }, { "name": "attribute", "type": "string", "info": "The attribute.", "required": false, "schema": { "title": "attribute", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/resetFpgaImageAttribute" }, "task": true }, { "name": "resetFpgaImageAttributeSTSRole", "summary": "Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value. You can only reset the load permission attribute.", "description": "Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value. You can only reset the load permission attribute.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "fpgaImageId", "type": "string", "info": "The ID of the AFI.", "required": true, "schema": { "title": "fpgaImageId", "type": "string" } }, { "name": "attribute", "type": "string", "info": "The attribute.", "required": false, "schema": { "title": "attribute", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/resetFpgaImageAttributeSTSRole" }, "task": true }, { "name": "resetImageAttribute", "summary": "Resets an attribute of an AMI to its default value. The productCodes attribute can't be reset.", "description": "Resets an attribute of an AMI to its default value. The productCodes attribute can't be reset.", "input": [ { "name": "attribute", "type": "string", "info": "The attribute to reset (currently you can only reset the launch permission attribute).", "required": true, "schema": { "title": "attribute", "type": "string" } }, { "name": "imageId", "type": "string", "info": "The ID of the AMI.", "required": true, "schema": { "title": "imageId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/resetImageAttribute" }, "task": true }, { "name": "resetImageAttributeSTSRole", "summary": "Resets an attribute of an AMI to its default value. The productCodes attribute can't be reset.", "description": "Resets an attribute of an AMI to its default value. The productCodes attribute can't be reset.", "input": [ { "name": "attribute", "type": "string", "info": "The attribute to reset (currently you can only reset the launch permission attribute).", "required": true, "schema": { "title": "attribute", "type": "string" } }, { "name": "imageId", "type": "string", "info": "The ID of the AMI.", "required": true, "schema": { "title": "imageId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/resetImageAttributeSTSRole" }, "task": true }, { "name": "resetInstanceAttribute", "summary": "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 Privat...(description truncated)", "description": "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 Privat...(description truncated)", "input": [ { "name": "attribute", "type": "string", "info": "The attribute to reset. You can only reset the following attributes: kernel | ramdisk | sourceDestCheck . To change an instance attribute, use ModifyInstanceAt...(description truncated)", "required": true, "schema": { "title": "attribute", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "instanceId", "type": "string", "info": "The ID of the instance.", "required": true, "schema": { "title": "instanceId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/resetInstanceAttribute" }, "task": true }, { "name": "resetInstanceAttributeSTSRole", "summary": "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 Privat...(description truncated)", "description": "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 Privat...(description truncated)", "input": [ { "name": "attribute", "type": "string", "info": "The attribute to reset. You can only reset the following attributes: kernel | ramdisk | sourceDestCheck . To change an instance attribute, use ModifyInstanceAt...(description truncated)", "required": true, "schema": { "title": "attribute", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "instanceId", "type": "string", "info": "The ID of the instance.", "required": true, "schema": { "title": "instanceId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/resetInstanceAttributeSTSRole" }, "task": true }, { "name": "resetNetworkInterfaceAttribute", "summary": "Resets a network interface attribute. You can specify only one attribute at a time.", "description": "Resets a network interface attribute. You can specify only one attribute at a time.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "networkInterfaceId", "type": "string", "info": "The ID of the network interface.", "required": true, "schema": { "title": "networkInterfaceId", "type": "string" } }, { "name": "sourceDestCheck", "type": "string", "info": "The source/destination checking attribute. Resets the value to true .", "required": false, "schema": { "title": "sourceDestCheck", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/resetNetworkInterfaceAttribute" }, "task": true }, { "name": "resetNetworkInterfaceAttributeSTSRole", "summary": "Resets a network interface attribute. You can specify only one attribute at a time.", "description": "Resets a network interface attribute. You can specify only one attribute at a time.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "networkInterfaceId", "type": "string", "info": "The ID of the network interface.", "required": true, "schema": { "title": "networkInterfaceId", "type": "string" } }, { "name": "sourceDestCheck", "type": "string", "info": "The source/destination checking attribute. Resets the value to true .", "required": false, "schema": { "title": "sourceDestCheck", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/resetNetworkInterfaceAttributeSTSRole" }, "task": true }, { "name": "resetSnapshotAttribute", "summary": "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 .", "description": "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 .", "input": [ { "name": "attribute", "type": "string", "info": "The attribute to reset. Currently, only the attribute for permission to create volumes can be reset.", "required": true, "schema": { "title": "attribute", "type": "string" } }, { "name": "snapshotId", "type": "string", "info": "The ID of the snapshot.", "required": true, "schema": { "title": "snapshotId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/resetSnapshotAttribute" }, "task": true }, { "name": "resetSnapshotAttributeSTSRole", "summary": "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 .", "description": "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 .", "input": [ { "name": "attribute", "type": "string", "info": "The attribute to reset. Currently, only the attribute for permission to create volumes can be reset.", "required": true, "schema": { "title": "attribute", "type": "string" } }, { "name": "snapshotId", "type": "string", "info": "The ID of the snapshot.", "required": true, "schema": { "title": "snapshotId", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/resetSnapshotAttributeSTSRole" }, "task": true }, { "name": "restoreAddressToClassic", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "publicIp", "type": "string", "info": "The Elastic IP address.", "required": true, "schema": { "title": "publicIp", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/restoreAddressToClassic" }, "task": true }, { "name": "restoreAddressToClassicSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "publicIp", "type": "string", "info": "The Elastic IP address.", "required": true, "schema": { "title": "publicIp", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/restoreAddressToClassicSTSRole" }, "task": true }, { "name": "revokeClientVpnIngress", "summary": "Removes an ingress authorization rule from a Client VPN endpoint.", "description": "Removes an ingress authorization rule from a Client VPN endpoint.", "input": [ { "name": "clientVpnEndpointId", "type": "string", "info": "The ID of the Client VPN endpoint with which the authorization rule is associated.", "required": true, "schema": { "title": "clientVpnEndpointId", "type": "string" } }, { "name": "targetNetworkCidr", "type": "string", "info": "The IPv4 address range, in CIDR notation, of the network for which access is being removed.", "required": true, "schema": { "title": "targetNetworkCidr", "type": "string" } }, { "name": "accessGroupId", "type": "string", "info": "The ID of the Active Directory group for which to revoke access.", "required": false, "schema": { "title": "accessGroupId", "type": "string" } }, { "name": "revokeAllGroups", "type": "boolean", "info": "Indicates whether access should be revoked for all clients.", "required": false, "schema": { "title": "revokeAllGroups", "type": "boolean" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/revokeClientVpnIngress" }, "task": true }, { "name": "revokeClientVpnIngressSTSRole", "summary": "Removes an ingress authorization rule from a Client VPN endpoint.", "description": "Removes an ingress authorization rule from a Client VPN endpoint.", "input": [ { "name": "clientVpnEndpointId", "type": "string", "info": "The ID of the Client VPN endpoint with which the authorization rule is associated.", "required": true, "schema": { "title": "clientVpnEndpointId", "type": "string" } }, { "name": "targetNetworkCidr", "type": "string", "info": "The IPv4 address range, in CIDR notation, of the network for which access is being removed.", "required": true, "schema": { "title": "targetNetworkCidr", "type": "string" } }, { "name": "accessGroupId", "type": "string", "info": "The ID of the Active Directory group for which to revoke access.", "required": false, "schema": { "title": "accessGroupId", "type": "string" } }, { "name": "revokeAllGroups", "type": "boolean", "info": "Indicates whether access should be revoked for all clients.", "required": false, "schema": { "title": "revokeAllGroups", "type": "boolean" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/revokeClientVpnIngressSTSRole" }, "task": true }, { "name": "revokeSecurityGroupEgress", "summary": "[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 th...(description truncated)", "description": "[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 th...(description truncated)", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "groupId", "type": "string", "info": "The ID of the security group.", "required": true, "schema": { "title": "groupId", "type": "string" } }, { "name": "ipPermissions", "type": "array", "info": "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.", "required": false, "schema": { "title": "ipPermissions", "type": "array" } }, { "name": "cidrIp", "type": "string", "info": "Not supported. Use a set of IP permissions to specify the CIDR.", "required": false, "schema": { "title": "cidrIp", "type": "string" } }, { "name": "fromPort", "type": "number", "info": "Not supported. Use a set of IP permissions to specify the port.", "required": false, "schema": { "title": "fromPort", "type": "number" } }, { "name": "ipProtocol", "type": "string", "info": "Not supported. Use a set of IP permissions to specify the protocol name or number.", "required": false, "schema": { "title": "ipProtocol", "type": "string" } }, { "name": "toPort", "type": "number", "info": "Not supported. Use a set of IP permissions to specify the port.", "required": false, "schema": { "title": "toPort", "type": "number" } }, { "name": "sourceSecurityGroupName", "type": "string", "info": "Not supported. Use a set of IP permissions to specify a destination security group.", "required": false, "schema": { "title": "sourceSecurityGroupName", "type": "string" } }, { "name": "sourceSecurityGroupOwnerId", "type": "string", "info": "Not supported. Use a set of IP permissions to specify a destination security group.", "required": false, "schema": { "title": "sourceSecurityGroupOwnerId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/revokeSecurityGroupEgress" }, "task": true }, { "name": "revokeSecurityGroupEgressSTSRole", "summary": "[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 th...(description truncated)", "description": "[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 th...(description truncated)", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "groupId", "type": "string", "info": "The ID of the security group.", "required": true, "schema": { "title": "groupId", "type": "string" } }, { "name": "ipPermissions", "type": "array", "info": "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.", "required": false, "schema": { "title": "ipPermissions", "type": "array" } }, { "name": "cidrIp", "type": "string", "info": "Not supported. Use a set of IP permissions to specify the CIDR.", "required": false, "schema": { "title": "cidrIp", "type": "string" } }, { "name": "fromPort", "type": "number", "info": "Not supported. Use a set of IP permissions to specify the port.", "required": false, "schema": { "title": "fromPort", "type": "number" } }, { "name": "ipProtocol", "type": "string", "info": "Not supported. Use a set of IP permissions to specify the protocol name or number.", "required": false, "schema": { "title": "ipProtocol", "type": "string" } }, { "name": "toPort", "type": "number", "info": "Not supported. Use a set of IP permissions to specify the port.", "required": false, "schema": { "title": "toPort", "type": "number" } }, { "name": "sourceSecurityGroupName", "type": "string", "info": "Not supported. Use a set of IP permissions to specify a destination security group.", "required": false, "schema": { "title": "sourceSecurityGroupName", "type": "string" } }, { "name": "sourceSecurityGroupOwnerId", "type": "string", "info": "Not supported. Use a set of IP permissions to specify a destination security group.", "required": false, "schema": { "title": "sourceSecurityGroupOwnerId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/revokeSecurityGroupEgressSTSRole" }, "task": true }, { "name": "revokeSecurityGroupIngress", "summary": "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 de...(description truncated)", "description": "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 de...(description truncated)", "input": [ { "name": "cidrIp", "type": "string", "info": "The CIDR IP address range. You can't specify this parameter when specifying a source security group.", "required": false, "schema": { "title": "cidrIp", "type": "string" } }, { "name": "fromPort", "type": "number", "info": "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 ICMP types.", "required": false, "schema": { "title": "fromPort", "type": "number" } }, { "name": "groupId", "type": "string", "info": "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 s...(description truncated)", "required": false, "schema": { "title": "groupId", "type": "string" } }, { "name": "groupName", "type": "string", "info": "[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.", "required": false, "schema": { "title": "groupName", "type": "string" } }, { "name": "ipPermissions", "type": "array", "info": "The sets of IP permissions. You can't specify a source security group and a CIDR IP address range in the same set of permissions.", "required": false, "schema": { "title": "ipPermissions", "type": "array" } }, { "name": "ipProtocol", "type": "string", "info": "The IP protocol name ( tcp , udp , icmp ) or number (see Protocol Numbers ). Use -1 to specify all.", "required": false, "schema": { "title": "ipProtocol", "type": "string" } }, { "name": "sourceSecurityGroupName", "type": "string", "info": "[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...(description truncated)", "required": false, "schema": { "title": "sourceSecurityGroupName", "type": "string" } }, { "name": "sourceSecurityGroupOwnerId", "type": "string", "info": "[EC2-Classic] The AWS account ID of the source security group, if the source security group is in a different account. You can't specify this parameter in combination wit...(description truncated)", "required": false, "schema": { "title": "sourceSecurityGroupOwnerId", "type": "string" } }, { "name": "toPort", "type": "number", "info": "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 ICMP codes for the ICMP type.", "required": false, "schema": { "title": "toPort", "type": "number" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/revokeSecurityGroupIngress" }, "task": true }, { "name": "revokeSecurityGroupIngressSTSRole", "summary": "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 de...(description truncated)", "description": "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 de...(description truncated)", "input": [ { "name": "cidrIp", "type": "string", "info": "The CIDR IP address range. You can't specify this parameter when specifying a source security group.", "required": false, "schema": { "title": "cidrIp", "type": "string" } }, { "name": "fromPort", "type": "number", "info": "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 ICMP types.", "required": false, "schema": { "title": "fromPort", "type": "number" } }, { "name": "groupId", "type": "string", "info": "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 s...(description truncated)", "required": false, "schema": { "title": "groupId", "type": "string" } }, { "name": "groupName", "type": "string", "info": "[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.", "required": false, "schema": { "title": "groupName", "type": "string" } }, { "name": "ipPermissions", "type": "array", "info": "The sets of IP permissions. You can't specify a source security group and a CIDR IP address range in the same set of permissions.", "required": false, "schema": { "title": "ipPermissions", "type": "array" } }, { "name": "ipProtocol", "type": "string", "info": "The IP protocol name ( tcp , udp , icmp ) or number (see Protocol Numbers ). Use -1 to specify all.", "required": false, "schema": { "title": "ipProtocol", "type": "string" } }, { "name": "sourceSecurityGroupName", "type": "string", "info": "[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...(description truncated)", "required": false, "schema": { "title": "sourceSecurityGroupName", "type": "string" } }, { "name": "sourceSecurityGroupOwnerId", "type": "string", "info": "[EC2-Classic] The AWS account ID of the source security group, if the source security group is in a different account. You can't specify this parameter in combination wit...(description truncated)", "required": false, "schema": { "title": "sourceSecurityGroupOwnerId", "type": "string" } }, { "name": "toPort", "type": "number", "info": "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 ICMP codes for the ICMP type.", "required": false, "schema": { "title": "toPort", "type": "number" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/revokeSecurityGroupIngressSTSRole" }, "task": true }, { "name": "revokeSecurityGroupIngressWithOptionsSTSRole", "summary": "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 de...(description truncated)", "description": "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 de...(description truncated)", "input": [ { "name": "cidrIp", "type": "string", "info": "The CIDR IP address range. You can't specify this parameter when specifying a source security group.", "required": false, "schema": { "title": "cidrIp", "type": "string" } }, { "name": "fromPort", "type": "number", "info": "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 ICMP types.", "required": false, "schema": { "title": "fromPort", "type": "number" } }, { "name": "groupId", "type": "string", "info": "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 s...(description truncated)", "required": false, "schema": { "title": "groupId", "type": "string" } }, { "name": "groupName", "type": "string", "info": "[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.", "required": false, "schema": { "title": "groupName", "type": "string" } }, { "name": "ipPermissions", "type": "array", "info": "The sets of IP permissions. You can't specify a source security group and a CIDR IP address range in the same set of permissions.", "required": false, "schema": { "title": "ipPermissions", "type": "array" } }, { "name": "ipProtocol", "type": "string", "info": "The IP protocol name ( tcp , udp , icmp ) or number (see Protocol Numbers ). Use -1 to specify all.", "required": false, "schema": { "title": "ipProtocol", "type": "string" } }, { "name": "sourceSecurityGroupName", "type": "string", "info": "[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...(description truncated)", "required": false, "schema": { "title": "sourceSecurityGroupName", "type": "string" } }, { "name": "sourceSecurityGroupOwnerId", "type": "string", "info": "[EC2-Classic] The AWS account ID of the source security group, if the source security group is in a different account. You can't specify this parameter in combination wit...(description truncated)", "required": false, "schema": { "title": "sourceSecurityGroupOwnerId", "type": "string" } }, { "name": "toPort", "type": "number", "info": "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 ICMP codes for the ICMP type.", "required": false, "schema": { "title": "toPort", "type": "number" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "iapMetadata", "type": "object", "info": "Itential Platform Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.", "required": false, "schema": { "title": "iapMetadata", "type": "object" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/revokeSecurityGroupIngressWithOptionsSTSRole" }, "task": true }, { "name": "runInstances", "summary": "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 int...(description truncated)", "description": "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 int...(description truncated)", "input": [ { "name": "blockDeviceMapping", "type": "array", "info": "The block device mapping entries. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snap...(description truncated)", "required": false, "schema": { "title": "blockDeviceMapping", "type": "array" } }, { "name": "imageId", "type": "string", "info": "The ID of the AMI. An AMI is required to launch an instance and must be specified here or in a launch template.", "required": false, "schema": { "title": "imageId", "type": "string" } }, { "name": "instanceType", "type": "string", "info": "The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide . Default: m1.small", "required": false, "schema": { "title": "instanceType", "type": "string" } }, { "name": "ipv6AddressCount", "type": "number", "info": "[EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot s...(description truncated)", "required": false, "schema": { "title": "ipv6AddressCount", "type": "number" } }, { "name": "ipv6Address", "type": "array", "info": "[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a numb...(description truncated)", "required": false, "schema": { "title": "ipv6Address", "type": "array" } }, { "name": "kernelId", "type": "string", "info": "The ID of the kernel. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud U...(description truncated)", "required": false, "schema": { "title": "kernelId", "type": "string" } }, { "name": "keyName", "type": "string", "info": "The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair . If you do not specify a key pair, you can't connect to the instance unl...(description truncated)", "required": false, "schema": { "title": "keyName", "type": "string" } }, { "name": "maxCount", "type": "number", "info": "The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest poss...(description truncated)", "required": true, "schema": { "title": "maxCount", "type": "number" } }, { "name": "minCount", "type": "number", "info": "The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launche...(description truncated)", "required": true, "schema": { "title": "minCount", "type": "number" } }, { "name": "monitoringEnabled", "type": "string", "info": "Describes the monitoring of an instance.\nIndicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.", "required": false, "schema": { "title": "monitoringEnabled", "type": "string" } }, { "name": "placementAvailabilityZone", "type": "string", "info": "Describes the placement of an instance.\n The Availability Zone of the instance. If not specified, an Availability Zone will be automatically chosen for you based on the...(description truncated)", "required": false, "schema": { "title": "placementAvailabilityZone", "type": "string" } }, { "name": "placementAffinity", "type": "string", "info": "Describes the placement of an instance.\nThe affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.", "required": false, "schema": { "title": "placementAffinity", "type": "string" } }, { "name": "placementGroupName", "type": "string", "info": "Describes the placement of an instance.\nThe name of the placement group the instance is in.", "required": false, "schema": { "title": "placementGroupName", "type": "string" } }, { "name": "placementPartitionNumber", "type": "string", "info": "Describes the placement of an instance.\nThe number of the partition the instance is in. Valid only if the placement group strategy is set to partition .", "required": false, "schema": { "title": "placementPartitionNumber", "type": "string" } }, { "name": "placementHostId", "type": "string", "info": "Describes the placement of an instance.\nThe ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.", "required": false, "schema": { "title": "placementHostId", "type": "string" } }, { "name": "placementTenancy", "type": "string", "info": "Describes the placement of an instance.\nThe tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant...(description truncated)", "required": false, "schema": { "title": "placementTenancy", "type": "string" } }, { "name": "placementSpreadDomain", "type": "string", "info": "Describes the placement of an instance.\nReserved for future use.", "required": false, "schema": { "title": "placementSpreadDomain", "type": "string" } }, { "name": "ramdiskId", "type": "string", "info": "The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RA...(description truncated)", "required": false, "schema": { "title": "ramdiskId", "type": "string" } }, { "name": "securityGroupId", "type": "array", "info": "The IDs of the security groups. You can create a security group using CreateSecurityGroup . If you specify a network interface, you must specify any security groups a...(description truncated)", "required": false, "schema": { "title": "securityGroupId", "type": "array" } }, { "name": "securityGroup", "type": "array", "info": "[EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead. If you specify a network interface, you mus...(description truncated)", "required": false, "schema": { "title": "securityGroup", "type": "array" } }, { "name": "subnetId", "type": "string", "info": "[EC2-VPC] The ID of the subnet to launch the instance into. You cannot specify this option and the network interfaces option in the same request.", "required": false, "schema": { "title": "subnetId", "type": "string" } }, { "name": "userData", "type": "string", "info": "The user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding User Data (Windows). I...(description truncated)", "required": false, "schema": { "title": "userData", "type": "string" } }, { "name": "additionalInfo", "type": "string", "info": "Reserved.", "required": false, "schema": { "title": "additionalInfo", "type": "string" } }, { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency . Constraints: Maximum 64 ASCII...(description truncated)", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "disableApiTermination", "type": "boolean", "info": "If you set this parameter to true , you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute to false ...(description truncated)", "required": false, "schema": { "title": "disableApiTermination", "type": "boolean" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "ebsOptimized", "type": "boolean", "info": "Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to pro...(description truncated)", "required": false, "schema": { "title": "ebsOptimized", "type": "boolean" } }, { "name": "iamInstanceProfileArn", "type": "string", "info": "Describes an IAM instance profile.\nThe Amazon Resource Name (ARN) of the instance profile.", "required": false, "schema": { "title": "iamInstanceProfileArn", "type": "string" } }, { "name": "iamInstanceProfileName", "type": "string", "info": "Describes an IAM instance profile.\nThe name of the instance profile.", "required": false, "schema": { "title": "iamInstanceProfileName", "type": "string" } }, { "name": "instanceInitiatedShutdownBehavior", "type": "string", "info": "Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). Default: stop...(description truncated)", "required": false, "schema": { "title": "instanceInitiatedShutdownBehavior", "type": "string" } }, { "name": "networkInterface", "type": "array", "info": "The network interfaces to associate with the instance. If you specify a network interface, you must specify any security groups as part of the network interface.", "required": false, "schema": { "title": "networkInterface", "type": "array" } }, { "name": "privateIpAddress", "type": "string", "info": "[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet. Only one private IP address can be designated as primary. You c...(description truncated)", "required": false, "schema": { "title": "privateIpAddress", "type": "string" } }, { "name": "elasticGpuSpecification", "type": "array", "info": "An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of you...(description truncated)", "required": false, "schema": { "title": "elasticGpuSpecification", "type": "array" } }, { "name": "elasticInferenceAccelerator", "type": "array", "info": "An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate y...(description truncated)", "required": false, "schema": { "title": "elasticInferenceAccelerator", "type": "array" } }, { "name": "tagSpecification", "type": "array", "info": "The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are cr...(description truncated)", "required": false, "schema": { "title": "tagSpecification", "type": "array" } }, { "name": "launchTemplateLaunchTemplateId", "type": "string", "info": "The launch template to use. You must specify either the launch template ID or launch template name in the request, but not both.\nThe ID of the launch template.", "required": false, "schema": { "title": "launchTemplateLaunchTemplateId", "type": "string" } }, { "name": "launchTemplateLaunchTemplateName", "type": "string", "info": "The launch template to use. You must specify either the launch template ID or launch template name in the request, but not both.\nThe name of the launch template.", "required": false, "schema": { "title": "launchTemplateLaunchTemplateName", "type": "string" } }, { "name": "launchTemplateVersion", "type": "string", "info": "The launch template to use. You must specify either the launch template ID or launch template name in the request, but not both.\n The version number of the launch templat...(description truncated)", "required": false, "schema": { "title": "launchTemplateVersion", "type": "string" } }, { "name": "instanceMarketOptionsMarketType", "type": "string", "info": "Describes the market (purchasing) option for the instances.\nThe market type.", "required": false, "schema": { "title": "instanceMarketOptionsMarketType", "type": "string" } }, { "name": "instanceMarketOptionsSpotOptions", "type": "string", "info": "Describes the market (purchasing) option for the instances.\nThe options for Spot Instances.", "required": false, "schema": { "title": "instanceMarketOptionsSpotOptions", "type": "string" } }, { "name": "creditSpecificationCpuCredits", "type": "string", "info": "The credit option for CPU usage of a T2 or T3 instance.\nThe credit option for CPU usage of a T2 or T3 instance. Valid values are standard and unlimited .", "required": false, "schema": { "title": "creditSpecificationCpuCredits", "type": "string" } }, { "name": "cpuOptionsCoreCount", "type": "string", "info": "The CPU options for the instance. Both the core count and threads per core must be specified in the request.\nThe number of CPU cores for the instance.", "required": false, "schema": { "title": "cpuOptionsCoreCount", "type": "string" } }, { "name": "cpuOptionsThreadsPerCore", "type": "string", "info": "The CPU options for the instance. Both the core count and threads per core must be specified in the request.\nThe number of threads per CPU core. To disable Intel Hyper-Th...(description truncated)", "required": false, "schema": { "title": "cpuOptionsThreadsPerCore", "type": "string" } }, { "name": "capacityReservationSpecificationCapacityReservationPreference", "type": "string", "info": "Describes an instance's Capacity Reservation targeting option. You can specify only one parameter at a time. If you specify CapacityReservationPreference and Capacity...(description truncated)", "required": false, "schema": { "title": "capacityReservationSpecificationCapacityReservationPreference", "type": "string" } }, { "name": "capacityReservationSpecificationCapacityReservationTarget", "type": "string", "info": "Describes an instance's Capacity Reservation targeting option. You can specify only one parameter at a time. If you specify CapacityReservationPreference and Capacity...(description truncated)", "required": false, "schema": { "title": "capacityReservationSpecificationCapacityReservationTarget", "type": "string" } }, { "name": "hibernationOptionsConfigured", "type": "string", "info": "Indicates whether your instance is configured for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites . Hibernation is currentl...(description truncated)", "required": false, "schema": { "title": "hibernationOptionsConfigured", "type": "string" } }, { "name": "licenseSpecification", "type": "array", "info": "The license configurations.", "required": false, "schema": { "title": "licenseSpecification", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/runInstances" }, "task": true }, { "name": "runInstancesSTSRole", "summary": "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 int...(description truncated)", "description": "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 int...(description truncated)", "input": [ { "name": "blockDeviceMapping", "type": "array", "info": "The block device mapping entries. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snap...(description truncated)", "required": false, "schema": { "title": "blockDeviceMapping", "type": "array" } }, { "name": "imageId", "type": "string", "info": "The ID of the AMI. An AMI is required to launch an instance and must be specified here or in a launch template.", "required": false, "schema": { "title": "imageId", "type": "string" } }, { "name": "instanceType", "type": "string", "info": "The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide . Default: m1.small", "required": false, "schema": { "title": "instanceType", "type": "string" } }, { "name": "ipv6AddressCount", "type": "number", "info": "[EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot s...(description truncated)", "required": false, "schema": { "title": "ipv6AddressCount", "type": "number" } }, { "name": "ipv6Address", "type": "array", "info": "[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a numb...(description truncated)", "required": false, "schema": { "title": "ipv6Address", "type": "array" } }, { "name": "kernelId", "type": "string", "info": "The ID of the kernel. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud U...(description truncated)", "required": false, "schema": { "title": "kernelId", "type": "string" } }, { "name": "keyName", "type": "string", "info": "The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair . If you do not specify a key pair, you can't connect to the instance unl...(description truncated)", "required": false, "schema": { "title": "keyName", "type": "string" } }, { "name": "maxCount", "type": "number", "info": "The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest poss...(description truncated)", "required": true, "schema": { "title": "maxCount", "type": "number" } }, { "name": "minCount", "type": "number", "info": "The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launche...(description truncated)", "required": true, "schema": { "title": "minCount", "type": "number" } }, { "name": "monitoringEnabled", "type": "string", "info": "Describes the monitoring of an instance.\nIndicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.", "required": false, "schema": { "title": "monitoringEnabled", "type": "string" } }, { "name": "placementAvailabilityZone", "type": "string", "info": "Describes the placement of an instance.\n The Availability Zone of the instance. If not specified, an Availability Zone will be automatically chosen for you based on the...(description truncated)", "required": false, "schema": { "title": "placementAvailabilityZone", "type": "string" } }, { "name": "placementAffinity", "type": "string", "info": "Describes the placement of an instance.\nThe affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.", "required": false, "schema": { "title": "placementAffinity", "type": "string" } }, { "name": "placementGroupName", "type": "string", "info": "Describes the placement of an instance.\nThe name of the placement group the instance is in.", "required": false, "schema": { "title": "placementGroupName", "type": "string" } }, { "name": "placementPartitionNumber", "type": "string", "info": "Describes the placement of an instance.\nThe number of the partition the instance is in. Valid only if the placement group strategy is set to partition .", "required": false, "schema": { "title": "placementPartitionNumber", "type": "string" } }, { "name": "placementHostId", "type": "string", "info": "Describes the placement of an instance.\nThe ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.", "required": false, "schema": { "title": "placementHostId", "type": "string" } }, { "name": "placementTenancy", "type": "string", "info": "Describes the placement of an instance.\nThe tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant...(description truncated)", "required": false, "schema": { "title": "placementTenancy", "type": "string" } }, { "name": "placementSpreadDomain", "type": "string", "info": "Describes the placement of an instance.\nReserved for future use.", "required": false, "schema": { "title": "placementSpreadDomain", "type": "string" } }, { "name": "ramdiskId", "type": "string", "info": "The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RA...(description truncated)", "required": false, "schema": { "title": "ramdiskId", "type": "string" } }, { "name": "securityGroupId", "type": "array", "info": "The IDs of the security groups. You can create a security group using CreateSecurityGroup . If you specify a network interface, you must specify any security groups a...(description truncated)", "required": false, "schema": { "title": "securityGroupId", "type": "array" } }, { "name": "securityGroup", "type": "array", "info": "[EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead. If you specify a network interface, you mus...(description truncated)", "required": false, "schema": { "title": "securityGroup", "type": "array" } }, { "name": "subnetId", "type": "string", "info": "[EC2-VPC] The ID of the subnet to launch the instance into. You cannot specify this option and the network interfaces option in the same request.", "required": false, "schema": { "title": "subnetId", "type": "string" } }, { "name": "userData", "type": "string", "info": "The user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding User Data (Windows). I...(description truncated)", "required": false, "schema": { "title": "userData", "type": "string" } }, { "name": "additionalInfo", "type": "string", "info": "Reserved.", "required": false, "schema": { "title": "additionalInfo", "type": "string" } }, { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency . Constraints: Maximum 64 ASCII...(description truncated)", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "disableApiTermination", "type": "boolean", "info": "If you set this parameter to true , you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute to false ...(description truncated)", "required": false, "schema": { "title": "disableApiTermination", "type": "boolean" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "ebsOptimized", "type": "boolean", "info": "Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to pro...(description truncated)", "required": false, "schema": { "title": "ebsOptimized", "type": "boolean" } }, { "name": "iamInstanceProfileArn", "type": "string", "info": "Describes an IAM instance profile.\nThe Amazon Resource Name (ARN) of the instance profile.", "required": false, "schema": { "title": "iamInstanceProfileArn", "type": "string" } }, { "name": "iamInstanceProfileName", "type": "string", "info": "Describes an IAM instance profile.\nThe name of the instance profile.", "required": false, "schema": { "title": "iamInstanceProfileName", "type": "string" } }, { "name": "instanceInitiatedShutdownBehavior", "type": "string", "info": "Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). Default: stop...(description truncated)", "required": false, "schema": { "title": "instanceInitiatedShutdownBehavior", "type": "string" } }, { "name": "networkInterface", "type": "array", "info": "The network interfaces to associate with the instance. If you specify a network interface, you must specify any security groups as part of the network interface.", "required": false, "schema": { "title": "networkInterface", "type": "array" } }, { "name": "privateIpAddress", "type": "string", "info": "[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet. Only one private IP address can be designated as primary. You c...(description truncated)", "required": false, "schema": { "title": "privateIpAddress", "type": "string" } }, { "name": "elasticGpuSpecification", "type": "array", "info": "An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of you...(description truncated)", "required": false, "schema": { "title": "elasticGpuSpecification", "type": "array" } }, { "name": "elasticInferenceAccelerator", "type": "array", "info": "An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate y...(description truncated)", "required": false, "schema": { "title": "elasticInferenceAccelerator", "type": "array" } }, { "name": "tagSpecification", "type": "array", "info": "The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are cr...(description truncated)", "required": false, "schema": { "title": "tagSpecification", "type": "array" } }, { "name": "launchTemplateLaunchTemplateId", "type": "string", "info": "The launch template to use. You must specify either the launch template ID or launch template name in the request, but not both.\nThe ID of the launch template.", "required": false, "schema": { "title": "launchTemplateLaunchTemplateId", "type": "string" } }, { "name": "launchTemplateLaunchTemplateName", "type": "string", "info": "The launch template to use. You must specify either the launch template ID or launch template name in the request, but not both.\nThe name of the launch template.", "required": false, "schema": { "title": "launchTemplateLaunchTemplateName", "type": "string" } }, { "name": "launchTemplateVersion", "type": "string", "info": "The launch template to use. You must specify either the launch template ID or launch template name in the request, but not both.\n The version number of the launch templat...(description truncated)", "required": false, "schema": { "title": "launchTemplateVersion", "type": "string" } }, { "name": "instanceMarketOptionsMarketType", "type": "string", "info": "Describes the market (purchasing) option for the instances.\nThe market type.", "required": false, "schema": { "title": "instanceMarketOptionsMarketType", "type": "string" } }, { "name": "instanceMarketOptionsSpotOptions", "type": "string", "info": "Describes the market (purchasing) option for the instances.\nThe options for Spot Instances.", "required": false, "schema": { "title": "instanceMarketOptionsSpotOptions", "type": "string" } }, { "name": "creditSpecificationCpuCredits", "type": "string", "info": "The credit option for CPU usage of a T2 or T3 instance.\nThe credit option for CPU usage of a T2 or T3 instance. Valid values are standard and unlimited .", "required": false, "schema": { "title": "creditSpecificationCpuCredits", "type": "string" } }, { "name": "cpuOptionsCoreCount", "type": "string", "info": "The CPU options for the instance. Both the core count and threads per core must be specified in the request.\nThe number of CPU cores for the instance.", "required": false, "schema": { "title": "cpuOptionsCoreCount", "type": "string" } }, { "name": "cpuOptionsThreadsPerCore", "type": "string", "info": "The CPU options for the instance. Both the core count and threads per core must be specified in the request.\nThe number of threads per CPU core. To disable Intel Hyper-Th...(description truncated)", "required": false, "schema": { "title": "cpuOptionsThreadsPerCore", "type": "string" } }, { "name": "capacityReservationSpecificationCapacityReservationPreference", "type": "string", "info": "Describes an instance's Capacity Reservation targeting option. You can specify only one parameter at a time. If you specify CapacityReservationPreference and Capacity...(description truncated)", "required": false, "schema": { "title": "capacityReservationSpecificationCapacityReservationPreference", "type": "string" } }, { "name": "capacityReservationSpecificationCapacityReservationTarget", "type": "string", "info": "Describes an instance's Capacity Reservation targeting option. You can specify only one parameter at a time. If you specify CapacityReservationPreference and Capacity...(description truncated)", "required": false, "schema": { "title": "capacityReservationSpecificationCapacityReservationTarget", "type": "string" } }, { "name": "hibernationOptionsConfigured", "type": "string", "info": "Indicates whether your instance is configured for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites . Hibernation is currentl...(description truncated)", "required": false, "schema": { "title": "hibernationOptionsConfigured", "type": "string" } }, { "name": "licenseSpecification", "type": "array", "info": "The license configurations.", "required": false, "schema": { "title": "licenseSpecification", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/runInstancesSTSRole" }, "task": true }, { "name": "runScheduledInstances", "summary": "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 Inst...(description truncated)", "description": "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 Inst...(description truncated)", "input": [ { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency .", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "instanceCount", "type": "number", "info": "The number of instances. Default: 1", "required": false, "schema": { "title": "instanceCount", "type": "number" } }, { "name": "launchSpecificationBlockDeviceMappings", "type": "array", "info": "Describes the launch specification for a Scheduled Instance. If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can spe...(description truncated)", "required": false, "schema": { "title": "launchSpecificationBlockDeviceMappings", "type": "array" } }, { "name": "launchSpecificationEbsOptimized", "type": "string", "info": "Describes the launch specification for a Scheduled Instance. If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can spe...(description truncated)", "required": false, "schema": { "title": "launchSpecificationEbsOptimized", "type": "string" } }, { "name": "launchSpecificationIamInstanceProfile", "type": "string", "info": "Describes the launch specification for a Scheduled Instance. If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can spe...(description truncated)", "required": false, "schema": { "title": "launchSpecificationIamInstanceProfile", "type": "string" } }, { "name": "launchSpecificationImageId", "type": "string", "info": "Describes the launch specification for a Scheduled Instance. If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can spe...(description truncated)", "required": false, "schema": { "title": "launchSpecificationImageId", "type": "string" } }, { "name": "launchSpecificationInstanceType", "type": "string", "info": "Describes the launch specification for a Scheduled Instance. If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can spe...(description truncated)", "required": false, "schema": { "title": "launchSpecificationInstanceType", "type": "string" } }, { "name": "launchSpecificationKernelId", "type": "string", "info": "Describes the launch specification for a Scheduled Instance. If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can spe...(description truncated)", "required": false, "schema": { "title": "launchSpecificationKernelId", "type": "string" } }, { "name": "launchSpecificationKeyName", "type": "string", "info": "Describes the launch specification for a Scheduled Instance. If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can spe...(description truncated)", "required": false, "schema": { "title": "launchSpecificationKeyName", "type": "string" } }, { "name": "launchSpecificationMonitoring", "type": "string", "info": "Describes the launch specification for a Scheduled Instance. If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can spe...(description truncated)", "required": false, "schema": { "title": "launchSpecificationMonitoring", "type": "string" } }, { "name": "launchSpecificationNetworkInterfaces", "type": "array", "info": "Describes the launch specification for a Scheduled Instance. If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can spe...(description truncated)", "required": false, "schema": { "title": "launchSpecificationNetworkInterfaces", "type": "array" } }, { "name": "launchSpecificationPlacement", "type": "string", "info": "Describes the launch specification for a Scheduled Instance. If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can spe...(description truncated)", "required": false, "schema": { "title": "launchSpecificationPlacement", "type": "string" } }, { "name": "launchSpecificationRamdiskId", "type": "string", "info": "Describes the launch specification for a Scheduled Instance. If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can spe...(description truncated)", "required": false, "schema": { "title": "launchSpecificationRamdiskId", "type": "string" } }, { "name": "launchSpecificationSecurityGroupIds", "type": "array", "info": "Describes the launch specification for a Scheduled Instance. If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can spe...(description truncated)", "required": false, "schema": { "title": "launchSpecificationSecurityGroupIds", "type": "array" } }, { "name": "launchSpecificationSubnetId", "type": "string", "info": "Describes the launch specification for a Scheduled Instance. If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can spe...(description truncated)", "required": false, "schema": { "title": "launchSpecificationSubnetId", "type": "string" } }, { "name": "launchSpecificationUserData", "type": "string", "info": "Describes the launch specification for a Scheduled Instance. If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can spe...(description truncated)", "required": false, "schema": { "title": "launchSpecificationUserData", "type": "string" } }, { "name": "scheduledInstanceId", "type": "string", "info": "The Scheduled Instance ID.", "required": true, "schema": { "title": "scheduledInstanceId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/runScheduledInstances" }, "task": true }, { "name": "runScheduledInstancesSTSRole", "summary": "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 Inst...(description truncated)", "description": "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 Inst...(description truncated)", "input": [ { "name": "clientToken", "type": "string", "info": "Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency .", "required": false, "schema": { "title": "clientToken", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "instanceCount", "type": "number", "info": "The number of instances. Default: 1", "required": false, "schema": { "title": "instanceCount", "type": "number" } }, { "name": "launchSpecificationBlockDeviceMappings", "type": "array", "info": "Describes the launch specification for a Scheduled Instance. If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can spe...(description truncated)", "required": false, "schema": { "title": "launchSpecificationBlockDeviceMappings", "type": "array" } }, { "name": "launchSpecificationEbsOptimized", "type": "string", "info": "Describes the launch specification for a Scheduled Instance. If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can spe...(description truncated)", "required": false, "schema": { "title": "launchSpecificationEbsOptimized", "type": "string" } }, { "name": "launchSpecificationIamInstanceProfile", "type": "string", "info": "Describes the launch specification for a Scheduled Instance. If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can spe...(description truncated)", "required": false, "schema": { "title": "launchSpecificationIamInstanceProfile", "type": "string" } }, { "name": "launchSpecificationImageId", "type": "string", "info": "Describes the launch specification for a Scheduled Instance. If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can spe...(description truncated)", "required": false, "schema": { "title": "launchSpecificationImageId", "type": "string" } }, { "name": "launchSpecificationInstanceType", "type": "string", "info": "Describes the launch specification for a Scheduled Instance. If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can spe...(description truncated)", "required": false, "schema": { "title": "launchSpecificationInstanceType", "type": "string" } }, { "name": "launchSpecificationKernelId", "type": "string", "info": "Describes the launch specification for a Scheduled Instance. If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can spe...(description truncated)", "required": false, "schema": { "title": "launchSpecificationKernelId", "type": "string" } }, { "name": "launchSpecificationKeyName", "type": "string", "info": "Describes the launch specification for a Scheduled Instance. If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can spe...(description truncated)", "required": false, "schema": { "title": "launchSpecificationKeyName", "type": "string" } }, { "name": "launchSpecificationMonitoring", "type": "string", "info": "Describes the launch specification for a Scheduled Instance. If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can spe...(description truncated)", "required": false, "schema": { "title": "launchSpecificationMonitoring", "type": "string" } }, { "name": "launchSpecificationNetworkInterfaces", "type": "array", "info": "Describes the launch specification for a Scheduled Instance. If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can spe...(description truncated)", "required": false, "schema": { "title": "launchSpecificationNetworkInterfaces", "type": "array" } }, { "name": "launchSpecificationPlacement", "type": "string", "info": "Describes the launch specification for a Scheduled Instance. If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can spe...(description truncated)", "required": false, "schema": { "title": "launchSpecificationPlacement", "type": "string" } }, { "name": "launchSpecificationRamdiskId", "type": "string", "info": "Describes the launch specification for a Scheduled Instance. If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can spe...(description truncated)", "required": false, "schema": { "title": "launchSpecificationRamdiskId", "type": "string" } }, { "name": "launchSpecificationSecurityGroupIds", "type": "array", "info": "Describes the launch specification for a Scheduled Instance. If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can spe...(description truncated)", "required": false, "schema": { "title": "launchSpecificationSecurityGroupIds", "type": "array" } }, { "name": "launchSpecificationSubnetId", "type": "string", "info": "Describes the launch specification for a Scheduled Instance. If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can spe...(description truncated)", "required": false, "schema": { "title": "launchSpecificationSubnetId", "type": "string" } }, { "name": "launchSpecificationUserData", "type": "string", "info": "Describes the launch specification for a Scheduled Instance. If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can spe...(description truncated)", "required": false, "schema": { "title": "launchSpecificationUserData", "type": "string" } }, { "name": "scheduledInstanceId", "type": "string", "info": "The Scheduled Instance ID.", "required": true, "schema": { "title": "scheduledInstanceId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/runScheduledInstancesSTSRole" }, "task": true }, { "name": "searchTransitGatewayRoutes", "summary": "Searches for routes in the specified transit gateway route table.", "description": "Searches for routes in the specified transit gateway route table.", "input": [ { "name": "transitGatewayRouteTableId", "type": "string", "info": "The ID of the transit gateway route table.", "required": true, "schema": { "title": "transitGatewayRouteTableId", "type": "string" } }, { "name": "filter", "type": "array", "info": "One or more filters. The possible values are: attachment.transit-gateway-attachment-id - The id of the transit gateway attachment. attachment.resource-id...(description truncated)", "required": true, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of routes to return.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/searchTransitGatewayRoutes" }, "task": true }, { "name": "searchTransitGatewayRoutesSTSRole", "summary": "Searches for routes in the specified transit gateway route table.", "description": "Searches for routes in the specified transit gateway route table.", "input": [ { "name": "transitGatewayRouteTableId", "type": "string", "info": "The ID of the transit gateway route table.", "required": true, "schema": { "title": "transitGatewayRouteTableId", "type": "string" } }, { "name": "filter", "type": "array", "info": "One or more filters. The possible values are: attachment.transit-gateway-attachment-id - The id of the transit gateway attachment. attachment.resource-id...(description truncated)", "required": true, "schema": { "title": "filter", "type": "array" } }, { "name": "maxResults", "type": "number", "info": "The maximum number of routes to return.", "required": false, "schema": { "title": "maxResults", "type": "number" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/searchTransitGatewayRoutesSTSRole" }, "task": true }, { "name": "startInstances", "summary": "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...(description truncated)", "description": "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...(description truncated)", "input": [ { "name": "instanceId", "type": "array", "info": "The IDs of the instances.", "required": true, "schema": { "title": "instanceId", "type": "array" } }, { "name": "additionalInfo", "type": "string", "info": "Reserved.", "required": false, "schema": { "title": "additionalInfo", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/startInstances" }, "task": true }, { "name": "startInstancesSTSRole", "summary": "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...(description truncated)", "description": "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...(description truncated)", "input": [ { "name": "instanceId", "type": "array", "info": "The IDs of the instances.", "required": true, "schema": { "title": "instanceId", "type": "array" } }, { "name": "additionalInfo", "type": "string", "info": "Reserved.", "required": false, "schema": { "title": "additionalInfo", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/startInstancesSTSRole" }, "task": true }, { "name": "stopInstances", "summary": "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. Eve...(description truncated)", "description": "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. Eve...(description truncated)", "input": [ { "name": "instanceId", "type": "array", "info": "The IDs of the instances.", "required": true, "schema": { "title": "instanceId", "type": "array" } }, { "name": "hibernate", "type": "boolean", "info": "Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more informat...(description truncated)", "required": false, "schema": { "title": "hibernate", "type": "boolean" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "force", "type": "boolean", "info": "Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file...(description truncated)", "required": false, "schema": { "title": "force", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/stopInstances" }, "task": true }, { "name": "stopInstancesSTSRole", "summary": "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. Eve...(description truncated)", "description": "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. Eve...(description truncated)", "input": [ { "name": "instanceId", "type": "array", "info": "The IDs of the instances.", "required": true, "schema": { "title": "instanceId", "type": "array" } }, { "name": "hibernate", "type": "boolean", "info": "Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more informat...(description truncated)", "required": false, "schema": { "title": "hibernate", "type": "boolean" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "force", "type": "boolean", "info": "Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file...(description truncated)", "required": false, "schema": { "title": "force", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/stopInstancesSTSRole" }, "task": true }, { "name": "terminateClientVpnConnections", "summary": "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.", "description": "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.", "input": [ { "name": "clientVpnEndpointId", "type": "string", "info": "The ID of the Client VPN endpoint to which the client is connected.", "required": true, "schema": { "title": "clientVpnEndpointId", "type": "string" } }, { "name": "connectionId", "type": "string", "info": "The ID of the client connection to be terminated.", "required": false, "schema": { "title": "connectionId", "type": "string" } }, { "name": "username", "type": "string", "info": "The name of the user who initiated the connection. Use this option to terminate all active connections for the specified user. This option can only be used if the user ha...(description truncated)", "required": false, "schema": { "title": "username", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/terminateClientVpnConnections" }, "task": true }, { "name": "terminateClientVpnConnectionsSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "clientVpnEndpointId", "type": "string", "info": "The ID of the Client VPN endpoint to which the client is connected.", "required": true, "schema": { "title": "clientVpnEndpointId", "type": "string" } }, { "name": "connectionId", "type": "string", "info": "The ID of the client connection to be terminated.", "required": false, "schema": { "title": "connectionId", "type": "string" } }, { "name": "username", "type": "string", "info": "The name of the user who initiated the connection. Use this option to terminate all active connections for the specified user. This option can only be used if the user ha...(description truncated)", "required": false, "schema": { "title": "username", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/terminateClientVpnConnectionsSTSRole" }, "task": true }, { "name": "terminateInstances", "summary": "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...(description truncated)", "description": "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...(description truncated)", "input": [ { "name": "instanceId", "type": "array", "info": "The IDs of the instances. Constraints: Up to 1000 instance IDs. We recommend breaking up this request into smaller batches.", "required": true, "schema": { "title": "instanceId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/terminateInstances" }, "task": true }, { "name": "terminateInstancesSTSRole", "summary": "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...(description truncated)", "description": "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...(description truncated)", "input": [ { "name": "instanceId", "type": "array", "info": "The IDs of the instances. Constraints: Up to 1000 instance IDs. We recommend breaking up this request into smaller batches.", "required": true, "schema": { "title": "instanceId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/terminateInstancesSTSRole" }, "task": true }, { "name": "unassignIpv6Addresses", "summary": "Unassigns one or more IPv6 addresses from a network interface.", "description": "Unassigns one or more IPv6 addresses from a network interface.", "input": [ { "name": "ipv6Addresses", "type": "array", "info": "The IPv6 addresses to unassign from the network interface.", "required": true, "schema": { "title": "ipv6Addresses", "type": "array" } }, { "name": "networkInterfaceId", "type": "string", "info": "The ID of the network interface.", "required": true, "schema": { "title": "networkInterfaceId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/unassignIpv6Addresses" }, "task": true }, { "name": "unassignIpv6AddressesSTSRole", "summary": "Unassigns one or more IPv6 addresses from a network interface.", "description": "Unassigns one or more IPv6 addresses from a network interface.", "input": [ { "name": "ipv6Addresses", "type": "array", "info": "The IPv6 addresses to unassign from the network interface.", "required": true, "schema": { "title": "ipv6Addresses", "type": "array" } }, { "name": "networkInterfaceId", "type": "string", "info": "The ID of the network interface.", "required": true, "schema": { "title": "networkInterfaceId", "type": "string" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/unassignIpv6AddressesSTSRole" }, "task": true }, { "name": "unassignPrivateIpAddresses", "summary": "Unassigns one or more secondary private IP addresses from a network interface.", "description": "Unassigns one or more secondary private IP addresses from a network interface.", "input": [ { "name": "networkInterfaceId", "type": "string", "info": "The ID of the network interface.", "required": true, "schema": { "title": "networkInterfaceId", "type": "string" } }, { "name": "privateIpAddress", "type": "array", "info": "The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.", "required": true, "schema": { "title": "privateIpAddress", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/unassignPrivateIpAddresses" }, "task": true }, { "name": "unassignPrivateIpAddressesSTSRole", "summary": "Unassigns one or more secondary private IP addresses from a network interface.", "description": "Unassigns one or more secondary private IP addresses from a network interface.", "input": [ { "name": "networkInterfaceId", "type": "string", "info": "The ID of the network interface.", "required": true, "schema": { "title": "networkInterfaceId", "type": "string" } }, { "name": "privateIpAddress", "type": "array", "info": "The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.", "required": true, "schema": { "title": "privateIpAddress", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/unassignPrivateIpAddressesSTSRole" }, "task": true }, { "name": "unmonitorInstances", "summary": "Disables detailed monitoring for a running instance. For more information, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide .", "description": "Disables detailed monitoring for a running instance. For more information, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide .", "input": [ { "name": "instanceId", "type": "array", "info": "The IDs of the instances.", "required": true, "schema": { "title": "instanceId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/unmonitorInstances" }, "task": true }, { "name": "unmonitorInstancesSTSRole", "summary": "Disables detailed monitoring for a running instance. For more information, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide .", "description": "Disables detailed monitoring for a running instance. For more information, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide .", "input": [ { "name": "instanceId", "type": "array", "info": "The IDs of the instances.", "required": true, "schema": { "title": "instanceId", "type": "array" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/unmonitorInstancesSTSRole" }, "task": true }, { "name": "updateSecurityGroupRuleDescriptionsEgress", "summary": "[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.", "description": "[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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "groupId", "type": "string", "info": "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 s...(description truncated)", "required": false, "schema": { "title": "groupId", "type": "string" } }, { "name": "groupName", "type": "string", "info": "[Default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.", "required": false, "schema": { "title": "groupName", "type": "string" } }, { "name": "ipPermissions", "type": "array", "info": "The IP permissions for the security group rule.", "required": true, "schema": { "title": "ipPermissions", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateSecurityGroupRuleDescriptionsEgress" }, "task": true }, { "name": "updateSecurityGroupRuleDescriptionsEgressSTSRole", "summary": "[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.", "description": "[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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "groupId", "type": "string", "info": "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 s...(description truncated)", "required": false, "schema": { "title": "groupId", "type": "string" } }, { "name": "groupName", "type": "string", "info": "[Default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.", "required": false, "schema": { "title": "groupName", "type": "string" } }, { "name": "ipPermissions", "type": "array", "info": "The IP permissions for the security group rule.", "required": true, "schema": { "title": "ipPermissions", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateSecurityGroupRuleDescriptionsEgressSTSRole" }, "task": true }, { "name": "updateSecurityGroupRuleDescriptionsIngress", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "groupId", "type": "string", "info": "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 s...(description truncated)", "required": false, "schema": { "title": "groupId", "type": "string" } }, { "name": "groupName", "type": "string", "info": "[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.", "required": false, "schema": { "title": "groupName", "type": "string" } }, { "name": "ipPermissions", "type": "array", "info": "The IP permissions for the security group rule.", "required": true, "schema": { "title": "ipPermissions", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateSecurityGroupRuleDescriptionsIngress" }, "task": true }, { "name": "updateSecurityGroupRuleDescriptionsIngressSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "groupId", "type": "string", "info": "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 s...(description truncated)", "required": false, "schema": { "title": "groupId", "type": "string" } }, { "name": "groupName", "type": "string", "info": "[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.", "required": false, "schema": { "title": "groupName", "type": "string" } }, { "name": "ipPermissions", "type": "array", "info": "The IP permissions for the security group rule.", "required": true, "schema": { "title": "ipPermissions", "type": "array" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateSecurityGroupRuleDescriptionsIngressSTSRole" }, "task": true }, { "name": "withdrawByoipCidr", "summary": "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.", "description": "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.", "input": [ { "name": "cidr", "type": "string", "info": "The public IPv4 address range, in CIDR notation.", "required": true, "schema": { "title": "cidr", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/withdrawByoipCidr" }, "task": true }, { "name": "withdrawByoipCidrSTSRole", "summary": "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.", "description": "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.", "input": [ { "name": "cidr", "type": "string", "info": "The public IPv4 address range, in CIDR notation.", "required": true, "schema": { "title": "cidr", "type": "string" } }, { "name": "dryRun", "type": "boolean", "info": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions...(description truncated)", "required": false, "schema": { "title": "dryRun", "type": "boolean" } }, { "name": "stsParams", "type": "object", "info": "STS Parameters to use for authentication.", "required": false, "schema": { "title": "stsParams", "type": "object" } }, { "name": "roleName", "type": "string", "info": "RoleName to authenticate against", "required": false, "schema": { "title": "roleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/withdrawByoipCidrSTSRole" }, "task": true } ] }