From f525502dd083f368baa1046a3148a8654fc334c9 Mon Sep 17 00:00:00 2001 From: Outscale Bot Date: Thu, 29 Jan 2026 12:59:25 +0000 Subject: [PATCH] =?UTF-8?q?=F0=9F=94=96=20release:=20osc-sdk-python=20v0.3?= =?UTF-8?q?9.0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 2 +- osc_sdk_python/VERSION | 2 +- osc_sdk_python/resources/outscale.yaml | 6898 +++++++++++------------- pyproject.toml | 2 +- uv.lock | 66 +- 5 files changed, 3017 insertions(+), 3953 deletions(-) diff --git a/README.md b/README.md index 55faa02..cdd6c39 100644 --- a/README.md +++ b/README.md @@ -77,7 +77,7 @@ make package Then install the built wheel: ```bash -pip install dist/osc_sdk_python-0.38.1-py3-none-any.whl +pip install dist/osc_sdk_python-0.39.0-py3-none-any.whl ``` --- diff --git a/osc_sdk_python/VERSION b/osc_sdk_python/VERSION index bb22182..4ef2eb0 100644 --- a/osc_sdk_python/VERSION +++ b/osc_sdk_python/VERSION @@ -1 +1 @@ -0.38.1 +0.39.0 diff --git a/osc_sdk_python/resources/outscale.yaml b/osc_sdk_python/resources/outscale.yaml index 962d9cd..5a5e171 100644 --- a/osc_sdk_python/resources/outscale.yaml +++ b/osc_sdk_python/resources/outscale.yaml @@ -1,12 +1,10 @@ ---- components: schemas: AcceptNetPeeringRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean NetPeeringId: description: The ID of the Net peering you want to accept. @@ -18,10 +16,10 @@ components: additionalProperties: false properties: NetPeering: - "$ref": "#/components/schemas/NetPeering" + $ref: '#/components/schemas/NetPeering' description: Information about the Net peering. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object AccepterNet: @@ -32,8 +30,7 @@ components: description: The account ID of the owner of the accepter Net. type: string IpRange: - description: The IP range for the accepter Net, in CIDR notation (for example, - `10.0.0.0/16`). + description: The IP range for the accepter Net, in CIDR notation (for example, `10.0.0.0/16`). type: string NetId: description: The ID of the accepter Net. @@ -48,19 +45,18 @@ components: type: string CreationDate: description: The date and time (UTC) at which the access key was created. - format: datetime + format: date-time type: string ExpirationDate: description: The date and time (UTC) at which the access key expires. - format: datetime + format: date-time type: string LastModificationDate: description: The date and time (UTC) at which the access key was last modified. - format: datetime + format: date-time type: string State: - description: The state of the access key (`ACTIVE` if the key is valid for - API calls, or `INACTIVE` if not). + description: The state of the access key (`ACTIVE` if the key is valid for API calls, or `INACTIVE` if not). type: string Tag: description: The tag added to the access key. @@ -75,22 +71,21 @@ components: type: string CreationDate: description: The date and time (UTC) at which the access key was created. - format: datetime + format: date-time type: string ExpirationDate: description: The date and time (UTC) at which the access key expires. - format: datetime + format: date-time type: string LastModificationDate: description: The date and time (UTC) at which the access key was last modified. - format: datetime + format: date-time type: string SecretKey: description: The secret key that enables you to send requests. type: string State: - description: The state of the access key (`ACTIVE` if the key is valid for - API calls, or `INACTIVE` if not). + description: The state of the access key (`ACTIVE` if the key is valid for API calls, or `INACTIVE` if not). type: string Tag: description: A tag added to the access key. @@ -101,21 +96,16 @@ components: description: Information about access logs. properties: IsEnabled: - description: If true, access logs are enabled for your load balancer. If - false, they are not. If you set this to true in your request, the `OsuBucketName` - parameter is required. + description: If true, access logs are enabled for your load balancer. If false, they are not. If you set this to true in your request, the `OsuBucketName` parameter is required. type: boolean OsuBucketName: description: The name of the OOS bucket for the access logs. type: string OsuBucketPrefix: - description: The path to the folder of the access logs in your OOS bucket - (by default, the `root` level of your bucket). + description: The path to the folder of the access logs in your OOS bucket (by default, the `root` level of your bucket). type: string PublicationInterval: - description: The time interval for the publication of access logs in the - OOS bucket, in minutes. This value can be either `5` or `60` (by default, - `60`). + description: The time interval for the publication of access logs in the OOS bucket, in minutes. This value can be either `5` or `60` (by default, `60`). type: integer type: object Account: @@ -126,10 +116,9 @@ components: description: The ID of the account. type: string AdditionalEmails: - description: One or more additional email addresses for the account. These - addresses are used for notifications only. + description: One or more additional email addresses for the account. These addresses are used for notifications only. items: - pattern: "^.+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)+$" + pattern: ^.+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)+$ type: string type: array City: @@ -145,8 +134,7 @@ components: description: The ID of the customer. type: string Email: - description: The main email address for the account. This address is used - for your credentials and for notifications. + description: The main email address for the account. This address is used for your credentials and for notifications. type: string FirstName: description: The first name of the account owner. @@ -161,8 +149,7 @@ components: description: The mobile phone number of the account owner. type: string OutscaleLoginAllowed: - description: Whether the account is allowed to log in to Cockpit v2 using - its Outscale credentials when identity federation is activated. + description: Whether the account is allowed to log in to Cockpit v2 using its Outscale credentials when identity federation is activated. type: boolean PhoneNumber: description: The landline phone number of the account owner. @@ -181,30 +168,26 @@ components: description: The action to perform on the next boot of the VM. properties: SecureBoot: - "$ref": "#/components/schemas/SecureBootAction" - description: One action to perform on the next boot of the VM. For more - information, see [About Secure Boot](https://docs.outscale.com/en/userguide/About-Secure-Boot.html#_secure_boot_actions). + $ref: '#/components/schemas/SecureBootAction' + description: One action to perform on the next boot of the VM. For more information, see [About Secure Boot](https://docs.outscale.com/en/userguide/About-Secure-Boot.html#_secure_boot_actions). type: object AddUserToUserGroupRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean UserGroupName: description: The name of the group you want to add a user to. type: string UserGroupPath: - description: The path to the group. If not specified, it is set to a slash - (`/`). + description: The path to the group. If not specified, it is set to a slash (`/`). type: string UserName: description: The name of the user you want to add to the group. type: string UserPath: - description: The path to the user. If not specified, it is set to a slash - (`/`). + description: The path to the user. If not specified, it is set to a slash (`/`). type: string required: - UserGroupName @@ -214,7 +197,7 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ApiAccessPolicy: @@ -222,8 +205,7 @@ components: description: Information about the API access policy. properties: MaxAccessKeyExpirationSeconds: - description: The maximum possible lifetime for your access keys, in seconds. - If `0`, your access keys can have unlimited lifetimes. + description: The maximum possible lifetime for your access keys, in seconds. If `0`, your access keys can have unlimited lifetimes. format: int64 type: integer RequireTrustedEnv: @@ -240,8 +222,7 @@ components: description: The ID of the API access rule. type: string CaIds: - description: One or more IDs of Client Certificate Authorities (CAs) used - for the API access rule. + description: One or more IDs of Client Certificate Authorities (CAs) used for the API access rule. items: type: string type: array @@ -254,8 +235,7 @@ components: description: The description of the API access rule. type: string IpRanges: - description: One or more IP ranges used for the API access rule, in CIDR - notation (for example, `192.0.2.0/16`). + description: One or more IP ranges used for the API access rule, in CIDR notation (for example, `192.0.2.0/16`). items: type: string type: array @@ -265,11 +245,10 @@ components: description: Information about the stickiness policy. properties: CookieName: - description: The name of the application cookie used for stickiness. + description: The name of the application cookie used for stickiness, between 1 and 255 characters. type: string PolicyName: - description: The mnemonic name for the policy being created. The name must - be unique within a set of policies for this load balancer. + description: The mnemonic name for the policy being created. The name must be unique within a set of policies for this load balancer. type: string type: object BackendVmHealth: @@ -280,8 +259,7 @@ components: description: The description of the state of the backend VM. type: string State: - description: The state of the backend VM (`InService` \| `OutOfService` - \| `Unknown`). + description: The state of the backend VM (`InService` \| `OutOfService` \| `Unknown`). type: string StateReason: description: |- @@ -297,7 +275,7 @@ components: description: Information about the created block device mapping. properties: Bsu: - "$ref": "#/components/schemas/BsuCreated" + $ref: '#/components/schemas/BsuCreated' description: Information about the created BSU volume. DeviceName: description: The name of the device. @@ -305,17 +283,13 @@ components: type: object BlockDeviceMappingImage: additionalProperties: false - description: One or more parameters used to automatically set up volumes when - the VM is created. + description: One or more parameters used to automatically set up volumes when the VM is created. properties: Bsu: - "$ref": "#/components/schemas/BsuToCreate" + $ref: '#/components/schemas/BsuToCreate' description: Information about the BSU volume to create. DeviceName: - description: The device name for the volume. For a root device, you must - use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXX`, - `/dev/xvdX`, or `/dev/xvdXX` (where the first `X` is a letter between - `b` and `z`, and the second `X` is a letter between `a` and `z`). + description: The device name for the volume. For a root device, you must use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXX`, `/dev/xvdX`, or `/dev/xvdXX` (where the first `X` is a letter between `b` and `z`, and the second `X` is a letter between `a` and `z`). type: string VirtualDeviceName: description: The name of the virtual device (`ephemeralN`). @@ -326,17 +300,13 @@ components: description: Information about the block device mapping. properties: Bsu: - "$ref": "#/components/schemas/BsuToCreate" + $ref: '#/components/schemas/BsuToCreate' description: Information about the BSU volume to create. DeviceName: - description: The device name for the volume. For a root device, you must - use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXX`, - `/dev/xvdX`, or `/dev/xvdXX` (where the first `X` is a letter between - `b` and `z`, and the second `X` is a letter between `a` and `z`). + description: The device name for the volume. For a root device, you must use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXX`, `/dev/xvdX`, or `/dev/xvdXX` (where the first `X` is a letter between `b` and `z`, and the second `X` is a letter between `a` and `z`). type: string NoDevice: - description: Removes the device which is included in the block device mapping - of the OMI. + description: Removes the device which is included in the block device mapping of the OMI. type: string VirtualDeviceName: description: The name of the virtual device (`ephemeralN`). @@ -347,17 +317,13 @@ components: description: Information about the block device mapping. properties: Bsu: - "$ref": "#/components/schemas/BsuToUpdateVm" + $ref: '#/components/schemas/BsuToUpdateVm' description: Information about the BSU volume. DeviceName: - description: The device name for the volume. For a root device, you must - use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXX`, - `/dev/xvdX`, or `/dev/xvdXX` (where the first `X` is a letter between - `b` and `z`, and the second `X` is a letter between `a` and `z`). + description: The device name for the volume. For a root device, you must use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXX`, `/dev/xvdX`, or `/dev/xvdXX` (where the first `X` is a letter between `b` and `z`, and the second `X` is a letter between `a` and `z`). type: string NoDevice: - description: Removes the device which is included in the block device mapping - of the OMI. + description: Removes the device which is included in the block device mapping of the OMI. type: string VirtualDeviceName: description: The name of the virtual device (`ephemeralN`). @@ -374,13 +340,11 @@ components: description: Information about the created BSU volume. properties: DeleteOnVmDeletion: - description: If true, the volume is deleted when terminating the VM. If - false, the volume is not deleted when terminating the VM. + description: If true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM. type: boolean LinkDate: - description: The date and time (UTC) at which the volume was attached to - the VM, in ISO 8601 date-time format. - format: date + description: The date and time (UTC) at which the volume was attached to the VM, in ISO 8601 date-time format. + format: date-time type: string State: description: The state of the volume. @@ -395,14 +359,10 @@ components: properties: DeleteOnVmDeletion: default: true - description: If set to true, the volume is deleted when terminating the - VM. If false, the volume is not deleted when terminating the VM. + description: If set to true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM. type: boolean Iops: - description: The number of I/O operations per second (IOPS). This parameter - must be specified only if you create an `io1` volume. The maximum number - of IOPS allowed for `io1` volumes is `13000` with a maximum performance - ratio of 300 IOPS per gibibyte. + description: The number of I/O operations per second (IOPS). This parameter must be specified only if you create an `io1` volume. The maximum number of IOPS allowed for `io1` volumes is `13000` with a maximum performance ratio of 300 IOPS per gibibyte. type: integer SnapshotId: description: The ID of the snapshot used to create the volume. @@ -424,13 +384,65 @@ components: description: Information about the BSU volume. properties: DeleteOnVmDeletion: - description: If set to true, the volume is deleted when terminating the - VM. If set to false, the volume is not deleted when terminating the VM. + description: If set to true, the volume is deleted when terminating the VM. If set to false, the volume is not deleted when terminating the VM. type: boolean VolumeId: description: The ID of the volume. type: string type: object + CO2CategoryDistribution: + additionalProperties: false + description: The allocation of the `Value` among categories. + properties: + Category: + description: The category of the resource (for example, `storage`). + type: string + Value: + description: The total CO2 emissions for the category. + format: double + type: number + type: object + CO2EmissionEntry: + additionalProperties: false + description: The CO2 emission by month and account, for the specified request. + properties: + AccountId: + description: The ID of the account associated with the consumption. + type: string + CategoryDistribution: + description: The allocation of the `Value` among categories. + items: + $ref: '#/components/schemas/CO2CategoryDistribution' + type: array + FactorDistribution: + description: The allocation of the `Value` among factors. + items: + $ref: '#/components/schemas/CO2FactorDistribution' + type: array + Month: + description: The month associated with the CO2 emission entry. + format: date + type: string + PayingAccountId: + description: The ID of the paying account related to the `AccountId` parameter. + type: string + Value: + description: The total CO2 emissions for the `Month` and `AccountId` specified. This value corresponds to the sum of all entries in `CategoryDistribution` and `FactorDistributionEntry`. + format: double + type: number + type: object + CO2FactorDistribution: + additionalProperties: false + description: The allocation of the `Value` among factors. + properties: + Factor: + description: The emission source (for example, `hardware`). + type: string + Value: + description: The total CO2 emissions for the factor. + format: double + type: number + type: object Ca: additionalProperties: false description: Information about the Client Certificate Authority (CA). @@ -452,7 +464,7 @@ components: Entries: description: One or more catalog entries. items: - "$ref": "#/components/schemas/CatalogEntry" + $ref: '#/components/schemas/CatalogEntry' type: array type: object CatalogEntry: @@ -463,16 +475,13 @@ components: description: The category of the catalog entry (for example, `network`). type: string Flags: - description: When returned and equal to `PER_MONTH`, the price of the catalog - entry is calculated on a monthly basis. + description: When returned and equal to `PER_MONTH`, the price of the catalog entry is calculated on a monthly basis. type: string Operation: - description: The API call associated with the catalog entry (for example, - `CreateVms` or `RunInstances`). + description: The API call associated with the catalog entry (for example, `CreateVms` or `RunInstances`). type: string Service: - description: The service associated with the catalog entry (`TinaOS-FCU`, - `TinaOS-LBU`, `TinaOS-DirectLink`, or `TinaOS-OOS`). + description: The service associated with the catalog entry (`TinaOS-FCU`, `TinaOS-LBU`, `TinaOS-DirectLink`, or `TinaOS-OOS`). type: string SubregionName: description: The Subregion associated with the catalog entry. @@ -484,8 +493,7 @@ components: description: The type of resource associated with the catalog entry. type: string UnitPrice: - description: The unit price of the catalog entry in the currency of your - account, in the ISO-4217 format (for example, `EUR`). + description: The unit price of the catalog entry in the currency of your account, in the ISO-4217 format (for example, `EUR`). format: float type: number type: object @@ -496,7 +504,7 @@ components: Entries: description: One or more catalog entries. items: - "$ref": "#/components/schemas/CatalogEntry" + $ref: '#/components/schemas/CatalogEntry' type: array FromDate: description: The beginning of the time period (UTC). @@ -517,8 +525,7 @@ components: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Login: description: The email address of the account. @@ -534,7 +541,7 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ClientGateway: @@ -542,34 +549,29 @@ components: description: Information about the client gateway. properties: BgpAsn: - description: The Autonomous System Number (ASN) used by the Border Gateway - Protocol (BGP) to find the path to your client gateway through the Internet. + description: The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your client gateway through the Internet. type: integer ClientGatewayId: description: The ID of the client gateway. type: string ConnectionType: - description: The type of communication tunnel used by the client gateway - (always `ipsec.1`). + description: The type of communication tunnel used by the client gateway (always `ipsec.1`). type: string PublicIp: - description: The public IPv4 address of the client gateway (must be a fixed - address into a NATed network). + description: The public IPv4 address of the client gateway (must be a fixed address into a NATed network). type: string State: - description: The state of the client gateway (`pending` \| `available` \| - `deleting` \| `deleted`). + description: The state of the client gateway (`pending` \| `available` \| `deleting` \| `deleted`). type: string Tags: description: One or more tags associated with the client gateway. items: - "$ref": "#/components/schemas/ResourceTag" + $ref: '#/components/schemas/ResourceTag' type: array type: object ConsumptionEntry: additionalProperties: false - description: Information about the resources consumed during the specified time - period. + description: Information about the resources consumed during the specified time period. properties: AccountId: description: The ID of your TINA account. @@ -579,24 +581,23 @@ components: type: string FromDate: description: The beginning of the time period (UTC). - format: datetime + format: date-time type: string Operation: - description: The API call that triggered the resource consumption (for example, - `RunInstances` or `CreateVolume`). + description: The API call that triggered the resource consumption (for example, `RunInstances` or `CreateVolume`). type: string PayingAccountId: - description: The ID of the TINA account which is billed for your consumption. - It can be different from your account in the `AccountId` parameter. + description: The ID of the TINA account which is billed for your consumption. It can be different from your account in the `AccountId` parameter. type: string Price: - description: The total price of the consumed resource during the specified - time period, in the currency of the Region's catalog. + description: The total price of the consumed resource during the specified time period, in the currency of the Region's catalog. format: double type: number + ResourceId: + description: The ID of the consumed resource. + type: string Service: - description: The service of the API call (`TinaOS-FCU`, `TinaOS-LBU`, `TinaOS-DirectLink`, - `TinaOS-OOS`, or `TinaOS-OSU`). + description: The service of the API call (`TinaOS-FCU`, `TinaOS-LBU`, `TinaOS-DirectLink`, `TinaOS-OOS`, `TinaOS-OSU`, or `OKS`). type: string SubregionName: description: The name of the Subregion. @@ -606,19 +607,17 @@ components: type: string ToDate: description: The end of the time period (UTC). - format: datetime + format: date-time type: string Type: description: The type of resource, depending on the API call. type: string UnitPrice: - description: The unit price of the consumed resource in the currency of - your account, in the ISO-4217 format (for example, `EUR`). + description: The unit price of the consumed resource in the currency of your account, in the ISO-4217 format (for example, `EUR`). format: double type: number Value: - description: The consumed amount for the resource. The unit depends on the - resource type. For more information, see the `Title` element. + description: The consumed amount for the resource. The unit depends on the resource type. For more information, see the `Title` element. format: double type: number type: object @@ -626,45 +625,39 @@ components: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean ExpirationDate: - description: The date and time, or the date, at which you want the access - key to expire, in ISO 8601 format (for example, `2020-06-14T00:00:00.000Z`, - or `2020-06-14`). To remove an existing expiration date, use the method - without specifying this parameter. - format: datetime - type: string + description: The date and time, or the date, at which you want the access key to expire, in ISO 8601 format (for example, `2020-06-14T00:00:00.000Z`, or `2020-06-14`). To remove an existing expiration date, use the method without specifying this parameter. + oneOf: + - format: date-time + type: string + - format: date + type: string Tag: description: A tag to add to the access key. type: string UserName: - description: The name of the EIM user that owns the key to be created. If - you do not specify a user name, this action creates an access key for - the user who sends the request (which can be the root account). + description: The name of the EIM user that owns the key to be created. If you do not specify a user name, this action creates an access key for the user who sends the request (which can be the root account). type: string type: object CreateAccessKeyResponse: additionalProperties: false properties: AccessKey: - "$ref": "#/components/schemas/AccessKeySecretKey" + $ref: '#/components/schemas/AccessKeySecretKey' description: Information about the access key. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object CreateAccountRequest: additionalProperties: false properties: AdditionalEmails: - description: One or more additional email addresses for the account. These - addresses are used for notifications only. If you already have a list - of additional emails registered, you cannot add to it, only replace it. - To remove all registered additional emails, specify an empty list. + description: One or more additional email addresses for the account. These addresses are used for notifications only. If you already have a list of additional emails registered, you cannot add to it, only replace it. To remove all registered additional emails, specify an empty list. items: - pattern: "^.+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)+$" + pattern: ^.+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)+$ type: string type: array City: @@ -680,12 +673,10 @@ components: description: The ID of the customer. It must be 8 digits. type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Email: - description: The main email address for the account. This address is used - for your credentials and notifications. + description: The main email address for the account. This address is used for your credentials and notifications. type: string FirstName: description: The first name of the account owner. @@ -725,10 +716,10 @@ components: additionalProperties: false properties: Account: - "$ref": "#/components/schemas/Account" + $ref: '#/components/schemas/Account' description: Information about the account. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object CreateApiAccessRuleRequest: @@ -740,8 +731,7 @@ components: type: string type: array Cns: - description: One or more Client Certificate Common Names (CNs). If this - parameter is specified, you must also specify the `CaIds` parameter. + description: One or more Client Certificate Common Names (CNs). If this parameter is specified, you must also specify the `CaIds` parameter. items: type: string type: array @@ -749,8 +739,7 @@ components: description: A description for the API access rule. type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean IpRanges: description: One or more IPs or CIDR blocks (for example, `192.0.2.0/16`). @@ -762,26 +751,23 @@ components: additionalProperties: false properties: ApiAccessRule: - "$ref": "#/components/schemas/ApiAccessRule" + $ref: '#/components/schemas/ApiAccessRule' description: Information about the API access rule. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object CreateCaRequest: additionalProperties: false properties: CaPem: - description: 'The CA in PEM format.
With OSC CLI, use the following - syntax to make sure your CA file is correctly parsed: `--CaPem="$(cat - FILENAME)"`.' + description: 'The CA in PEM format.
With OSC CLI, use the following syntax to make sure your CA file is correctly parsed: `--CaPem="$(cat FILENAME)"`.' type: string Description: description: The description of the CA. type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean required: - CaPem @@ -790,10 +776,10 @@ components: additionalProperties: false properties: Ca: - "$ref": "#/components/schemas/Ca" + $ref: '#/components/schemas/Ca' description: Information about the Client Certificate Authority (CA). ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object CreateClientGatewayRequest: @@ -806,12 +792,10 @@ components: If you do not have an ASN, you can choose one between `64512` and `65534` (both included), or between `4200000000` and `4294967295` (both included). type: integer ConnectionType: - description: The communication protocol used to establish tunnel with your - client gateway (always `ipsec.1`). + description: The communication protocol used to establish tunnel with your client gateway (always `ipsec.1`). type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean PublicIp: description: The public fixed IPv4 address of your client gateway. @@ -825,22 +809,20 @@ components: additionalProperties: false properties: ClientGateway: - "$ref": "#/components/schemas/ClientGateway" + $ref: '#/components/schemas/ClientGateway' description: Information about the client gateway. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object CreateDedicatedGroupRequest: additionalProperties: false properties: CpuGeneration: - description: The processor generation for the VMs in the dedicated group - (for example, `4`). + description: The processor generation for the VMs in the dedicated group (for example, `4`). type: integer DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Name: description: A name for the dedicated group. @@ -857,44 +839,33 @@ components: additionalProperties: false properties: DedicatedGroup: - "$ref": "#/components/schemas/DedicatedGroup" + $ref: '#/components/schemas/DedicatedGroup' description: Information about the dedicated group. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object CreateDhcpOptionsRequest: additionalProperties: false properties: DomainName: - description: 'Specify a domain name (for example, `MyCompany.com`). You - can specify only one domain name. You must specify at least one of the - following parameters: `DomainName`, `DomainNameServers`, `LogServers`, - or `NtpServers`.' + description: 'Specify a domain name (for example, `MyCompany.com`). You can specify only one domain name. You must specify at least one of the following parameters: `DomainName`, `DomainNameServers`, `LogServers`, or `NtpServers`.' type: string DomainNameServers: - description: 'The IPs of domain name servers. If no IPs are specified, the - `OutscaleProvidedDNS` value is set by default. You must specify at least - one of the following parameters: `DomainName`, `DomainNameServers`, `LogServers`, - or `NtpServers`.' + description: 'The IPs of domain name servers. If no IPs are specified, the `OutscaleProvidedDNS` value is set by default. You must specify at least one of the following parameters: `DomainName`, `DomainNameServers`, `LogServers`, or `NtpServers`.' items: type: string type: array DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean LogServers: - description: 'The IPs of the log servers. You must specify at least one - of the following parameters: `DomainName`, `DomainNameServers`, `LogServers`, - or `NtpServers`.' + description: 'The IPs of the log servers. You must specify at least one of the following parameters: `DomainName`, `DomainNameServers`, `LogServers`, or `NtpServers`.' items: type: string type: array NtpServers: - description: 'The IPs of the Network Time Protocol (NTP) servers. You must - specify at least one of the following parameters: `DomainName`, `DomainNameServers`, - `LogServers`, or `NtpServers`.' + description: 'The IPs of the Network Time Protocol (NTP) servers. You must specify at least one of the following parameters: `DomainName`, `DomainNameServers`, `LogServers`, or `NtpServers`.' items: type: string type: array @@ -903,25 +874,23 @@ components: additionalProperties: false properties: DhcpOptionsSet: - "$ref": "#/components/schemas/DhcpOptionsSet" + $ref: '#/components/schemas/DhcpOptionsSet' description: Information about the DHCP options set. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object CreateDirectLinkInterfaceRequest: additionalProperties: false properties: DirectLinkId: - description: The ID of the existing DirectLink for which you want to create - the DirectLink interface. + description: The ID of the existing DirectLink for which you want to create the DirectLink interface. type: string DirectLinkInterface: - "$ref": "#/components/schemas/DirectLinkInterface" + $ref: '#/components/schemas/DirectLinkInterface' description: Information about the DirectLink interface. DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean required: - DirectLinkId @@ -931,10 +900,10 @@ components: additionalProperties: false properties: DirectLinkInterface: - "$ref": "#/components/schemas/DirectLinkInterfaces" + $ref: '#/components/schemas/DirectLinkInterfaces' description: Information about the DirectLink interfaces. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object CreateDirectLinkRequest: @@ -947,12 +916,10 @@ components: description: The name of the DirectLink. type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Location: - description: The code of the requested location for the DirectLink, returned - by the [ReadLocations](#readlocations) method. + description: The code of the requested location for the DirectLink, returned by the [ReadLocations](#readlocations) method. type: string required: - Bandwidth @@ -963,10 +930,10 @@ components: additionalProperties: false properties: DirectLink: - "$ref": "#/components/schemas/DirectLink" + $ref: '#/components/schemas/DirectLink' description: Information about the DirectLink. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object CreateFlexibleGpuRequest: @@ -977,18 +944,13 @@ components: description: If true, the fGPU is deleted when the VM is terminated. type: boolean DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Generation: - description: The processor generation that the fGPU must be compatible with. - If not specified, the oldest possible processor generation is selected - (as provided by [ReadFlexibleGpuCatalog](#readflexiblegpucatalog) for - the specified model of fGPU). + description: The processor generation that the fGPU must be compatible with. If not specified, the oldest possible processor generation is selected (as provided by [ReadFlexibleGpuCatalog](#readflexiblegpucatalog) for the specified model of fGPU). type: string ModelName: - description: The model of fGPU you want to allocate. For more information, - see [About Flexible GPUs](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html). + description: The model of fGPU you want to allocate. For more information, see [About Flexible GPUs](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html). type: string SubregionName: description: The Subregion in which you want to create the fGPU. @@ -1001,24 +963,23 @@ components: additionalProperties: false properties: FlexibleGpu: - "$ref": "#/components/schemas/FlexibleGpu" + $ref: '#/components/schemas/FlexibleGpu' description: Information about the flexible GPU (fGPU). ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object CreateImageExportTaskRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean ImageId: description: The ID of the OMI to export. type: string OsuExport: - "$ref": "#/components/schemas/OsuExportToCreate" + $ref: '#/components/schemas/OsuExportToCreate' description: Information about the OOS export task to create. required: - OsuExport @@ -1028,41 +989,36 @@ components: additionalProperties: false properties: ImageExportTask: - "$ref": "#/components/schemas/ImageExportTask" + $ref: '#/components/schemas/ImageExportTask' description: Information about the OMI export task. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object CreateImageRequest: additionalProperties: false properties: Architecture: - description: "**When registering from a snapshot:** The architecture of - the OMI (`i386` or `x86_64`)." + description: '**When registering from a snapshot:** The architecture of the OMI (`i386` or `x86_64`). By default, set to `x86_64`.' type: string BlockDeviceMappings: - description: "**(required) When registering from a snapshot:** One or more - block device mappings." + description: '**(required) When registering from a snapshot:** One or more block device mappings.' items: - "$ref": "#/components/schemas/BlockDeviceMappingImage" + $ref: '#/components/schemas/BlockDeviceMappingImage' type: array BootModes: description: The boot modes compatible with the OMI. items: - "$ref": "#/components/schemas/BootMode" + $ref: '#/components/schemas/BootMode' type: array Description: description: A description for the new OMI. type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean FileLocation: - description: "**(required) When registering from a bucket by using a manifest - file:** The pre-signed URL of the manifest file for the OMI you want to - register. For more information, see [Creating a Pre-signed URL](https://docs.outscale.com/en/userguide/Creating-a-Pre-Signed-URL.html)." + description: '**(required) When registering from a bucket by using a manifest file:** The pre-signed URL of the manifest file for the OMI you want to register. For more information, see [Creating a Pre-signed URL](https://docs.outscale.com/en/userguide/Creating-a-Pre-Signed-URL.html).' type: string ImageName: description: |- @@ -1070,8 +1026,7 @@ components: Constraints: 3-128 alphanumeric characters, underscores (`_`), spaces (` `), parentheses (`()`), slashes (`/`), periods (`.`), or dashes (`-`). type: string NoReboot: - description: "**When creating from a VM:** If false, the VM shuts down before - creating the OMI and then reboots. If true, the VM does not." + description: '**When creating from a VM:** If false, the VM shuts down before creating the OMI and then reboots. If true, the VM does not.' type: boolean ProductCodes: description: The product codes associated with the OMI. @@ -1079,69 +1034,59 @@ components: type: string type: array RootDeviceName: - description: "**(required) When registering from a snapshot:** The name - of the root device for the new OMI." + description: '**(required) When registering from a snapshot:** The name of the root device for the new OMI.' type: string SourceImageId: - description: "**(required) When copying an OMI:** The ID of the OMI you - want to copy." + description: '**(required) When copying an OMI:** The ID of the OMI you want to copy.' type: string SourceRegionName: - description: "**(required) When copying an OMI:** The name of the source - Region (always the same as the Region of your account)." + description: '**(required) When copying an OMI:** The name of the source Region (always the same as the Region of your account).' type: string TpmMandatory: - description: By default or if set to false, a virtual Trusted Platform Module - (vTPM) is not mandatory on VMs created from this OMI. If true, VMs created - from this OMI must have a vTPM enabled. + description: By default or if set to false, a virtual Trusted Platform Module (vTPM) is not mandatory on VMs created from this OMI. If true, VMs created from this OMI must have a vTPM enabled. type: boolean VmId: - description: "**(required) When creating from a VM:** The ID of the VM from - which you want to create the OMI." + description: '**(required) When creating from a VM:** The ID of the VM from which you want to create the OMI.' type: string type: object CreateImageResponse: additionalProperties: false properties: Image: - "$ref": "#/components/schemas/Image" + $ref: '#/components/schemas/Image' description: Information about the OMI. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object CreateInternetServiceRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean type: object CreateInternetServiceResponse: additionalProperties: false properties: InternetService: - "$ref": "#/components/schemas/InternetService" + $ref: '#/components/schemas/InternetService' description: Information about the internet service. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object CreateKeypairRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean KeypairName: - description: A unique name for the keypair, with a maximum length of 255 - [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#Printable_characters). + description: A unique name for the keypair, with a maximum length of 255 [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#Printable_characters). type: string PublicKey: - description: The public key to import in your account, if you are importing - an existing keypair. This value must be Base64-encoded. + description: The public key to import in your account, if you are importing an existing keypair. This value must be Base64-encoded. type: string required: - KeypairName @@ -1150,24 +1095,23 @@ components: additionalProperties: false properties: Keypair: - "$ref": "#/components/schemas/KeypairCreated" + $ref: '#/components/schemas/KeypairCreated' description: Information about the created keypair. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object CreateListenerRuleRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Listener: - "$ref": "#/components/schemas/LoadBalancerLight" + $ref: '#/components/schemas/LoadBalancerLight' description: Information about the load balancer. ListenerRule: - "$ref": "#/components/schemas/ListenerRuleForCreation" + $ref: '#/components/schemas/ListenerRuleForCreation' description: Information about the listener rule. VmIds: description: The IDs of the backend VMs. @@ -1183,27 +1127,25 @@ components: additionalProperties: false properties: ListenerRule: - "$ref": "#/components/schemas/ListenerRule" + $ref: '#/components/schemas/ListenerRule' description: Information about the listener rule. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object CreateLoadBalancerListenersRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Listeners: description: One or more listeners for the load balancer. items: - "$ref": "#/components/schemas/ListenerForCreation" + $ref: '#/components/schemas/ListenerForCreation' type: array LoadBalancerName: - description: The name of the load balancer for which you want to create - listeners. + description: The name of the load balancer for which you want to create listeners. type: string required: - Listeners @@ -1213,40 +1155,33 @@ components: additionalProperties: false properties: LoadBalancer: - "$ref": "#/components/schemas/LoadBalancer" + $ref: '#/components/schemas/LoadBalancer' description: Information about the load balancer. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object CreateLoadBalancerPolicyRequest: additionalProperties: false properties: CookieExpirationPeriod: - description: The lifetime of the cookie, in seconds. If not specified, the - default value of this parameter is `1`, which means that the sticky session - lasts for the duration of the browser session. + description: The lifetime of the cookie, in seconds. If not specified, the default value of this parameter is `1`, which means that the sticky session lasts for the duration of the browser session. type: integer CookieName: - description: The name of the application cookie used for stickiness. This - parameter is required if you create a stickiness policy based on an application-generated - cookie. + description: The name of the application cookie used for stickiness, between 1 and 255 characters. This parameter is required if you create a stickiness policy based on an application-generated cookie. + maxLength: 255 type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean LoadBalancerName: - description: The name of the load balancer for which you want to create - a policy. + description: The name of the load balancer for which you want to create a policy. type: string PolicyName: - description: The unique name of the policy, with a maximum length of 32 - alphanumeric characters and dashes (`-`). + description: The unique name of the policy, with a maximum length of 32 alphanumeric characters and dashes (`-`). type: string PolicyType: - description: 'The type of stickiness policy you want to create: `app` or - `load_balancer`.' + description: 'The type of stickiness policy you want to create: `app` or `load_balancer`.' type: string required: - PolicyType @@ -1257,64 +1192,51 @@ components: additionalProperties: false properties: LoadBalancer: - "$ref": "#/components/schemas/LoadBalancer" + $ref: '#/components/schemas/LoadBalancer' description: Information about the load balancer. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object CreateLoadBalancerRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Listeners: description: One or more listeners to create. items: - "$ref": "#/components/schemas/ListenerForCreation" + $ref: '#/components/schemas/ListenerForCreation' type: array LoadBalancerName: - description: The unique name of the load balancer, with a maximum length - of 32 alphanumeric characters and dashes (`-`). This name must not start - or end with a dash. + description: The unique name of the load balancer, with a maximum length of 32 alphanumeric characters and dashes (`-`). This name must not start or end with a dash. type: string LoadBalancerType: - description: 'The type of load balancer: `internet-facing` or `internal`. - Use this parameter only for load balancers in a Net.' + description: 'The type of load balancer: `internet-facing` or `internal`. Use this parameter only for load balancers in a Net.' type: string PublicIp: - description: "(internet-facing only) The public IP you want to associate - with the load balancer. If not specified, a public IP owned by 3DS OUTSCALE - is associated." + description: (internet-facing only) The public IP you want to associate with the load balancer. If not specified, a public IP owned by 3DS OUTSCALE is associated. type: string SecurityGroups: - description: "(Net only) One or more IDs of security groups you want to - assign to the load balancer. If not specified, the default security group - of the Net is assigned to the load balancer." + description: (Net only) One or more IDs of security groups you want to assign to the load balancer. If not specified, the default security group of the Net is assigned to the load balancer. items: type: string type: array Subnets: - description: "(Net only) The ID of the Subnet in which you want to create - the load balancer. Regardless of this Subnet, the load balancer can distribute - traffic to all Subnets. This parameter is required in a Net." + description: (Net only) The ID of the Subnet in which you want to create the load balancer. Regardless of this Subnet, the load balancer can distribute traffic to all Subnets. This parameter is required in a Net. items: type: string type: array SubregionNames: - description: "(public Cloud only) The Subregion in which you want to create - the load balancer. Regardless of this Subregion, the load balancer can - distribute traffic to all Subregions. This parameter is required in the - public Cloud." + description: (public Cloud only) The Subregion in which you want to create the load balancer. Regardless of this Subregion, the load balancer can distribute traffic to all Subregions. This parameter is required in the public Cloud. items: type: string type: array Tags: description: One or more tags assigned to the load balancer. items: - "$ref": "#/components/schemas/ResourceTag" + $ref: '#/components/schemas/ResourceTag' type: array required: - Listeners @@ -1324,18 +1246,17 @@ components: additionalProperties: false properties: LoadBalancer: - "$ref": "#/components/schemas/LoadBalancer" + $ref: '#/components/schemas/LoadBalancer' description: Information about the load balancer. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object CreateLoadBalancerTagsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean LoadBalancerNames: description: One or more load balancer names. @@ -1345,7 +1266,7 @@ components: Tags: description: One or more tags to add to the specified load balancers. items: - "$ref": "#/components/schemas/ResourceTag" + $ref: '#/components/schemas/ResourceTag' type: array required: - LoadBalancerNames @@ -1355,7 +1276,7 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object CreateNatServiceRequest: @@ -1365,8 +1286,7 @@ components: description: A unique identifier which enables you to manage the idempotency. type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean PublicIpId: description: |- @@ -1384,18 +1304,17 @@ components: additionalProperties: false properties: NatService: - "$ref": "#/components/schemas/NatService" + $ref: '#/components/schemas/NatService' description: Information about the NAT service. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object CreateNetAccessPointRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean NetId: description: The ID of the Net. @@ -1416,10 +1335,10 @@ components: additionalProperties: false properties: NetAccessPoint: - "$ref": "#/components/schemas/NetAccessPoint" + $ref: '#/components/schemas/NetAccessPoint' description: Information about the Net access point. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object CreateNetPeeringRequest: @@ -1436,8 +1355,7 @@ components: This parameter is required if the Net you want to connect with does not belong to you. type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean SourceNetId: description: The ID of the Net you send the peering request from. @@ -1450,18 +1368,17 @@ components: additionalProperties: false properties: NetPeering: - "$ref": "#/components/schemas/NetPeering" + $ref: '#/components/schemas/NetPeering' description: Information about the Net peering. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object CreateNetRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean IpRange: description: The IP range for the Net, in CIDR notation (for example, `10.0.0.0/16`). @@ -1480,10 +1397,10 @@ components: additionalProperties: false properties: Net: - "$ref": "#/components/schemas/Net" + $ref: '#/components/schemas/Net' description: Information about the Net. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object CreateNicRequest: @@ -1493,8 +1410,7 @@ components: description: A description for the NIC. type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean PrivateIps: description: |- @@ -1502,7 +1418,7 @@ components: This IP must be within the IP range of the Subnet that you specify with the `SubnetId` attribute.
If you do not specify this attribute, a random private IP is selected within the IP range of the Subnet. items: - "$ref": "#/components/schemas/PrivateIpLight" + $ref: '#/components/schemas/PrivateIpLight' type: array SecurityGroupIds: description: One or more IDs of security groups for the NIC. @@ -1519,10 +1435,10 @@ components: additionalProperties: false properties: Nic: - "$ref": "#/components/schemas/Nic" + $ref: '#/components/schemas/Nic' description: Information about the NIC. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object CreatePolicyRequest: @@ -1532,14 +1448,10 @@ components: description: A description for the policy. type: string Document: - description: The policy document, corresponding to a JSON string that contains - the policy. This policy document can contain a maximum of 5120 non-whitespace - characters. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html) - and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html). + description: The policy document, corresponding to a JSON string that contains the policy. This policy document can contain a maximum of 5120 non-whitespace characters. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html) and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html). type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Path: description: The path of the policy. @@ -1555,29 +1467,24 @@ components: additionalProperties: false properties: Policy: - "$ref": "#/components/schemas/Policy" + $ref: '#/components/schemas/Policy' description: Information about the policy. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object CreatePolicyVersionRequest: additionalProperties: false properties: Document: - description: The policy document, corresponding to a JSON string that contains - the policy. This policy document can contain a maximum of 5120 non-whitespace - characters. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html) - and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html). + description: The policy document, corresponding to a JSON string that contains the policy. This policy document can contain a maximum of 5120 non-whitespace characters. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html) and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html). type: string PolicyOrn: - description: The OUTSCALE Resource Name (ORN) of the policy. For more information, - see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). - pattern: "^orn:ows:(iam|idauth):\\S*:\\d{12}:policy/\\S+$" + description: The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + pattern: ^orn:ows:(iam|idauth):\S*:\d{12}:policy/\S+$ type: string SetAsDefault: - description: If set to true, the new policy version is set as the default - version and becomes the operative one. + description: If set to true, the new policy version is set as the default version and becomes the operative one. type: boolean required: - Document @@ -1587,10 +1494,10 @@ components: additionalProperties: false properties: PolicyVersion: - "$ref": "#/components/schemas/PolicyVersion" + $ref: '#/components/schemas/PolicyVersion' description: Information about the policy version. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object CreateProductTypeRequest: @@ -1600,8 +1507,7 @@ components: description: The description of the product type. type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Vendor: description: The vendor of the product type. @@ -1613,44 +1519,40 @@ components: additionalProperties: false properties: ProductType: - "$ref": "#/components/schemas/ProductType" + $ref: '#/components/schemas/ProductType' description: Information about the product type. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object CreatePublicIpRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean type: object CreatePublicIpResponse: additionalProperties: false properties: PublicIp: - "$ref": "#/components/schemas/PublicIp" + $ref: '#/components/schemas/PublicIp' description: Information about the public IP. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object CreateRouteRequest: additionalProperties: false properties: DestinationIpRange: - description: The IP range used for the destination match, in CIDR notation - (for example, `10.0.0.0/24`). + description: The IP range used for the destination match, in CIDR notation (for example, `10.0.0.0/24`). type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean GatewayId: - description: The ID of an internet service or virtual gateway attached to - your Net. + description: The ID of an internet service or virtual gateway attached to your Net. type: string NatServiceId: description: The ID of a NAT service. @@ -1675,18 +1577,17 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. RouteTable: - "$ref": "#/components/schemas/RouteTable" + $ref: '#/components/schemas/RouteTable' description: Information about the route table. type: object CreateRouteTableRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean NetId: description: The ID of the Net for which you want to create a route table. @@ -1698,10 +1599,10 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. RouteTable: - "$ref": "#/components/schemas/RouteTable" + $ref: '#/components/schemas/RouteTable' description: Information about the route table. type: object CreateSecurityGroupRequest: @@ -1713,8 +1614,7 @@ components: This description can contain between 1 and 255 characters. Allowed characters are `a-z`, `A-Z`, `0-9`, accented letters, spaces, and `_.-:/()#,@[]+=&;{}!$*`. type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean NetId: description: The ID of the Net for the security group. @@ -1733,64 +1633,46 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. SecurityGroup: - "$ref": "#/components/schemas/SecurityGroup" + $ref: '#/components/schemas/SecurityGroup' description: Information about the security group. type: object CreateSecurityGroupRuleRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Flow: - description: 'The direction of the flow: `Inbound` or `Outbound`. You can - specify `Outbound` for Nets only.' + description: 'The direction of the flow: `Inbound` or `Outbound`. You can specify `Outbound` for Nets only.' type: string FromPortRange: - description: The beginning of the port range for the TCP and UDP protocols, - or an ICMP type number. If you specify this parameter, you cannot specify - the `Rules` parameter and its subparameters. + description: The beginning of the port range for the TCP and UDP protocols, or an ICMP type number. If you specify this parameter, you cannot specify the `Rules` parameter and its subparameters. type: integer IpProtocol: - description: The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all - protocols). By default, `-1`. In a Net, this can also be an IP protocol - number. For more information, see the [IANA.org website](https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). - If you specify this parameter, you cannot specify the `Rules` parameter - and its subparameters. + description: The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all protocols). By default, `-1`. In a Net, this can also be an IP protocol number. For more information, see the [IANA.org website](https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). If you specify this parameter, you cannot specify the `Rules` parameter and its subparameters. type: string IpRange: - description: The IP range for the security group rule, in CIDR notation - (for example, 10.0.0.0/16). If you specify this parameter, you cannot - specify the `Rules` parameter and its subparameters. + description: The IP range for the security group rule, in CIDR notation (for example, `10.0.0.0/16`). If you specify this parameter, you cannot specify the `Rules` parameter and its subparameters. type: string Rules: - description: 'Information about the security group rule to create. If you - specify this parent parameter and its subparameters, you cannot specify - the following parent parameters: `FromPortRange`, `IpProtocol`, `IpRange`, - and `ToPortRange`.' + description: 'Information about the security group rule to create. If you specify this parent parameter and its subparameters, you cannot specify the following parent parameters: `FromPortRange`, `IpProtocol`, `IpRange`, and `ToPortRange`.' items: - "$ref": "#/components/schemas/SecurityGroupRule" + $ref: '#/components/schemas/SecurityGroupRule' type: array SecurityGroupAccountIdToLink: - description: The account ID that owns the source or destination security - group specified in the `SecurityGroupNameToLink` parameter. + description: The account ID that owns the source or destination security group specified in the `SecurityGroupNameToLink` parameter. type: string SecurityGroupId: - description: The ID of the security group for which you want to create a - rule. + description: The ID of the security group for which you want to create a rule. type: string SecurityGroupNameToLink: - description: The ID of a source or destination security group that you want - to link to the security group of the rule. + description: The ID of a source or destination security group that you want to link to the security group of the rule. type: string ToPortRange: - description: The end of the port range for the TCP and UDP protocols, or - an ICMP code number. If you specify this parameter, you cannot specify - the `Rules` parameter and its subparameters. + description: The end of the port range for the TCP and UDP protocols, or an ICMP code number. If you specify this parameter, you cannot specify the `Rules` parameter and its subparameters. type: integer required: - SecurityGroupId @@ -1800,42 +1682,32 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. SecurityGroup: - "$ref": "#/components/schemas/SecurityGroup" + $ref: '#/components/schemas/SecurityGroup' description: Information about the security group. type: object CreateServerCertificateRequest: additionalProperties: false properties: Body: - description: 'The PEM-encoded X509 certificate.
With OSC CLI, use the - following syntax to make sure your certificate file is correctly parsed: - `--Body="$(cat FILENAME)"`.' + description: 'The PEM-encoded X509 certificate.
With OSC CLI, use the following syntax to make sure your certificate file is correctly parsed: `--Body="$(cat FILENAME)"`.' type: string Chain: - description: 'The PEM-encoded intermediate certification authorities.
With OSC CLI, use the following syntax to make sure your certificate - chain file is correctly parsed: `--Chain="$(cat FILENAME)"`.' + description: 'The PEM-encoded intermediate certification authorities.
With OSC CLI, use the following syntax to make sure your certificate chain file is correctly parsed: `--Chain="$(cat FILENAME)"`.' type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Name: - description: 'A unique name for the certificate. Constraints: 1-128 alphanumeric - characters, pluses (`+`), equals (`=`), commas (`,`), periods (`.`), at - signs (`@`), minuses (`-`), or underscores (`_`).' + description: 'A unique name for the certificate. Constraints: 1-128 alphanumeric characters, pluses (`+`), equals (`=`), commas (`,`), periods (`.`), at signs (`@`), minuses (`-`), or underscores (`_`).' type: string Path: - description: The path to the server certificate, set to a slash (`/`) if - not specified. + description: The path to the server certificate, set to a slash (`/`) if not specified. type: string PrivateKey: - description: 'The PEM-encoded private key matching the certificate.
With - OSC CLI, use the following syntax to make sure your key file is correctly - parsed: `--PrivateKey="$(cat FILENAME)"`.' + description: 'The PEM-encoded private key matching the certificate.
With OSC CLI, use the following syntax to make sure your key file is correctly parsed: `--PrivateKey="$(cat FILENAME)"`.' type: string required: - Body @@ -1846,21 +1718,20 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. ServerCertificate: - "$ref": "#/components/schemas/ServerCertificate" + $ref: '#/components/schemas/ServerCertificate' description: Information about the server certificate. type: object CreateSnapshotExportTaskRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean OsuExport: - "$ref": "#/components/schemas/OsuExportToCreate" + $ref: '#/components/schemas/OsuExportToCreate' description: Information about the OOS export task to create. SnapshotId: description: The ID of the snapshot to export. @@ -1873,10 +1744,10 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. SnapshotExportTask: - "$ref": "#/components/schemas/SnapshotExportTask" + $ref: '#/components/schemas/SnapshotExportTask' description: Information about the snapshot export task. type: object CreateSnapshotRequest: @@ -1889,49 +1760,40 @@ components: description: A description for the snapshot. type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean FileLocation: - description: "**(when importing from a bucket)** The pre-signed URL of the - snapshot you want to import. For more information, see [Creating a Pre-signed - URL](https://docs.outscale.com/en/userguide/Creating-a-Pre-Signed-URL.html)." + description: '**(when importing from a bucket)** The pre-signed URL of the snapshot you want to import. For more information, see [Creating a Pre-signed URL](https://docs.outscale.com/en/userguide/Creating-a-Pre-Signed-URL.html).' type: string SnapshotSize: - description: "**(when importing from a bucket)** The size of the snapshot - you want to create in your account, in bytes. This size must be greater - than or equal to the size of the original, uncompressed snapshot." + description: '**(when importing from a bucket)** The size of the snapshot you want to create in your account, in bytes. This size must be greater than or equal to the size of the original, uncompressed snapshot.' format: int64 type: integer SourceRegionName: - description: "**(when copying a snapshot)** The name of the source Region, - which must be the same as the Region of your account." + description: '**(when copying a snapshot)** The name of the source Region, which must be the same as the Region of your account.' type: string SourceSnapshotId: - description: "**(when copying a snapshot)** The ID of the snapshot you want - to copy." + description: '**(when copying a snapshot)** The ID of the snapshot you want to copy.' type: string VolumeId: - description: "**(when creating from a volume)** The ID of the volume you - want to create a snapshot of." + description: '**(when creating from a volume)** The ID of the volume you want to create a snapshot of.' type: string type: object CreateSnapshotResponse: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. Snapshot: - "$ref": "#/components/schemas/Snapshot" + $ref: '#/components/schemas/Snapshot' description: Information about the snapshot. type: object CreateSubnetRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean IpRange: description: |- @@ -1952,18 +1814,17 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. Subnet: - "$ref": "#/components/schemas/Subnet" + $ref: '#/components/schemas/Subnet' description: Information about the Subnet. type: object CreateTagsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean ResourceIds: description: One or more resource IDs. @@ -1973,7 +1834,7 @@ components: Tags: description: One or more tags to add to the specified resources. items: - "$ref": "#/components/schemas/ResourceTag" + $ref: '#/components/schemas/ResourceTag' type: array required: - ResourceIds @@ -1983,19 +1844,17 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object CreateUserGroupRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Path: - description: The path to the group. If not specified, it is set to a slash - (`/`). + description: The path to the group. If not specified, it is set to a slash (`/`). type: string UserGroupName: description: The name of the group. @@ -2007,32 +1866,26 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. UserGroup: - "$ref": "#/components/schemas/UserGroup" + $ref: '#/components/schemas/UserGroup' description: Information about the user group. type: object CreateUserRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Path: - description: The path to the EIM user you want to create (by default, `/`). - This path name must begin and end with a slash (`/`), and contain between - 1 and 512 alphanumeric characters and/or slashes (`/`), or underscores - (`_`). + description: The path to the EIM user you want to create (by default, `/`). This path name must begin and end with a slash (`/`), and contain between 1 and 512 alphanumeric characters and/or slashes (`/`), or underscores (`_`). type: string UserEmail: description: The email address of the EIM user. type: string UserName: - description: The name of the EIM user. This user name must contain between - 1 and 64 alphanumeric characters and/or pluses (`+`), equals (`=`), commas - (`,`), periods (`.`), at signs (`@`), dashes (`-`), or underscores (`_`). + description: The name of the EIM user. This user name must contain between 1 and 64 alphanumeric characters and/or pluses (`+`), equals (`=`), commas (`,`), periods (`.`), at signs (`@`), dashes (`-`), or underscores (`_`). type: string required: - UserName @@ -2041,22 +1894,20 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. User: - "$ref": "#/components/schemas/User" + $ref: '#/components/schemas/User' description: Information about the EIM user. type: object CreateVirtualGatewayRequest: additionalProperties: false properties: ConnectionType: - description: The type of VPN connection supported by the virtual gateway - (always `ipsec.1`). + description: The type of VPN connection supported by the virtual gateway (always `ipsec.1`). type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean required: - ConnectionType @@ -2065,10 +1916,10 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. VirtualGateway: - "$ref": "#/components/schemas/VirtualGateway" + $ref: '#/components/schemas/VirtualGateway' description: Information about the virtual gateway. type: object CreateVmGroupRequest: @@ -2078,16 +1929,11 @@ components: description: A description for the VM group. type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean PositioningStrategy: default: no-strategy - description: The positioning strategy of VMs on hypervisors. If set to `no-strategy`, - our orchestrator determines the most adequate position for your VMs. If - set to `attract`, your VMs are deployed on the same hypervisor, which - improves network performance. If set to `repulse`, your VMs are deployed - on a different hypervisor, which improves fault tolerance. + description: The positioning strategy of VMs on hypervisors. If set to `no-strategy`, our orchestrator determines the most adequate position for your VMs. If set to `attract`, your VMs are deployed on the same hypervisor, which improves network performance. If set to `repulse`, your VMs are deployed on a different hypervisor, which improves fault tolerance. enum: - attract - no-strategy @@ -2104,7 +1950,7 @@ components: Tags: description: One or more tags to add to the VM group. items: - "$ref": "#/components/schemas/ResourceTag" + $ref: '#/components/schemas/ResourceTag' type: array VmCount: description: The number of VMs deployed in the VM group. @@ -2126,10 +1972,10 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. VmGroup: - "$ref": "#/components/schemas/VmGroup" + $ref: '#/components/schemas/VmGroup' description: Information about the VM group. type: object CreateVmTemplateRequest: @@ -2153,12 +1999,10 @@ components: description: A description for the VM template. type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean ImageId: - description: The ID of the OMI to use for each VM. You can find a list of - OMIs by calling the [ReadImages](#readimages) method. + description: The ID of the OMI to use for each VM. You can find a list of OMIs by calling the [ReadImages](#readimages) method. type: string KeypairName: description: The name of the keypair to use for each VM. @@ -2169,7 +2013,7 @@ components: Tags: description: One or more tags to add to the VM template. items: - "$ref": "#/components/schemas/ResourceTag" + $ref: '#/components/schemas/ResourceTag' type: array VmTemplateName: description: The name of the VM template. @@ -2185,86 +2029,73 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. VmTemplate: - "$ref": "#/components/schemas/VmTemplate" + $ref: '#/components/schemas/VmTemplate' description: Information about the VM template. type: object CreateVmsRequest: additionalProperties: false properties: ActionsOnNextBoot: - "$ref": "#/components/schemas/ActionsOnNextBoot" + $ref: '#/components/schemas/ActionsOnNextBoot' description: The action to perform on the next boot of the VM. BlockDeviceMappings: description: One or more block device mappings. items: - "$ref": "#/components/schemas/BlockDeviceMappingVmCreation" + $ref: '#/components/schemas/BlockDeviceMappingVmCreation' type: array BootMode: - "$ref": "#/components/schemas/BootMode" + $ref: '#/components/schemas/BootMode' description: The boot mode of the VM. BootOnCreation: default: true - description: If true, the VM is started on creation. If false, the VM is - stopped on creation. + description: If true, the VM is started on creation. If false, the VM is stopped on creation. type: boolean BsuOptimized: - description: This parameter is not available. It is present in our API for - the sake of historical compatibility with AWS. + description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS. type: boolean ClientToken: description: A unique identifier which enables you to manage the idempotency. type: string DeletionProtection: - description: If true, you cannot delete the VM unless you change this parameter - back to false. + description: If true, you cannot delete the VM unless you change this parameter back to false. type: boolean DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean ImageId: - description: The ID of the OMI used to create the VM. You can find the list - of OMIs by calling the [ReadImages](#readimages) method. + description: The ID of the OMI used to create the VM. You can find the list of OMIs by calling the [ReadImages](#readimages) method. type: string KeypairName: description: The name of the keypair. type: string MaxVmsCount: - description: The maximum number of VMs you want to create. If all the VMs - cannot be created, the largest possible number of VMs above MinVmsCount - is created. + description: The maximum number of VMs you want to create. If all the VMs cannot be created, the largest possible number of VMs above MinVmsCount is created. type: integer MinVmsCount: - description: The minimum number of VMs you want to create. If this number - of VMs cannot be created, no VMs are created. + description: The minimum number of VMs you want to create. If this number of VMs cannot be created, no VMs are created. type: integer NestedVirtualization: default: false - description: "(dedicated tenancy only) If true, nested virtualization is - enabled. If false, it is disabled." + description: (dedicated tenancy only) If true, nested virtualization is enabled. If false, it is disabled. type: boolean Nics: - description: One or more NICs. If you specify this parameter, you must not - specify the `SubnetId` and `SubregionName` parameters. You also must define - one NIC as the primary network interface of the VM with `0` as its device - number. + description: One or more NICs. If you specify this parameter, you must not specify the `SubnetId` and `SubregionName` parameters. You also must define one NIC as the primary network interface of the VM with `0` as its device number. items: - "$ref": "#/components/schemas/NicForVmCreation" + $ref: '#/components/schemas/NicForVmCreation' type: array Performance: default: high - description: The performance of the VM. This parameter is ignored if you - specify a performance flag directly in the `VmType` parameter. + description: The performance of the VM. This parameter is ignored if you specify a performance flag directly in the `VmType` parameter. enum: - medium - high - highest type: string Placement: - "$ref": "#/components/schemas/Placement" + $ref: '#/components/schemas/Placement' description: Information about the placement of the VM. PrivateIps: description: One or more private IPs of the VM. @@ -2282,24 +2113,17 @@ components: type: string type: array SubnetId: - description: The ID of the Subnet in which you want to create the VM. If - you specify this parameter, you must not specify the `Nics` parameter. + description: The ID of the Subnet in which you want to create the VM. If you specify this parameter, you must not specify the `Nics` parameter. type: string TpmEnabled: - description: If true, a virtual Trusted Platform Module (vTPM) is enabled - on the VM. If false, it is not. + description: If true, a virtual Trusted Platform Module (vTPM) is enabled on the VM. If false, it is not. type: boolean UserData: - description: Data or script used to add a specific configuration to the - VM. It must be Base64-encoded and is limited to 500 kibibytes (KiB). For - more information about user data, see [Configuring a VM with User Data - and OUTSCALE Tags](https://docs.outscale.com/en/userguide/Configuring-a-VM-with-User-Data-and-OUTSCALE-Tags.html). + description: Data or script used to add a specific configuration to the VM. It must be Base64-encoded and is limited to 500 kibibytes (KiB). For more information about user data, see [Configuring a VM with User Data and OUTSCALE Tags](https://docs.outscale.com/en/userguide/Configuring-a-VM-with-User-Data-and-OUTSCALE-Tags.html). type: string VmInitiatedShutdownBehavior: default: stop - description: The VM behavior when you stop it. If set to `stop`, the VM - stops. If set to `restart`, the VM stops then automatically restarts. - If set to `terminate`, the VM stops and is terminated. + description: The VM behavior when you stop it. If set to `stop`, the VM stops. If set to `restart`, the VM stops then automatically restarts. If set to `terminate`, the VM stops and is terminated. type: string VmType: description: |- @@ -2313,12 +2137,12 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. Vms: description: Information about one or more created VMs. items: - "$ref": "#/components/schemas/Vm" + $ref: '#/components/schemas/Vm' type: array type: object CreateVolumeRequest: @@ -2328,19 +2152,13 @@ components: description: A unique identifier which enables you to manage the idempotency. type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Iops: - description: The number of I/O operations per second (IOPS). This parameter - must be specified only if you create an `io1` volume. The maximum number - of IOPS allowed for `io1` volumes is `13000` with a maximum performance - ratio of 300 IOPS per gibibyte. + description: The number of I/O operations per second (IOPS). This parameter must be specified only if you create an `io1` volume. The maximum number of IOPS allowed for `io1` volumes is `13000` with a maximum performance ratio of 300 IOPS per gibibyte. type: integer Size: - description: The size of the volume, in gibibytes (GiB). The maximum allowed - size for a volume is 14901 GiB. This parameter is required if the volume - is not created from a snapshot (`SnapshotId` unspecified). + description: The size of the volume, in gibibytes (GiB). The maximum allowed size for a volume is 14901 GiB. This parameter is required if the volume is not created from a snapshot (`SnapshotId` unspecified). type: integer SnapshotId: description: The ID of the snapshot from which you want to create the volume. @@ -2360,10 +2178,10 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. Volume: - "$ref": "#/components/schemas/Volume" + $ref: '#/components/schemas/Volume' description: Information about the volume. type: object CreateVpnConnectionRequest: @@ -2376,15 +2194,10 @@ components: description: The type of VPN connection (always `ipsec.1`). type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean StaticRoutesOnly: - description: By default or if false, the VPN connection uses dynamic routing - with Border Gateway Protocol (BGP). If true, routing is controlled using - static routes. For more information about how to create and delete static - routes, see [CreateVpnConnectionRoute](#createvpnconnectionroute) and - [DeleteVpnConnectionRoute](#deletevpnconnectionroute). + description: By default or if false, the VPN connection uses dynamic routing with Border Gateway Protocol (BGP). If true, routing is controlled using static routes. For more information about how to create and delete static routes, see [CreateVpnConnectionRoute](#createvpnconnectionroute) and [DeleteVpnConnectionRoute](#deletevpnconnectionroute). type: boolean VirtualGatewayId: description: The ID of the virtual gateway. @@ -2398,22 +2211,20 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. VpnConnection: - "$ref": "#/components/schemas/VpnConnection" + $ref: '#/components/schemas/VpnConnection' description: Information about a VPN connection. type: object CreateVpnConnectionRouteRequest: additionalProperties: false properties: DestinationIpRange: - description: The network prefix of the route, in CIDR notation (for example, - `10.12.0.0/16`). + description: The network prefix of the route, in CIDR notation (for example, `10.12.0.0/16`). type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean VpnConnectionId: description: The ID of the target VPN connection of the static route. @@ -2426,7 +2237,7 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DedicatedGroup: @@ -2466,13 +2277,10 @@ components: description: The ID of the access key you want to delete. type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean UserName: - description: The name of the EIM user the access key you want to delete - is associated with. By default, the user who sends the request (which - can be the root account). + description: The name of the EIM user the access key you want to delete is associated with. By default, the user who sends the request (which can be the root account). type: string required: - AccessKeyId @@ -2481,7 +2289,7 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteApiAccessRuleRequest: @@ -2491,8 +2299,7 @@ components: description: The ID of the API access rule you want to delete. type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean required: - ApiAccessRuleId @@ -2501,7 +2308,7 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteCaRequest: @@ -2511,8 +2318,7 @@ components: description: The ID of the CA you want to delete. type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean required: - CaId @@ -2521,7 +2327,7 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteClientGatewayRequest: @@ -2531,8 +2337,7 @@ components: description: The ID of the client gateway you want to delete. type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean required: - ClientGatewayId @@ -2541,7 +2346,7 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteDedicatedGroupRequest: @@ -2551,12 +2356,10 @@ components: description: The ID of the dedicated group you want to delete. type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Force: - description: If true, forces the deletion of the dedicated group and all - its dependencies. + description: If true, forces the deletion of the dedicated group and all its dependencies. type: boolean required: - DedicatedGroupId @@ -2565,7 +2368,7 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteDhcpOptionsRequest: @@ -2575,8 +2378,7 @@ components: description: The ID of the DHCP options set you want to delete. type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean required: - DhcpOptionsSetId @@ -2585,7 +2387,7 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteDirectLinkInterfaceRequest: @@ -2595,8 +2397,7 @@ components: description: The ID of the DirectLink interface you want to delete. type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean required: - DirectLinkInterfaceId @@ -2605,7 +2406,7 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteDirectLinkRequest: @@ -2615,8 +2416,7 @@ components: description: The ID of the DirectLink you want to delete. type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean required: - DirectLinkId @@ -2625,15 +2425,14 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteExportTaskRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean ExportTaskId: description: The ID of the export task to delete. @@ -2645,15 +2444,14 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteFlexibleGpuRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean FlexibleGpuId: description: The ID of the fGPU you want to delete. @@ -2665,15 +2463,14 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteImageRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean ImageId: description: The ID of the OMI you want to delete. @@ -2685,15 +2482,14 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteInternetServiceRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean InternetServiceId: description: The ID of the internet service you want to delete. @@ -2705,15 +2501,14 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteKeypairRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean KeypairId: description: The ID of the keypair you want to delete. @@ -2726,15 +2521,14 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteListenerRuleRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean ListenerRuleName: description: The name of the rule you want to delete. @@ -2746,19 +2540,17 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteLoadBalancerListenersRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean LoadBalancerName: - description: The name of the load balancer for which you want to delete - listeners. + description: The name of the load balancer for which you want to delete listeners. type: string LoadBalancerPorts: description: One or more port numbers of the listeners you want to delete. @@ -2773,22 +2565,20 @@ components: additionalProperties: false properties: LoadBalancer: - "$ref": "#/components/schemas/LoadBalancer" + $ref: '#/components/schemas/LoadBalancer' description: Information about the load balancer. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteLoadBalancerPolicyRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean LoadBalancerName: - description: The name of the load balancer for which you want to delete - a policy. + description: The name of the load balancer for which you want to delete a policy. type: string PolicyName: description: The name of the policy you want to delete. @@ -2801,18 +2591,17 @@ components: additionalProperties: false properties: LoadBalancer: - "$ref": "#/components/schemas/LoadBalancer" + $ref: '#/components/schemas/LoadBalancer' description: Information about the load balancer. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteLoadBalancerRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean LoadBalancerName: description: The name of the load balancer you want to delete. @@ -2824,15 +2613,14 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteLoadBalancerTagsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean LoadBalancerNames: description: One or more load balancer names. @@ -2842,7 +2630,7 @@ components: Tags: description: One or more tags to delete from the load balancers. items: - "$ref": "#/components/schemas/ResourceLoadBalancerTag" + $ref: '#/components/schemas/ResourceLoadBalancerTag' type: array required: - LoadBalancerNames @@ -2852,15 +2640,14 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteNatServiceRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean NatServiceId: description: The ID of the NAT service you want to delete. @@ -2872,15 +2659,14 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteNetAccessPointRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean NetAccessPointId: description: The ID of the Net access point. @@ -2892,15 +2678,14 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteNetPeeringRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean NetPeeringId: description: The ID of the Net peering you want to delete. @@ -2912,15 +2697,14 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteNetRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean NetId: description: The ID of the Net you want to delete. @@ -2932,15 +2716,14 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteNicRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean NicId: description: The ID of the NIC you want to delete. @@ -2952,20 +2735,18 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeletePolicyRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean PolicyOrn: - description: The OUTSCALE Resource Name (ORN) of the policy you want to - delete. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). - pattern: "^orn:ows:(iam|idauth):\\S*:\\d{12}:policy/\\S+$" + description: The OUTSCALE Resource Name (ORN) of the policy you want to delete. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + pattern: ^orn:ows:(iam|idauth):\S*:\d{12}:policy/\S+$ type: string required: - PolicyOrn @@ -2974,16 +2755,15 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeletePolicyVersionRequest: additionalProperties: false properties: PolicyOrn: - description: The OUTSCALE Resource Name (ORN) of the policy. For more information, - see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). - pattern: "^orn:ows:(iam|idauth):\\S*:\\d{12}:policy/\\S+$" + description: The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + pattern: ^orn:ows:(iam|idauth):\S*:\d{12}:policy/\S+$ type: string VersionId: description: The ID of the version of the policy you want to delete. @@ -2996,19 +2776,17 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteProductTypeRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Force: - description: If true, forces the deletion of the product type associated - with one or more OMIs. + description: If true, forces the deletion of the product type associated with one or more OMIs. type: boolean ProductTypeId: description: The ID of the product type you want to delete. @@ -3020,29 +2798,27 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeletePublicIpRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean PublicIp: description: The public IP. In the public Cloud, this parameter is required. type: string PublicIpId: - description: The ID representing the association of the public IP with the - VM or the NIC. In a Net, this parameter is required. + description: The ID representing the association of the public IP with the VM or the NIC. In a Net, this parameter is required. type: string type: object DeletePublicIpResponse: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteRouteRequest: @@ -3052,8 +2828,7 @@ components: description: The exact IP range for the route. type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean RouteTableId: description: The ID of the route table from which you want to delete a route. @@ -3066,18 +2841,17 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. RouteTable: - "$ref": "#/components/schemas/RouteTable" + $ref: '#/components/schemas/RouteTable' description: Information about the route table. type: object DeleteRouteTableRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean RouteTableId: description: The ID of the route table you want to delete. @@ -3089,15 +2863,14 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteSecurityGroupRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean SecurityGroupId: description: The ID of the security group you want to delete. @@ -3110,52 +2883,43 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteSecurityGroupRuleRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Flow: - description: 'The direction of the flow: `Inbound` or `Outbound`. You can - specify `Outbound` for Nets only.' + description: 'The direction of the flow: `Inbound` or `Outbound`. You can specify `Outbound` for Nets only.' type: string FromPortRange: - description: The beginning of the port range for the TCP and UDP protocols, - or an ICMP type number. + description: The beginning of the port range for the TCP and UDP protocols, or an ICMP type number. type: integer IpProtocol: - description: The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all - protocols). By default, `-1`. In a Net, this can also be an IP protocol - number. For more information, see the [IANA.org website](https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). + description: The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all protocols). By default, `-1`. In a Net, this can also be an IP protocol number. For more information, see the [IANA.org website](https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). type: string IpRange: - description: The IP range for the security group rule, in CIDR notation - (for example, `10.0.0.0/16`). + description: The IP range for the security group rule, in CIDR notation (for example, `10.0.0.0/16`). type: string Rules: description: One or more rules you want to delete from the security group. items: - "$ref": "#/components/schemas/SecurityGroupRule" + $ref: '#/components/schemas/SecurityGroupRule' type: array SecurityGroupAccountIdToUnlink: - description: The account ID of the owner of the security group you want - to delete a rule from. + description: The account ID of the owner of the security group you want to delete a rule from. type: string SecurityGroupId: description: The ID of the security group you want to delete a rule from. type: string SecurityGroupNameToUnlink: - description: The ID of the source security group. If you are in the Public - Cloud, you can also specify the name of the source security group. + description: The ID of the source security group. If you are in the Public Cloud, you can also specify the name of the source security group. type: string ToPortRange: - description: The end of the port range for the TCP and UDP protocols, or - an ICMP code number. + description: The end of the port range for the TCP and UDP protocols, or an ICMP code number. type: integer required: - SecurityGroupId @@ -3165,18 +2929,17 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. SecurityGroup: - "$ref": "#/components/schemas/SecurityGroup" + $ref: '#/components/schemas/SecurityGroup' description: Information about the security group. type: object DeleteServerCertificateRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Name: description: The name of the server certificate you want to delete. @@ -3188,15 +2951,14 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteSnapshotRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean SnapshotId: description: The ID of the snapshot you want to delete. @@ -3208,15 +2970,14 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteSubnetRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean SubnetId: description: The ID of the Subnet you want to delete. @@ -3228,15 +2989,14 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteTagsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean ResourceIds: description: One or more resource IDs. @@ -3244,10 +3004,9 @@ components: type: string type: array Tags: - description: One or more tags to delete (if you set a tag value, only the - tags matching exactly this value are deleted). + description: One or more tags to delete (if you set a tag value, only the tags matching exactly this value are deleted). items: - "$ref": "#/components/schemas/ResourceTag" + $ref: '#/components/schemas/ResourceTag' type: array required: - ResourceIds @@ -3257,15 +3016,14 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteUserGroupPolicyRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean PolicyName: description: The name of the policy document you want to delete. @@ -3274,8 +3032,7 @@ components: description: The name of the group. type: string UserGroupPath: - description: The path to the group. If not specified, it is set to a slash - (`/`). + description: The path to the group. If not specified, it is set to a slash (`/`). type: string required: - UserGroupName @@ -3285,23 +3042,20 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteUserGroupRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Force: - description: If true, forces the deletion of the user group even if it is - not empty. + description: If true, forces the deletion of the user group even if it is not empty. type: boolean Path: - description: The path to the group. If not specified, it is set to a slash - (`/`). + description: The path to the group. If not specified, it is set to a slash (`/`). type: string UserGroupName: description: The name of the group you want to delete. @@ -3313,19 +3067,17 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteUserPolicyRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean PolicyName: - description: The name of the policy document you want to delete (between - 1 and 128 characters). + description: The name of the policy document you want to delete (between 1 and 128 characters). type: string UserName: description: The name of the user you want to delete the policy from. @@ -3338,15 +3090,14 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteUserRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean UserName: description: The name of the EIM user you want to delete. @@ -3358,15 +3109,14 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteVirtualGatewayRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean VirtualGatewayId: description: The ID of the virtual gateway you want to delete. @@ -3378,15 +3128,14 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteVmGroupRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean VmGroupId: description: The ID of the VM group you want to delete. @@ -3398,15 +3147,14 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteVmTemplateRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean VmTemplateId: description: The ID of the VM template you want to delete. @@ -3418,15 +3166,14 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteVmsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean VmIds: description: One or more IDs of VMs. @@ -3440,20 +3187,19 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. Vms: description: Information about one or more terminated VMs. items: - "$ref": "#/components/schemas/VmState" + $ref: '#/components/schemas/VmState' type: array type: object DeleteVolumeRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean VolumeId: description: The ID of the volume you want to delete. @@ -3465,15 +3211,14 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteVpnConnectionRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean VpnConnectionId: description: The ID of the VPN connection you want to delete. @@ -3485,23 +3230,20 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeleteVpnConnectionRouteRequest: additionalProperties: false properties: DestinationIpRange: - description: The network prefix of the route to delete, in CIDR notation - (for example, `10.12.0.0/16`). + description: The network prefix of the route to delete, in CIDR notation (for example, `10.12.0.0/16`). type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean VpnConnectionId: - description: The ID of the target VPN connection of the static route to - delete. + description: The ID of the target VPN connection of the static route to delete. type: string required: - DestinationIpRange @@ -3511,7 +3253,7 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DeregisterVmsInLoadBalancerRequest: @@ -3523,8 +3265,7 @@ components: type: string type: array DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean LoadBalancerName: description: The name of the load balancer. @@ -3537,7 +3278,7 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DhcpOptionsSet: @@ -3545,8 +3286,7 @@ components: description: Information about the DHCP options set. properties: Default: - description: If true, the DHCP options set is a default one. If false, it - is not. + description: If true, the DHCP options set is a default one. If false, it is not. type: boolean DhcpOptionsSetId: description: The ID of the DHCP options set. @@ -3572,7 +3312,7 @@ components: Tags: description: One or more tags associated with the DHCP options set. items: - "$ref": "#/components/schemas/ResourceTag" + $ref: '#/components/schemas/ResourceTag' type: array type: object DirectLink: @@ -3633,8 +3373,7 @@ components: description: The ID of the target virtual gateway. type: string Vlan: - description: The VLAN number associated with the DirectLink interface. This - number must be unique and be between `2` and `4094`. + description: The VLAN number associated with the DirectLink interface. This number must be unique and be between `2` and `4094`. type: integer required: - BgpAsn @@ -3650,8 +3389,7 @@ components: description: The account ID of the owner of the DirectLink interface. type: string BgpAsn: - description: The BGP (Border Gateway Protocol) ASN (Autonomous System Number) - on the customer's side of the DirectLink interface. + description: The BGP (Border Gateway Protocol) ASN (Autonomous System Number) on the customer's side of the DirectLink interface. type: integer BgpKey: description: The BGP authentication key. @@ -3675,15 +3413,13 @@ components: description: The datacenter where the DirectLink interface is located. type: string Mtu: - description: The maximum transmission unit (MTU) of the DirectLink interface, - in bytes. + description: The maximum transmission unit (MTU) of the DirectLink interface, in bytes. type: integer OutscalePrivateIp: description: The IP on the OUTSCALE side of the DirectLink interface. type: string State: - description: The state of the DirectLink interface (`pending` \| `available` - \| `deleting` \| `deleted` \| `confirming` \| `rejected` \| `expired`). + description: The state of the DirectLink interface (`pending` \| `available` \| `deleting` \| `deleted` \| `confirming` \| `rejected` \| `expired`). type: string VirtualGatewayId: description: The ID of the target virtual gateway. @@ -3696,27 +3432,24 @@ components: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean type: object DisableOutscaleLoginForUsersResponse: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DisableOutscaleLoginPerUsersRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean UserNames: - description: The usernames of the EIM users you want to disable the Outscale - login for. + description: The usernames of the EIM users you want to disable the Outscale login for. items: type: string type: array @@ -3727,49 +3460,45 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object DisableOutscaleLoginRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean type: object DisableOutscaleLoginResponse: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object EnableOutscaleLoginForUsersRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean type: object EnableOutscaleLoginForUsersResponse: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object EnableOutscaleLoginPerUsersRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean UserNames: - description: The usernames of the EIM users you want to enable the Outscale - login for. + description: The usernames of the EIM users you want to enable the Outscale login for. items: type: string type: array @@ -3780,22 +3509,21 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object EnableOutscaleLoginRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean type: object EnableOutscaleLoginResponse: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ErrorResponse: @@ -3804,10 +3532,10 @@ components: Errors: description: One or more errors. items: - "$ref": "#/components/schemas/Errors" + $ref: '#/components/schemas/Errors' type: array ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object Errors: @@ -3815,9 +3543,7 @@ components: description: Information about the errors. properties: Code: - description: The code of the error (for example, `4078`). You can search - for this returned code in the [errors page](api-errors.html) to find more - details about the error. + description: The code of the error (for example, `4078`). You can search for this returned code in the [errors page](api-errors.html) to find more details about the error. type: string Details: description: A description providing more details about the error. @@ -3881,8 +3607,7 @@ components: type: string type: array QueryApiNames: - description: The names of the APIs of the logged calls (always `oapi` for - the OUTSCALE API). + description: The names of the APIs of the logged calls (always `oapi` for the OUTSCALE API). items: type: string type: array @@ -3892,19 +3617,19 @@ components: type: string type: array QueryDateAfter: - description: The date and time, or the date, after which you want to retrieve - logged calls, in ISO 8601 format (for example, `2020-06-14T00:00:00.000Z` - or `2020-06-14`). By default, this date is set to 48 hours before the - `QueryDateBefore` parameter value. - format: date - type: string + description: The date and time, or the date, after which you want to retrieve logged calls, in ISO 8601 format (for example, `2020-06-14T00:00:00.000Z` or `2020-06-14`). By default, this date is set to 48 hours before the `QueryDateBefore` parameter value. + oneOf: + - format: date-time + type: string + - format: date + type: string QueryDateBefore: - description: The date and time, or the date, before which you want to retrieve - logged calls, in ISO 8601 format (for example, `2020-06-30T00:00:00.000Z` - or `2020-06-14`). By default, this date is set to now, or 48 hours after - the `QueryDateAfter` parameter value. - format: date - type: string + description: The date and time, or the date, before which you want to retrieve logged calls, in ISO 8601 format (for example, `2020-06-30T00:00:00.000Z` or `2020-06-14`). By default, this date is set to now, or 48 hours after the `QueryDateAfter` parameter value. + oneOf: + - format: date-time + type: string + - format: date + type: string QueryIpAddresses: description: The IPs used for the logged calls. items: @@ -3951,19 +3676,14 @@ components: description: One or more filters. properties: CurrentCatalogOnly: - description: By default or if set to true, only returns the current catalog. - If false, returns the current catalog and past catalogs. + description: By default or if set to true, only returns the current catalog. If false, returns the current catalog and past catalogs. type: boolean FromDate: - description: The beginning of the time period, in ISO 8601 date format (for - example, `2020-06-14`). This date cannot be older than 3 years. You must - specify the parameters `FromDate` and `ToDate` together. + description: The beginning of the time period, in ISO 8601 date format (for example, `2020-06-14`). This date cannot be older than 3 years. You must specify the parameters `FromDate` and `ToDate` together. format: date type: string ToDate: - description: The end of the time period, in ISO 8601 date format (for example, - `2020-06-30`). You must specify the parameters `FromDate` and `ToDate` - together. + description: The end of the time period, in ISO 8601 date format (for example, `2020-06-30`). You must specify the parameters `FromDate` and `ToDate` together. format: date type: string type: object @@ -3972,8 +3692,7 @@ components: description: One or more filters. properties: BgpAsns: - description: The Border Gateway Protocol (BGP) Autonomous System Numbers - (ASNs) of the connections. + description: The Border Gateway Protocol (BGP) Autonomous System Numbers (ASNs) of the connections. items: type: integer type: array @@ -3983,8 +3702,7 @@ components: type: string type: array ConnectionTypes: - description: The types of communication tunnels used by the client gateways - (always `ipsec.1`). + description: The types of communication tunnels used by the client gateways (always `ipsec.1`). items: type: string type: array @@ -3994,8 +3712,7 @@ components: type: string type: array States: - description: The states of the client gateways (`pending` \| `available` - \| `deleting` \| `deleted`). + description: The states of the client gateways (`pending` \| `available` \| `deleting` \| `deleted`). items: type: string type: array @@ -4010,8 +3727,7 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the - client gateways, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the client gateways, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -4021,8 +3737,7 @@ components: description: One or more filters. properties: CpuGenerations: - description: The processor generation for the VMs in the dedicated group - (for example, `4`). + description: The processor generation for the VMs in the dedicated group (for example, `4`). items: type: integer type: array @@ -4037,8 +3752,7 @@ components: type: string type: array SubregionNames: - description: The names of the Subregions in which the dedicated groups are - located. + description: The names of the Subregions in which the dedicated groups are located. items: type: string type: array @@ -4048,8 +3762,7 @@ components: description: One or more filters. properties: Default: - description: If true, lists all default DHCP options set. If false, lists - all non-default DHCP options set. + description: If true, lists all default DHCP options set. If false, lists all non-default DHCP options set. type: boolean DhcpOptionsSetIds: description: The IDs of the DHCP options sets. @@ -4057,8 +3770,7 @@ components: type: string type: array DomainNameServers: - description: The IPs of the domain name servers used for the DHCP options - sets. + description: The IPs of the domain name servers used for the DHCP options sets. items: type: string type: array @@ -4073,8 +3785,7 @@ components: type: string type: array NtpServers: - description: The IPs of the Network Time Protocol (NTP) servers used for - the DHCP options sets. + description: The IPs of the Network Time Protocol (NTP) servers used for the DHCP options sets. items: type: string type: array @@ -4089,8 +3800,7 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the - DHCP options sets, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the DHCP options sets, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -4135,8 +3845,7 @@ components: description: One or more filters. properties: DeleteOnVmDeletion: - description: Indicates whether the fGPU is deleted when terminating the - VM. + description: Indicates whether the fGPU is deleted when terminating the VM. type: boolean FlexibleGpuIds: description: One or more IDs of fGPUs. @@ -4149,14 +3858,12 @@ components: type: string type: array ModelNames: - description: One or more models of fGPUs. For more information, see [About - Flexible GPUs](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html). + description: One or more models of fGPUs. For more information, see [About Flexible GPUs](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html). items: type: string type: array States: - description: The states of the fGPUs (`allocated` \| `attaching` \| `attached` - \| `detaching`). + description: The states of the fGPUs (`allocated` \| `attaching` \| `attached` \| `detaching`). items: type: string type: array @@ -4168,7 +3875,7 @@ components: Tags: description: One or more tags associated with the fGPUs. items: - "$ref": "#/components/schemas/Tag" + $ref: '#/components/schemas/Tag' type: array VmIds: description: One or more IDs of VMs. @@ -4186,8 +3893,7 @@ components: type: string type: array AccountIds: - description: The account IDs of the owners of the OMIs. By default, all - the OMIs for which you have launch permissions are described. + description: The account IDs of the owners of the OMIs. By default, all the OMIs for which you have launch permissions are described. items: type: string type: array @@ -4197,8 +3903,7 @@ components: type: string type: array BlockDeviceMappingDeleteOnVmDeletion: - description: Whether the volumes are deleted or not when terminating the - VM. + description: Whether the volumes are deleted or not when terminating the VM. type: boolean BlockDeviceMappingDeviceNames: description: The device names for the volumes. @@ -4223,7 +3928,7 @@ components: BootModes: description: The boot modes compatible with the OMIs. items: - "$ref": "#/components/schemas/BootMode" + $ref: '#/components/schemas/BootMode' type: array Descriptions: description: The descriptions of the OMIs, provided when they were created. @@ -4256,8 +3961,7 @@ components: type: string type: array PermissionsToLaunchGlobalPermission: - description: If true, lists all public OMIs. If false, lists all private - OMIs. + description: If true, lists all public OMIs. If false, lists all private OMIs. type: boolean ProductCodeNames: description: The names of the product codes associated with the OMI. @@ -4298,14 +4002,12 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the - OMIs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the OMIs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array TpmMandatory: - description: Whether a virtual Trusted Platform Module (vTPM) is mandatory - for VMs created from this OMI (true) or not (false). + description: Whether a virtual Trusted Platform Module (vTPM) is mandatory for VMs created from this OMI (true) or not (false). type: boolean VirtualizationTypes: description: The virtualization types (always `hvm`). @@ -4328,9 +4030,7 @@ components: type: string type: array LinkStates: - description: The current states of the attachments between the internet - services and the Nets (only `available`, if the internet gateway is attached - to a Net). + description: The current states of the attachments between the internet services and the Nets (only `available`, if the internet gateway is attached to a Net). items: type: string type: array @@ -4345,8 +4045,7 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the - internet services, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the internet services, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -4371,8 +4070,7 @@ components: type: string type: array KeypairTypes: - description: The types of the keypairs (`ssh-rsa`, `ssh-ed25519`, `ecdsa-sha2-nistp256`, - `ecdsa-sha2-nistp384`, or `ecdsa-sha2-nistp521`). + description: The types of the keypairs (`ssh-rsa`, `ssh-ed25519`, `ecdsa-sha2-nistp256`, `ecdsa-sha2-nistp384`, or `ecdsa-sha2-nistp521`). items: type: string type: array @@ -4387,8 +4085,7 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the - keypairs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the keypairs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -4433,8 +4130,7 @@ components: type: string type: array States: - description: The states of the NAT services (`pending` \| `available` \| - `deleting` \| `deleted`). + description: The states of the NAT services (`pending` \| `available` \| `deleting` \| `deleted`). items: type: string type: array @@ -4454,8 +4150,7 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the - NAT services, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the NAT services, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -4470,8 +4165,7 @@ components: type: string type: array IpRanges: - description: The IP ranges for the Nets, in CIDR notation (for example, - `10.0.0.0/16`). + description: The IP ranges for the Nets, in CIDR notation (for example, `10.0.0.0/16`). items: type: string type: array @@ -4499,8 +4193,7 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the - Nets, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the Nets, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -4525,8 +4218,7 @@ components: type: string type: array States: - description: The states of the Net access points (`pending` \| `available` - \| `deleting` \| `deleted`). + description: The states of the Net access points (`pending` \| `available` \| `deleting` \| `deleted`). items: type: string type: array @@ -4541,8 +4233,7 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the - Net access points, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the Net access points, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -4557,8 +4248,7 @@ components: type: string type: array AccepterNetIpRanges: - description: The IP ranges of the peer Nets, in CIDR notation (for example, - `10.0.0.0/24`). + description: The IP ranges of the peer Nets, in CIDR notation (for example, `10.0.0.0/24`). items: type: string type: array @@ -4568,8 +4258,7 @@ components: type: string type: array ExpirationDates: - description: The dates and times at which the Net peerings expire, in ISO - 8601 date-time format (for example, `2020-06-14T00:00:00.000Z`). + description: The dates and times at which the Net peerings expire, in ISO 8601 date-time format (for example, `2020-06-14T00:00:00.000Z`). items: format: date-time type: string @@ -4600,8 +4289,7 @@ components: type: string type: array StateNames: - description: The states of the Net peerings (`pending-acceptance` \| `active` - \| `rejected` \| `failed` \| `expired` \| `deleted`). + description: The states of the Net peerings (`pending-acceptance` \| `active` \| `rejected` \| `failed` \| `expired` \| `deleted`). items: type: string type: array @@ -4616,8 +4304,7 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the - Net peerings, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the Net peerings, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -4632,12 +4319,10 @@ components: type: string type: array IsSourceDestCheck: - description: Whether the source/destination checking is enabled (true) or - disabled (false). + description: Whether the source/destination checking is enabled (true) or disabled (false). type: boolean LinkNicDeleteOnVmDeletion: - description: Whether the NICs are deleted when the VMs they are attached - to are terminated. + description: Whether the NICs are deleted when the VMs they are attached to are terminated. type: boolean LinkNicDeviceNumbers: description: The device numbers the NICs are attached to. @@ -4655,8 +4340,7 @@ components: type: string type: array LinkNicVmAccountIds: - description: The account IDs of the owners of the VMs the NICs are attached - to. + description: The account IDs of the owners of the VMs the NICs are attached to. items: type: string type: array @@ -4666,14 +4350,12 @@ components: type: string type: array LinkPublicIpAccountIds: - description: The account IDs of the owners of the public IPs associated - with the NICs. + description: The account IDs of the owners of the public IPs associated with the NICs. items: type: string type: array LinkPublicIpLinkPublicIpIds: - description: The association IDs returned when the public IPs were associated - with the NICs. + description: The association IDs returned when the public IPs were associated with the NICs. items: type: string type: array @@ -4683,8 +4365,7 @@ components: type: string type: array LinkPublicIpPublicIpIds: - description: The allocation IDs returned when the public IPs were allocated - to their accounts. + description: The allocation IDs returned when the public IPs were allocated to their accounts. items: type: string type: array @@ -4714,8 +4395,7 @@ components: type: string type: array PrivateIpsLinkPublicIpAccountIds: - description: The account IDs of the owner of the public IPs associated with - the private IPs. + description: The account IDs of the owner of the public IPs associated with the private IPs. items: type: string type: array @@ -4725,8 +4405,7 @@ components: type: string type: array PrivateIpsPrimaryIp: - description: Whether the private IP is the primary IP associated with the - NIC. + description: Whether the private IP is the primary IP associated with the NIC. type: boolean PrivateIpsPrivateIps: description: The private IPs of the NICs. @@ -4769,8 +4448,7 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the - NICs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the NICs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -4790,8 +4468,7 @@ components: description: One or more filters. properties: LinkPublicIpIds: - description: The IDs representing the associations of public IPs with VMs - or NICs. + description: The IDs representing the associations of public IPs with VMs or NICs. items: type: string type: array @@ -4806,8 +4483,7 @@ components: type: string type: array Placements: - description: Whether the public IPs are for use in the public Cloud or in - a Net. + description: Whether the public IPs are for use in the public Cloud or in a Net. items: type: string type: array @@ -4837,8 +4513,7 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the - public IPs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the public IPs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -4863,8 +4538,7 @@ components: type: string type: array QuotaTypes: - description: The resource IDs if these are resource-specific quotas, `global` - if they are not. + description: The resource IDs if these are resource-specific quotas, `global` if they are not. items: type: string type: array @@ -4884,8 +4558,7 @@ components: type: string type: array LinkRouteTableLinkRouteTableIds: - description: The IDs of the associations between the route tables and the - Subnets. + description: The IDs of the associations between the route tables and the Subnets. items: type: string type: array @@ -4958,8 +4631,7 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the - route tables, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the route tables, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -4979,20 +4651,17 @@ components: type: string type: array InboundRuleFromPortRanges: - description: The beginnings of the port ranges for the TCP and UDP protocols, - or the ICMP type numbers. + description: The beginnings of the port ranges for the TCP and UDP protocols, or the ICMP type numbers. items: type: integer type: array InboundRuleIpRanges: - description: The IP ranges that have been granted permissions, in CIDR notation - (for example, `10.0.0.0/24`). + description: The IP ranges that have been granted permissions, in CIDR notation (for example, `10.0.0.0/24`). items: type: string type: array InboundRuleProtocols: - description: The IP protocols for the permissions (`tcp` \| `udp` \| `icmp`, - or a protocol number, or `-1` for all protocols). + description: The IP protocols for the permissions (`tcp` \| `udp` \| `icmp`, or a protocol number, or `-1` for all protocols). items: type: string type: array @@ -5007,14 +4676,12 @@ components: type: string type: array InboundRuleToPortRanges: - description: The ends of the port ranges for the TCP and UDP protocols, - or the ICMP code numbers. + description: The ends of the port ranges for the TCP and UDP protocols, or the ICMP code numbers. items: type: integer type: array NetIds: - description: The IDs of the Nets specified when the security groups were - created. + description: The IDs of the Nets specified when the security groups were created. items: type: string type: array @@ -5024,20 +4691,17 @@ components: type: string type: array OutboundRuleFromPortRanges: - description: The beginnings of the port ranges for the TCP and UDP protocols, - or the ICMP type numbers. + description: The beginnings of the port ranges for the TCP and UDP protocols, or the ICMP type numbers. items: type: integer type: array OutboundRuleIpRanges: - description: The IP ranges that have been granted permissions, in CIDR notation - (for example, `10.0.0.0/24`). + description: The IP ranges that have been granted permissions, in CIDR notation (for example, `10.0.0.0/24`). items: type: string type: array OutboundRuleProtocols: - description: The IP protocols for the permissions (`tcp` \| `udp` \| `icmp`, - or a protocol number, or `-1` for all protocols). + description: The IP protocols for the permissions (`tcp` \| `udp` \| `icmp`, or a protocol number, or `-1` for all protocols). items: type: string type: array @@ -5052,8 +4716,7 @@ components: type: string type: array OutboundRuleToPortRanges: - description: The ends of the port ranges for the TCP and UDP protocols, - or the ICMP code numbers. + description: The ends of the port ranges for the TCP and UDP protocols, or the ICMP code numbers. items: type: integer type: array @@ -5078,8 +4741,7 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the - security groups, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the security groups, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -5134,8 +4796,7 @@ components: type: string type: array FromCreationDate: - description: The beginning of the time period, in ISO 8601 date-time format - (for example, `2020-06-14T00:00:00.000Z`). + description: The beginning of the time period, in ISO 8601 date-time format (for example, `2020-06-14T00:00:00.000Z`). format: date-time type: string PermissionsToCreateVolumeAccountIds: @@ -5144,8 +4805,7 @@ components: type: string type: array PermissionsToCreateVolumeGlobalPermission: - description: If true, lists all public volumes. If false, lists all private - volumes. + description: If true, lists all public volumes. If false, lists all private volumes. type: boolean Progresses: description: The progresses of the snapshots, as a percentage. @@ -5158,8 +4818,7 @@ components: type: string type: array States: - description: The states of the snapshots (`in-queue` \| `pending` \| `completed` - \| `error` \| `deleting`). + description: The states of the snapshots (`in-queue` \| `pending` \| `completed` \| `error` \| `deleting`). items: type: string type: array @@ -5174,14 +4833,12 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the - snapshots, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the snapshots, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array ToCreationDate: - description: The end of the time period, in ISO 8601 date-time format (for - example, `2020-06-30T00:00:00.000Z`). + description: The end of the time period, in ISO 8601 date-time format (for example, `2020-06-30T00:00:00.000Z`). format: date-time type: string VolumeIds: @@ -5190,8 +4847,7 @@ components: type: string type: array VolumeSizes: - description: The sizes of the volumes used to create the snapshots, in gibibytes - (GiB). + description: The sizes of the volumes used to create the snapshots, in gibibytes (GiB). items: type: integer type: array @@ -5206,8 +4862,7 @@ components: type: integer type: array IpRanges: - description: The IP ranges in the Subnets, in CIDR notation (for example, - `10.0.0.0/16`). + description: The IP ranges in the Subnets, in CIDR notation (for example, `10.0.0.0/16`). items: type: string type: array @@ -5242,8 +4897,7 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the - Subnets, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the Subnets, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -5273,9 +4927,7 @@ components: description: One or more filters. properties: Keys: - description: The keys of the tags that are assigned to the resources. You - can use this filter alongside the `Values` filter. In that case, you filter - the resources corresponding to each tag, regardless of the other filter. + description: The keys of the tags that are assigned to the resources. You can use this filter alongside the `Values` filter. In that case, you filter the resources corresponding to each tag, regardless of the other filter. items: type: string type: array @@ -5285,19 +4937,12 @@ components: type: string type: array ResourceTypes: - description: The resource type (`customer-gateway` \| `dhcpoptions` \| `flexible-gpu` - \| `image` \| `instance` \| `keypair` \| `natgateway` \| `network-interface` - \| `public-ip` \| `route-table` \| `security-group` \| `snapshot` \| `subnet` - \| `task` \| `virtual-private-gateway` \| `volume` \| `vpc` \| `vpc-endpoint` - \| `vpc-peering-connection`\| `vpn-connection`). + description: The resource type (`customer-gateway` \| `dhcpoptions` \| `flexible-gpu` \| `image` \| `instance` \| `keypair` \| `natgateway` \| `network-interface` \| `public-ip` \| `route-table` \| `security-group` \| `snapshot` \| `subnet` \| `task` \| `virtual-private-gateway` \| `volume` \| `vpc` \| `vpc-endpoint` \| `vpc-peering-connection`\| `vpn-connection`). items: type: string type: array Values: - description: The values of the tags that are assigned to the resources. - You can use this filter alongside the `TagKeys` filter. In that case, - you filter the resources corresponding to each tag, regardless of the - other filter. + description: The values of the tags that are assigned to the resources. You can use this filter alongside the `TagKeys` filter. In that case, you filter the resources corresponding to each tag, regardless of the other filter. items: type: string type: array @@ -5317,8 +4962,7 @@ components: description: One or more filters. properties: PathPrefix: - description: The path prefix of the groups. If not specified, it is set - to a slash (`/`). + description: The path prefix of the groups. If not specified, it is set to a slash (`/`). type: string UserGroupIds: description: The IDs of the user groups. @@ -5351,14 +4995,12 @@ components: type: string type: array LinkStates: - description: The current states of the attachments between the virtual gateways - and the Nets (`attaching` \| `attached` \| `detaching` \| `detached`). + description: The current states of the attachments between the virtual gateways and the Nets (`attaching` \| `attached` \| `detaching` \| `detached`). items: type: string type: array States: - description: The states of the virtual gateways (`pending` \| `available` - \| `deleting` \| `deleted`). + description: The states of the virtual gateways (`pending` \| `available` \| `deleting` \| `deleted`). items: type: string type: array @@ -5373,8 +5015,7 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the - virtual gateways, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the virtual gateways, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -5397,21 +5038,21 @@ components: description: Whether the BSU volumes are deleted when terminating the VMs. type: boolean BlockDeviceMappingDeviceNames: - description: The device names for the BSU volumes (in the format `/dev/sdX`, - `/dev/sdXX`, `/dev/xvdX`, or `/dev/xvdXX`). + description: The device names for the BSU volumes (in the format `/dev/sdX`, `/dev/sdXX`, `/dev/xvdX`, or `/dev/xvdXX`). items: type: string type: array BlockDeviceMappingLinkDates: - description: The link dates for the BSU volumes mapped to the VMs (for example, - `2016-01-23T18:45:30.000Z`). + description: The link dates for the BSU volumes mapped to the VMs (for example, `2016-01-23T18:45:30.000Z`). items: - format: date - type: string + oneOf: + - format: date + type: string + - format: date-time + type: string type: array BlockDeviceMappingStates: - description: The states for the BSU volumes (`attaching` \| `attached` \| - `detaching` \| `detached`). + description: The states for the BSU volumes (`attaching` \| `attached` \| `detaching` \| `detached`). items: type: string type: array @@ -5423,7 +5064,7 @@ components: BootModes: description: The boot modes of the VMs. items: - "$ref": "#/components/schemas/BootMode" + $ref: '#/components/schemas/BootMode' type: array ClientTokens: description: The idempotency tokens provided when launching the VMs. @@ -5433,8 +5074,11 @@ components: CreationDates: description: The dates when the VMs were launched. items: - format: date - type: string + oneOf: + - format: date + type: string + - format: date-time + type: string type: array ImageIds: description: The IDs of the OMIs used to launch the VMs. @@ -5442,8 +5086,7 @@ components: type: string type: array IsSourceDestChecked: - description: Whether the source/destination checking is enabled (true) or - disabled (false). + description: Whether the source/destination checking is enabled (true) or disabled (false). type: boolean KeypairNames: description: The names of the keypairs used when launching the VMs. @@ -5451,8 +5094,7 @@ components: type: string type: array LaunchNumbers: - description: The numbers for the VMs when launching a group of several VMs - (for example, `0`, `1`, `2`, and so on). + description: The numbers for the VMs when launching a group of several VMs (for example, `0`, `1`, `2`, and so on). items: type: integer type: array @@ -5477,12 +5119,10 @@ components: type: string type: array NicIsSourceDestChecked: - description: Whether the source/destination checking is enabled (true) or - disabled (false). + description: Whether the source/destination checking is enabled (true) or disabled (false). type: boolean NicLinkNicDeleteOnVmDeletion: - description: Whether the NICs are deleted when the VMs they are attached - to are deleted. + description: Whether the NICs are deleted when the VMs they are attached to are deleted. type: boolean NicLinkNicDeviceNumbers: description: The device numbers the NICs are attached to. @@ -5490,11 +5130,13 @@ components: type: integer type: array NicLinkNicLinkNicDates: - description: The dates and times (UTC) when the NICs were attached to the - VMs. + description: The dates and times (UTC) when the NICs were attached to the VMs. items: - format: date - type: string + oneOf: + - format: date + type: string + - format: date-time + type: string type: array NicLinkNicLinkNicIds: description: The IDs of the NIC attachments. @@ -5507,8 +5149,7 @@ components: type: string type: array NicLinkNicVmAccountIds: - description: The account IDs of the owners of the VMs the NICs are attached - to. + description: The account IDs of the owners of the VMs the NICs are attached to. items: type: string type: array @@ -5518,20 +5159,17 @@ components: type: string type: array NicLinkPublicIpAccountIds: - description: The account IDs of the owners of the public IPs associated - with the NICs. + description: The account IDs of the owners of the public IPs associated with the NICs. items: type: string type: array NicLinkPublicIpLinkPublicIpIds: - description: The association IDs returned when the public IPs were associated - with the NICs. + description: The association IDs returned when the public IPs were associated with the NICs. items: type: string type: array NicLinkPublicIpPublicIpIds: - description: The allocation IDs returned when the public IPs were allocated - to their accounts. + description: The allocation IDs returned when the public IPs were allocated to their accounts. items: type: string type: array @@ -5556,8 +5194,7 @@ components: type: string type: array NicPrivateIpsLinkPublicIpAccountIds: - description: The account IDs of the owner of the public IPs associated with - the private IPs. + description: The account IDs of the owner of the public IPs associated with the private IPs. items: type: string type: array @@ -5567,8 +5204,7 @@ components: type: string type: array NicPrivateIpsPrimaryIp: - description: Whether the private IPs are the primary IPs associated with - the NICs. + description: Whether the private IPs are the primary IPs associated with the NICs. type: boolean NicPrivateIpsPrivateIps: description: The private IPs of the NICs. @@ -5601,8 +5237,7 @@ components: type: string type: array Platforms: - description: The platforms. Use windows if you have Windows VMs. Otherwise, - leave this filter blank. + description: The platforms. Use windows if you have Windows VMs. Otherwise, leave this filter blank. items: type: string type: array @@ -5612,8 +5247,7 @@ components: type: string type: array ProductCodes: - description: The product codes associated with the OMI used to create the - VMs. + description: The product codes associated with the OMI used to create the VMs. items: type: string type: array @@ -5623,9 +5257,7 @@ components: type: string type: array ReservationIds: - description: The IDs of the reservation of the VMs, created every time you - launch VMs. These reservation IDs can be associated with several VMs when - you launch a group of VMs using the same launch request. + description: The IDs of the reservation of the VMs, created every time you launch VMs. These reservation IDs can be associated with several VMs when you launch a group of VMs using the same launch request. items: type: string type: array @@ -5640,14 +5272,12 @@ components: type: string type: array SecurityGroupIds: - description: The IDs of the security groups for the VMs (only in the public - Cloud). + description: The IDs of the security groups for the VMs (only in the public Cloud). items: type: string type: array SecurityGroupNames: - description: The names of the security groups for the VMs (only in the public - Cloud). + description: The names of the security groups for the VMs (only in the public Cloud). items: type: string type: array @@ -5662,8 +5292,7 @@ components: type: string type: array StateReasons: - description: The reasons explaining the current states of the VMs. This - filter is like the `StateReasonCodes` one. + description: The reasons explaining the current states of the VMs. This filter is like the `StateReasonCodes` one. items: type: string type: array @@ -5688,8 +5317,7 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the - VMs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the VMs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -5699,8 +5327,7 @@ components: type: string type: array TpmEnabled: - description: Whether a virtual Trusted Platform Module (vTPM) is enabled - (true) or disabled (false) on the VM. + description: Whether a virtual Trusted Platform Module (vTPM) is enabled (true) or disabled (false) on the VM. type: boolean VmIds: description: One or more IDs of VMs. @@ -5718,21 +5345,17 @@ components: type: string type: array VmStateCodes: - description: 'The state codes of the VMs: `-1` (quarantine), `0` (pending), - `16` (running), `32` (shutting-down), `48` (terminated), `64` (stopping), - and `80` (stopped).' + description: 'The state codes of the VMs: `-1` (quarantine), `0` (pending), `16` (running), `32` (shutting-down), `48` (terminated), `64` (stopping), and `80` (stopped).' items: type: integer type: array VmStateNames: - description: The state names of the VMs (`pending` \| `running` \| `stopping` - \| `stopped` \| `shutting-down` \| `terminated` \| `quarantine`). + description: The state names of the VMs (`pending` \| `running` \| `stopping` \| `stopped` \| `shutting-down` \| `terminated` \| `quarantine`). items: type: string type: array VmTypes: - description: The VM types (for example, t2.micro). For more information, - see [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html). + description: The VM types (for example, t2.micro). For more information, see [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html). items: type: string type: array @@ -5767,8 +5390,7 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the - VMs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the VMs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -5843,8 +5465,7 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the - VM templates, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the VM templates, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -5864,8 +5485,7 @@ components: description: One or more filters. properties: BsuOptimized: - description: This parameter is not available. It is present in our API for - the sake of historical compatibility with AWS. + description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS. type: boolean EphemeralsTypes: description: The types of ephemeral storage disk. @@ -5946,8 +5566,7 @@ components: type: string type: array VmStates: - description: The states of the VMs (`pending` \| `running` \| `stopping` - \| `stopped` \| `shutting-down` \| `terminated` \| `quarantine`). + description: The states of the VMs (`pending` \| `running` \| `stopping` \| `stopped` \| `shutting-down` \| `terminated` \| `quarantine`). items: type: string type: array @@ -5962,15 +5581,13 @@ components: type: string type: array CreationDates: - description: The dates and times at which the volumes were created, in ISO - 8601 date-time format (for example, `2020-06-30T00:00:00.000Z`). + description: The dates and times at which the volumes were created, in ISO 8601 date-time format (for example, `2020-06-30T00:00:00.000Z`). items: format: date-time type: string type: array LinkVolumeDeleteOnVmDeletion: - description: Whether the volumes are deleted or not when terminating the - VMs. + description: Whether the volumes are deleted or not when terminating the VMs. type: boolean LinkVolumeDeviceNames: description: The VM device names. @@ -5978,15 +5595,13 @@ components: type: string type: array LinkVolumeLinkDates: - description: The dates and times at which the volumes were attached, in - ISO 8601 date-time format (for example, `2020-06-30T00:00:00.000Z`). + description: The dates and times at which the volumes were attached, in ISO 8601 date-time format (for example, `2020-06-30T00:00:00.000Z`). items: format: date-time type: string type: array LinkVolumeLinkStates: - description: The attachment states of the volumes (`attaching` \| `detaching` - \| `attached` \| `detached`). + description: The attachment states of the volumes (`attaching` \| `detaching` \| `attached` \| `detached`). items: type: string type: array @@ -6016,8 +5631,7 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the - volumes, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the volumes, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -6032,8 +5646,7 @@ components: type: integer type: array VolumeStates: - description: The states of the volumes (`creating` \| `available` \| `in-use` - \| `deleting` \| `error`). + description: The states of the volumes (`creating` \| `available` \| `in-use` \| `deleting` \| `error`). items: type: string type: array @@ -6048,8 +5661,7 @@ components: description: One or more filters. properties: BgpAsns: - description: The Border Gateway Protocol (BGP) Autonomous System Numbers - (ASNs) of the connections. + description: The Border Gateway Protocol (BGP) Autonomous System Numbers (ASNs) of the connections. items: type: integer type: array @@ -6069,16 +5681,12 @@ components: type: string type: array States: - description: The states of the VPN connections (`pending` \| `available` - \| `deleting` \| `deleted`). + description: The states of the VPN connections (`pending` \| `available` \| `deleting` \| `deleted`). items: type: string type: array StaticRoutesOnly: - description: If false, the VPN connection uses dynamic routing with Border - Gateway Protocol (BGP). If true, routing is controlled using static routes. - For more information about how to create and delete static routes, see - [CreateVpnConnectionRoute](#createvpnconnectionroute) and [DeleteVpnConnectionRoute](#deletevpnconnectionroute). + description: If false, the VPN connection uses dynamic routing with Border Gateway Protocol (BGP). If true, routing is controlled using static routes. For more information about how to create and delete static routes, see [CreateVpnConnectionRoute](#createvpnconnectionroute) and [DeleteVpnConnectionRoute](#deletevpnconnectionroute). type: boolean TagKeys: description: The keys of the tags associated with the VPN connections. @@ -6091,8 +5699,7 @@ components: type: string type: array Tags: - description: 'The key/value combination of the tags associated with the - VPN connections, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + description: 'The key/value combination of the tags associated with the VPN connections, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -6121,12 +5728,10 @@ components: description: The compatible processor generation. type: string ModelName: - description: The model of fGPU. For more information, see [About Flexible - GPUs](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html). + description: The model of fGPU. For more information, see [About Flexible GPUs](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html). type: string State: - description: The state of the fGPU (`allocated` \| `attaching` \| `attached` - \| `detaching`). + description: The state of the fGPU (`allocated` \| `attaching` \| `attached` \| `detaching`). type: string SubregionName: description: The Subregion where the fGPU is located. @@ -6134,7 +5739,7 @@ components: Tags: description: One or more tags associated with the fGPU. items: - "$ref": "#/components/schemas/Tag" + $ref: '#/components/schemas/Tag' type: array VmId: description: The ID of the VM the fGPU is attached to, if any. @@ -6142,8 +5747,7 @@ components: type: object FlexibleGpuCatalog: additionalProperties: false - description: Information about the flexible GPU (fGPU) that is available in - the public catalog. + description: Information about the flexible GPU (fGPU) that is available in the public catalog. properties: Generations: description: The processor generations that the fGPUs are compatible with. @@ -6151,12 +5755,10 @@ components: type: string type: array MaxCpu: - description: The maximum number of VM vCores that the fGPU is compatible - with. + description: The maximum number of VM vCores that the fGPU is compatible with. type: integer MaxRam: - description: The maximum amount of VM memory that the fGPU is compatible - with. + description: The maximum amount of VM memory that the fGPU is compatible with. type: integer ModelName: description: The model of fGPU. @@ -6170,31 +5772,25 @@ components: description: Information about the health check configuration. properties: CheckInterval: - description: The number of seconds between two requests (between `5` and - `600` both included). + description: The number of seconds between two requests (between `5` and `600` both included). type: integer HealthyThreshold: - description: The number of consecutive successful requests before considering - the VM as healthy (between `2` and `10` both included). + description: The number of consecutive successful requests before considering the VM as healthy (between `2` and `10` both included). type: integer Path: - description: If you use the HTTP or HTTPS protocols, the request URL path. - Always starts with a slash (`/`). + description: If you use the HTTP or HTTPS protocols, the request URL path. Always starts with a slash (`/`). type: string Port: description: The port number (between `1` and `65535`, both included). type: integer Protocol: - description: The protocol for the URL of the VM (`HTTP` \| `HTTPS` \| `TCP` - \| `SSL`). + description: The protocol for the URL of the VM (`HTTP` \| `HTTPS` \| `TCP` \| `SSL`). type: string Timeout: - description: The maximum waiting time for a response before considering - the VM as unhealthy, in seconds (between `2` and `60` both included). + description: The maximum waiting time for a response before considering the VM as unhealthy, in seconds (between `2` and `60` both included). type: integer UnhealthyThreshold: - description: The number of consecutive failed requests before considering - the VM as unhealthy (between `2` and `10` both included). + description: The number of consecutive failed requests before considering the VM as unhealthy (between `2` and `10` both included). type: integer required: - CheckInterval @@ -6220,16 +5816,16 @@ components: BlockDeviceMappings: description: One or more block device mappings. items: - "$ref": "#/components/schemas/BlockDeviceMappingImage" + $ref: '#/components/schemas/BlockDeviceMappingImage' type: array BootModes: description: The boot modes compatible with the OMI. items: - "$ref": "#/components/schemas/BootMode" + $ref: '#/components/schemas/BootMode' type: array CreationDate: description: The date and time (UTC) at which the OMI was created. - format: date + format: date-time type: string Description: description: The description of the OMI. @@ -6247,7 +5843,7 @@ components: description: The type of the OMI. type: string PermissionsToLaunch: - "$ref": "#/components/schemas/PermissionsOnResource" + $ref: '#/components/schemas/PermissionsOnResource' description: Permissions for the resource. ProductCodes: description: The product codes associated with the OMI. @@ -6267,16 +5863,15 @@ components: description: The state of the OMI (`pending` \| `available` \| `failed`). type: string StateComment: - "$ref": "#/components/schemas/StateComment" + $ref: '#/components/schemas/StateComment' description: Information about the change of state. Tags: description: One or more tags associated with the OMI. items: - "$ref": "#/components/schemas/ResourceTag" + $ref: '#/components/schemas/ResourceTag' type: array TpmMandatory: - description: If true, a virtual Trusted Platform Module (vTPM) is mandatory - for VMs created from this OMI. If false, a vTPM is not mandatory. + description: If true, a virtual Trusted Platform Module (vTPM) is mandatory for VMs created from this OMI. If false, a vTPM is not mandatory. type: boolean type: object ImageExportTask: @@ -6290,19 +5885,18 @@ components: description: The ID of the OMI to be exported. type: string OsuExport: - "$ref": "#/components/schemas/OsuExportImageExportTask" + $ref: '#/components/schemas/OsuExportImageExportTask' description: Information about the OMI export task. Progress: description: The progress of the OMI export task, as a percentage. type: integer State: - description: The state of the OMI export task (`pending/queued` \| `pending` - \| `completed` \| `failed` \| `cancelled`). + description: The state of the OMI export task (`pending/queued` \| `pending` \| `completed` \| `failed` \| `cancelled`). type: string Tags: description: One or more tags associated with the image export task. items: - "$ref": "#/components/schemas/ResourceTag" + $ref: '#/components/schemas/ResourceTag' type: array TaskId: description: The ID of the OMI export task. @@ -6313,9 +5907,7 @@ components: description: Information about an inline policy. properties: Body: - description: The policy document, corresponding to a JSON string that contains - the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html) - and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html). + description: The policy document, corresponding to a JSON string that contains the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html) and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html). type: string Name: description: The name of the policy. @@ -6332,13 +5924,12 @@ components: description: The ID of the Net attached to the internet service. type: string State: - description: The state of the attachment of the internet service to the - Net (always `available`). + description: The state of the attachment of the internet service to the Net (always `available`). type: string Tags: description: One or more tags associated with the internet service. items: - "$ref": "#/components/schemas/ResourceTag" + $ref: '#/components/schemas/ResourceTag' type: array type: object Keypair: @@ -6346,8 +5937,7 @@ components: description: Information about the keypair. properties: KeypairFingerprint: - description: The MD5 public key fingerprint as specified in section 4 of - RFC 4716. + description: The MD5 public key fingerprint as specified in section 4 of RFC 4716. type: string KeypairId: description: The ID of the keypair. @@ -6356,13 +5946,12 @@ components: description: The name of the keypair. type: string KeypairType: - description: The type of the keypair (`ssh-rsa`, `ssh-ed25519`, `ecdsa-sha2-nistp256`, - `ecdsa-sha2-nistp384`, or `ecdsa-sha2-nistp521`). + description: The type of the keypair (`ssh-rsa`, `ssh-ed25519`, `ecdsa-sha2-nistp256`, `ecdsa-sha2-nistp384`, or `ecdsa-sha2-nistp521`). type: string Tags: description: One or more tags associated with the keypair. items: - "$ref": "#/components/schemas/ResourceTag" + $ref: '#/components/schemas/ResourceTag' type: array type: object KeypairCreated: @@ -6370,8 +5959,7 @@ components: description: Information about the created keypair. properties: KeypairFingerprint: - description: The MD5 public key fingerprint, as specified in section 4 of - RFC 4716. + description: The MD5 public key fingerprint, as specified in section 4 of RFC 4716. type: string KeypairId: description: The ID of the keypair. @@ -6380,26 +5968,22 @@ components: description: The name of the keypair. type: string KeypairType: - description: The type of the keypair (`ssh-rsa`, `ssh-ed25519`, `ecdsa-sha2-nistp256`, - `ecdsa-sha2-nistp384`, or `ecdsa-sha2-nistp521`). + description: The type of the keypair (`ssh-rsa`, `ssh-ed25519`, `ecdsa-sha2-nistp256`, `ecdsa-sha2-nistp384`, or `ecdsa-sha2-nistp521`). type: string PrivateKey: - description: The private key, returned only if you are creating a keypair - (not if you are importing). When you save this private key in a .rsa file, - make sure you replace the `\n` escape sequences with real line breaks. + description: The private key, returned only if you are creating a keypair (not if you are importing). When you save this private key in a .rsa file, make sure you replace the `\n` escape sequences with real line breaks. type: string Tags: description: One or more tags associated with the keypair. items: - "$ref": "#/components/schemas/ResourceTag" + $ref: '#/components/schemas/ResourceTag' type: array type: object LinkFlexibleGpuRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean FlexibleGpuId: description: The ID of the fGPU you want to attach. @@ -6415,22 +5999,20 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object LinkInternetServiceRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean InternetServiceId: description: The ID of the internet service you want to attach. type: string NetId: - description: The ID of the Net to which you want to attach the internet - service. + description: The ID of the Net to which you want to attach the internet service. type: string required: - InternetServiceId @@ -6440,7 +6022,7 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object LinkLoadBalancerBackendMachinesRequest: @@ -6457,8 +6039,7 @@ components: type: string type: array DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean LoadBalancerName: description: The name of the load balancer. @@ -6470,19 +6051,17 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object LinkManagedPolicyToUserGroupRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean PolicyOrn: - description: The OUTSCALE Resource Name (ORN) of the policy. For more information, - see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + description: The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). type: string UserGroupName: description: The name of the group you want to link the policy to. @@ -6495,7 +6074,7 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object LinkNic: @@ -6506,15 +6085,13 @@ components: description: If true, the NIC is deleted when the VM is terminated. type: boolean DeviceNumber: - description: The device index for the NIC attachment (between `1` and `7`, - both included). + description: The device index for the NIC attachment (between `1` and `7`, both included). type: integer LinkNicId: description: The ID of the NIC to attach. type: string State: - description: The state of the attachment (`attaching` \| `attached` \| `detaching` - \| `detached`). + description: The state of the attachment (`attaching` \| `attached` \| `detaching` \| `detached`). type: string VmAccountId: description: The account ID of the owner of the VM. @@ -6531,27 +6108,23 @@ components: description: If true, the NIC is deleted when the VM is terminated. type: boolean DeviceNumber: - description: The device index for the NIC attachment (between `1` and `7`, - both included). + description: The device index for the NIC attachment (between `1` and `7`, both included). type: integer LinkNicId: description: The ID of the NIC to attach. type: string State: - description: The state of the attachment (`attaching` \| `attached` \| `detaching` - \| `detached`). + description: The state of the attachment (`attaching` \| `attached` \| `detaching` \| `detached`). type: string type: object LinkNicRequest: additionalProperties: false properties: DeviceNumber: - description: The index of the VM device for the NIC attachment (between - `1` and `7`, both included). + description: The index of the VM device for the NIC attachment (between `1` and `7`, both included). type: integer DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean NicId: description: The ID of the NIC you want to attach. @@ -6571,17 +6144,15 @@ components: description: The ID of the NIC attachment. type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object LinkNicToUpdate: additionalProperties: false - description: Information about the NIC attachment. If you are modifying the - `DeleteOnVmDeletion` attribute, you must specify the ID of the NIC attachment. + description: Information about the NIC attachment. If you are modifying the `DeleteOnVmDeletion` attribute, you must specify the ID of the NIC attachment. properties: DeleteOnVmDeletion: - description: If true, the NIC is deleted when the VM is terminated. If false, - the NIC is detached from the VM. + description: If true, the NIC is deleted when the VM is terminated. If false, the NIC is detached from the VM. type: boolean LinkNicId: description: The ID of the NIC attachment. @@ -6591,17 +6162,14 @@ components: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean PolicyOrn: - description: The OUTSCALE Resource Name (ORN) of the policy. For more information, - see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). - pattern: "^orn:ows:(iam|idauth):\\S*:\\d{12}:policy/\\S+$" + description: The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + pattern: ^orn:ows:(iam|idauth):\S*:\d{12}:policy/\S+$ type: string UserName: - description: The name of the user you want to link the policy to (between - 1 and 64 characters). + description: The name of the user you want to link the policy to (between 1 and 64 characters). type: string required: - PolicyOrn @@ -6611,26 +6179,23 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object LinkPrivateIpsRequest: additionalProperties: false properties: AllowRelink: - description: If true, allows an IP that is already assigned to another NIC - in the same Subnet to be assigned to the NIC you specified. + description: If true, allows an IP that is already assigned to another NIC in the same Subnet to be assigned to the NIC you specified. type: boolean DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean NicId: description: The ID of the NIC. type: string PrivateIps: - description: The secondary private IP or IPs you want to assign to the NIC - within the IP range of the Subnet. + description: The secondary private IP or IPs you want to assign to the NIC within the IP range of the Subnet. items: type: string type: array @@ -6644,7 +6209,7 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object LinkPublicIp: @@ -6652,8 +6217,7 @@ components: description: Information about the public IP association. properties: LinkPublicIpId: - description: "(Required in a Net) The ID representing the association of - the public IP with the VM or the NIC." + description: (Required in a Net) The ID representing the association of the public IP with the VM or the NIC. type: string PublicDnsName: description: The name of the public DNS. @@ -6686,33 +6250,22 @@ components: additionalProperties: false properties: AllowRelink: - description: If true, allows the public IP to be associated with the VM - or NIC that you specify even if it is already associated with another - VM or NIC. If false, prevents the public IP from being associated with - the VM or NIC that you specify if it is already associated with another - VM or NIC. (By default, true in the public Cloud, false in a Net.) + description: If true, allows the public IP to be associated with the VM or NIC that you specify even if it is already associated with another VM or NIC. If false, prevents the public IP from being associated with the VM or NIC that you specify if it is already associated with another VM or NIC. (By default, true in the public Cloud, false in a Net.) type: boolean DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean NicId: - description: "(Net only) The ID of the NIC. This parameter is required if - the VM has more than one NIC attached. Otherwise, you need to specify - the `VmId` parameter instead. You cannot specify both parameters at the - same time." + description: (Net only) The ID of the NIC. This parameter is required if the VM has more than one NIC attached. Otherwise, you need to specify the `VmId` parameter instead. You cannot specify both parameters at the same time. type: string PrivateIp: - description: "(Net only) The primary or secondary private IP of the specified - NIC. By default, the primary private IP." + description: (Net only) The primary or secondary private IP of the specified NIC. By default, the primary private IP. type: string PublicIp: - description: The public IP. This parameter is required unless you use the - `PublicIpId` parameter. + description: The public IP. This parameter is required unless you use the `PublicIpId` parameter. type: string PublicIpId: - description: The allocation ID of the public IP. This parameter is required - unless you use the `PublicIp` parameter. + description: The allocation ID of the public IP. This parameter is required unless you use the `PublicIp` parameter. type: string VmId: description: |- @@ -6725,11 +6278,10 @@ components: additionalProperties: false properties: LinkPublicIpId: - description: "(Net only) The ID representing the association of the public - IP with the VM or the NIC." + description: (Net only) The ID representing the association of the public IP with the VM or the NIC. type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object LinkRouteTable: @@ -6737,30 +6289,26 @@ components: description: One or more associations between the route table and the Subnets. properties: LinkRouteTableId: - description: The ID of the association between the route table and the Net - or Subnet. + description: The ID of the association between the route table and the Net or Subnet. type: string Main: description: If true, the route table is the main one. type: boolean NetId: - description: The ID of the Net, if the route table is not explicitly linked - to a Subnet. + description: The ID of the Net, if the route table is not explicitly linked to a Subnet. type: string RouteTableId: description: The ID of the route table. type: string SubnetId: - description: The ID of the Subnet, if the route table is explicitly linked - to a Subnet. + description: The ID of the Subnet, if the route table is explicitly linked to a Subnet. type: string type: object LinkRouteTableRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean RouteTableId: description: The ID of the route table. @@ -6779,15 +6327,14 @@ components: description: The ID of the association between the route table and the Subnet. type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object LinkVirtualGatewayRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean NetId: description: The ID of the Net to which you want to attach the virtual gateway. @@ -6803,24 +6350,20 @@ components: additionalProperties: false properties: NetToVirtualGatewayLink: - "$ref": "#/components/schemas/NetToVirtualGatewayLink" + $ref: '#/components/schemas/NetToVirtualGatewayLink' description: Information about the attachment. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object LinkVolumeRequest: additionalProperties: false properties: DeviceName: - description: The name of the device. For a root device, you must use `/dev/sda1`. - For other volumes, you must use `/dev/sdX`, `/dev/sdXX`, `/dev/xvdX`, - or `/dev/xvdXX` (where the first `X` is a letter between `b` and `z`, - and the second `X` is a letter between `a` and `z`). + description: The name of the device. For a root device, you must use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXX`, `/dev/xvdX`, or `/dev/xvdXX` (where the first `X` is a letter between `b` and `z`, and the second `X` is a letter between `a` and `z`). type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean VmId: description: The ID of the VM you want to attach the volume to. @@ -6837,7 +6380,7 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object LinkedPolicy: @@ -6849,13 +6392,11 @@ components: format: date-time type: string LastModificationDate: - description: The date and time (UTC) at which the linked policy was last - modified. + description: The date and time (UTC) at which the linked policy was last modified. format: date-time type: string Orn: - description: The OUTSCALE Resource Name (ORN) of the policy. For more information, - see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + description: The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). type: string PolicyId: description: The ID of the policy. @@ -6869,15 +6410,13 @@ components: description: Information about volume attachment. properties: DeleteOnVmDeletion: - description: If true, the volume is deleted when terminating the VM. If - false, the volume is not deleted when terminating the VM. + description: If true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM. type: boolean DeviceName: description: The name of the device. type: string State: - description: The state of the attachment of the volume (`attaching` \| `detaching` - \| `attached` \| `detached`). + description: The state of the attachment of the volume (`attaching` \| `detaching` \| `attached` \| `detached`). type: string VmId: description: The ID of the VM. @@ -6891,30 +6430,24 @@ components: description: Information about the listener. properties: BackendPort: - description: The port on which the backend VM is listening (between `1` - and `65535`, both included). + description: The port on which the backend VM is listening (between `1` and `65535`, both included). type: integer BackendProtocol: - description: The protocol for routing traffic to backend VMs (`HTTP` \| - `HTTPS` \| `TCP` \| `SSL`). + description: The protocol for routing traffic to backend VMs (`HTTP` \| `HTTPS` \| `TCP` \| `SSL`). type: string LoadBalancerPort: - description: The port on which the load balancer is listening (between `1` - and `65535`, both included). + description: The port on which the load balancer is listening (between `1` and `65535`, both included). type: integer LoadBalancerProtocol: description: The routing protocol (`HTTP` \| `HTTPS` \| `TCP` \| `SSL`). type: string PolicyNames: - description: The names of the policies. If there are no policies enabled, - the list is empty. + description: The names of the policies. If there are no policies enabled, the list is empty. items: type: string type: array ServerCertificateId: - description: The OUTSCALE Resource Name (ORN) of the server certificate. - For more information, see [Resource Identifiers > OUTSCALE Resource Names - (ORNs)](https://docs.outscale.com/en/userguide/Resource-Identifiers.html#_outscale_resource_names_orns). + description: The OUTSCALE Resource Name (ORN) of the server certificate. For more information, see [Resource Identifiers > OUTSCALE Resource Names (ORNs)](https://docs.outscale.com/en/userguide/Resource-Identifiers.html#_outscale_resource_names_orns). type: string type: object ListenerForCreation: @@ -6922,16 +6455,13 @@ components: description: Information about the listener to create. properties: BackendPort: - description: The port on which the backend VM is listening (between `1` - and `65535`, both included). + description: The port on which the backend VM is listening (between `1` and `65535`, both included). type: integer BackendProtocol: - description: The protocol for routing traffic to backend VMs (`HTTP` \| - `HTTPS` \| `TCP` \| `SSL`). + description: The protocol for routing traffic to backend VMs (`HTTP` \| `HTTPS` \| `TCP` \| `SSL`). type: string LoadBalancerPort: - description: The port on which the load balancer is listening (between `1` - and `65535`, both included). + description: The port on which the load balancer is listening (between `1` and `65535`, both included). type: integer LoadBalancerProtocol: description: The routing protocol (`HTTP` \| `HTTPS` \| `TCP` \| `SSL`). @@ -6954,9 +6484,7 @@ components: description: The type of action for the rule (always `forward`). type: string HostNamePattern: - description: A host-name pattern for the rule, with a maximum length of - 128 characters. This host-name pattern supports maximum three wildcards, - and must not contain any special characters except `-.?`. + description: A host-name pattern for the rule, with a maximum length of 128 characters. This host-name pattern supports maximum three wildcards, and must not contain any special characters except `-.?`. type: string ListenerId: description: The ID of the listener. @@ -6968,14 +6496,10 @@ components: description: A human-readable name for the listener rule. type: string PathPattern: - description: A path pattern for the rule, with a maximum length of 128 characters. - This path pattern supports maximum three wildcards, and must not contain - any special characters except `_-.$/~"'@:+?`. + description: A path pattern for the rule, with a maximum length of 128 characters. This path pattern supports maximum three wildcards, and must not contain any special characters except `_-.$/~"'@:+?`. type: string Priority: - description: The priority level of the listener rule, between `1` and `19999` - both included. Each rule must have a unique priority level. Otherwise, - an error is returned. + description: The priority level of the listener rule, between `1` and `19999` both included. Each rule must have a unique priority level. Otherwise, an error is returned. type: integer VmIds: description: The IDs of the backend VMs. @@ -6991,22 +6515,16 @@ components: description: The type of action for the rule (always `forward`). type: string HostNamePattern: - description: A host-name pattern for the rule, with a maximum length of - 128 characters. This host-name pattern supports maximum three wildcards, - and must not contain any special characters except `-.?`. + description: A host-name pattern for the rule, with a maximum length of 128 characters. This host-name pattern supports maximum three wildcards, and must not contain any special characters except `-.?`. type: string ListenerRuleName: description: A human-readable name for the listener rule. type: string PathPattern: - description: A path pattern for the rule, with a maximum length of 128 characters. - This path pattern supports maximum three wildcards, and must not contain - any special characters except `_-.$/~"'@:+?`. + description: A path pattern for the rule, with a maximum length of 128 characters. This path pattern supports maximum three wildcards, and must not contain any special characters except `_-.$/~"'@:+?`. type: string Priority: - description: The priority level of the listener rule, between `1` and `19999` - both included. Each rule must have a unique priority level. Otherwise, - an error is returned. + description: The priority level of the listener rule, between `1` and `19999` both included. Each rule must have a unique priority level. Otherwise, an error is returned. type: integer required: - ListenerRuleName @@ -7017,12 +6535,12 @@ components: description: Information about the load balancer. properties: AccessLog: - "$ref": "#/components/schemas/AccessLog" + $ref: '#/components/schemas/AccessLog' description: Information about access logs. ApplicationStickyCookiePolicies: description: The stickiness policies defined for the load balancer. items: - "$ref": "#/components/schemas/ApplicationStickyCookiePolicy" + $ref: '#/components/schemas/ApplicationStickyCookiePolicy' type: array BackendIps: description: One or more public IPs of backend VMs. @@ -7038,12 +6556,12 @@ components: description: The DNS name of the load balancer. type: string HealthCheck: - "$ref": "#/components/schemas/HealthCheck" + $ref: '#/components/schemas/HealthCheck' description: Information about the health check configuration. Listeners: description: The listeners for the load balancer. items: - "$ref": "#/components/schemas/Listener" + $ref: '#/components/schemas/Listener' type: array LoadBalancerName: description: The name of the load balancer. @@ -7051,7 +6569,7 @@ components: LoadBalancerStickyCookiePolicies: description: The policies defined for the load balancer. items: - "$ref": "#/components/schemas/LoadBalancerStickyCookiePolicy" + $ref: '#/components/schemas/LoadBalancerStickyCookiePolicy' type: array LoadBalancerType: description: |- @@ -7063,20 +6581,18 @@ components: description: The ID of the Net for the load balancer. type: string PublicIp: - description: "(internet-facing only) The public IP associated with the load - balancer." + description: (internet-facing only) The public IP associated with the load balancer. type: string SecuredCookies: description: Whether secure cookies are enabled for the load balancer. type: boolean SecurityGroups: - description: One or more IDs of security groups for the load balancers. - Valid only for load balancers in a Net. + description: One or more IDs of security groups for the load balancers. Valid only for load balancers in a Net. items: type: string type: array SourceSecurityGroup: - "$ref": "#/components/schemas/SourceSecurityGroup" + $ref: '#/components/schemas/SourceSecurityGroup' description: |- Information about the source security group of the load balancer, which you can use as part of your inbound rules for your registered VMs.
To only allow traffic from load balancers, add a security group rule that specifies this source security group as the inbound source. @@ -7093,7 +6609,7 @@ components: Tags: description: One or more tags associated with the load balancer. items: - "$ref": "#/components/schemas/ResourceTag" + $ref: '#/components/schemas/ResourceTag' type: array type: object LoadBalancerLight: @@ -7104,8 +6620,7 @@ components: description: The name of the load balancer to which the listener is attached. type: string LoadBalancerPort: - description: The port of load balancer on which the load balancer is listening - (between `1` and `65535` both included). + description: The port of load balancer on which the load balancer is listening (between `1` and `65535` both included). type: integer required: - LoadBalancerName @@ -7143,12 +6658,10 @@ components: description: Information about the DirectLink location. properties: Code: - description: The location code, to be set as the `Location` parameter of - the *CreateDirectLink* method when creating a DirectLink. + description: The location code, to be set as the `Location` parameter of the *CreateDirectLink* method when creating a DirectLink. type: string Name: - description: The name and description of the location, corresponding to - a datacenter. + description: The name and description of the location, corresponding to a datacenter. type: string type: object Log: @@ -7165,8 +6678,7 @@ components: description: The access key used for the logged call. type: string QueryApiName: - description: The name of the API used by the logged call (always `oapi` - for the OUTSCALE API). + description: The name of the API used by the logged call (always `oapi` for the OUTSCALE API). type: string QueryApiVersion: description: The version of the API used by the logged call. @@ -7176,14 +6688,13 @@ components: type: string QueryDate: description: The date and time (UTC) of the logged call. - format: date + format: date-time type: string QueryHeaderRaw: description: The raw header of the HTTP request of the logged call. type: string QueryHeaderSize: - description: The size of the raw header of the HTTP request of the logged - call, in bytes. + description: The size of the raw header of the HTTP request of the logged call, in bytes. type: integer QueryIpAddress: description: The IP used for the logged call. @@ -7192,8 +6703,7 @@ components: description: The raw payload of the HTTP request of the logged call. type: string QueryPayloadSize: - description: The size of the raw payload of the HTTP request of the logged - call, in bytes. + description: The size of the raw payload of the HTTP request of the logged call, in bytes. type: integer QueryUserAgent: description: The user agent of the HTTP request of the logged call. @@ -7238,8 +6748,7 @@ components: description: The name of the entity. type: string Orn: - description: The OUTSCALE Resource Name (ORN) of the entity. For more information, - see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + description: The OUTSCALE Resource Name (ORN) of the entity. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). type: string type: object NatService: @@ -7256,14 +6765,12 @@ components: description: The ID of the Net in which the NAT service is. type: string PublicIps: - description: Information about the public IP or IPs associated with the - NAT service. + description: Information about the public IP or IPs associated with the NAT service. items: - "$ref": "#/components/schemas/PublicIpLight" + $ref: '#/components/schemas/PublicIpLight' type: array State: - description: The state of the NAT service (`pending` \| `available` \| `deleting` - \| `deleted`). + description: The state of the NAT service (`pending` \| `available` \| `deleting` \| `deleted`). type: string SubnetId: description: The ID of the Subnet in which the NAT service is. @@ -7271,7 +6778,7 @@ components: Tags: description: One or more tags associated with the NAT service. items: - "$ref": "#/components/schemas/ResourceTag" + $ref: '#/components/schemas/ResourceTag' type: array type: object Net: @@ -7279,8 +6786,7 @@ components: description: Information about the Net. properties: DhcpOptionsSetId: - description: The ID of the DHCP options set (or `default` if you want to - associate the default one). + description: The ID of the DHCP options set (or `default` if you want to associate the default one). type: string IpRange: description: The IP range for the Net, in CIDR notation (for example, `10.0.0.0/16`). @@ -7294,7 +6800,7 @@ components: Tags: description: One or more tags associated with the Net. items: - "$ref": "#/components/schemas/ResourceTag" + $ref: '#/components/schemas/ResourceTag' type: array Tenancy: description: The VM tenancy in a Net. @@ -7316,17 +6822,15 @@ components: type: string type: array ServiceName: - description: The name of the service with which the Net access point is - associated. + description: The name of the service with which the Net access point is associated. type: string State: - description: The state of the Net access point (`pending` \| `available` - \| `deleting` \| `deleted`). + description: The state of the Net access point (`pending` \| `available` \| `deleting` \| `deleted`). type: string Tags: description: One or more tags associated with the Net access point. items: - "$ref": "#/components/schemas/ResourceTag" + $ref: '#/components/schemas/ResourceTag' type: array type: object NetPeering: @@ -7334,7 +6838,7 @@ components: description: Information about the Net peering. properties: AccepterNet: - "$ref": "#/components/schemas/AccepterNet" + $ref: '#/components/schemas/AccepterNet' description: Information about the accepter Net. ExpirationDate: description: The date and time (UTC) at which the Net peerings expire. @@ -7345,15 +6849,15 @@ components: description: The ID of the Net peering. type: string SourceNet: - "$ref": "#/components/schemas/SourceNet" + $ref: '#/components/schemas/SourceNet' description: Information about the source Net. State: - "$ref": "#/components/schemas/NetPeeringState" + $ref: '#/components/schemas/NetPeeringState' description: Information about the state of the Net peering. Tags: description: One or more tags associated with the Net peering. items: - "$ref": "#/components/schemas/ResourceTag" + $ref: '#/components/schemas/ResourceTag' type: array type: object NetPeeringState: @@ -7364,8 +6868,7 @@ components: description: Additional information about the state of the Net peering. type: string Name: - description: The state of the Net peering (`pending-acceptance` \| `active` - \| `rejected` \| `failed` \| `expired` \| `deleted`). + description: The state of the Net peering (`pending-acceptance` \| `active` \| `rejected` \| `failed` \| `expired` \| `deleted`). type: string type: object NetToVirtualGatewayLink: @@ -7376,8 +6879,7 @@ components: description: The ID of the Net to which the virtual gateway is attached. type: string State: - description: The state of the attachment (`attaching` \| `attached` \| `detaching` - \| `detached`). + description: The state of the attachment (`attaching` \| `attached` \| `detaching` \| `detached`). type: string type: object Nic: @@ -7391,14 +6893,13 @@ components: description: The description of the NIC. type: string IsSourceDestChecked: - description: "(Net only) If true, the source/destination check is enabled. - If false, it is disabled." + description: (Net only) If true, the source/destination check is enabled. If false, it is disabled. type: boolean LinkNic: - "$ref": "#/components/schemas/LinkNic" + $ref: '#/components/schemas/LinkNic' description: Information about the NIC attachment. LinkPublicIp: - "$ref": "#/components/schemas/LinkPublicIp" + $ref: '#/components/schemas/LinkPublicIp' description: Information about the public IP association. MacAddress: description: The Media Access Control (MAC) address of the NIC. @@ -7415,16 +6916,15 @@ components: PrivateIps: description: The private IPs of the NIC. items: - "$ref": "#/components/schemas/PrivateIp" + $ref: '#/components/schemas/PrivateIp' type: array SecurityGroups: description: One or more IDs of security groups for the NIC. items: - "$ref": "#/components/schemas/SecurityGroupLight" + $ref: '#/components/schemas/SecurityGroupLight' type: array State: - description: The state of the NIC (`available` \| `attaching` \| `in-use` - \| `detaching`). + description: The state of the NIC (`available` \| `attaching` \| `in-use` \| `detaching`). type: string SubnetId: description: The ID of the Subnet. @@ -7435,54 +6935,40 @@ components: Tags: description: One or more tags associated with the NIC. items: - "$ref": "#/components/schemas/ResourceTag" + $ref: '#/components/schemas/ResourceTag' type: array type: object NicForVmCreation: additionalProperties: false - description: Information about the network interface card (NIC) when creating - a virtual machine (VM). + description: Information about the network interface card (NIC) when creating a virtual machine (VM). properties: DeleteOnVmDeletion: - description: If true, the NIC is deleted when the VM is terminated. You - can specify this parameter only for a new NIC. To modify this value for - an existing NIC, see [UpdateNic](#updatenic). + description: If true, the NIC is deleted when the VM is terminated. You can specify this parameter only for a new NIC. To modify this value for an existing NIC, see [UpdateNic](#updatenic). type: boolean Description: - description: The description of the NIC, if you are creating a NIC when - creating the VM. + description: The description of the NIC, if you are creating a NIC when creating the VM. type: string DeviceNumber: - description: The index of the VM device for the NIC attachment (between - `0` and `7`, both included). This parameter is required if you create - a NIC when creating the VM. + description: The index of the VM device for the NIC attachment (between `0` and `7`, both included). This parameter is required if you create a NIC when creating the VM. type: integer NicId: - description: The ID of the NIC, if you are attaching an existing NIC when - creating a VM. + description: The ID of the NIC, if you are attaching an existing NIC when creating a VM. type: string PrivateIps: - description: One or more private IPs to assign to the NIC, if you create - a NIC when creating a VM. Only one private IP can be the primary private - IP. + description: One or more private IPs to assign to the NIC, if you create a NIC when creating a VM. Only one private IP can be the primary private IP. items: - "$ref": "#/components/schemas/PrivateIpLight" + $ref: '#/components/schemas/PrivateIpLight' type: array SecondaryPrivateIpCount: - description: The number of secondary private IPs, if you create a NIC when - creating a VM. This parameter cannot be specified if you specified more - than one private IP in the `PrivateIps` parameter. + description: The number of secondary private IPs, if you create a NIC when creating a VM. This parameter cannot be specified if you specified more than one private IP in the `PrivateIps` parameter. type: integer SecurityGroupIds: - description: One or more IDs of security groups for the NIC, if you create - a NIC when creating a VM. + description: One or more IDs of security groups for the NIC, if you create a NIC when creating a VM. items: type: string type: array SubnetId: - description: The ID of the Subnet for the NIC, if you create a NIC when - creating a VM. This parameter is required if you create a NIC when creating - the VM. + description: The ID of the Subnet for the NIC, if you create a NIC when creating a VM. This parameter is required if you create a NIC when creating the VM. type: string type: object NicLight: @@ -7496,14 +6982,13 @@ components: description: The description of the NIC. type: string IsSourceDestChecked: - description: "(Net only) If true, the source/destination check is enabled. - If false, it is disabled." + description: (Net only) If true, the source/destination check is enabled. If false, it is disabled. type: boolean LinkNic: - "$ref": "#/components/schemas/LinkNicLight" + $ref: '#/components/schemas/LinkNicLight' description: Information about the network interface card (NIC). LinkPublicIp: - "$ref": "#/components/schemas/LinkPublicIpLightForVm" + $ref: '#/components/schemas/LinkPublicIpLightForVm' description: Information about the public IP associated with the NIC. MacAddress: description: The Media Access Control (MAC) address of the NIC. @@ -7520,16 +7005,15 @@ components: PrivateIps: description: The private IP or IPs of the NIC. items: - "$ref": "#/components/schemas/PrivateIpLightForVm" + $ref: '#/components/schemas/PrivateIpLightForVm' type: array SecurityGroups: description: One or more IDs of security groups for the NIC. items: - "$ref": "#/components/schemas/SecurityGroupLight" + $ref: '#/components/schemas/SecurityGroupLight' type: array State: - description: The state of the NIC (`available` \| `attaching` \| `in-use` - \| `detaching`). + description: The state of the NIC (`available` \| `attaching` \| `in-use` \| `detaching`). type: string SubnetId: description: The ID of the Subnet for the NIC. @@ -7540,12 +7024,10 @@ components: description: Information about the OOS API key. properties: ApiKeyId: - description: The API key of the OOS account that enables you to access the - bucket. + description: The API key of the OOS account that enables you to access the bucket. type: string SecretKey: - description: The secret key of the OOS account that enables you to access - the bucket. + description: The secret key of the OOS account that enables you to access the bucket. type: string type: object OsuExportImageExportTask: @@ -7562,8 +7044,7 @@ components: description: The URL of the manifest file. type: string OsuPrefix: - description: The prefix for the key of the OOS object corresponding to the - image. + description: The prefix for the key of the OOS object corresponding to the image. type: string required: - DiskImageFormat @@ -7580,8 +7061,7 @@ components: description: The name of the OOS bucket the snapshot is exported to. type: string OsuPrefix: - description: The prefix for the key of the OOS object corresponding to the - snapshot. + description: The prefix for the key of the OOS object corresponding to the snapshot. type: string required: - DiskImageFormat @@ -7595,7 +7075,7 @@ components: description: The format of the export disk (`qcow2` \| `raw`). type: string OsuApiKey: - "$ref": "#/components/schemas/OsuApiKey" + $ref: '#/components/schemas/OsuApiKey' description: Information about the OOS API key. OsuBucket: description: The name of the OOS bucket where you want to export the object. @@ -7633,60 +7113,50 @@ components: Specify either the `Additions` or the `Removals` parameter. properties: Additions: - "$ref": "#/components/schemas/PermissionsOnResource" + $ref: '#/components/schemas/PermissionsOnResource' description: Permissions for the resource. Removals: - "$ref": "#/components/schemas/PermissionsOnResource" + $ref: '#/components/schemas/PermissionsOnResource' description: Permissions for the resource. type: object Phase1Options: additionalProperties: false - description: This parameter is not available. It is present in our API for the - sake of historical compatibility with AWS. + description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS. properties: DpdTimeoutAction: - description: This parameter is not available. It is present in our API for - the sake of historical compatibility with AWS. + description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS. type: string DpdTimeoutSeconds: - description: This parameter is not available. It is present in our API for - the sake of historical compatibility with AWS. + description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS. type: integer IkeVersions: - description: This parameter is not available. It is present in our API for - the sake of historical compatibility with AWS. + description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS. items: type: string type: array Phase1DhGroupNumbers: - description: This parameter is not available. It is present in our API for - the sake of historical compatibility with AWS. + description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS. items: type: integer type: array Phase1EncryptionAlgorithms: - description: This parameter is not available. It is present in our API for - the sake of historical compatibility with AWS. + description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS. items: type: string type: array Phase1IntegrityAlgorithms: - description: This parameter is not available. It is present in our API for - the sake of historical compatibility with AWS. + description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS. items: type: string type: array Phase1LifetimeSeconds: - description: This parameter is not available. It is present in our API for - the sake of historical compatibility with AWS. + description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS. type: integer ReplayWindowSize: - description: This parameter is not available. It is present in our API for - the sake of historical compatibility with AWS. + description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS. type: integer StartupAction: - description: This parameter is not available. It is present in our API for - the sake of historical compatibility with AWS. + description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS. type: string type: object Phase2Options: @@ -7694,31 +7164,25 @@ components: description: Information about Phase 2 of the Internet Key Exchange (IKE) negotiation. properties: Phase2DhGroupNumbers: - description: This parameter is not available. It is present in our API for - the sake of historical compatibility with AWS. + description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS. items: type: integer type: array Phase2EncryptionAlgorithms: - description: This parameter is not available. It is present in our API for - the sake of historical compatibility with AWS. + description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS. items: type: string type: array Phase2IntegrityAlgorithms: - description: This parameter is not available. It is present in our API for - the sake of historical compatibility with AWS. + description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS. items: type: string type: array Phase2LifetimeSeconds: - description: This parameter is not available. It is present in our API for - the sake of historical compatibility with AWS. + description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS. type: integer PreSharedKey: - description: The pre-shared key to establish the initial authentication - between the client gateway and the virtual gateway. This key can contain - any character except line breaks and double quotes ("). + description: The pre-shared key to establish the initial authentication between the client gateway and the virtual gateway. This key can contain any character except line breaks and double quotes ("). type: string type: object Placement: @@ -7726,12 +7190,10 @@ components: description: Information about the placement of the VM. properties: SubregionName: - description: The name of the Subregion. If you specify this parameter, you - must not specify the `Nics` parameter. + description: The name of the Subregion. If you specify this parameter, you must not specify the `Nics` parameter. type: string Tenancy: - description: The tenancy of the VM (`default`, `dedicated`, or a dedicated - group ID). + description: The tenancy of the VM (`default`, `dedicated`, or a dedicated group ID). type: string type: object Policy: @@ -7746,16 +7208,14 @@ components: description: A friendly name for the policy (between 0 and 1000 characters). type: string IsLinkable: - description: Indicates whether the policy can be linked to a group or an - EIM user. + description: Indicates whether the policy can be linked to a group or an EIM user. type: boolean LastModificationDate: description: The date and time (UTC) at which the policy was last modified. format: date-time type: string Orn: - description: The OUTSCALE Resource Name (ORN) of the policy. For more information, - see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + description: The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). type: string Path: description: The path to the policy. @@ -7780,16 +7240,15 @@ components: Accounts: description: The accounts linked to the specified policy. items: - "$ref": "#/components/schemas/MinimalPolicy" + $ref: '#/components/schemas/MinimalPolicy' type: array Groups: description: The groups linked to the specified policy. items: - "$ref": "#/components/schemas/MinimalPolicy" + $ref: '#/components/schemas/MinimalPolicy' type: array HasMoreItems: - description: If true, there are more items to return using the `FirstItem` - parameter in a new request. + description: If true, there are more items to return using the `FirstItem` parameter in a new request. type: boolean ItemsCount: description: The number of entities the specified policy is linked to. @@ -7798,13 +7257,12 @@ components: description: Indicates maximum results defined for the operation. type: integer MaxResultsTruncated: - description: If true, indicates whether requested page size is more than - allowed. + description: If true, indicates whether requested page size is more than allowed. type: boolean Users: description: The users linked to the specified policy. items: - "$ref": "#/components/schemas/MinimalPolicy" + $ref: '#/components/schemas/MinimalPolicy' type: array type: object PolicyVersion: @@ -7812,9 +7270,7 @@ components: description: Information about the policy version. properties: Body: - description: The policy document, corresponding to a JSON string that contains - the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html) - and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html). + description: The policy document, corresponding to a JSON string that contains the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html) and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html). type: string CreationDate: description: The date and time (UTC) at which the version was created. @@ -7835,7 +7291,7 @@ components: description: If true, the IP is the primary private IP of the NIC. type: boolean LinkPublicIp: - "$ref": "#/components/schemas/LinkPublicIp" + $ref: '#/components/schemas/LinkPublicIp' description: Information about the public IP association. PrivateDnsName: description: The name of the private DNS. @@ -7863,7 +7319,7 @@ components: description: If true, the IP is the primary private IP of the NIC. type: boolean LinkPublicIp: - "$ref": "#/components/schemas/LinkPublicIpLightForVm" + $ref: '#/components/schemas/LinkPublicIpLightForVm' description: Information about the public IP associated with the NIC. PrivateDnsName: description: The name of the private DNS. @@ -7891,8 +7347,7 @@ components: description: Information about the public IP. properties: LinkPublicIpId: - description: "(Required in a Net) The ID representing the association of - the public IP with the VM or the NIC." + description: (Required in a Net) The ID representing the association of the public IP with the VM or the NIC. type: string NicAccountId: description: The account ID of the owner of the NIC. @@ -7912,7 +7367,7 @@ components: Tags: description: One or more tags associated with the public IP. items: - "$ref": "#/components/schemas/ResourceTag" + $ref: '#/components/schemas/ResourceTag' type: array VmId: description: The ID of the VM the public IP is associated with (if any). @@ -7926,21 +7381,17 @@ components: description: The public IP associated with the NAT service. type: string PublicIpId: - description: The allocation ID of the public IP associated with the NAT - service. + description: The allocation ID of the public IP associated with the NAT service. type: string type: object PutUserGroupPolicyRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean PolicyDocument: - description: The policy document, corresponding to a JSON string that contains - the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html) - and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html). + description: The policy document, corresponding to a JSON string that contains the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html) and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html). type: string PolicyName: description: The name of the policy. @@ -7949,8 +7400,7 @@ components: description: The name of the group. type: string UserGroupPath: - description: The path to the group. If not specified, it is set to a slash - (`/`). + description: The path to the group. If not specified, it is set to a slash (`/`). type: string required: - PolicyName @@ -7961,20 +7411,17 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object PutUserPolicyRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean PolicyDocument: - description: The policy document, corresponding to a JSON string that contains - the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html) - and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html). + description: The policy document, corresponding to a JSON string that contains the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html) and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html). type: string PolicyName: description: The name of the policy (between 1 and 128 characters). @@ -7991,7 +7438,7 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object Quota: @@ -8005,8 +7452,7 @@ components: description: The description of the quota. type: string MaxValue: - description: The maximum value of the quota for the account (if there is - no limit, `0`). + description: The maximum value of the quota for the account (if there is no limit, `0`). type: integer Name: description: The unique name of the quota. @@ -8026,31 +7472,28 @@ components: description: One or more quotas. properties: QuotaType: - description: The resource ID if it is a resource-specific quota, `global` - if it is not. + description: The resource ID if it is a resource-specific quota, `global` if it is not. type: string Quotas: description: One or more quotas associated with the account. items: - "$ref": "#/components/schemas/Quota" + $ref: '#/components/schemas/Quota' type: array type: object ReadAccessKeysRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersAccessKeys" + $ref: '#/components/schemas/FiltersAccessKeys' description: One or more filters. Tag: description: The tag added to the access key. type: string UserName: - description: The name of the EIM user. By default, the user who sends the - request (which can be the root account). + description: The name of the EIM user. By default, the user who sends the request (which can be the root account). type: string type: object ReadAccessKeysResponse: @@ -8059,18 +7502,17 @@ components: AccessKeys: description: A list of access keys. items: - "$ref": "#/components/schemas/AccessKey" + $ref: '#/components/schemas/AccessKey' type: array ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadAccountsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean type: object ReadAccountsResponse: @@ -8079,18 +7521,17 @@ components: Accounts: description: The list of the accounts. items: - "$ref": "#/components/schemas/Account" + $ref: '#/components/schemas/Account' type: array ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadAdminPasswordRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean VmId: description: The ID of the VM. @@ -8102,11 +7543,10 @@ components: additionalProperties: false properties: AdminPassword: - description: The password of the VM. After the first boot, returns an empty - string. + description: The password of the VM. After the first boot, returns an empty string. type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. VmId: description: The ID of the VM. @@ -8116,29 +7556,27 @@ components: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean type: object ReadApiAccessPolicyResponse: additionalProperties: false properties: ApiAccessPolicy: - "$ref": "#/components/schemas/ApiAccessPolicy" + $ref: '#/components/schemas/ApiAccessPolicy' description: Information about the API access policy. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadApiAccessRulesRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersApiAccessRule" + $ref: '#/components/schemas/FiltersApiAccessRule' description: One or more filters. type: object ReadApiAccessRulesResponse: @@ -8147,33 +7585,30 @@ components: ApiAccessRules: description: A list of API access rules. items: - "$ref": "#/components/schemas/ApiAccessRule" + $ref: '#/components/schemas/ApiAccessRule' type: array ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadApiLogsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersApiLog" + $ref: '#/components/schemas/FiltersApiLog' description: One or more filters. NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. type: string ResultsPerPage: default: 100 - description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). + description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). type: integer With: - "$ref": "#/components/schemas/With" + $ref: '#/components/schemas/With' description: The information to display in each returned log. type: object ReadApiLogsResponse: @@ -8182,25 +7617,67 @@ components: Logs: description: Information about one or more logs. items: - "$ref": "#/components/schemas/Log" + $ref: '#/components/schemas/Log' type: array NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' + description: Information about the context of the response. + type: object + ReadCO2EmissionAccountRequest: + additionalProperties: false + properties: + FromMonth: + description: The beginning of the time period, in ISO 8601 date format (for example, `2020-06-01`). This value must correspond to the first day of the month and is included in the time period. + oneOf: + - format: date + type: string + - format: date-time + type: string + Overall: + default: false + description: If false, returns only the CO2 emission of the specific account that sends the request. If true, returns either the overall CO2 emission of your paying account and all linked accounts (if the account that sends this request is a paying account) or returns nothing (if the account that sends this request is a linked account). + type: boolean + ToMonth: + description: The end of the time period, in ISO 8601 date format (for example, `2020-06-14`). This value must correspond to the first day of the month and is excluded from the time period. It must be set to a later date than `FromMonth`. + oneOf: + - format: date + type: string + - format: date-time + type: string + required: + - FromMonth + - ToMonth + type: object + ReadCO2EmissionAccountResponse: + additionalProperties: false + properties: + CO2EmissionEntries: + description: The CO2 emission by month and account, for the specified request. + items: + $ref: '#/components/schemas/CO2EmissionEntry' + type: array + ResponseContext: + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. + Unit: + description: The unit of all the `Value` fields of the response, expressed in kgCOâ‚‚e. + type: string + Value: + description: The total CO2 emission for the specified request. + format: double + type: number type: object ReadCasRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersCa" + $ref: '#/components/schemas/FiltersCa' description: One or more filters. type: object ReadCasResponse: @@ -8209,39 +7686,37 @@ components: Cas: description: Information about one or more CAs. items: - "$ref": "#/components/schemas/Ca" + $ref: '#/components/schemas/Ca' type: array ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadCatalogRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean type: object ReadCatalogResponse: additionalProperties: false properties: Catalog: - "$ref": "#/components/schemas/Catalog" + $ref: '#/components/schemas/Catalog' description: Information about our catalog of prices. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadCatalogsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersCatalogs" + $ref: '#/components/schemas/FiltersCatalogs' description: One or more filters. type: object ReadCatalogsResponse: @@ -8250,30 +7725,27 @@ components: Catalogs: description: Information about one or more catalogs. items: - "$ref": "#/components/schemas/Catalogs" + $ref: '#/components/schemas/Catalogs' type: array ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadClientGatewaysRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersClientGateway" + $ref: '#/components/schemas/FiltersClientGateway' description: One or more filters. NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResultsPerPage: - description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). + description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). type: integer type: object ReadClientGatewaysResponse: @@ -8282,23 +7754,21 @@ components: ClientGateways: description: Information about one or more client gateways. items: - "$ref": "#/components/schemas/ClientGateway" + $ref: '#/components/schemas/ClientGateway' type: array NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadConsoleOutputRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean VmId: description: The ID of the VM. @@ -8310,11 +7780,10 @@ components: additionalProperties: false properties: ConsoleOutput: - description: The Base64-encoded output of the console. If a command line - tool is used, the output is decoded by the tool. + description: The Base64-encoded output of the console. If a command line tool is used, the output is decoded by the tool. type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. VmId: description: The ID of the VM. @@ -8324,37 +7793,33 @@ components: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean FromDate: - description: The beginning of the time period, in ISO 8601 date format (for - example, `2020-06-14`). The date-time format is also accepted, but only - with a time set to midnight (for example, `2020-06-14T00:00:00.000Z`). - This value is included in the time period. - format: datetime - type: string + description: The beginning of the time period, in ISO 8601 date format (for example, `2020-06-14`). The date-time format is also accepted, but only with a time set to midnight (for example, `2020-06-14T00:00:00.000Z`). This value is included in the time period. + oneOf: + - format: date + type: string + - format: date-time + type: string Overall: default: false - description: If false, returns only the consumption of the specific account - that sends this request. If true, returns either the overall consumption - of your paying account and all linked accounts (if the account that sends - this request is a paying account) or returns nothing (if the account that - sends this request is a linked account). + description: If false, returns only the consumption of the specific account that sends this request. If true, returns either the overall consumption of your paying account and all linked accounts (if the account that sends this request is a paying account) or returns nothing (if the account that sends this request is a linked account). type: boolean ShowPrice: - description: If true, the response also includes the unit price of the consumed - resource (`UnitPrice`) and the total price of the consumed resource during - the specified time period (`Price`), in the currency of your account. + description: If true, the response also includes the unit price of the consumed resource (`UnitPrice`) and the total price of the consumed resource during the specified time period (`Price`), in the currency of the Region's catalog. + type: boolean + ShowResourceDetails: + default: false + description: By default or if false, returns the consumption aggregated by resource type. If true, the response returns the consumption per `ResourceId`. type: boolean ToDate: - description: The end of the time period, in ISO 8601 date format (for example, - `2020-06-30`). The date-time format is also accepted, but only with a - time set to midnight (for example, `2020-06-30T00:00:00.000Z`). This value - is excluded from the time period, and must be set to a later date than - `FromDate`. - format: datetime - type: string + description: The end of the time period, in ISO 8601 date format (for example, `2020-06-30`). The date-time format is also accepted, but only with a time set to midnight (for example, `2020-06-30T00:00:00.000Z`). This value is excluded from the time period, and must be set to a later date than `FromDate`. + oneOf: + - format: date + type: string + - format: date-time + type: string required: - FromDate - ToDate @@ -8363,38 +7828,33 @@ components: additionalProperties: false properties: ConsumptionEntries: - description: Information about the resources consumed during the specified - time period. + description: Information about the resources consumed during the specified time period. items: - "$ref": "#/components/schemas/ConsumptionEntry" + $ref: '#/components/schemas/ConsumptionEntry' type: array Currency: - description: The currency of your account for the `UnitPrice` and `Price` - parameters, in the ISO-4217 format (for example, `EUR`). + description: The currency of your account for the `UnitPrice` and `Price` parameters, in the ISO-4217 format (for example, `EUR`). nullable: true type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadDedicatedGroupsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersDedicatedGroup" + $ref: '#/components/schemas/FiltersDedicatedGroup' description: One or more filters. NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResultsPerPage: - description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). + description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). type: integer type: object ReadDedicatedGroupsResponse: @@ -8403,35 +7863,31 @@ components: DedicatedGroups: description: Information about one or more dedicated groups. items: - "$ref": "#/components/schemas/DedicatedGroup" + $ref: '#/components/schemas/DedicatedGroup' type: array NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadDhcpOptionsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersDhcpOptions" + $ref: '#/components/schemas/FiltersDhcpOptions' description: One or more filters. NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResultsPerPage: - description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). + description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). type: integer type: object ReadDhcpOptionsResponse: @@ -8440,35 +7896,31 @@ components: DhcpOptionsSets: description: Information about one or more DHCP options sets. items: - "$ref": "#/components/schemas/DhcpOptionsSet" + $ref: '#/components/schemas/DhcpOptionsSet' type: array NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadDirectLinkInterfacesRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersDirectLinkInterface" + $ref: '#/components/schemas/FiltersDirectLinkInterface' description: One or more filters. NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResultsPerPage: - description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). + description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). type: integer type: object ReadDirectLinkInterfacesResponse: @@ -8477,35 +7929,31 @@ components: DirectLinkInterfaces: description: Information about one or more DirectLink interfaces. items: - "$ref": "#/components/schemas/DirectLinkInterfaces" + $ref: '#/components/schemas/DirectLinkInterfaces' type: array NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadDirectLinksRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersDirectLink" + $ref: '#/components/schemas/FiltersDirectLink' description: One or more filters. NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResultsPerPage: - description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). + description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). type: integer type: object ReadDirectLinksResponse: @@ -8514,23 +7962,21 @@ components: DirectLinks: description: Information about one or more DirectLinks. items: - "$ref": "#/components/schemas/DirectLink" + $ref: '#/components/schemas/DirectLink' type: array NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadEntitiesLinkedToPolicyRequest: additionalProperties: false properties: EntitiesType: - description: The type of entity linked to the policy you want to get information - about. + description: The type of entity linked to the policy you want to get information about. items: enum: - ACCOUNT @@ -8542,16 +7988,11 @@ components: description: The item starting the list of entities requested. type: integer PolicyOrn: - description: The OUTSCALE Resource Name (ORN) of the policy. For more information, - see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). - pattern: "^orn:ows:(iam|idauth):\\S*:\\d{12}:policy/\\S+$" + description: The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + pattern: ^orn:ows:(iam|idauth):\S*:\d{12}:policy/\S+$ type: string - ResponseContext: - "$ref": "#/components/schemas/ResponseContext" - description: Information about the context of the response. ResultsPerPage: - description: The maximum number of items that can be returned in a single - response (by default, 100). + description: The maximum number of items that can be returned in a single response (by default, 100). type: integer required: - PolicyOrn @@ -8560,42 +8001,39 @@ components: additionalProperties: false properties: PolicyEntities: - "$ref": "#/components/schemas/PolicyEntities" + $ref: '#/components/schemas/PolicyEntities' description: Information about the policy entities. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadFlexibleGpuCatalogRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean type: object ReadFlexibleGpuCatalogResponse: additionalProperties: false properties: FlexibleGpuCatalog: - description: Information about one or more fGPUs available in the public - catalog. + description: Information about one or more fGPUs available in the public catalog. items: - "$ref": "#/components/schemas/FlexibleGpuCatalog" + $ref: '#/components/schemas/FlexibleGpuCatalog' type: array ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadFlexibleGpusRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersFlexibleGpu" + $ref: '#/components/schemas/FiltersFlexibleGpu' description: One or more filters. type: object ReadFlexibleGpusResponse: @@ -8604,30 +8042,27 @@ components: FlexibleGpus: description: Information about one or more fGPUs. items: - "$ref": "#/components/schemas/FlexibleGpu" + $ref: '#/components/schemas/FlexibleGpu' type: array ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadImageExportTasksRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersExportTask" + $ref: '#/components/schemas/FiltersExportTask' description: One or more filters. NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResultsPerPage: - description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). + description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). type: integer type: object ReadImageExportTasksResponse: @@ -8636,35 +8071,31 @@ components: ImageExportTasks: description: Information about one or more image export tasks. items: - "$ref": "#/components/schemas/ImageExportTask" + $ref: '#/components/schemas/ImageExportTask' type: array NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadImagesRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersImage" + $ref: '#/components/schemas/FiltersImage' description: One or more filters. NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResultsPerPage: - description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). + description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). type: integer type: object ReadImagesResponse: @@ -8673,35 +8104,31 @@ components: Images: description: Information about one or more OMIs. items: - "$ref": "#/components/schemas/Image" + $ref: '#/components/schemas/Image' type: array NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadInternetServicesRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersInternetService" + $ref: '#/components/schemas/FiltersInternetService' description: One or more filters. NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResultsPerPage: - description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). + description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). type: integer type: object ReadInternetServicesResponse: @@ -8710,35 +8137,31 @@ components: InternetServices: description: Information about one or more internet services. items: - "$ref": "#/components/schemas/InternetService" + $ref: '#/components/schemas/InternetService' type: array NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadKeypairsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersKeypair" + $ref: '#/components/schemas/FiltersKeypair' description: One or more filters. NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResultsPerPage: - description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). By default, `100`. type: integer type: object ReadKeypairsResponse: @@ -8747,15 +8170,14 @@ components: Keypairs: description: Information about one or more keypairs. items: - "$ref": "#/components/schemas/Keypair" + $ref: '#/components/schemas/Keypair' type: array NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadLinkedPoliciesFilters: @@ -8763,26 +8185,23 @@ components: description: One or more filters. properties: PathPrefix: - description: The path prefix of the policies. If not specified, it is set - to a slash (`/`). + description: The path prefix of the policies. If not specified, it is set to a slash (`/`). type: string type: object ReadLinkedPoliciesRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/ReadLinkedPoliciesFilters" + $ref: '#/components/schemas/ReadLinkedPoliciesFilters' description: One or more filters. FirstItem: description: The item starting the list of policies requested. type: integer ResultsPerPage: - description: The maximum number of items that can be returned in a single - response (by default, `100`). + description: The maximum number of items that can be returned in a single response (by default, `100`). type: integer UserName: description: The name of the user the policies are linked to. @@ -8794,34 +8213,31 @@ components: additionalProperties: false properties: HasMoreItems: - description: If true, there are more items to return using the `FirstItem` - parameter in a new request. + description: If true, there are more items to return using the `FirstItem` parameter in a new request. type: boolean MaxResultsLimit: description: Indicates maximum results defined for the operation. type: integer MaxResultsTruncated: - description: If true, indicates whether requested page size is more than - allowed. + description: If true, indicates whether requested page size is more than allowed. type: boolean Policies: description: One or more policies linked to the specified user. items: - "$ref": "#/components/schemas/LinkedPolicy" + $ref: '#/components/schemas/LinkedPolicy' type: array ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadListenerRulesRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersListenerRule" + $ref: '#/components/schemas/FiltersListenerRule' description: One or more filters. type: object ReadListenerRulesResponse: @@ -8830,18 +8246,17 @@ components: ListenerRules: description: The list of the rules to describe. items: - "$ref": "#/components/schemas/ListenerRule" + $ref: '#/components/schemas/ListenerRule' type: array ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadLoadBalancerTagsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean LoadBalancerNames: description: One or more load balancer names. @@ -8855,23 +8270,22 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. Tags: description: Information about one or more load balancer tags. items: - "$ref": "#/components/schemas/LoadBalancerTag" + $ref: '#/components/schemas/LoadBalancerTag' type: array type: object ReadLoadBalancersRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersLoadBalancer" + $ref: '#/components/schemas/FiltersLoadBalancer' description: One or more filters. type: object ReadLoadBalancersResponse: @@ -8880,27 +8294,24 @@ components: LoadBalancers: description: Information about one or more load balancers. items: - "$ref": "#/components/schemas/LoadBalancer" + $ref: '#/components/schemas/LoadBalancer' type: array ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadLocationsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResultsPerPage: - description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). + description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). type: integer type: object ReadLocationsResponse: @@ -8909,33 +8320,30 @@ components: Locations: description: Information about one or more locations. items: - "$ref": "#/components/schemas/Location" + $ref: '#/components/schemas/Location' type: array NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadManagedPoliciesLinkedToUserGroupRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersUserGroup" + $ref: '#/components/schemas/FiltersUserGroup' description: One or more filters. FirstItem: description: The item starting the list of policies requested. type: integer ResultsPerPage: - description: The maximum number of items that can be returned in a single - response (by default, `100`). + description: The maximum number of items that can be returned in a single response (by default, `100`). type: integer UserGroupName: description: The name of the group. @@ -8947,43 +8355,38 @@ components: additionalProperties: false properties: HasMoreItems: - description: If true, there are more items to return using the `FirstItem` - parameter in a new request. + description: If true, there are more items to return using the `FirstItem` parameter in a new request. type: boolean MaxResultsLimit: description: Indicates maximum results defined for the operation. type: integer MaxResultsTruncated: - description: If true, indicates whether requested page size is more than - allowed. + description: If true, indicates whether requested page size is more than allowed. type: boolean Policies: description: A list of policies. items: - "$ref": "#/components/schemas/LinkedPolicy" + $ref: '#/components/schemas/LinkedPolicy' type: array ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadNatServicesRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersNatService" + $ref: '#/components/schemas/FiltersNatService' description: One or more filters. NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResultsPerPage: - description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). + description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). type: integer type: object ReadNatServicesResponse: @@ -8992,72 +8395,64 @@ components: NatServices: description: Information about one or more NAT services. items: - "$ref": "#/components/schemas/NatService" + $ref: '#/components/schemas/NatService' type: array NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadNetAccessPointServicesRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersService" + $ref: '#/components/schemas/FiltersService' description: One or more filters. NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResultsPerPage: - description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). + description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). type: integer type: object ReadNetAccessPointServicesResponse: additionalProperties: false properties: NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. Services: description: The names of the services you can use for Net access points. items: - "$ref": "#/components/schemas/Service" + $ref: '#/components/schemas/Service' type: array type: object ReadNetAccessPointsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersNetAccessPoint" + $ref: '#/components/schemas/FiltersNetAccessPoint' description: One or more filters. NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResultsPerPage: - description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). + description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). type: integer type: object ReadNetAccessPointsResponse: @@ -9066,35 +8461,31 @@ components: NetAccessPoints: description: One or more Net access points. items: - "$ref": "#/components/schemas/NetAccessPoint" + $ref: '#/components/schemas/NetAccessPoint' type: array NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadNetPeeringsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersNetPeering" + $ref: '#/components/schemas/FiltersNetPeering' description: One or more filters. NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResultsPerPage: - description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). + description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). type: integer type: object ReadNetPeeringsResponse: @@ -9103,35 +8494,31 @@ components: NetPeerings: description: Information about one or more Net peerings. items: - "$ref": "#/components/schemas/NetPeering" + $ref: '#/components/schemas/NetPeering' type: array NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadNetsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersNet" + $ref: '#/components/schemas/FiltersNet' description: One or more filters. NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResultsPerPage: - description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). + description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). type: integer type: object ReadNetsResponse: @@ -9140,52 +8527,47 @@ components: Nets: description: Information about the described Nets. items: - "$ref": "#/components/schemas/Net" + $ref: '#/components/schemas/Net' type: array NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadNicsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersNic" + $ref: '#/components/schemas/FiltersNic' description: One or more filters. NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResultsPerPage: - description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). + description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). type: integer type: object ReadNicsResponse: additionalProperties: false properties: NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string Nics: description: Information about one or more NICs. items: - "$ref": "#/components/schemas/Nic" + $ref: '#/components/schemas/Nic' type: array ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadPoliciesFilters: @@ -9196,13 +8578,10 @@ components: description: If set to true, lists only the policies attached to a user. type: boolean PathPrefix: - description: The path prefix you can use to filter the results. If not specified, - it is set to a slash (`/`). + description: The path prefix you can use to filter the results. If not specified, it is set to a slash (`/`). type: string Scope: - description: The scope of the policies. A policy can either be created by - Outscale (`OWS`), and therefore applies to all accounts, or be created - by its users (`LOCAL`). + description: The scope of the policies. A policy can either be created by Outscale (`OWS`), and therefore applies to all accounts, or be created by its users (`LOCAL`). enum: - LOCAL - OWS @@ -9212,50 +8591,45 @@ components: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/ReadPoliciesFilters" + $ref: '#/components/schemas/ReadPoliciesFilters' description: One or more filters. FirstItem: description: The item starting the list of policies requested. type: integer ResultsPerPage: - description: The maximum number of items that can be returned in a single - response (by default, `100`). + description: The maximum number of items that can be returned in a single response (by default, `100`). type: integer type: object ReadPoliciesResponse: additionalProperties: false properties: HasMoreItems: - description: If true, there are more items to return using the `FirstItem` - parameter in a new request. + description: If true, there are more items to return using the `FirstItem` parameter in a new request. type: boolean MaxResultsLimit: description: Indicates maximum results defined for the operation. type: integer MaxResultsTruncated: - description: If true, indicates whether requested page size is more than - allowed. + description: If true, indicates whether requested page size is more than allowed. type: boolean Policies: description: Information about one or more policies. items: - "$ref": "#/components/schemas/Policy" + $ref: '#/components/schemas/Policy' type: array ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadPolicyRequest: additionalProperties: false properties: PolicyOrn: - description: The OUTSCALE Resource Name (ORN) of the policy. For more information, - see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). - pattern: "^orn:ows:(iam|idauth):\\S*:\\d{12}:policy/\\S+$" + description: The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + pattern: ^orn:ows:(iam|idauth):\S*:\d{12}:policy/\S+$ type: string required: - PolicyOrn @@ -9264,19 +8638,18 @@ components: additionalProperties: false properties: Policy: - "$ref": "#/components/schemas/Policy" + $ref: '#/components/schemas/Policy' description: Information about the policy. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadPolicyVersionRequest: additionalProperties: false properties: PolicyOrn: - description: The OUTSCALE Resource Name (ORN) of the policy. For more information, - see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). - pattern: "^orn:ows:(iam|idauth):\\S*:\\d{12}:policy/\\S+$" + description: The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + pattern: ^orn:ows:(iam|idauth):\S*:\d{12}:policy/\S+$ type: string VersionId: description: The ID of the policy version. @@ -9289,10 +8662,10 @@ components: additionalProperties: false properties: PolicyVersion: - "$ref": "#/components/schemas/PolicyVersion" + $ref: '#/components/schemas/PolicyVersion' description: Information about the policy version. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadPolicyVersionsRequest: @@ -9302,13 +8675,11 @@ components: description: The item starting the list of policies requested. type: integer PolicyOrn: - description: The OUTSCALE Resource Name (ORN) of the policy. For more information, - see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). - pattern: "^orn:ows:(iam|idauth):\\S*:\\d{12}:policy/\\S+$" + description: The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + pattern: ^orn:ows:(iam|idauth):\S*:\d{12}:policy/\S+$ type: string ResultsPerPage: - description: The maximum number of items that can be returned in a single - response (by default, `100`). + description: The maximum number of items that can be returned in a single response (by default, `100`). type: integer required: - PolicyOrn @@ -9317,8 +8688,7 @@ components: additionalProperties: false properties: HasMoreItems: - description: If true, there are more items to return using the `FirstItem` - parameter in a new request. + description: If true, there are more items to return using the `FirstItem` parameter in a new request. type: boolean MaxResultsLimit: description: Indicates maximum results defined for the operation. @@ -9326,182 +8696,163 @@ components: PolicyVersions: description: A list of all the versions of the policy. items: - "$ref": "#/components/schemas/PolicyVersion" + $ref: '#/components/schemas/PolicyVersion' type: array ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadProductTypesRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersProductType" + $ref: '#/components/schemas/FiltersProductType' description: One or more filters. NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResultsPerPage: - description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). + description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). type: integer type: object ReadProductTypesResponse: additionalProperties: false properties: NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ProductTypes: description: Information about one or more product types. items: - "$ref": "#/components/schemas/ProductType" + $ref: '#/components/schemas/ProductType' type: array ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadPublicCatalogRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean type: object ReadPublicCatalogResponse: additionalProperties: false properties: Catalog: - "$ref": "#/components/schemas/Catalog" + $ref: '#/components/schemas/Catalog' description: Information about our catalog of prices. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadPublicIpRangesRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResultsPerPage: - description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). + description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). type: integer type: object ReadPublicIpRangesResponse: additionalProperties: false properties: NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string PublicIps: - description: The list of public IPv4 addresses used in the Region, in CIDR - notation. + description: The list of public IPv4 addresses used in the Region, in CIDR notation. items: type: string type: array ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadPublicIpsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersPublicIp" + $ref: '#/components/schemas/FiltersPublicIp' description: One or more filters. NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResultsPerPage: - description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). + description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). type: integer type: object ReadPublicIpsResponse: additionalProperties: false properties: NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string PublicIps: description: Information about one or more public IPs. items: - "$ref": "#/components/schemas/PublicIp" + $ref: '#/components/schemas/PublicIp' type: array ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadQuotasRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersQuota" + $ref: '#/components/schemas/FiltersQuota' description: One or more filters. NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResultsPerPage: - description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). + description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). type: integer type: object ReadQuotasResponse: additionalProperties: false properties: NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string QuotaTypes: description: Information about one or more quotas. items: - "$ref": "#/components/schemas/QuotaTypes" + $ref: '#/components/schemas/QuotaTypes' type: array ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadRegionsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean type: object ReadRegionsResponse: @@ -9510,308 +8861,276 @@ components: Regions: description: Information about one or more Regions. items: - "$ref": "#/components/schemas/Region" + $ref: '#/components/schemas/Region' type: array ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadRouteTablesRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersRouteTable" + $ref: '#/components/schemas/FiltersRouteTable' description: One or more filters. NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResultsPerPage: - description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). + description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). type: integer type: object ReadRouteTablesResponse: additionalProperties: false properties: NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. RouteTables: description: Information about one or more route tables. items: - "$ref": "#/components/schemas/RouteTable" + $ref: '#/components/schemas/RouteTable' type: array type: object ReadSecurityGroupsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersSecurityGroup" + $ref: '#/components/schemas/FiltersSecurityGroup' description: One or more filters. NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResultsPerPage: - description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). + description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). type: integer type: object ReadSecurityGroupsResponse: additionalProperties: false properties: NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. SecurityGroups: description: Information about one or more security groups. items: - "$ref": "#/components/schemas/SecurityGroup" + $ref: '#/components/schemas/SecurityGroup' type: array type: object ReadServerCertificatesRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersServerCertificate" + $ref: '#/components/schemas/FiltersServerCertificate' description: One or more filters. type: object ReadServerCertificatesResponse: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. ServerCertificates: description: Information about one or more server certificates. items: - "$ref": "#/components/schemas/ServerCertificate" + $ref: '#/components/schemas/ServerCertificate' type: array type: object ReadSnapshotExportTasksRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersExportTask" + $ref: '#/components/schemas/FiltersExportTask' description: One or more filters. NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResultsPerPage: - description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). + description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). type: integer type: object ReadSnapshotExportTasksResponse: additionalProperties: false properties: NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. SnapshotExportTasks: description: Information about one or more snapshot export tasks. items: - "$ref": "#/components/schemas/SnapshotExportTask" + $ref: '#/components/schemas/SnapshotExportTask' type: array type: object ReadSnapshotsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersSnapshot" + $ref: '#/components/schemas/FiltersSnapshot' description: One or more filters. NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResultsPerPage: - description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). + description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). type: integer type: object ReadSnapshotsResponse: additionalProperties: false properties: NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. Snapshots: description: Information about one or more snapshots and their permissions. items: - "$ref": "#/components/schemas/Snapshot" + $ref: '#/components/schemas/Snapshot' type: array type: object ReadSubnetsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersSubnet" + $ref: '#/components/schemas/FiltersSubnet' description: One or more filters. NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResultsPerPage: - description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). + description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). type: integer type: object ReadSubnetsResponse: additionalProperties: false properties: NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. Subnets: description: Information about one or more Subnets. items: - "$ref": "#/components/schemas/Subnet" + $ref: '#/components/schemas/Subnet' type: array type: object ReadSubregionsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersSubregion" + $ref: '#/components/schemas/FiltersSubregion' description: One or more filters. NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResultsPerPage: - description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). + description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). type: integer type: object ReadSubregionsResponse: additionalProperties: false properties: NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. Subregions: description: Information about one or more Subregions. items: - "$ref": "#/components/schemas/Subregion" + $ref: '#/components/schemas/Subregion' type: array type: object ReadTagsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersTag" + $ref: '#/components/schemas/FiltersTag' description: One or more filters. NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResultsPerPage: - description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). + description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). type: integer type: object ReadTagsResponse: additionalProperties: false properties: NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. Tags: description: Information about one or more tags. items: - "$ref": "#/components/schemas/Tag" + $ref: '#/components/schemas/Tag' type: array type: object ReadUnitPriceRequest: additionalProperties: false properties: Operation: - description: The operation associated with the catalog entry (for example, - `RunInstances-OD` or `CreateVolume`). + description: The operation associated with the catalog entry (for example, `RunInstances-OD` or `CreateVolume`). type: string Service: - description: The service associated with the catalog entry (for example, - `TinaOS-FCU` or `TinaOS-OOS`). + description: The service associated with the catalog entry (for example, `TinaOS-FCU` or `TinaOS-OOS`). type: string Type: - description: The type associated with the catalog entry (for example, `BSU:VolumeIOPS:io1` - or `BoxUsage:tinav6.c6r16p3`). + description: The type associated with the catalog entry (for example, `BSU:VolumeIOPS:io1` or `BoxUsage:tinav6.c6r16p3`). type: string required: - Operation @@ -9822,32 +9141,29 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. UnitPriceEntry: - "$ref": "#/components/schemas/UnitPriceEntry" + $ref: '#/components/schemas/UnitPriceEntry' description: Information about the unit price entry. type: object ReadUserGroupPoliciesRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean FirstItem: description: The item starting the list of policies requested. type: integer ResultsPerPage: - description: The maximum number of items that can be returned in a single - response (by default, `100`). + description: The maximum number of items that can be returned in a single response (by default, `100`). type: integer UserGroupName: description: The name of the group. type: string UserGroupPath: - description: The path to the group. If not specified, it is set to a slash - (`/`). + description: The path to the group. If not specified, it is set to a slash (`/`). type: string required: - UserGroupName @@ -9856,31 +9172,28 @@ components: additionalProperties: false properties: HasMoreItems: - description: If true, there are more items to return using the `FirstItem` - parameter in a new request. + description: If true, there are more items to return using the `FirstItem` parameter in a new request. type: boolean MaxResultsLimit: description: Indicates maximum results defined for the operation. type: integer MaxResultsTruncated: - description: If true, indicates whether requested page size is more than - allowed. + description: If true, indicates whether requested page size is more than allowed. type: boolean Policies: description: A list of policies. items: - "$ref": "#/components/schemas/InlinePolicy" + $ref: '#/components/schemas/InlinePolicy' type: array ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadUserGroupPolicyRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean PolicyName: description: The name of the policy. @@ -9889,8 +9202,7 @@ components: description: The name of the group. type: string UserGroupPath: - description: The path to the group. If not specified, it is set to a slash - (`/`). + description: The path to the group. If not specified, it is set to a slash (`/`). type: string required: - PolicyName @@ -9900,22 +9212,20 @@ components: additionalProperties: false properties: Policy: - "$ref": "#/components/schemas/InlinePolicy" + $ref: '#/components/schemas/InlinePolicy' description: Information about an inline policy. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadUserGroupRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Path: - description: The path to the group. If not specified, it is set to a slash - (`/`). + description: The path to the group. If not specified, it is set to a slash (`/`). type: string UserGroupName: description: The name of the group. @@ -9927,23 +9237,22 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. UserGroup: - "$ref": "#/components/schemas/UserGroup" + $ref: '#/components/schemas/UserGroup' description: Information about the user group. Users: description: A list of EIM users. items: - "$ref": "#/components/schemas/User" + $ref: '#/components/schemas/User' type: array type: object ReadUserGroupsPerUserRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean UserName: description: The name of the user. @@ -9958,60 +9267,55 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. UserGroups: description: A list of user groups. items: - "$ref": "#/components/schemas/UserGroup" + $ref: '#/components/schemas/UserGroup' type: array type: object ReadUserGroupsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersUserGroup" + $ref: '#/components/schemas/FiltersUserGroup' description: One or more filters. FirstItem: description: The item starting the list of groups requested. type: integer ResultsPerPage: - description: The maximum number of items that can be returned in a single - response (by default, `100`). + description: The maximum number of items that can be returned in a single response (by default, `100`). type: integer type: object ReadUserGroupsResponse: additionalProperties: false properties: HasMoreItems: - description: If true, there are more items to return using the `FirstItem` - parameter in a new request. + description: If true, there are more items to return using the `FirstItem` parameter in a new request. type: boolean MaxResultsLimit: description: Indicates maximum results defined for the operation. type: integer MaxResultsTruncated: - description: If true, indicates whether requested page size is more than - allowed. + description: If true, indicates whether requested page size is more than allowed. type: boolean ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. UserGroups: description: A list of user groups. items: - "$ref": "#/components/schemas/UserGroup" + $ref: '#/components/schemas/UserGroup' type: array type: object ReadUserPoliciesRequest: properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean UserName: description: The name of the user. @@ -10027,14 +9331,13 @@ components: type: string type: array ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadUserPolicyRequest: properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean PolicyName: description: The name of the policy. @@ -10055,7 +9358,7 @@ components: description: The name of the inline policy. type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. UserName: description: The name of the user in which the inline policy is included. @@ -10065,161 +9368,147 @@ components: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersUsers" + $ref: '#/components/schemas/FiltersUsers' description: One or more filters. FirstItem: description: The item starting the list of users requested. type: integer ResultsPerPage: - description: The maximum number of items that can be returned in a single - response (by default, `100`). + description: The maximum number of items that can be returned in a single response (by default, `100`). type: integer type: object ReadUsersResponse: additionalProperties: false properties: HasMoreItems: - description: If true, there are more items to return using the `FirstItem` - parameter in a new request. + description: If true, there are more items to return using the `FirstItem` parameter in a new request. type: boolean MaxResultsLimit: description: Indicates maximum results defined for the operation. type: integer MaxResultsTruncated: - description: If true, indicates whether requested page size is more than - allowed. + description: If true, indicates whether requested page size is more than allowed. type: boolean ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. Users: description: A list of EIM users. items: - "$ref": "#/components/schemas/User" + $ref: '#/components/schemas/User' type: array type: object ReadVirtualGatewaysRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersVirtualGateway" + $ref: '#/components/schemas/FiltersVirtualGateway' description: One or more filters. NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResultsPerPage: - description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). + description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). type: integer type: object ReadVirtualGatewaysResponse: additionalProperties: false properties: NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. VirtualGateways: description: Information about one or more virtual gateways. items: - "$ref": "#/components/schemas/VirtualGateway" + $ref: '#/components/schemas/VirtualGateway' type: array type: object ReadVmGroupsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersVmGroup" + $ref: '#/components/schemas/FiltersVmGroup' description: One or more filters. type: object ReadVmGroupsResponse: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. VmGroups: description: Information about one or more VM groups. items: - "$ref": "#/components/schemas/VmGroup" + $ref: '#/components/schemas/VmGroup' type: array type: object ReadVmTemplatesRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersVmTemplate" + $ref: '#/components/schemas/FiltersVmTemplate' description: One or more filters. type: object ReadVmTemplatesResponse: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. VmTemplates: description: Information about one or more VM templates. items: - "$ref": "#/components/schemas/VmTemplate" + $ref: '#/components/schemas/VmTemplate' type: array type: object ReadVmTypesRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersVmType" + $ref: '#/components/schemas/FiltersVmType' description: One or more filters. NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResultsPerPage: - description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). + description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). type: integer type: object ReadVmTypesResponse: additionalProperties: false properties: NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. VmTypes: description: Information about one or more VM types. items: - "$ref": "#/components/schemas/VmType" + $ref: '#/components/schemas/VmType' type: array type: object ReadVmsHealthRequest: @@ -10231,8 +9520,7 @@ components: type: string type: array DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean LoadBalancerName: description: The name of the load balancer. @@ -10246,47 +9534,43 @@ components: BackendVmHealth: description: Information about the health of one or more backend VMs. items: - "$ref": "#/components/schemas/BackendVmHealth" + $ref: '#/components/schemas/BackendVmHealth' type: array ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ReadVmsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersVm" + $ref: '#/components/schemas/FiltersVm' description: One or more filters. NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResultsPerPage: - description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). + description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). type: integer type: object ReadVmsResponse: additionalProperties: false properties: NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. Vms: description: Information about one or more VMs. items: - "$ref": "#/components/schemas/Vm" + $ref: '#/components/schemas/Vm' type: array type: object ReadVmsStateRequest: @@ -10294,160 +9578,142 @@ components: properties: AllVms: default: false - description: If true, includes the status of all VMs. If false, only includes - the status of running VMs. + description: If true, includes the status of all VMs. If false, only includes the status of running VMs. type: boolean DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersVmsState" + $ref: '#/components/schemas/FiltersVmsState' description: One or more filters. NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResultsPerPage: - description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). + description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). type: integer type: object ReadVmsStateResponse: additionalProperties: false properties: NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. VmStates: description: Information about one or more VM states. items: - "$ref": "#/components/schemas/VmStates" + $ref: '#/components/schemas/VmStates' type: array type: object ReadVolumeUpdateTasksRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersUpdateVolumeTask" + $ref: '#/components/schemas/FiltersUpdateVolumeTask' description: One or more filters. NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResultsPerPage: - description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). By default, `100`. + description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). By default, `100`. type: integer type: object ReadVolumeUpdateTasksResponse: additionalProperties: false properties: NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. VolumeUpdateTasks: description: Information about one or more volume update tasks. items: - "$ref": "#/components/schemas/VolumeUpdateTask" + $ref: '#/components/schemas/VolumeUpdateTask' type: array type: object ReadVolumesRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersVolume" + $ref: '#/components/schemas/FiltersVolume' description: One or more filters. NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResultsPerPage: - description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). + description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). type: integer type: object ReadVolumesResponse: additionalProperties: false properties: NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. Volumes: description: Information about one or more volumes. items: - "$ref": "#/components/schemas/Volume" + $ref: '#/components/schemas/Volume' type: array type: object ReadVpnConnectionsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Filters: - "$ref": "#/components/schemas/FiltersVpnConnection" + $ref: '#/components/schemas/FiltersVpnConnection' description: One or more filters. NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResultsPerPage: - description: The maximum number of logs returned in a single response (between - `1` and `1000`, both included). + description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). type: integer type: object ReadVpnConnectionsResponse: additionalProperties: false properties: NextPageToken: - description: The token to request the next page of results. Each token refers - to a specific page. + description: The token to request the next page of results. Each token refers to a specific page. format: byte type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. VpnConnections: description: Information about one or more VPN connections. items: - "$ref": "#/components/schemas/VpnConnection" + $ref: '#/components/schemas/VpnConnection' type: array type: object RebootVmsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean VmIds: description: One or more IDs of the VMs you want to reboot. @@ -10461,7 +9727,7 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object Region: @@ -10486,8 +9752,7 @@ components: type: string type: array DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean LoadBalancerName: description: The name of the load balancer. @@ -10500,15 +9765,14 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object RejectNetPeeringRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean NetPeeringId: description: The ID of the Net peering you want to reject. @@ -10520,22 +9784,20 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object RemoveUserFromUserGroupRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean UserGroupName: description: The name of the group you want to remove the user from. type: string UserGroupPath: - description: The path to the group. If not specified, it is set to a slash - (`/`). + description: The path to the group. If not specified, it is set to a slash (`/`). type: string UserName: description: The name of the user you want to remove from the group. @@ -10551,7 +9813,7 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ResourceLoadBalancerTag: @@ -10569,7 +9831,7 @@ components: description: Information about the tag. properties: Key: - description: The key of the tag, with a minimum of 1 character. + description: The key of the tag, between 1 and 255 characters. type: string Value: description: The value of the tag, between 0 and 255 characters. @@ -10594,15 +9856,13 @@ components: description: The method used to create the route. type: string DestinationIpRange: - description: The IP range used for the destination match, in CIDR notation - (for example, `10.0.0.0/24`). + description: The IP range used for the destination match, in CIDR notation (for example, `10.0.0.0/24`). type: string DestinationServiceId: description: The ID of the OUTSCALE service. type: string GatewayId: - description: The ID of the internet service or virtual gateway attached - to the Net. + description: The ID of the internet service or virtual gateway attached to the Net. type: string NatServiceId: description: The ID of a NAT service attached to the Net. @@ -10631,15 +9891,13 @@ components: description: Information about the route. properties: DestinationIpRange: - description: The IP range used for the destination match, in CIDR notation - (for example, `10.0.0.0/24`). + description: The IP range used for the destination match, in CIDR notation (for example, `10.0.0.0/24`). type: string RouteType: description: The type of route (always `static`). type: string State: - description: The current state of the static route (`pending` \| `available` - \| `deleting` \| `deleted`). + description: The current state of the static route (`pending` \| `available` \| `deleting` \| `deleted`). type: string type: object RoutePropagatingVirtualGateway: @@ -10657,7 +9915,7 @@ components: LinkRouteTables: description: One or more associations between the route table and Subnets. items: - "$ref": "#/components/schemas/LinkRouteTable" + $ref: '#/components/schemas/LinkRouteTable' type: array NetId: description: The ID of the Net for the route table. @@ -10665,7 +9923,7 @@ components: RoutePropagatingVirtualGateways: description: Information about virtual gateways propagating routes. items: - "$ref": "#/components/schemas/RoutePropagatingVirtualGateway" + $ref: '#/components/schemas/RoutePropagatingVirtualGateway' type: array RouteTableId: description: The ID of the route table. @@ -10673,20 +9931,19 @@ components: Routes: description: One or more routes in the route table. items: - "$ref": "#/components/schemas/Route" + $ref: '#/components/schemas/Route' type: array Tags: description: One or more tags associated with the route table. items: - "$ref": "#/components/schemas/ResourceTag" + $ref: '#/components/schemas/ResourceTag' type: array type: object ScaleDownVmGroupRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean VmGroupId: description: The ID of the VM group you want to scale down. @@ -10702,15 +9959,14 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object ScaleUpVmGroupRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean VmAddition: description: The number of VMs you want to add to the VM group. @@ -10726,12 +9982,11 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object SecureBootAction: - description: One action to perform on the next boot of the VM. For more information, - see [About Secure Boot](https://docs.outscale.com/en/userguide/About-Secure-Boot.html#_secure_boot_actions). + description: One action to perform on the next boot of the VM (`enable` | `disable` | `setup-mode` | `none`). For more information, see [About Secure Boot](https://docs.outscale.com/en/userguide/About-Secure-Boot.html#_secure_boot_actions). enum: - enable - disable @@ -10752,7 +10007,7 @@ components: InboundRules: description: The inbound rules associated with the security group. items: - "$ref": "#/components/schemas/SecurityGroupRule" + $ref: '#/components/schemas/SecurityGroupRule' type: array NetId: description: The ID of the Net for the security group. @@ -10760,7 +10015,7 @@ components: OutboundRules: description: The outbound rules associated with the security group. items: - "$ref": "#/components/schemas/SecurityGroupRule" + $ref: '#/components/schemas/SecurityGroupRule' type: array SecurityGroupId: description: The ID of the security group. @@ -10771,7 +10026,7 @@ components: Tags: description: One or more tags associated with the security group. items: - "$ref": "#/components/schemas/ResourceTag" + $ref: '#/components/schemas/ResourceTag' type: array type: object SecurityGroupLight: @@ -10790,35 +10045,31 @@ components: description: Information about the security group rule. properties: FromPortRange: - description: The beginning of the port range for the TCP and UDP protocols, - or an ICMP type number. + description: The beginning of the port range for the TCP and UDP protocols, or an ICMP type number. type: integer IpProtocol: - description: The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all - protocols). By default, `-1`. In a Net, this can also be an IP protocol - number. For more information, see the [IANA.org website](https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). + description: The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all protocols). By default, `-1`. In a Net, this can also be an IP protocol number. For more information, see the [IANA.org website](https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). type: string IpRanges: - description: One or more IP ranges for the security group rules, in CIDR - notation (for example, `10.0.0.0/16`). + description: One or more IP ranges for the security group rules, in CIDR notation (for example, `["10.0.0.0/24" , "10.0.1.0/24"]`). items: type: string type: array + SecurityGroupRuleId: + description: The ID of the security group rule. + type: string SecurityGroupsMembers: - description: Information about one or more source or destination security - groups. + description: Information about one or more source or destination security groups. items: - "$ref": "#/components/schemas/SecurityGroupsMember" + $ref: '#/components/schemas/SecurityGroupsMember' type: array ServiceIds: - description: One or more service IDs to allow traffic from a Net to access - the corresponding OUTSCALE services. For more information, see [ReadNetAccessPointServices](#readnetaccesspointservices). + description: One or more service IDs to allow traffic from a Net to access the corresponding OUTSCALE services. For more information, see [ReadNetAccessPointServices](#readnetaccesspointservices). items: type: string type: array ToPortRange: - description: The end of the port range for the TCP and UDP protocols, or - an ICMP code number. + description: The end of the port range for the TCP and UDP protocols, or an ICMP code number. type: integer type: object SecurityGroupsMember: @@ -10826,16 +10077,13 @@ components: description: Information about a source or destination security group. properties: AccountId: - description: The account ID that owns the source or destination security - group. + description: The account ID that owns the source or destination security group. type: string SecurityGroupId: - description: The ID of a source or destination security group that you want - to link to the security group of the rule. + description: The ID of a source or destination security group that you want to link to the security group of the rule. type: string SecurityGroupName: - description: "(Public Cloud only) The name of a source or destination security - group that you want to link to the security group of the rule." + description: The name of a source or destination security group that you want to link to the security group of the rule. type: string type: object ServerCertificate: @@ -10843,8 +10091,8 @@ components: description: Information about the server certificate. properties: ExpirationDate: - description: The date on which the server certificate expires. - format: date + description: The date and time (UTC) on which the server certificate expires. + format: date-time type: string Id: description: The ID of the server certificate. @@ -10853,16 +10101,14 @@ components: description: The name of the server certificate. type: string Orn: - description: The OUTSCALE Resource Name (ORN) of the server certificate. - For more information, see [Resource Identifiers > OUTSCALE Resource Names - (ORNs)](https://docs.outscale.com/en/userguide/Resource-Identifiers.html#_outscale_resource_names_orns). + description: The OUTSCALE Resource Name (ORN) of the server certificate. For more information, see [Resource Identifiers > OUTSCALE Resource Names (ORNs)](https://docs.outscale.com/en/userguide/Resource-Identifiers.html#_outscale_resource_names_orns). type: string Path: description: The path to the server certificate. type: string UploadDate: - description: The date on which the server certificate has been uploaded. - format: date + description: The date and time (UTC) on which the server certificate has been uploaded. + format: date-time type: string type: object Service: @@ -10885,9 +10131,8 @@ components: additionalProperties: false properties: PolicyOrn: - description: The OUTSCALE Resource Name (ORN) of the policy. For more information, - see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). - pattern: "^orn:ows:(iam|idauth):\\S*:\\d{12}:policy/\\S+$" + description: The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + pattern: ^orn:ows:(iam|idauth):\S*:\d{12}:policy/\S+$ type: string VersionId: description: The ID of the version. @@ -10900,7 +10145,7 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object Snapshot: @@ -10918,13 +10163,13 @@ components: type: string CreationDate: description: The date and time (UTC) at which the snapshot was created. - format: datetime + format: date-time type: string Description: description: The description of the snapshot. type: string PermissionsToCreateVolume: - "$ref": "#/components/schemas/PermissionsOnResource" + $ref: '#/components/schemas/PermissionsOnResource' description: Permissions for the resource. Progress: description: The progress of the snapshot, as a percentage. @@ -10933,20 +10178,18 @@ components: description: The ID of the snapshot. type: string State: - description: The state of the snapshot (`in-queue` \| `pending` \| `completed` - \| `error` \| `deleting`). + description: The state of the snapshot (`in-queue` \| `pending` \| `completed` \| `error` \| `deleting`). type: string Tags: description: One or more tags associated with the snapshot. items: - "$ref": "#/components/schemas/ResourceTag" + $ref: '#/components/schemas/ResourceTag' type: array VolumeId: description: The ID of the volume used to create the snapshot. type: string VolumeSize: - description: The size of the volume used to create the snapshot, in gibibytes - (GiB). + description: The size of the volume used to create the snapshot, in gibibytes (GiB). type: integer type: object SnapshotExportTask: @@ -10957,7 +10200,7 @@ components: description: If the snapshot export task fails, an error message appears. type: string OsuExport: - "$ref": "#/components/schemas/OsuExportSnapshotExportTask" + $ref: '#/components/schemas/OsuExportSnapshotExportTask' description: Information about the snapshot export task. Progress: description: The progress of the snapshot export task, as a percentage. @@ -10966,13 +10209,12 @@ components: description: The ID of the snapshot to be exported. type: string State: - description: The state of the snapshot export task (`pending` \| `active` - \| `completed` \| `cancelled` \| `failed`). + description: The state of the snapshot export task (`pending` \| `active` \| `completed` \| `cancelled` \| `failed`). type: string Tags: description: One or more tags associated with the snapshot export task. items: - "$ref": "#/components/schemas/ResourceTag" + $ref: '#/components/schemas/ResourceTag' type: array TaskId: description: The ID of the snapshot export task. @@ -10986,8 +10228,7 @@ components: description: The account ID of the owner of the source Net. type: string IpRange: - description: The IP range for the source Net, in CIDR notation (for example, - `10.0.0.0/16`). + description: The IP range for the source Net, in CIDR notation (for example, `10.0.0.0/16`). type: string NetId: description: The ID of the source Net. @@ -11010,8 +10251,7 @@ components: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean VmIds: description: One or more IDs of VMs. @@ -11025,12 +10265,12 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. Vms: description: Information about one or more started VMs. items: - "$ref": "#/components/schemas/VmState" + $ref: '#/components/schemas/VmState' type: array type: object StateComment: @@ -11048,8 +10288,7 @@ components: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean ForceStop: description: Forces the VM to stop. @@ -11066,12 +10305,12 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. Vms: description: Information about one or more stopped VMs. items: - "$ref": "#/components/schemas/VmState" + $ref: '#/components/schemas/VmState' type: array type: object Subnet: @@ -11082,12 +10321,10 @@ components: description: The number of available IPs in the Subnets. type: integer IpRange: - description: The IP range in the Subnet, in CIDR notation (for example, - `10.0.0.0/16`). + description: The IP range in the Subnet, in CIDR notation (for example, `10.0.0.0/16`). type: string MapPublicIpOnLaunch: - description: If true, a public IP is assigned to the network interface cards - (NICs) created in the specified Subnet. + description: If true, a public IP is assigned to the network interface cards (NICs) created in the specified Subnet. type: boolean NetId: description: The ID of the Net in which the Subnet is. @@ -11104,7 +10341,7 @@ components: Tags: description: One or more tags associated with the Subnet. items: - "$ref": "#/components/schemas/ResourceTag" + $ref: '#/components/schemas/ResourceTag' type: array type: object Subregion: @@ -11112,9 +10349,7 @@ components: description: Information about the Subregion. properties: LocationCode: - description: The location code (physical zone) of the Subregion. For more - information, see [About Regions > Mapping Between Subregions and Physical - Zones](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html#_mapping_between_subregions_and_physical_zones). + description: The location code (physical zone) of the Subregion. For more information, see [About Regions > Mapping Between Subregions and Physical Zones](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html#_mapping_between_subregions_and_physical_zones). type: string RegionName: description: The name of the Region containing the Subregion. @@ -11131,7 +10366,7 @@ components: description: Information about the tag. properties: Key: - description: The key of the tag, with a minimum of 1 character. + description: The key of the tag, between 1 and 255 characters. type: string ResourceId: description: The ID of the resource. @@ -11148,28 +10383,22 @@ components: description: Information about the unit price entry. properties: Currency: - description: The currency of your account for the `UnitPrice` parameter, - in the ISO-4217 format (for example, `EUR`). + description: The currency of your account for the `UnitPrice` parameter, in the ISO-4217 format (for example, `EUR`). type: string Operation: - description: The operation associated with the catalog entry (for example, - `RunInstances-OD` or `CreateVolume`). + description: The operation associated with the catalog entry (for example, `RunInstances-OD` or `CreateVolume`). type: string Service: - description: The service associated with the catalog entry (for example, - `TinaOS-FCU` or `TinaOS-OOS`). + description: The service associated with the catalog entry (for example, `TinaOS-FCU` or `TinaOS-OOS`). type: string Type: - description: The type associated with the catalog entry (for example, `BSU:VolumeIOPS:io1` - or `BoxUsage:tinav6.c6r16p3`). + description: The type associated with the catalog entry (for example, `BSU:VolumeIOPS:io1` or `BoxUsage:tinav6.c6r16p3`). type: string Unit: - description: The unit associated with the catalog entry (for example, `PER_MONTH` - or `PER_COUNT`). + description: The unit associated with the catalog entry (for example, `PER_MONTH` or `PER_COUNT`). type: string UnitPrice: - description: The unit price of the catalog entry in the currency of your - account, in the ISO-4217 format (for example, `EUR`). + description: The unit price of the catalog entry in the currency of your account, in the ISO-4217 format (for example, `EUR`). format: double type: number type: object @@ -11177,8 +10406,7 @@ components: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean FlexibleGpuId: description: The ID of the fGPU you want to detach from your VM. @@ -11190,22 +10418,20 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object UnlinkInternetServiceRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean InternetServiceId: description: The ID of the internet service you want to detach. type: string NetId: - description: The ID of the Net from which you want to detach the internet - service. + description: The ID of the Net from which you want to detach the internet service. type: string required: - InternetServiceId @@ -11215,7 +10441,7 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object UnlinkLoadBalancerBackendMachinesRequest: @@ -11232,8 +10458,7 @@ components: type: string type: array DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean LoadBalancerName: description: The name of the load balancer. @@ -11245,19 +10470,17 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object UnlinkManagedPolicyFromUserGroupRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean PolicyOrn: - description: The OUTSCALE Resource Name (ORN) of the policy. For more information, - see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + description: The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). type: string UserGroupName: description: The name of the group you want to unlink the policy from. @@ -11270,15 +10493,14 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object UnlinkNicRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean LinkNicId: description: The ID of the attachment operation. @@ -11290,20 +10512,18 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object UnlinkPolicyRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean PolicyOrn: - description: The OUTSCALE Resource Name (ORN) of the policy. For more information, - see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). - pattern: "^orn:ows:(iam|idauth):\\S*:\\d{12}:policy/\\S+$" + description: The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + pattern: ^orn:ows:(iam|idauth):\S*:\d{12}:policy/\S+$ type: string UserName: description: The name of the user you want to detach the policy from. @@ -11316,22 +10536,20 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object UnlinkPrivateIpsRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean NicId: description: The ID of the NIC. type: string PrivateIps: - description: One or more secondary private IPs you want to unassign from - the NIC. + description: One or more secondary private IPs you want to unassign from the NIC. items: type: string type: array @@ -11343,39 +10561,34 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object UnlinkPublicIpRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean LinkPublicIpId: - description: The ID representing the association of the public IP with the - VM or the NIC. This parameter is required unless you use the `PublicIp` - parameter. + description: The ID representing the association of the public IP with the VM or the NIC. This parameter is required unless you use the `PublicIp` parameter. type: string PublicIp: - description: The public IP. This parameter is required unless you use the - `LinkPublicIpId` parameter. + description: The public IP. This parameter is required unless you use the `LinkPublicIpId` parameter. type: string type: object UnlinkPublicIpResponse: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object UnlinkRouteTableRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean LinkRouteTableId: description: The ID of the association between the route table and the Subnet. @@ -11387,19 +10600,17 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object UnlinkVirtualGatewayRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean NetId: - description: The ID of the Net from which you want to detach the virtual - gateway. + description: The ID of the Net from which you want to detach the virtual gateway. type: string VirtualGatewayId: description: The ID of the virtual gateway. @@ -11412,19 +10623,17 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object UnlinkVolumeRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean ForceUnlink: - description: 'Forces the detachment of the volume in case of previous failure. - Important: This action may damage your data or file systems.' + description: 'Forces the detachment of the volume in case of previous failure. Important: This action may damage your data or file systems.' type: boolean VolumeId: description: The ID of the volume you want to detach. @@ -11436,7 +10645,7 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object UpdateAccessKeyRequest: @@ -11446,25 +10655,20 @@ components: description: The ID of the access key. type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean ExpirationDate: - description: The date and time, or the date, at which you want the access - key to expire, in ISO 8601 format (for example, `2020-06-14T00:00:00.000Z` - or `2020-06-14`). If not specified, the access key is set to not expire. - format: datetime - type: string + description: The date and time, or the date, at which you want the access key to expire, in ISO 8601 format (for example, `2020-06-14T00:00:00.000Z` or `2020-06-14`). If not specified, the access key is set to not expire. + oneOf: + - format: date-time + type: string + - format: date + type: string State: - description: The new state for the access key (`ACTIVE` \| `INACTIVE`). - When set to `ACTIVE`, the access key is enabled and can be used to send - requests. When set to `INACTIVE`, the access key is disabled. + description: The new state for the access key (`ACTIVE` \| `INACTIVE`). When set to `ACTIVE`, the access key is enabled and can be used to send requests. When set to `INACTIVE`, the access key is disabled. type: string UserName: - description: The name of the EIM user that the access key you want to modify - is associated with. If you do not specify a user name, this action modifies - the access key of the user who sends the request (which can be the root - account). + description: The name of the EIM user that the access key you want to modify is associated with. If you do not specify a user name, this action modifies the access key of the user who sends the request (which can be the root account). type: string required: - AccessKeyId @@ -11474,22 +10678,19 @@ components: additionalProperties: false properties: AccessKey: - "$ref": "#/components/schemas/AccessKey" + $ref: '#/components/schemas/AccessKey' description: Information about the access key. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object UpdateAccountRequest: additionalProperties: false properties: AdditionalEmails: - description: One or more additional email addresses for the account. These - addresses are used for notifications only. If you already have a list - of additional emails registered, you cannot add to it, only replace it. - To remove all registered additional emails, specify an empty list. + description: One or more additional email addresses for the account. These addresses are used for notifications only. If you already have a list of additional emails registered, you cannot add to it, only replace it. To remove all registered additional emails, specify an empty list. items: - pattern: "^.+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)+$" + pattern: ^.+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)+$ type: string type: array City: @@ -11502,12 +10703,10 @@ components: description: The new country of the account owner. type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Email: - description: The main email address for the account. This address is used - for your credentials and notifications. + description: The main email address for the account. This address is used for your credentials and notifications. type: string FirstName: description: The new first name of the account owner. @@ -11538,26 +10737,20 @@ components: additionalProperties: false properties: Account: - "$ref": "#/components/schemas/Account" + $ref: '#/components/schemas/Account' description: Information about the account. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object UpdateApiAccessPolicyRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean MaxAccessKeyExpirationSeconds: - description: The maximum possible lifetime for your access keys, in seconds - (between `0` and `3153600000`, both included). If set to `O`, your access - keys can have unlimited lifetimes, but a trusted session cannot be activated. - Otherwise, all your access keys must have an expiration date. This value - must be greater than the remaining lifetime of each access key of your - account. + description: The maximum possible lifetime for your access keys, in seconds (between `0` and `3153600000`, both included). If set to `O`, your access keys can have unlimited lifetimes, but a trusted session cannot be activated. Otherwise, all your access keys must have an expiration date. This value must be greater than the remaining lifetime of each access key of your account. format: int64 type: integer RequireTrustedEnv: @@ -11573,10 +10766,10 @@ components: additionalProperties: false properties: ApiAccessPolicy: - "$ref": "#/components/schemas/ApiAccessPolicy" + $ref: '#/components/schemas/ApiAccessPolicy' description: Information about the API access policy. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object UpdateApiAccessRuleRequest: @@ -11599,8 +10792,7 @@ components: description: A new description for the API access rule. type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean IpRanges: description: One or more IPs or CIDR blocks (for example, `192.0.2.0/16`). @@ -11614,10 +10806,10 @@ components: additionalProperties: false properties: ApiAccessRule: - "$ref": "#/components/schemas/ApiAccessRule" + $ref: '#/components/schemas/ApiAccessRule' description: Information about the API access rule. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object UpdateCaRequest: @@ -11630,8 +10822,7 @@ components: description: The description of the CA. type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean required: - CaId @@ -11640,10 +10831,10 @@ components: additionalProperties: false properties: Ca: - "$ref": "#/components/schemas/Ca" + $ref: '#/components/schemas/Ca' description: Information about the Client Certificate Authority (CA). ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object UpdateDedicatedGroupRequest: @@ -11653,8 +10844,7 @@ components: description: The ID of the dedicated group you want to update. type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Name: description: The new name of the dedicated group. @@ -11667,10 +10857,10 @@ components: additionalProperties: false properties: DedicatedGroup: - "$ref": "#/components/schemas/DedicatedGroup" + $ref: '#/components/schemas/DedicatedGroup' description: Information about the dedicated group. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object UpdateDirectLinkInterfaceRequest: @@ -11680,12 +10870,10 @@ components: description: The ID of the DirectLink interface you want to update. type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Mtu: - description: The maximum transmission unit (MTU) of the DirectLink interface, - in bytes. + description: The maximum transmission unit (MTU) of the DirectLink interface, in bytes. enum: - 1500 type: integer @@ -11697,10 +10885,10 @@ components: additionalProperties: false properties: DirectLinkInterface: - "$ref": "#/components/schemas/DirectLinkInterfaces" + $ref: '#/components/schemas/DirectLinkInterfaces' description: Information about the DirectLink interfaces. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object UpdateFlexibleGpuRequest: @@ -11710,8 +10898,7 @@ components: description: If true, the fGPU is deleted when the VM is terminated. type: boolean DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean FlexibleGpuId: description: The ID of the fGPU you want to modify. @@ -11723,10 +10910,10 @@ components: additionalProperties: false properties: FlexibleGpu: - "$ref": "#/components/schemas/FlexibleGpu" + $ref: '#/components/schemas/FlexibleGpu' description: Information about the flexible GPU (fGPU). ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object UpdateImageRequest: @@ -11736,21 +10923,18 @@ components: description: A new description for the image. type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean ImageId: description: The ID of the OMI you want to modify. type: string PermissionsToLaunch: - "$ref": "#/components/schemas/PermissionsOnResourceCreation" + $ref: '#/components/schemas/PermissionsOnResourceCreation' description: |- Information about the permissions for the resource.
Specify either the `Additions` or the `Removals` parameter. ProductCodes: - description: The product codes associated with the OMI. Any previously set - value is deleted. Make sure to specify all product codes you want to associate - with the OMI. + description: The product codes associated with the OMI. Any previously set value is deleted. Make sure to specify all product codes you want to associate with the OMI. items: type: string type: array @@ -11761,32 +10945,27 @@ components: additionalProperties: false properties: Image: - "$ref": "#/components/schemas/Image" + $ref: '#/components/schemas/Image' description: Information about the OMI. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object UpdateListenerRuleRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean HostPattern: - description: A host-name pattern for the rule, with a maximum length of - 128 characters. This host-name pattern supports maximum three wildcards, - and must not contain any special characters except `-.?`. + description: A host-name pattern for the rule, with a maximum length of 128 characters. This host-name pattern supports maximum three wildcards, and must not contain any special characters except `-.?`. nullable: true type: string ListenerRuleName: description: The name of the listener rule. type: string PathPattern: - description: A path pattern for the rule, with a maximum length of 128 characters. - This path pattern supports maximum three wildcards, and must not contain - any special characters except `_-.$/~"'@:+?`. + description: A path pattern for the rule, with a maximum length of 128 characters. This path pattern supports maximum three wildcards, and must not contain any special characters except `_-.$/~"'@:+?`. nullable: true type: string required: @@ -11796,32 +10975,29 @@ components: additionalProperties: false properties: ListenerRule: - "$ref": "#/components/schemas/ListenerRule" + $ref: '#/components/schemas/ListenerRule' description: Information about the listener rule. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object UpdateLoadBalancerRequest: additionalProperties: false properties: AccessLog: - "$ref": "#/components/schemas/AccessLog" + $ref: '#/components/schemas/AccessLog' description: Information about access logs. DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean HealthCheck: - "$ref": "#/components/schemas/HealthCheck" + $ref: '#/components/schemas/HealthCheck' description: Information about the health check configuration. LoadBalancerName: description: The name of the load balancer. type: string LoadBalancerPort: - description: The port on which the load balancer is listening (between `1` - and `65535`, both included). This parameter is required if you want to - update the server certificate. + description: The port on which the load balancer is listening (between `1` and `65535`, both included). This parameter is required if you want to update the server certificate. type: integer PolicyNames: description: The name of the policy you want to enable for the listener. @@ -11829,30 +11005,18 @@ components: type: string type: array PublicIp: - description: "(internet-facing only) The public IP you want to associate - with the load balancer. The former public IP of the load balancer is then - disassociated. If you specify an empty string and the former public IP - belonged to you, it is disassociated and replaced by a public IP owned - by 3DS OUTSCALE." + description: (internet-facing only) The public IP you want to associate with the load balancer. The former public IP of the load balancer is then disassociated. If you specify an empty string and the former public IP belonged to you, it is disassociated and replaced by a public IP owned by 3DS OUTSCALE. type: string SecuredCookies: description: If true, secure cookies are enabled for the load balancer. type: boolean SecurityGroups: - description: "(Net only) One or more IDs of security groups you want to - assign to the load balancer. You need to specify the already assigned - security groups that you want to keep along with the new ones you are - assigning. If the list is empty, the default security group of the Net - is assigned to the load balancer." + description: (Net only) One or more IDs of security groups you want to assign to the load balancer. You need to specify the already assigned security groups that you want to keep along with the new ones you are assigning. If the list is empty, the default security group of the Net is assigned to the load balancer. items: type: string type: array ServerCertificateId: - description: The OUTSCALE Resource Name (ORN) of the server certificate. - For more information, see [Resource Identifiers > OUTSCALE Resource Names - (ORNs)](https://docs.outscale.com/en/userguide/Resource-Identifiers.html#_outscale_resource_names_orns). - If this parameter is specified, you must also specify the `LoadBalancerPort` - parameter. + description: The OUTSCALE Resource Name (ORN) of the server certificate. For more information, see [Resource Identifiers > OUTSCALE Resource Names (ORNs)](https://docs.outscale.com/en/userguide/Resource-Identifiers.html#_outscale_resource_names_orns). If this parameter is specified, you must also specify the `LoadBalancerPort` parameter. type: string required: - LoadBalancerName @@ -11861,31 +11025,28 @@ components: additionalProperties: false properties: LoadBalancer: - "$ref": "#/components/schemas/LoadBalancer" + $ref: '#/components/schemas/LoadBalancer' description: Information about the load balancer. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object UpdateNetAccessPointRequest: additionalProperties: false properties: AddRouteTableIds: - description: One or more IDs of route tables to associate with the specified - Net access point. + description: One or more IDs of route tables to associate with the specified Net access point. items: type: string type: array DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean NetAccessPointId: description: The ID of the Net access point. type: string RemoveRouteTableIds: - description: One or more IDs of route tables to disassociate from the specified - Net access point. + description: One or more IDs of route tables to disassociate from the specified Net access point. items: type: string type: array @@ -11896,22 +11057,20 @@ components: additionalProperties: false properties: NetAccessPoint: - "$ref": "#/components/schemas/NetAccessPoint" + $ref: '#/components/schemas/NetAccessPoint' description: Information about the Net access point. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object UpdateNetRequest: additionalProperties: false properties: DhcpOptionsSetId: - description: The ID of the DHCP options set (or `default` if you want to - associate the default one). + description: The ID of the DHCP options set (or `default` if you want to associate the default one). type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean NetId: description: The ID of the Net. @@ -11924,10 +11083,10 @@ components: additionalProperties: false properties: Net: - "$ref": "#/components/schemas/Net" + $ref: '#/components/schemas/Net' description: Information about the Net. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object UpdateNicRequest: @@ -11937,14 +11096,11 @@ components: description: A new description for the NIC. type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean LinkNic: - "$ref": "#/components/schemas/LinkNicToUpdate" - description: Information about the NIC attachment. If you are modifying - the `DeleteOnVmDeletion` attribute, you must specify the ID of the NIC - attachment. + $ref: '#/components/schemas/LinkNicToUpdate' + description: Information about the NIC attachment. If you are modifying the `DeleteOnVmDeletion` attribute, you must specify the ID of the NIC attachment. NicId: description: The ID of the NIC you want to modify. type: string @@ -11962,22 +11118,20 @@ components: additionalProperties: false properties: Nic: - "$ref": "#/components/schemas/Nic" + $ref: '#/components/schemas/Nic' description: Information about the NIC. ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object UpdateRoutePropagationRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Enable: - description: If true, a virtual gateway can propagate routes to a specified - route table of a Net. If false, the propagation is disabled. + description: If true, a virtual gateway can propagate routes to a specified route table of a Net. If false, the propagation is disabled. type: boolean RouteTableId: description: The ID of the route table. @@ -11994,26 +11148,23 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. RouteTable: - "$ref": "#/components/schemas/RouteTable" + $ref: '#/components/schemas/RouteTable' description: Information about the route table. type: object UpdateRouteRequest: additionalProperties: false properties: DestinationIpRange: - description: The IP range used for the destination match, in CIDR notation - (for example, `10.0.0.0/24`). + description: The IP range used for the destination match, in CIDR notation (for example, `10.0.0.0/24`). type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean GatewayId: - description: The ID of an internet service or virtual gateway attached to - your Net. + description: The ID of an internet service or virtual gateway attached to your Net. type: string NatServiceId: description: The ID of a NAT service. @@ -12038,18 +11189,17 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. RouteTable: - "$ref": "#/components/schemas/RouteTable" + $ref: '#/components/schemas/RouteTable' description: Information about the route table. type: object UpdateRouteTableLinkRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean LinkRouteTableId: description: The ID of the current route table link. @@ -12068,15 +11218,14 @@ components: description: The ID of the association between the route table and the Subnet. type: string ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. type: object UpdateServerCertificateRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Name: description: The name of the server certificate you want to modify. @@ -12094,21 +11243,20 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. ServerCertificate: - "$ref": "#/components/schemas/ServerCertificate" + $ref: '#/components/schemas/ServerCertificate' description: Information about the server certificate. type: object UpdateSnapshotRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean PermissionsToCreateVolume: - "$ref": "#/components/schemas/PermissionsOnResourceCreation" + $ref: '#/components/schemas/PermissionsOnResourceCreation' description: |- Information about the permissions for the resource.
Specify either the `Additions` or the `Removals` parameter. @@ -12123,22 +11271,20 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. Snapshot: - "$ref": "#/components/schemas/Snapshot" + $ref: '#/components/schemas/Snapshot' description: Information about the snapshot. type: object UpdateSubnetRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean MapPublicIpOnLaunch: - description: If true, a public IP is assigned to the network interface cards - (NICs) created in the specified Subnet. + description: If true, a public IP is assigned to the network interface cards (NICs) created in the specified Subnet. type: boolean SubnetId: description: The ID of the Subnet. @@ -12151,29 +11297,26 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. Subnet: - "$ref": "#/components/schemas/Subnet" + $ref: '#/components/schemas/Subnet' description: Information about the Subnet. type: object UpdateUserGroupRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean NewPath: - description: A new path for the group. If not specified, it is set to a - slash (`/`). + description: A new path for the group. If not specified, it is set to a slash (`/`). type: string NewUserGroupName: description: A new name for the user group. type: string Path: - description: The path to the group. If not specified, it is set to a slash - (`/`). + description: The path to the group. If not specified, it is set to a slash (`/`). type: string UserGroupName: description: The name of the group you want to update. @@ -12185,23 +11328,22 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. UserGroup: - "$ref": "#/components/schemas/UserGroup" + $ref: '#/components/schemas/UserGroup' description: Information about the user group. Users: description: A list of EIM users. items: - "$ref": "#/components/schemas/User" + $ref: '#/components/schemas/User' type: array type: object UpdateUserRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean NewPath: description: A new path for the EIM user. @@ -12222,10 +11364,10 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. User: - "$ref": "#/components/schemas/User" + $ref: '#/components/schemas/User' description: Information about the EIM user. type: object UpdateVmGroupRequest: @@ -12235,13 +11377,12 @@ components: description: A new description for the VM group. type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Tags: description: New tags for your VM group. items: - "$ref": "#/components/schemas/ResourceTag" + $ref: '#/components/schemas/ResourceTag' type: array VmGroupId: description: The ID of the VM group you want to update. @@ -12259,38 +11400,34 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. VmGroup: - "$ref": "#/components/schemas/VmGroup" + $ref: '#/components/schemas/VmGroup' description: Information about the VM group. type: object UpdateVmRequest: additionalProperties: false properties: ActionsOnNextBoot: - "$ref": "#/components/schemas/ActionsOnNextBoot" + $ref: '#/components/schemas/ActionsOnNextBoot' description: The action to perform on the next boot of the VM. BlockDeviceMappings: description: One or more block device mappings of the VM. items: - "$ref": "#/components/schemas/BlockDeviceMappingVmUpdate" + $ref: '#/components/schemas/BlockDeviceMappingVmUpdate' type: array BsuOptimized: - description: This parameter is not available. It is present in our API for - the sake of historical compatibility with AWS. + description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS. type: boolean DeletionProtection: - description: If true, you cannot delete the VM unless you change this parameter - back to false. + description: If true, you cannot delete the VM unless you change this parameter back to false. type: boolean DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean IsSourceDestChecked: - description: "(Net only) If true, the source/destination check is enabled. - If false, it is disabled." + description: (Net only) If true, the source/destination check is enabled. If false, it is disabled. type: boolean KeypairName: description: |- @@ -12298,8 +11435,7 @@ components: When you replace the keypair of a VM with another one, the metadata of the VM is modified to reflect the new public key, but the replacement is still not effective in the operating system of the VM. To complete the replacement and effectively apply the new keypair, you need to perform other actions inside the VM. For more information, see [Modifying the Keypair of a VM](https://docs.outscale.com/en/userguide/Modifying-the-Keypair-of-a-VM.html). type: string NestedVirtualization: - description: "(dedicated tenancy only) If true, nested virtualization is - enabled. If false, it is disabled." + description: (dedicated tenancy only) If true, nested virtualization is enabled. If false, it is disabled. type: boolean Performance: description: The performance of the VM. @@ -12314,16 +11450,13 @@ components: type: string type: array UserData: - description: The Base64-encoded MIME user data, limited to 500 kibibytes - (KiB). + description: The Base64-encoded MIME user data, limited to 500 kibibytes (KiB). type: string VmId: description: The ID of the VM. type: string VmInitiatedShutdownBehavior: - description: The VM behavior when you stop it. If set to `stop`, the VM - stops. If set to `restart`, the VM stops then automatically restarts. - If set to `terminate`, the VM stops and is terminated. + description: The VM behavior when you stop it. If set to `stop`, the VM stops. If set to `restart`, the VM stops then automatically restarts. If set to `terminate`, the VM stops and is terminated. type: string VmType: description: The type of VM. For more information, see [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html). @@ -12335,10 +11468,10 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. Vm: - "$ref": "#/components/schemas/Vm" + $ref: '#/components/schemas/Vm' description: Information about the VM. type: object UpdateVmTemplateRequest: @@ -12348,13 +11481,12 @@ components: description: A new description for the VM template. type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Tags: description: New tags for your VM template. items: - "$ref": "#/components/schemas/ResourceTag" + $ref: '#/components/schemas/ResourceTag' type: array VmTemplateId: description: The ID of the VM template you want to update. @@ -12369,35 +11501,29 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. VmTemplate: - "$ref": "#/components/schemas/VmTemplate" + $ref: '#/components/schemas/VmTemplate' description: Information about the VM template. type: object UpdateVolumeRequest: additionalProperties: false properties: DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean Iops: - description: The new number of I/O operations per second (IOPS). This parameter - can be specified only if you update an `io1` volume or if you change the - type of the volume for an `io1`. + description: The new number of I/O operations per second (IOPS). This parameter can be specified only if you update an `io1` volume or if you change the type of the volume for an `io1`. type: integer Size: - description: The new size of the volume, in gibibytes (GiB). This value - must be equal to or greater than the current size of the volume. This - modification is not instantaneous. + description: The new size of the volume, in gibibytes (GiB). This value must be equal to or greater than the current size of the volume. This modification is not instantaneous. type: integer VolumeId: description: The ID of the volume you want to update. type: string VolumeType: - description: The new type of the volume (`standard` \| `io1` \| `gp2`). - If you update to an `io1` volume, you must also specify the `Iops` parameter. + description: The new type of the volume (`standard` \| `io1` \| `gp2`). If you update to an `io1` volume, you must also specify the `Iops` parameter. type: string required: - VolumeId @@ -12406,10 +11532,10 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. Volume: - "$ref": "#/components/schemas/Volume" + $ref: '#/components/schemas/Volume' description: Information about the volume. type: object UpdateVpnConnectionRequest: @@ -12419,8 +11545,7 @@ components: description: The ID of the client gateway. type: string DryRun: - description: If true, checks whether you have the required permissions to - perform the action. + description: If true, checks whether you have the required permissions to perform the action. type: boolean VirtualGatewayId: description: The ID of the virtual gateway. @@ -12429,7 +11554,7 @@ components: description: The ID of the VPN connection you want to modify. type: string VpnOptions: - "$ref": "#/components/schemas/VpnOptions" + $ref: '#/components/schemas/VpnOptions' description: Information about the VPN options. required: - VpnConnectionId @@ -12438,10 +11563,10 @@ components: additionalProperties: false properties: ResponseContext: - "$ref": "#/components/schemas/ResponseContext" + $ref: '#/components/schemas/ResponseContext' description: Information about the context of the response. VpnConnection: - "$ref": "#/components/schemas/VpnConnection" + $ref: '#/components/schemas/VpnConnection' description: Information about a VPN connection. type: object User: @@ -12453,13 +11578,11 @@ components: format: date-time type: string LastModificationDate: - description: The date and time (UTC) of the last modification of the EIM - user. + description: The date and time (UTC) of the last modification of the EIM user. format: date-time type: string OutscaleLoginAllowed: - description: Whether the user is allowed to log in to Cockpit v2 using its - Outscale credentials when identity federation is activated. + description: Whether the user is allowed to log in to Cockpit v2 using its Outscale credentials when identity federation is activated. type: boolean Path: description: The path to the EIM user. @@ -12483,16 +11606,14 @@ components: format: date-time type: string LastModificationDate: - description: The date and time (UTC) of the last modification of the user - group. + description: The date and time (UTC) of the last modification of the user group. format: date-time type: string Name: description: The name of the user group. type: string Orn: - description: The Outscale Resource Name (ORN) of the user group. For more - information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + description: The Outscale Resource Name (ORN) of the user group. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). type: string Path: description: The path to the user group. @@ -12506,12 +11627,11 @@ components: description: Information about the current state of a VPN tunnel. properties: AcceptedRouteCount: - description: The number of routes accepted through BGP (Border Gateway Protocol) - route exchanges. + description: The number of routes accepted through BGP (Border Gateway Protocol) route exchanges. type: integer LastStateChangeDate: description: The date and time (UTC) of the latest state update. - format: datetime + format: date-time type: string OutsideIpAddress: description: The IP on the OUTSCALE side of the tunnel. @@ -12528,22 +11648,20 @@ components: description: Information about the virtual gateway. properties: ConnectionType: - description: The type of VPN connection supported by the virtual gateway - (always `ipsec.1`). + description: The type of VPN connection supported by the virtual gateway (always `ipsec.1`). type: string NetToVirtualGatewayLinks: description: The Net to which the virtual gateway is attached. items: - "$ref": "#/components/schemas/NetToVirtualGatewayLink" + $ref: '#/components/schemas/NetToVirtualGatewayLink' type: array State: - description: The state of the virtual gateway (`pending` \| `available` - \| `deleting` \| `deleted`). + description: The state of the virtual gateway (`pending` \| `available` \| `deleting` \| `deleted`). type: string Tags: description: One or more tags associated with the virtual gateway. items: - "$ref": "#/components/schemas/ResourceTag" + $ref: '#/components/schemas/ResourceTag' type: array VirtualGatewayId: description: The ID of the virtual gateway. @@ -12554,7 +11672,7 @@ components: description: Information about the VM. properties: ActionsOnNextBoot: - "$ref": "#/components/schemas/ActionsOnNextBoot" + $ref: '#/components/schemas/ActionsOnNextBoot' description: The action to perform on the next boot of the VM. Architecture: description: The architecture of the VM (`i386` \| `x86_64`). @@ -12562,25 +11680,23 @@ components: BlockDeviceMappings: description: The block device mapping of the VM. items: - "$ref": "#/components/schemas/BlockDeviceMappingCreated" + $ref: '#/components/schemas/BlockDeviceMappingCreated' type: array BootMode: - "$ref": "#/components/schemas/BootMode" + $ref: '#/components/schemas/BootMode' description: The boot mode of the VM. BsuOptimized: - description: This parameter is not available. It is present in our API for - the sake of historical compatibility with AWS. + description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS. type: boolean ClientToken: description: The idempotency token provided when launching the VM. type: string CreationDate: description: The date and time (UTC) at which the VM was created. - format: datetime + format: date-time type: string DeletionProtection: - description: If true, you cannot delete the VM unless you change this parameter - back to false. + description: If true, you cannot delete the VM unless you change this parameter back to false. type: boolean Hypervisor: description: The hypervisor type of the VMs (`ovm` \| `xen`). @@ -12589,28 +11705,24 @@ components: description: The ID of the OMI used to create the VM. type: string IsSourceDestChecked: - description: "(Net only) If true, the source/destination check is enabled. - If false, it is disabled." + description: (Net only) If true, the source/destination check is enabled. If false, it is disabled. type: boolean KeypairName: description: The name of the keypair used when launching the VM. type: string LaunchNumber: - description: The number for the VM when launching a group of several VMs - (for example, `0`, `1`, `2`, and so on). + description: The number for the VM when launching a group of several VMs (for example, `0`, `1`, `2`, and so on). type: integer NestedVirtualization: - description: If true, nested virtualization is enabled. If false, it is - disabled. + description: If true, nested virtualization is enabled. If false, it is disabled. type: boolean NetId: description: The ID of the Net in which the VM is running. type: string Nics: - description: "(Net only) The network interface cards (NICs) the VMs are - attached to." + description: (Net only) The network interface cards (NICs) the VMs are attached to. items: - "$ref": "#/components/schemas/NicLight" + $ref: '#/components/schemas/NicLight' type: array OsFamily: description: Indicates the operating system (OS) of the VM. @@ -12619,7 +11731,7 @@ components: description: The performance of the VM. type: string Placement: - "$ref": "#/components/schemas/Placement" + $ref: '#/components/schemas/Placement' description: Information about the placement of the VM. PrivateDnsName: description: The name of the private DNS. @@ -12628,8 +11740,7 @@ components: description: The primary private IP of the VM. type: string ProductCodes: - description: The product codes associated with the OMI used to create the - VM. + description: The product codes associated with the OMI used to create the VM. items: type: string type: array @@ -12651,11 +11762,10 @@ components: SecurityGroups: description: One or more security groups associated with the VM. items: - "$ref": "#/components/schemas/SecurityGroupLight" + $ref: '#/components/schemas/SecurityGroupLight' type: array State: - description: The state of the VM (`pending` \| `running` \| `stopping` \| - `stopped` \| `shutting-down` \| `terminated` \| `quarantine`). + description: The state of the VM (`pending` \| `running` \| `stopping` \| `stopped` \| `shutting-down` \| `terminated` \| `quarantine`). type: string StateReason: description: The reason explaining the current state of the VM. @@ -12666,11 +11776,10 @@ components: Tags: description: One or more tags associated with the VM. items: - "$ref": "#/components/schemas/ResourceTag" + $ref: '#/components/schemas/ResourceTag' type: array TpmEnabled: - description: If true, a virtual Trusted Platform Module (vTPM) is enabled - on the VM. If false, it is not. + description: If true, a virtual Trusted Platform Module (vTPM) is enabled on the VM. If false, it is not. type: boolean UserData: description: The Base64-encoded MIME user data. @@ -12679,9 +11788,7 @@ components: description: The ID of the VM. type: string VmInitiatedShutdownBehavior: - description: The VM behavior when you stop it. If set to `stop`, the VM - stops. If set to `restart`, the VM stops then automatically restarts. - If set to `terminate`, the VM stops and is deleted. + description: The VM behavior when you stop it. If set to `stop`, the VM stops. If set to `restart`, the VM stops then automatically restarts. If set to `terminate`, the VM stops and is deleted. type: string VmType: description: The type of VM. For more information, see [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html). @@ -12693,17 +11800,13 @@ components: properties: CreationDate: description: The date and time (UTC) at which the VM group was created. - format: datetime + format: date-time type: string Description: description: The description of the VM group. type: string PositioningStrategy: - description: The positioning strategy of the VMs on hypervisors. If set - to `no-strategy`, TINA determines the most adequate position for the VMs. - If set to `attract`, the VMs are deployed on the same hypervisor, which - improves network performance. If set to `repulse`, the VMs are deployed - on a different hypervisor, which improves fault tolerance. + description: The positioning strategy of the VMs on hypervisors. If set to `no-strategy`, TINA determines the most adequate position for the VMs. If set to `attract`, the VMs are deployed on the same hypervisor, which improves network performance. If set to `repulse`, the VMs are deployed on a different hypervisor, which improves fault tolerance. enum: - attract - no-strategy @@ -12730,7 +11833,7 @@ components: Tags: description: One or more tags associated with the VM group. items: - "$ref": "#/components/schemas/ResourceTag" + $ref: '#/components/schemas/ResourceTag' type: array VmCount: description: The number of VMs in the VM group. @@ -12755,12 +11858,10 @@ components: description: Information about the state of the VM. properties: CurrentState: - description: The current state of the VM (`InService` \| `OutOfService` - \| `Unknown`). + description: The current state of the VM (`InService` \| `OutOfService` \| `Unknown`). type: string PreviousState: - description: The previous state of the VM (`InService` \| `OutOfService` - \| `Unknown`). + description: The previous state of the VM (`InService` \| `OutOfService` \| `Unknown`). type: string VmId: description: The ID of the VM. @@ -12773,7 +11874,7 @@ components: MaintenanceEvents: description: One or more scheduled events associated with the VM. items: - "$ref": "#/components/schemas/MaintenanceEvent" + $ref: '#/components/schemas/MaintenanceEvent' type: array SubregionName: description: The name of the Subregion of the VM. @@ -12782,8 +11883,7 @@ components: description: The ID of the VM. type: string VmState: - description: The state of the VM (`pending` \| `running` \| `stopping` \| - `stopped` \| `shutting-down` \| `terminated` \| `quarantine`). + description: The state of the VM (`pending` \| `running` \| `stopping` \| `stopped` \| `shutting-down` \| `terminated` \| `quarantine`). type: string type: object VmTemplate: @@ -12822,7 +11922,7 @@ components: Tags: description: One or more tags associated with the VM template. items: - "$ref": "#/components/schemas/ResourceTag" + $ref: '#/components/schemas/ResourceTag' type: array VmTemplateId: description: The ID of the VM template. @@ -12843,8 +11943,7 @@ components: description: Information about the VM type. properties: BsuOptimized: - description: This parameter is not available. It is present in our API for - the sake of historical compatibility with AWS. + description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS. type: boolean EphemeralsType: description: The type of ephemeral storage disk. @@ -12856,8 +11955,7 @@ components: description: The number of GPU available. type: integer MaxPrivateIps: - description: The maximum number of private IPs per network interface card - (NIC). + description: The maximum number of private IPs per network interface card (NIC). type: integer MemorySize: description: The amount of memory, in gibibytes. @@ -12885,7 +11983,7 @@ components: type: string CreationDate: description: The date and time (UTC) at which the volume was created. - format: datetime + format: date-time type: string Iops: description: |- @@ -12896,7 +11994,7 @@ components: LinkedVolumes: description: Information about your volume attachment. items: - "$ref": "#/components/schemas/LinkedVolume" + $ref: '#/components/schemas/LinkedVolume' type: array Size: description: The size of the volume, in gibibytes (GiB). @@ -12905,8 +12003,7 @@ components: description: The snapshot from which the volume was created. type: string State: - description: The state of the volume (`creating` \| `available` \| `in-use` - \| `deleting` \| `error`). + description: The state of the volume (`creating` \| `available` \| `in-use` \| `deleting` \| `error`). type: string SubregionName: description: The Subregion in which the volume was created. @@ -12914,11 +12011,10 @@ components: Tags: description: One or more tags associated with the volume. items: - "$ref": "#/components/schemas/ResourceTag" + $ref: '#/components/schemas/ResourceTag' type: array TaskId: - description: The ID of the volume update task in progress. Otherwise, it - is not returned. + description: The ID of the volume update task in progress. Otherwise, it is not returned. nullable: true type: string VolumeId: @@ -12933,10 +12029,10 @@ components: description: Information about the update of a volume. properties: Origin: - "$ref": "#/components/schemas/VolumeUpdateParameters" + $ref: '#/components/schemas/VolumeUpdateParameters' description: Information about the parameters of the update of a volume. Target: - "$ref": "#/components/schemas/VolumeUpdateParameters" + $ref: '#/components/schemas/VolumeUpdateParameters' description: Information about the parameters of the update of a volume. type: object VolumeUpdateParameters: @@ -12985,18 +12081,16 @@ components: format: date-time type: string State: - description: The state of the volume (`pending` \| `active` \| `completed` - \| `failed` \| `canceled`). + description: The state of the volume (`pending` \| `active` \| `completed` \| `failed` \| `canceled`). example: completed type: string Tags: description: One or more tags associated with the volume update task. items: - "$ref": "#/components/schemas/ResourceTag" + $ref: '#/components/schemas/ResourceTag' type: array TaskId: - description: The ID of the volume update task in progress. Otherwise, it - is not returned. + description: The ID of the volume update task in progress. Otherwise, it is not returned. example: vol-update-12345678 type: string VolumeId: @@ -13004,7 +12098,7 @@ components: example: vol-12345678 type: string VolumeUpdate: - "$ref": "#/components/schemas/VolumeUpdate" + $ref: '#/components/schemas/VolumeUpdate' description: Information about the update of a volume. type: object VpnConnection: @@ -13015,48 +12109,40 @@ components: description: Example configuration for the client gateway. type: string ClientGatewayId: - description: The ID of the client gateway used on the client end of the - connection. + description: The ID of the client gateway used on the client end of the connection. type: string ConnectionType: description: The type of VPN connection (always `ipsec.1`). type: string Routes: - description: Information about one or more static routes associated with - the VPN connection, if any. + description: Information about one or more static routes associated with the VPN connection, if any. items: - "$ref": "#/components/schemas/RouteLight" + $ref: '#/components/schemas/RouteLight' type: array State: - description: The state of the VPN connection (`pending` \| `available` \| - `deleting` \| `deleted`). + description: The state of the VPN connection (`pending` \| `available` \| `deleting` \| `deleted`). type: string StaticRoutesOnly: - description: If false, the VPN connection uses dynamic routing with Border - Gateway Protocol (BGP). If true, routing is controlled using static routes. - For more information about how to create and delete static routes, see - [CreateVpnConnectionRoute](#createvpnconnectionroute) and [DeleteVpnConnectionRoute](#deletevpnconnectionroute). + description: If false, the VPN connection uses dynamic routing with Border Gateway Protocol (BGP). If true, routing is controlled using static routes. For more information about how to create and delete static routes, see [CreateVpnConnectionRoute](#createvpnconnectionroute) and [DeleteVpnConnectionRoute](#deletevpnconnectionroute). type: boolean Tags: description: One or more tags associated with the VPN connection. items: - "$ref": "#/components/schemas/ResourceTag" + $ref: '#/components/schemas/ResourceTag' type: array VgwTelemetries: - description: Information about the current state of one or more of the VPN - tunnels. + description: Information about the current state of one or more of the VPN tunnels. items: - "$ref": "#/components/schemas/VgwTelemetry" + $ref: '#/components/schemas/VgwTelemetry' type: array VirtualGatewayId: - description: The ID of the virtual gateway used on the OUTSCALE end of the - connection. + description: The ID of the virtual gateway used on the OUTSCALE end of the connection. type: string VpnConnectionId: description: The ID of the VPN connection. type: string VpnOptions: - "$ref": "#/components/schemas/VpnOptions" + $ref: '#/components/schemas/VpnOptions' description: Information about the VPN options. type: object VpnOptions: @@ -13064,16 +12150,13 @@ components: description: Information about the VPN options. properties: Phase1Options: - "$ref": "#/components/schemas/Phase1Options" - description: This parameter is not available. It is present in our API for - the sake of historical compatibility with AWS. + $ref: '#/components/schemas/Phase1Options' + description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS. Phase2Options: - "$ref": "#/components/schemas/Phase2Options" - description: Information about Phase 2 of the Internet Key Exchange (IKE) - negotiation. + $ref: '#/components/schemas/Phase2Options' + description: Information about Phase 2 of the Internet Key Exchange (IKE) negotiation. TunnelInsideIpRange: - description: The range of inside IPs for the tunnel. This must be a /30 - CIDR block from the 169.254.254.0/24 range. + description: The range of inside IPs for the tunnel. This must be a /30 CIDR block from the 169.254.254.0/24 range. type: string type: object With: @@ -13114,8 +12197,7 @@ components: type: boolean QueryHeaderSize: default: true - description: If true, the size of the raw header of the HTTP request is - displayed. + description: If true, the size of the raw header of the HTTP request is displayed. type: boolean QueryIpAddress: default: true @@ -13127,8 +12209,7 @@ components: type: boolean QueryPayloadSize: default: true - description: If true, the size of the raw payload of the HTTP request is - displayed. + description: If true, the size of the raw payload of the HTTP request is displayed. type: boolean QueryUserAgent: default: true @@ -13226,16 +12307,16 @@ info: url: https://opensource.org/licenses/BSD-3-Clause termsOfService: https://en.outscale.com/terms-of-service/ title: 3DS OUTSCALE API - version: 1.36.3 - x-osc-api-osc-billing: 1.36.0 - x-osc-api-osc-cloud-region: 1.36.0 + version: 1.39.1 + x-osc-api-osc-billing: 1.38.0 + x-osc-api-osc-cloud-region: 1.36.1 x-osc-api-osc-cloud-vision: 1.36.0 - x-osc-api-osc-core-iaas: 1.36.1 - x-osc-api-osc-iam: 1.36.2 + x-osc-api-osc-core-iaas: 1.37.1 + x-osc-api-osc-iam: 1.37.4 x-osc-api-type: external openapi: 3.0.0 paths: - "/AcceptNetPeering": + /AcceptNetPeering: post: description: |- Accepts a Net peering request.
@@ -13248,7 +12329,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/AcceptNetPeeringRequest" + $ref: '#/components/schemas/AcceptNetPeeringRequest' examples: ex1: value: @@ -13258,7 +12339,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/AcceptNetPeeringResponse" + $ref: '#/components/schemas/AcceptNetPeeringResponse' examples: ex1: value: @@ -13284,29 +12365,29 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '409': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 409 response (Conflict). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - NetPeering - "/AddUserToUserGroup": + /AddUserToUserGroup: post: description: Adds a user to a specified group. operationId: AddUserToUserGroup @@ -13314,20 +12395,20 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/AddUserToUserGroupRequest" + $ref: '#/components/schemas/AddUserToUserGroupRequest' examples: ex1: value: UserGroupName: example-usergroup - UserGroupPath: "/example/" + UserGroupPath: /example/ UserName: example-user - UserPath: "/example/" + UserPath: /example/ responses: '200': content: application/json: schema: - "$ref": "#/components/schemas/AddUserToUserGroupResponse" + $ref: '#/components/schemas/AddUserToUserGroupResponse' examples: ex1: value: @@ -13336,7 +12417,7 @@ paths: description: The HTTP 200 response (OK). tags: - UserGroup - "/CheckAuthentication": + /CheckAuthentication: post: description: Validates the authenticity of the account. operationId: CheckAuthentication @@ -13344,18 +12425,18 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CheckAuthenticationRequest" + $ref: '#/components/schemas/CheckAuthenticationRequest' examples: ex1: value: Login: example@example.com - Password: "$OSC_PASSWORD" + Password: $OSC_PASSWORD responses: '200': content: application/json: schema: - "$ref": "#/components/schemas/CheckAuthenticationResponse" + $ref: '#/components/schemas/CheckAuthenticationResponse' examples: ex1: value: @@ -13364,7 +12445,7 @@ paths: description: The HTTP 200 response (OK). tags: - Account - "/CreateAccessKey": + /CreateAccessKey: post: description: |- Creates an access key for either your root account or an EIM user. The new key is automatically set to `ACTIVE`.

@@ -13374,7 +12455,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateAccessKeyRequest" + $ref: '#/components/schemas/CreateAccessKeyRequest' examples: ex1: value: @@ -13386,7 +12467,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateAccessKeyResponse" + $ref: '#/components/schemas/CreateAccessKeyResponse' examples: ex1: value: @@ -13395,10 +12476,10 @@ paths: AccessKey: State: ACTIVE AccessKeyId: ABCDEFGHIJ0123456789 - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 - ExpirationDate: 2063-04-05 00:00:00.000000000 +00:00 + CreationDate: 2010-10-01T12:34:56.789+0000 + ExpirationDate: 2063-04-05T00:00:00.000+0000 SecretKey: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 + LastModificationDate: 2010-10-01T12:34:56.789+0000 Tag: Group1 description: The HTTP 200 response (OK). security: @@ -13406,7 +12487,7 @@ paths: - BasicAuth: [] tags: - AccessKey - "/CreateAccount": + /CreateAccount: post: description: |- Creates an OUTSCALE account.

@@ -13421,7 +12502,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateAccountRequest" + $ref: '#/components/schemas/CreateAccountRequest' examples: ex1: value: @@ -13438,7 +12519,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateAccountResponse" + $ref: '#/components/schemas/CreateAccountResponse' examples: ex1: value: @@ -13456,7 +12537,7 @@ paths: description: The HTTP 200 response (OK). tags: - Account - "/CreateApiAccessRule": + /CreateApiAccessRule: post: description: |- Creates a rule to allow access to the API from your account.
@@ -13470,7 +12551,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateApiAccessRuleRequest" + $ref: '#/components/schemas/CreateApiAccessRuleRequest' examples: ex1: summary: Creating an API access rule based on IPs @@ -13480,8 +12561,7 @@ paths: - 198.51.100.0/24 Description: Basic API Access Rule with IPs ex2: - summary: Creating an API access rule based on IPs and Certificate - Authority (CA) + summary: Creating an API access rule based on IPs and Certificate Authority (CA) value: IpRanges: - 192.0.2.0 @@ -13494,7 +12574,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateApiAccessRuleResponse" + $ref: '#/components/schemas/CreateApiAccessRuleResponse' examples: ex1: summary: Creating an API access rule based on IPs @@ -13510,8 +12590,7 @@ paths: Cns: [] Description: Basic API Access Rule with IPs ex2: - summary: Creating an API access rule based on IPs and Certificate - Authority (CA) + summary: Creating an API access rule based on IPs and Certificate Authority (CA) value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 @@ -13530,7 +12609,7 @@ paths: - BasicAuth: [] tags: - ApiAccessRule - "/CreateCa": + /CreateCa: post: description: |- Creates a Client Certificate Authority (CA).

@@ -13540,7 +12619,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateCaRequest" + $ref: '#/components/schemas/CreateCaRequest' examples: ex1: value: @@ -13551,7 +12630,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateCaResponse" + $ref: '#/components/schemas/CreateCaResponse' examples: ex1: value: @@ -13567,7 +12646,7 @@ paths: - BasicAuth: [] tags: - Ca - "/CreateClientGateway": + /CreateClientGateway: post: description: |- Provides information about your client gateway.
@@ -13579,7 +12658,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateClientGatewayRequest" + $ref: '#/components/schemas/CreateClientGatewayRequest' examples: ex1: value: @@ -13591,7 +12670,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateClientGatewayResponse" + $ref: '#/components/schemas/CreateClientGatewayResponse' examples: ex1: value: @@ -13607,12 +12686,9 @@ paths: description: The HTTP 200 response (OK). tags: - ClientGateway - "/CreateDedicatedGroup": + /CreateDedicatedGroup: post: description: |- - > [WARNING]
- > This feature is currently in beta.
- Creates a dedicated group for virtual machines (VMs).

For more information, see [About Dedicated Groups](https://docs.outscale.com/en/userguide/About-Dedicated-Groups.html). operationId: CreateDedicatedGroup @@ -13620,7 +12696,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateDedicatedGroupRequest" + $ref: '#/components/schemas/CreateDedicatedGroupRequest' examples: ex1: value: @@ -13632,7 +12708,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateDedicatedGroupResponse" + $ref: '#/components/schemas/CreateDedicatedGroupResponse' examples: ex1: value: @@ -13651,23 +12727,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - DedicatedGroup - "/CreateDhcpOptions": + /CreateDhcpOptions: post: description: |- Creates a set of DHCP options, that you can then associate with a Net using the [UpdateNet](#updatenet) method.

@@ -13677,7 +12753,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateDhcpOptionsRequest" + $ref: '#/components/schemas/CreateDhcpOptionsRequest' examples: ex1: value: @@ -13693,7 +12769,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateDhcpOptionsResponse" + $ref: '#/components/schemas/CreateDhcpOptionsResponse' examples: ex1: value: @@ -13713,7 +12789,7 @@ paths: description: The HTTP 200 response (OK). tags: - DhcpOption - "/CreateDirectLink": + /CreateDirectLink: post: description: |- Creates a DirectLink between a customer network and a specified DirectLink location.

@@ -13723,7 +12799,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateDirectLinkRequest" + $ref: '#/components/schemas/CreateDirectLinkRequest' examples: ex1: value: @@ -13735,7 +12811,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateDirectLinkResponse" + $ref: '#/components/schemas/CreateDirectLinkResponse' examples: ex1: value: @@ -13752,7 +12828,7 @@ paths: description: The HTTP 200 response (OK). tags: - DirectLink - "/CreateDirectLinkInterface": + /CreateDirectLinkInterface: post: description: |- Creates a DirectLink interface.
@@ -13763,7 +12839,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateDirectLinkInterfaceRequest" + $ref: '#/components/schemas/CreateDirectLinkInterfaceRequest' examples: ex1: value: @@ -13781,7 +12857,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateDirectLinkInterfaceResponse" + $ref: '#/components/schemas/CreateDirectLinkInterfaceResponse' examples: ex1: value: @@ -13804,7 +12880,7 @@ paths: description: The HTTP 200 response (OK). tags: - DirectLinkInterface - "/CreateFlexibleGpu": + /CreateFlexibleGpu: post: description: |- Allocates a flexible GPU (fGPU) to your account.
@@ -13815,7 +12891,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateFlexibleGpuRequest" + $ref: '#/components/schemas/CreateFlexibleGpuRequest' examples: ex1: value: @@ -13828,7 +12904,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateFlexibleGpuResponse" + $ref: '#/components/schemas/CreateFlexibleGpuResponse' examples: ex1: value: @@ -13845,7 +12921,7 @@ paths: description: The HTTP 200 response (OK). tags: - FlexibleGpu - "/CreateImage": + /CreateImage: post: description: |- Creates an OUTSCALE machine image (OMI).
@@ -13864,7 +12940,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateImageRequest" + $ref: '#/components/schemas/CreateImageRequest' examples: ex1: summary: Creating from a VM @@ -13883,14 +12959,14 @@ paths: value: ImageName: register-image-from-snapshot-example BlockDeviceMappings: - - DeviceName: "/dev/sda1" + - DeviceName: /dev/sda1 Bsu: SnapshotId: snap-12345678 VolumeSize: 120 VolumeType: io1 Iops: 150 DeleteOnVmDeletion: true - RootDeviceName: "/dev/sda1" + RootDeviceName: /dev/sda1 ex4: summary: Registering from a bucket by using a manifest file value: @@ -13901,7 +12977,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateImageResponse" + $ref: '#/components/schemas/CreateImageResponse' examples: ex1: summary: Creating from a VM @@ -13913,7 +12989,7 @@ paths: StateComment: {} State: pending RootDeviceType: bsu - RootDeviceName: "/dev/sda1" + RootDeviceName: /dev/sda1 ProductCodes: - '0001' PermissionsToLaunch: @@ -13924,7 +13000,7 @@ paths: Description: '' ImageId: ami-12345678 BlockDeviceMappings: - - DeviceName: "/dev/sda1" + - DeviceName: /dev/sda1 Bsu: VolumeType: standard DeleteOnVmDeletion: true @@ -13948,7 +13024,7 @@ paths: StateComment: {} State: available RootDeviceType: bsu - RootDeviceName: "/dev/sda1" + RootDeviceName: /dev/sda1 ProductCodes: - '0001' PermissionsToLaunch: @@ -13959,7 +13035,7 @@ paths: Description: '' ImageId: ami-12345678 BlockDeviceMappings: - - DeviceName: "/dev/sda1" + - DeviceName: /dev/sda1 Bsu: VolumeType: standard DeleteOnVmDeletion: true @@ -13983,7 +13059,7 @@ paths: StateComment: {} State: available RootDeviceType: bsu - RootDeviceName: "/dev/sda1" + RootDeviceName: /dev/sda1 ProductCodes: - '0001' PermissionsToLaunch: @@ -13994,7 +13070,7 @@ paths: Description: '' ImageId: ami-12345678 BlockDeviceMappings: - - DeviceName: "/dev/sda1" + - DeviceName: /dev/sda1 Bsu: VolumeType: io1 DeleteOnVmDeletion: true @@ -14019,7 +13095,7 @@ paths: StateComment: {} State: pending RootDeviceType: bsu - RootDeviceName: "/dev/sda1" + RootDeviceName: /dev/sda1 ProductCodes: - '0001' PermissionsToLaunch: @@ -14030,7 +13106,7 @@ paths: Description: '' ImageId: ami-12345678 BlockDeviceMappings: - - DeviceName: "/dev/sda1" + - DeviceName: /dev/sda1 Bsu: VolumeType: standard DeleteOnVmDeletion: true @@ -14049,23 +13125,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Image - "/CreateImageExportTask": + /CreateImageExportTask: post: description: |- Exports an OUTSCALE machine image (OMI) to an OUTSCALE Object Storage (OOS) bucket.
@@ -14081,7 +13157,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateImageExportTaskRequest" + $ref: '#/components/schemas/CreateImageExportTaskRequest' examples: ex1: value: @@ -14095,7 +13171,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateImageExportTaskResponse" + $ref: '#/components/schemas/CreateImageExportTaskResponse' examples: ex1: value: @@ -14115,18 +13191,18 @@ paths: description: The HTTP 200 response (OK). tags: - Image - "/CreateInternetService": + /CreateInternetService: post: description: |- Creates an internet service you can use with a Net.
- An internet service enables virtual machines (VMs) launched in a Net to connect to the Internet. It allows routing of incoming and outgoing Internet traffic and management of public IP addresses.

+ An internet service enables virtual machines (VMs) launched in a Net to connect to the Internet. It allows routing of incoming and outgoing Internet traffic and management of public IPs.

For more information, see [About Internet Services](https://docs.outscale.com/en/userguide/About-Internet-Services.html). operationId: CreateInternetService requestBody: content: application/json: schema: - "$ref": "#/components/schemas/CreateInternetServiceRequest" + $ref: '#/components/schemas/CreateInternetServiceRequest' examples: ex1: value: {} @@ -14135,7 +13211,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateInternetServiceResponse" + $ref: '#/components/schemas/CreateInternetServiceResponse' examples: ex1: value: @@ -14149,23 +13225,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - InternetService - "/CreateKeypair": + /CreateKeypair: post: description: |- Creates a keypair to use with your virtual machines (VMs).
@@ -14180,7 +13256,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateKeypairRequest" + $ref: '#/components/schemas/CreateKeypairRequest' examples: ex1: summary: Creating a keypair @@ -14190,13 +13266,13 @@ paths: summary: Importing a keypair created locally value: KeypairName: import-keypair-example - PublicKey: "..." + PublicKey: ... responses: '200': content: application/json: schema: - "$ref": "#/components/schemas/CreateKeypairResponse" + $ref: '#/components/schemas/CreateKeypairResponse' examples: ex1: summary: Creating a keypair @@ -14227,29 +13303,29 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '409': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 409 response (Conflict). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Keypair - "/CreateListenerRule": + /CreateListenerRule: post: description: |- Creates a rule for traffic redirection for the specified listener. Each rule must have either the `HostNamePattern` or `PathPattern` parameter specified. Rules are treated in priority order, from the highest value to the lowest value.
@@ -14260,7 +13336,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateListenerRuleRequest" + $ref: '#/components/schemas/CreateListenerRuleRequest' examples: ex1: summary: Creating a listener rule based on a host pattern @@ -14270,7 +13346,7 @@ paths: LoadBalancerPort: 80 ListenerRule: Action: forward - HostNamePattern: "*.example.com" + HostNamePattern: '*.example.com' ListenerRuleName: example-listener-rule Priority: 10 VmIds: @@ -14283,7 +13359,7 @@ paths: LoadBalancerPort: 80 ListenerRule: Action: forward - PathPattern: "/docs/*" + PathPattern: /docs/* ListenerRuleName: example-listener-rule Priority: 100 VmIds: @@ -14293,7 +13369,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateListenerRuleResponse" + $ref: '#/components/schemas/CreateListenerRuleResponse' examples: ex1: summary: Creating a listener rule based on a host pattern @@ -14307,7 +13383,7 @@ paths: ListenerRuleName: example-listener-rule Action: forward ListenerId: 123456 - HostNamePattern: "*.example.com" + HostNamePattern: '*.example.com' ListenerRuleId: 1234 ex2: summary: Creating a listener rule based on a path pattern @@ -14321,12 +13397,12 @@ paths: ListenerRuleName: example-listener-rule Action: forward ListenerId: 123456 - PathPattern: "/docs/*" + PathPattern: /docs/* ListenerRuleId: 1234 description: The HTTP 200 response (OK). tags: - Listener - "/CreateLoadBalancer": + /CreateLoadBalancer: post: description: |- Creates a load balancer.
@@ -14339,7 +13415,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateLoadBalancerRequest" + $ref: '#/components/schemas/CreateLoadBalancerRequest' examples: ex1: summary: Creating an internal load balancer in a Net @@ -14387,7 +13463,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateLoadBalancerResponse" + $ref: '#/components/schemas/CreateLoadBalancerResponse' examples: ex1: summary: Creating an internal load balancer in a Net @@ -14470,8 +13546,7 @@ paths: LoadBalancerProtocol: HTTPS LoadBalancerName: private-lb-example ex3: - summary: Creating an internet-facing load balancer in the public - Cloud + summary: Creating an internet-facing load balancer in the public Cloud value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 @@ -14508,7 +13583,7 @@ paths: description: The HTTP 200 response (OK). tags: - LoadBalancer - "/CreateLoadBalancerListeners": + /CreateLoadBalancerListeners: post: description: |- Creates one or more listeners for a specified load balancer.

@@ -14518,7 +13593,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateLoadBalancerListenersRequest" + $ref: '#/components/schemas/CreateLoadBalancerListenersRequest' examples: ex1: value: @@ -14533,7 +13608,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateLoadBalancerListenersResponse" + $ref: '#/components/schemas/CreateLoadBalancerListenersResponse' examples: ex1: value: @@ -14580,7 +13655,7 @@ paths: description: The HTTP 200 response (OK). tags: - Listener - "/CreateLoadBalancerPolicy": + /CreateLoadBalancerPolicy: post: description: |- Creates a stickiness policy with sticky session lifetimes defined by the browser lifetime.
@@ -14596,7 +13671,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateLoadBalancerPolicyRequest" + $ref: '#/components/schemas/CreateLoadBalancerPolicyRequest' examples: ex1: summary: Creating a load balancer policy based on browser @@ -14616,7 +13691,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateLoadBalancerPolicyResponse" + $ref: '#/components/schemas/CreateLoadBalancerPolicyResponse' examples: ex1: summary: Creating a load balancer policy based on browser @@ -14701,7 +13776,7 @@ paths: description: The HTTP 200 response (OK). tags: - LoadBalancerPolicy - "/CreateLoadBalancerTags": + /CreateLoadBalancerTags: post: description: |- Adds one or more tags to the specified load balancers.
@@ -14712,7 +13787,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateLoadBalancerTagsRequest" + $ref: '#/components/schemas/CreateLoadBalancerTagsRequest' examples: ex1: value: @@ -14726,7 +13801,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateLoadBalancerTagsResponse" + $ref: '#/components/schemas/CreateLoadBalancerTagsResponse' examples: ex1: value: @@ -14735,7 +13810,7 @@ paths: description: The HTTP 200 response (OK). tags: - LoadBalancer - "/CreateNatService": + /CreateNatService: post: description: |- Creates a network address translation (NAT) service in the specified public Subnet of a Net.
@@ -14751,7 +13826,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateNatServiceRequest" + $ref: '#/components/schemas/CreateNatServiceRequest' examples: ex1: value: @@ -14762,7 +13837,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateNatServiceResponse" + $ref: '#/components/schemas/CreateNatServiceResponse' examples: ex1: value: @@ -14782,23 +13857,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - NatService - "/CreateNet": + /CreateNet: post: description: |- Creates a Net with a specified IP range.
@@ -14809,7 +13884,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateNetRequest" + $ref: '#/components/schemas/CreateNetRequest' examples: ex1: value: @@ -14819,7 +13894,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateNetResponse" + $ref: '#/components/schemas/CreateNetResponse' examples: ex1: value: @@ -14837,29 +13912,29 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '409': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 409 response (Conflict). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Net - "/CreateNetAccessPoint": + /CreateNetAccessPoint: post: description: |- Creates a Net access point to access an OUTSCALE service from this Net without using the Internet and public IPs.
@@ -14872,7 +13947,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateNetAccessPointRequest" + $ref: '#/components/schemas/CreateNetAccessPointRequest' examples: ex1: value: @@ -14885,7 +13960,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateNetAccessPointResponse" + $ref: '#/components/schemas/CreateNetAccessPointResponse' examples: ex1: value: @@ -14902,7 +13977,7 @@ paths: description: The HTTP 200 response (OK). tags: - NetAccessPoint - "/CreateNetPeering": + /CreateNetPeering: post: description: |- Requests a Net peering between a Net you own and a peer Net that belongs to you or another account.
@@ -14918,7 +13993,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateNetPeeringRequest" + $ref: '#/components/schemas/CreateNetPeeringRequest' examples: ex1: summary: Creating a Net peering between two Nets belonging to you @@ -14926,8 +14001,7 @@ paths: SourceNetId: vpc-12345678 AccepterNetId: vpc-87654321 ex2: - summary: Creating a Net peering with a Net that belongs to another - account + summary: Creating a Net peering with a Net that belongs to another account value: SourceNetId: vpc-12345678 AccepterNetId: vpc-87654321 @@ -14937,7 +14011,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateNetPeeringResponse" + $ref: '#/components/schemas/CreateNetPeeringResponse' examples: ex1: summary: Creating a Net peering between two Nets belonging to you @@ -14959,8 +14033,7 @@ paths: AccountId: '123456789012' NetPeeringId: pcx-12345678 ex2: - summary: Creating a Net peering with a Net that belongs to another - account + summary: Creating a Net peering with a Net that belongs to another account value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 @@ -14983,23 +14056,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - NetPeering - "/CreateNic": + /CreateNic: post: description: |- Creates a network interface card (NIC) in the specified Subnet.

@@ -15009,7 +14082,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateNicRequest" + $ref: '#/components/schemas/CreateNicRequest' examples: ex1: summary: Creating a NIC @@ -15034,7 +14107,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateNicResponse" + $ref: '#/components/schemas/CreateNicResponse' examples: ex1: summary: Creating a NIC @@ -15092,23 +14165,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Nic - "/CreatePolicy": + /CreatePolicy: post: description: |- Creates a managed policy to apply to a user.
@@ -15118,21 +14191,20 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreatePolicyRequest" + $ref: '#/components/schemas/CreatePolicyRequest' examples: ex1: value: Description: Example of description - Document: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], - "Resource": ["*"]} ]}' - Path: "/example/" + Document: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' + Path: /example/ PolicyName: example-user-policy responses: '200': content: application/json: schema: - "$ref": "#/components/schemas/CreatePolicyResponse" + $ref: '#/components/schemas/CreatePolicyResponse' examples: ex1: value: @@ -15142,32 +14214,35 @@ paths: ResourcesCount: 0 PolicyName: example-user-policy PolicyDefaultVersionId: v1 - Path: "/example/" - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + Path: /example/ + CreationDate: 2010-10-01T12:34:56.789+0000 Description: Example of description PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy IsLinkable: true - LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 + LastModificationDate: 2010-10-01T12:34:56.789+0000 description: The HTTP 200 response (OK). tags: - Policy - "/CreatePolicyVersion": + /CreatePolicyVersion: post: description: |- Creates a version of a specified managed policy.
A managed policy can have up to five versions. +

+ + **[IMPORTANT]**
+ A delay of up to 15 seconds can occur when attaching, detaching, or updating a managed policy. operationId: CreatePolicyVersion requestBody: content: application/json: schema: - "$ref": "#/components/schemas/CreatePolicyVersionRequest" + $ref: '#/components/schemas/CreatePolicyVersionRequest' examples: ex1: value: - Document: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], - "Resource": ["*"]} ]}' + Document: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy SetAsDefault: true responses: @@ -15175,7 +14250,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreatePolicyVersionResponse" + $ref: '#/components/schemas/CreatePolicyVersionResponse' examples: ex1: value: @@ -15184,22 +14259,20 @@ paths: PolicyVersion: VersionId: v2 DefaultVersion: true - CreationDate: 2017-05-10 12:34:56.789000000 +00:00 - Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], - "Resource": ["*"]} ]}' + CreationDate: 2017-05-10T12:34:56.789+0000 + Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' description: The HTTP 200 response (OK). tags: - Policy - "/CreateProductType": + /CreateProductType: post: - description: Creates a product type you can associate with an OMI for consumption - monitoring and billing purposes. + description: Creates a product type you can associate with an OMI for consumption monitoring and billing purposes. operationId: CreateProductType requestBody: content: application/json: schema: - "$ref": "#/components/schemas/CreateProductTypeRequest" + $ref: '#/components/schemas/CreateProductTypeRequest' examples: ex1: value: @@ -15210,7 +14283,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateProductTypeResponse" + $ref: '#/components/schemas/CreateProductTypeResponse' examples: ex1: value: @@ -15223,7 +14296,7 @@ paths: description: The HTTP 200 response (OK). tags: - ProductType - "/CreatePublicIp": + /CreatePublicIp: post: description: |- Acquires a public IP for your account.
@@ -15234,7 +14307,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreatePublicIpRequest" + $ref: '#/components/schemas/CreatePublicIpRequest' examples: ex1: value: {} @@ -15243,7 +14316,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreatePublicIpResponse" + $ref: '#/components/schemas/CreatePublicIpResponse' examples: ex1: value: @@ -15258,23 +14331,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - PublicIp - "/CreateRoute": + /CreateRoute: post: description: |- Creates a route in a specified route table within a specified Net.
@@ -15294,7 +14367,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateRouteRequest" + $ref: '#/components/schemas/CreateRouteRequest' examples: ex1: summary: Creating a route to an Internet service @@ -15307,7 +14380,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateRouteResponse" + $ref: '#/components/schemas/CreateRouteResponse' examples: ex1: summary: Creating a route to an Internet service @@ -15333,23 +14406,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Route - "/CreateRouteTable": + /CreateRouteTable: post: description: |- Creates a route table for a specified Net.
@@ -15360,7 +14433,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateRouteTableRequest" + $ref: '#/components/schemas/CreateRouteTableRequest' examples: ex1: value: @@ -15370,7 +14443,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateRouteTableResponse" + $ref: '#/components/schemas/CreateRouteTableResponse' examples: ex1: value: @@ -15391,23 +14464,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - RouteTable - "/CreateSecurityGroup": + /CreateSecurityGroup: post: description: |- Creates a security group.
@@ -15422,7 +14495,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateSecurityGroupRequest" + $ref: '#/components/schemas/CreateSecurityGroupRequest' examples: ex1: value: @@ -15434,7 +14507,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateSecurityGroupResponse" + $ref: '#/components/schemas/CreateSecurityGroupResponse' examples: ex1: value: @@ -15443,7 +14516,7 @@ paths: SecurityGroupName: security-group-example OutboundRules: - FromPortRange: -1 - IpProtocol: "-1" + IpProtocol: '-1' ToPortRange: -1 IpRanges: - 0.0.0.0/0 @@ -15459,23 +14532,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - SecurityGroup - "/CreateSecurityGroupRule": + /CreateSecurityGroupRule: post: description: |- Adds one or more rules to a security group.
@@ -15487,7 +14560,7 @@ paths: (Net only) An outbound rule works similarly but allows the security group to send traffic rather than receive traffic.
- Alternatively, you can use the `Rules` parameter to add several rules at the same time. + Alternatively, you can use the `Rules` parameter to add several rules at the same time. Note that the `SecurityGroupName` subparameter can only be used for security groups in the public Cloud. **[NOTE]**
* The modifications are effective as quickly as possible, but a small delay may occur.
@@ -15499,7 +14572,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateSecurityGroupRuleRequest" + $ref: '#/components/schemas/CreateSecurityGroupRuleRequest' examples: ex1: summary: Creating an inbound rule from an IP range @@ -15527,7 +14600,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateSecurityGroupRuleResponse" + $ref: '#/components/schemas/CreateSecurityGroupRuleResponse' examples: ex1: summary: Creating an inbound rule from an IP range @@ -15537,7 +14610,7 @@ paths: SecurityGroupName: security-group-example OutboundRules: - FromPortRange: -1 - IpProtocol: "-1" + IpProtocol: '-1' ToPortRange: -1 IpRanges: - 0.0.0.0/0 @@ -15561,7 +14634,7 @@ paths: SecurityGroupName: security-group-example OutboundRules: - FromPortRange: -1 - IpProtocol: "-1" + IpProtocol: '-1' ToPortRange: -1 IpRanges: - 0.0.0.0/0 @@ -15584,23 +14657,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - SecurityGroupRule - "/CreateServerCertificate": + /CreateServerCertificate: post: description: |- Creates a server certificate and its matching private key.

@@ -15615,26 +14688,26 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateServerCertificateRequest" + $ref: '#/components/schemas/CreateServerCertificateRequest' examples: ex1: value: Name: server-cert-example - Body: "..." - Chain: "..." - PrivateKey: "..." - Path: "/example/" + Body: ... + Chain: ... + PrivateKey: ... + Path: /example/ responses: '200': content: application/json: schema: - "$ref": "#/components/schemas/CreateServerCertificateResponse" + $ref: '#/components/schemas/CreateServerCertificateResponse' examples: ex1: value: ServerCertificate: - Path: "/example/" + Path: /example/ Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ1234 Orn: orn:ows:idauth::012345678910:server-certificate/example/server-cert-example Name: server-cert-example @@ -15643,7 +14716,7 @@ paths: description: The HTTP 200 response (OK). tags: - ServerCertificate - "/CreateSnapshot": + /CreateSnapshot: post: description: |- Creates a snapshot. Snapshots are point-in-time images of a volume that you can use to back up your data or to create replicas of this volume.
@@ -15661,7 +14734,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateSnapshotRequest" + $ref: '#/components/schemas/CreateSnapshotRequest' examples: ex1: summary: Creating from a volume @@ -15685,7 +14758,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateSnapshotResponse" + $ref: '#/components/schemas/CreateSnapshotResponse' examples: ex1: summary: Creating from a volume @@ -15746,23 +14819,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Snapshot - "/CreateSnapshotExportTask": + /CreateSnapshotExportTask: post: description: |- Exports a snapshot to an OUTSCALE Object Storage (OOS) bucket that belongs to you. This action enables you to create a backup of your snapshot.

@@ -15773,7 +14846,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateSnapshotExportTaskRequest" + $ref: '#/components/schemas/CreateSnapshotExportTaskRequest' examples: ex1: value: @@ -15787,7 +14860,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateSnapshotExportTaskResponse" + $ref: '#/components/schemas/CreateSnapshotExportTaskResponse' examples: ex1: value: @@ -15807,7 +14880,7 @@ paths: description: The HTTP 200 response (OK). tags: - Snapshot - "/CreateSubnet": + /CreateSubnet: post: description: |- Creates a Subnet in an existing Net.
@@ -15818,7 +14891,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateSubnetRequest" + $ref: '#/components/schemas/CreateSubnetRequest' examples: ex1: value: @@ -15829,7 +14902,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateSubnetResponse" + $ref: '#/components/schemas/CreateSubnetResponse' examples: ex1: value: @@ -15849,29 +14922,29 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '409': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 409 response (Conflict). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Subnet - "/CreateTags": + /CreateTags: post: description: |- Adds one or more tags to the specified resources.
@@ -15890,7 +14963,6 @@ paths: * Nets (vpc-xxxxxxxx)
* Network interface cards (NIC) (eni-xxxxxxxx)
* OMI export tasks (image-export-xxxxxxxx)
- * OMIs (ami-xxxxxxxx)
* Public IPs (eipalloc-xxxxxxxx)
* Route tables (rtb-xxxxxxxx)
* Security groups (sg-xxxxxxxx)
@@ -15908,7 +14980,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateTagsRequest" + $ref: '#/components/schemas/CreateTagsRequest' examples: ex1: value: @@ -15922,7 +14994,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateTagsResponse" + $ref: '#/components/schemas/CreateTagsResponse' examples: ex1: value: @@ -15933,23 +15005,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Tag - "/CreateUser": + /CreateUser: post: description: |- Creates an EIM user for your account.

@@ -15959,35 +15031,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateUserRequest" + $ref: '#/components/schemas/CreateUserRequest' examples: ex1: value: UserEmail: user@example.com UserName: example-user - Path: "/documentation/" + Path: /documentation/ responses: '200': content: application/json: schema: - "$ref": "#/components/schemas/CreateUserResponse" + $ref: '#/components/schemas/CreateUserResponse' examples: ex1: value: User: - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 - LastModificationDate: 2017-05-10 12:34:56.789000000 +00:00 + CreationDate: 2010-10-01T12:34:56.789+0000 + LastModificationDate: 2017-05-10T12:34:56.789+0000 UserEmail: user@example.com UserName: example-user UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 - Path: "/documentation/" + Path: /documentation/ ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - User - "/CreateUserGroup": + /CreateUserGroup: post: description: |- Creates a group to which you can add users.
@@ -15997,18 +15069,18 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateUserGroupRequest" + $ref: '#/components/schemas/CreateUserGroupRequest' examples: ex1: value: - Path: "/example/" + Path: /example/ UserGroupName: example-usergroup responses: '200': content: application/json: schema: - "$ref": "#/components/schemas/CreateUserGroupResponse" + $ref: '#/components/schemas/CreateUserGroupResponse' examples: ex1: value: @@ -16016,15 +15088,15 @@ paths: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 UserGroup: CreationDate: '2010-10-01T12:34:56.789Z' - LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 + LastModificationDate: 2010-10-01T12:34:56.789+0000 Name: example-usergroup Orn: orn:ows:idauth::012345678910:usergroup/example/usergroup-example - Path: "/example/" + Path: /example/ UserGroupId: ug-12345678 description: The HTTP 200 response (OK). tags: - UserGroup - "/CreateVirtualGateway": + /CreateVirtualGateway: post: description: |- Creates a virtual gateway.
@@ -16035,7 +15107,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateVirtualGatewayRequest" + $ref: '#/components/schemas/CreateVirtualGatewayRequest' examples: ex1: value: @@ -16045,7 +15117,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateVirtualGatewayResponse" + $ref: '#/components/schemas/CreateVirtualGatewayResponse' examples: ex1: value: @@ -16060,7 +15132,7 @@ paths: description: The HTTP 200 response (OK). tags: - VirtualGateway - "/CreateVmGroup": + /CreateVmGroup: post: description: |- > [WARNING]
@@ -16073,7 +15145,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateVmGroupRequest" + $ref: '#/components/schemas/CreateVmGroupRequest' examples: ex1: value: @@ -16093,7 +15165,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateVmGroupResponse" + $ref: '#/components/schemas/CreateVmGroupResponse' examples: ex1: value: @@ -16120,23 +15192,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - VmGroup - "/CreateVmTemplate": + /CreateVmTemplate: post: description: |- > [WARNING]
@@ -16149,7 +15221,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateVmTemplateRequest" + $ref: '#/components/schemas/CreateVmTemplateRequest' examples: ex1: value: @@ -16169,14 +15241,14 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateVmTemplateResponse" + $ref: '#/components/schemas/CreateVmTemplateResponse' examples: ex1: value: VmTemplate: VmTemplateName: vmtemplate-example CpuPerformance: high - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + CreationDate: 2010-10-01T12:34:56.789+0000 CpuCores: 2 Tags: - Key: key1 @@ -16191,22 +15263,26 @@ paths: description: The HTTP 200 response (OK). tags: - VmTemplate - "/CreateVms": + /CreateVms: post: description: |- Creates virtual machines (VMs), and then launches them.
This action enables you to create a specified number of VMs using an OUTSCALE machine image (OMI) that you are allowed to use, and then to automatically launch them.
The VMs remain in the `pending` state until they are created and ready to be used. Once automatically launched, they are in the `running` state.
To check the state of your VMs, call the [ReadVms](#readvms) method.
+ The metadata server enables you to get the public key provided when the VM is launched. Official OMIs contain a script to get this public key and put it inside the VM to provide secure access without password.
If not specified, the security group used by the service is the default one.
- The metadata server enables you to get the public key provided when the VM is launched. Official OMIs contain a script to get this public key and put it inside the VM to provide secure access without password.

+ + **[NOTE]**
+ When you attach a security group to a VM, it is actually attached to the primary network interface of the VM.
+ For more information, see [About VMs](https://docs.outscale.com/en/userguide/About-VMs.html). operationId: CreateVms requestBody: content: application/json: schema: - "$ref": "#/components/schemas/CreateVmsRequest" + $ref: '#/components/schemas/CreateVmsRequest' examples: ex1: summary: Creating a VM (minimal syntax) @@ -16221,7 +15297,7 @@ paths: SecurityGroupIds: - sg-12345678 SubnetId: subnet-12345678 - UserData: "..." + UserData: ... ex3: summary: Creating a VM with block device mappings value: @@ -16231,13 +15307,13 @@ paths: SecurityGroupIds: - sg-12345678 SubnetId: subnet-12345678 - UserData: "..." + UserData: ... BlockDeviceMappings: - - DeviceName: "/dev/sda1" + - DeviceName: /dev/sda1 Bsu: VolumeSize: 15 VolumeType: gp2 - - DeviceName: "/dev/sdb" + - DeviceName: /dev/sdb Bsu: SnapshotId: snap-12345678 VolumeSize: 22 @@ -16249,7 +15325,7 @@ paths: ImageId: ami-12345678 VmType: tinav5.c1r1p2 KeypairName: keypair-example - UserData: "..." + UserData: ... Nics: - DeviceNumber: 0 NicId: eni-12345678 @@ -16258,7 +15334,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateVmsResponse" + $ref: '#/components/schemas/CreateVmsResponse' examples: ex1: summary: Creating a VM (minimal syntax) @@ -16269,7 +15345,7 @@ paths: State: pending StateReason: '' RootDeviceType: ebs - RootDeviceName: "/dev/sda1" + RootDeviceName: /dev/sda1 IsSourceDestChecked: true ImageId: ami-12345678 DeletionProtection: false @@ -16278,7 +15354,7 @@ paths: Architecture: x86_64 NestedVirtualization: false BlockDeviceMappings: - - DeviceName: "/dev/sda1" + - DeviceName: /dev/sda1 Bsu: VolumeId: vol-12345678 State: attaching @@ -16293,7 +15369,7 @@ paths: ProductCodes: - '0001' CreationDate: '2010-10-01T12:34:56.789Z' - UserData: "..." + UserData: ... PrivateIp: 10.0.0.4 SecurityGroups: - SecurityGroupName: default @@ -16316,7 +15392,7 @@ paths: State: pending StateReason: '' RootDeviceType: ebs - RootDeviceName: "/dev/sda1" + RootDeviceName: /dev/sda1 IsSourceDestChecked: true KeypairName: keypair-example ImageId: ami-12345678 @@ -16326,7 +15402,7 @@ paths: Architecture: x86_64 NestedVirtualization: false BlockDeviceMappings: - - DeviceName: "/dev/sda1" + - DeviceName: /dev/sda1 Bsu: VolumeId: vol-12345678 State: attaching @@ -16341,7 +15417,7 @@ paths: ProductCodes: - '0001' CreationDate: '2010-10-01T12:34:56.789Z' - UserData: "..." + UserData: ... SubnetId: subnet-12345678 PrivateIp: 10.0.0.4 SecurityGroups: @@ -16388,7 +15464,7 @@ paths: State: pending StateReason: '' RootDeviceType: ebs - RootDeviceName: "/dev/sda1" + RootDeviceName: /dev/sda1 IsSourceDestChecked: true KeypairName: keypair-example ImageId: ami-12345678 @@ -16398,13 +15474,13 @@ paths: Architecture: x86_64 NestedVirtualization: false BlockDeviceMappings: - - DeviceName: "/dev/sda1" + - DeviceName: /dev/sda1 Bsu: VolumeId: vol-12345678 State: attaching LinkDate: '2010-10-01T12:34:56.789Z' DeleteOnVmDeletion: true - - DeviceName: "/dev/sda1" + - DeviceName: /dev/sda1 Bsu: VolumeId: vol-87654321 State: attaching @@ -16419,7 +15495,7 @@ paths: ProductCodes: - '0001' CreationDate: '2010-10-01T12:34:56.789Z' - UserData: "..." + UserData: ... SubnetId: subnet-12345678 PrivateIp: 10.0.0.4 SecurityGroups: @@ -16466,7 +15542,7 @@ paths: State: pending StateReason: '' RootDeviceType: ebs - RootDeviceName: "/dev/sda1" + RootDeviceName: /dev/sda1 IsSourceDestChecked: true KeypairName: keypair-example ImageId: ami-12345678 @@ -16476,7 +15552,7 @@ paths: Architecture: x86_64 NestedVirtualization: false BlockDeviceMappings: - - DeviceName: "/dev/sda1" + - DeviceName: /dev/sda1 Bsu: VolumeId: vol-12345678 State: attaching @@ -16491,7 +15567,7 @@ paths: ProductCodes: - '0001' CreationDate: '2010-10-01T12:34:56.789Z' - UserData: "..." + UserData: ... SubnetId: subnet-12345678 PrivateIp: 10.0.0.4 SecurityGroups: @@ -16534,23 +15610,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Vm - "/CreateVolume": + /CreateVolume: post: description: |- Creates a Block Storage Unit (BSU) volume in a specified Region.
@@ -16562,7 +15638,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateVolumeRequest" + $ref: '#/components/schemas/CreateVolumeRequest' examples: ex1: summary: Creating an io1 volume @@ -16583,7 +15659,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateVolumeResponse" + $ref: '#/components/schemas/CreateVolumeResponse' examples: ex1: summary: Creating an io1 volume @@ -16621,23 +15697,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Volume - "/CreateVpnConnection": + /CreateVpnConnection: post: description: |- Creates a VPN connection between a specified virtual gateway and a specified client gateway.
@@ -16651,7 +15727,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateVpnConnectionRequest" + $ref: '#/components/schemas/CreateVpnConnectionRequest' examples: ex1: value: @@ -16664,14 +15740,14 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateVpnConnectionResponse" + $ref: '#/components/schemas/CreateVpnConnectionResponse' examples: ex1: value: VpnConnection: Routes: [] Tags: [] - ClientGatewayConfiguration: "..." + ClientGatewayConfiguration: ... StaticRoutesOnly: true VirtualGatewayId: vgw-12345678 ConnectionType: ipsec.1 @@ -16688,7 +15764,7 @@ paths: description: The HTTP 200 response (OK). tags: - VpnConnection - "/CreateVpnConnectionRoute": + /CreateVpnConnectionRoute: post: description: |- Creates a static route to a VPN connection.
@@ -16699,7 +15775,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateVpnConnectionRouteRequest" + $ref: '#/components/schemas/CreateVpnConnectionRouteRequest' examples: ex1: value: @@ -16710,7 +15786,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CreateVpnConnectionRouteResponse" + $ref: '#/components/schemas/CreateVpnConnectionRouteResponse' examples: ex1: value: @@ -16719,7 +15795,7 @@ paths: description: The HTTP 200 response (OK). tags: - VpnConnection - "/DeleteAccessKey": + /DeleteAccessKey: post: description: |- Deletes the specified access key of either your root account or an EIM user.

@@ -16729,11 +15805,10 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteAccessKeyRequest" + $ref: '#/components/schemas/DeleteAccessKeyRequest' examples: ex1: - summary: Deleting one of your own access keys (if you are the root - account or an EIM user) + summary: Deleting one of your own access keys (if you are the root account or an EIM user) value: AccessKeyId: ABCDEFGHIJ0123456789 ex2: @@ -16746,7 +15821,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteAccessKeyResponse" + $ref: '#/components/schemas/DeleteAccessKeyResponse' examples: ex1: value: @@ -16758,7 +15833,7 @@ paths: - BasicAuth: [] tags: - AccessKey - "/DeleteApiAccessRule": + /DeleteApiAccessRule: post: description: |- Deletes a specified API access rule.

@@ -16770,7 +15845,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteApiAccessRuleRequest" + $ref: '#/components/schemas/DeleteApiAccessRuleRequest' examples: ex1: value: @@ -16780,7 +15855,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteApiAccessRuleResponse" + $ref: '#/components/schemas/DeleteApiAccessRuleResponse' examples: ex1: value: @@ -16792,7 +15867,7 @@ paths: - BasicAuth: [] tags: - ApiAccessRule - "/DeleteCa": + /DeleteCa: post: description: Deletes a specified Client Certificate Authority (CA). operationId: DeleteCa @@ -16800,7 +15875,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteCaRequest" + $ref: '#/components/schemas/DeleteCaRequest' examples: ex1: value: @@ -16810,7 +15885,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteCaResponse" + $ref: '#/components/schemas/DeleteCaResponse' examples: ex1: value: @@ -16822,7 +15897,7 @@ paths: - BasicAuth: [] tags: - Ca - "/DeleteClientGateway": + /DeleteClientGateway: post: description: |- Deletes a client gateway.
@@ -16832,7 +15907,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteClientGatewayRequest" + $ref: '#/components/schemas/DeleteClientGatewayRequest' examples: ex1: value: @@ -16842,7 +15917,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteClientGatewayResponse" + $ref: '#/components/schemas/DeleteClientGatewayResponse' examples: ex1: value: @@ -16851,12 +15926,9 @@ paths: description: The HTTP 200 response (OK). tags: - ClientGateway - "/DeleteDedicatedGroup": + /DeleteDedicatedGroup: post: description: |- - > [WARNING]
- > This feature is currently in beta.
- Deletes a specified dedicated group of virtual machines (VMs).
**[WARNING]**
@@ -16869,15 +15941,14 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteDedicatedGroupRequest" + $ref: '#/components/schemas/DeleteDedicatedGroupRequest' examples: ex1: summary: Deleting a dedicated group without any resource in it. value: DedicatedGroupId: ded-12345678 ex2: - summary: Forcing the deletion of a dedicated group and all resources - in it. + summary: Forcing the deletion of a dedicated group and all resources in it. value: DedicatedGroupId: ded-12345678 Force: true @@ -16886,7 +15957,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteDedicatedGroupResponse" + $ref: '#/components/schemas/DeleteDedicatedGroupResponse' examples: ex1: value: @@ -16897,23 +15968,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - DedicatedGroup - "/DeleteDhcpOptions": + /DeleteDhcpOptions: post: description: |- Deletes a specified DHCP options set.
@@ -16926,7 +15997,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteDhcpOptionsRequest" + $ref: '#/components/schemas/DeleteDhcpOptionsRequest' examples: ex1: value: @@ -16936,7 +16007,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteDhcpOptionsResponse" + $ref: '#/components/schemas/DeleteDhcpOptionsResponse' examples: ex1: value: @@ -16945,7 +16016,7 @@ paths: description: The HTTP 200 response (OK). tags: - DhcpOption - "/DeleteDirectLink": + /DeleteDirectLink: post: description: |- Deletes a specified DirectLink.
@@ -16955,7 +16026,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteDirectLinkRequest" + $ref: '#/components/schemas/DeleteDirectLinkRequest' examples: ex1: value: @@ -16965,7 +16036,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteDirectLinkResponse" + $ref: '#/components/schemas/DeleteDirectLinkResponse' examples: ex1: value: @@ -16974,7 +16045,7 @@ paths: description: The HTTP 200 response (OK). tags: - DirectLink - "/DeleteDirectLinkInterface": + /DeleteDirectLinkInterface: post: description: Deletes a specified DirectLink interface. operationId: DeleteDirectLinkInterface @@ -16982,7 +16053,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteDirectLinkInterfaceRequest" + $ref: '#/components/schemas/DeleteDirectLinkInterfaceRequest' examples: ex1: value: @@ -16992,7 +16063,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteDirectLinkInterfaceResponse" + $ref: '#/components/schemas/DeleteDirectLinkInterfaceResponse' examples: ex1: value: @@ -17001,7 +16072,7 @@ paths: description: The HTTP 200 response (OK). tags: - DirectLinkInterface - "/DeleteExportTask": + /DeleteExportTask: post: description: |- Deletes an export task.
@@ -17011,7 +16082,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteExportTaskRequest" + $ref: '#/components/schemas/DeleteExportTaskRequest' examples: ex1: summary: Deleting an image export task @@ -17026,7 +16097,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteExportTaskResponse" + $ref: '#/components/schemas/DeleteExportTaskResponse' examples: ex1: summary: Deleting an image export task @@ -17041,7 +16112,7 @@ paths: description: The HTTP 200 response (OK). tags: - Task - "/DeleteFlexibleGpu": + /DeleteFlexibleGpu: post: description: |- Releases a flexible GPU (fGPU) from your account.
@@ -17051,7 +16122,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteFlexibleGpuRequest" + $ref: '#/components/schemas/DeleteFlexibleGpuRequest' examples: ex1: value: @@ -17061,7 +16132,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteFlexibleGpuResponse" + $ref: '#/components/schemas/DeleteFlexibleGpuResponse' examples: ex1: value: @@ -17070,17 +16141,15 @@ paths: description: The HTTP 200 response (OK). tags: - FlexibleGpu - "/DeleteImage": + /DeleteImage: post: - description: Deletes an OUTSCALE machine image (OMI) so that you cannot use - it anymore to launch virtual machines (VMs). However, you can still use VMs - already launched from this OMI. + description: Deletes an OUTSCALE machine image (OMI) so that you cannot use it anymore to launch virtual machines (VMs). However, you can still use VMs already launched from this OMI. operationId: DeleteImage requestBody: content: application/json: schema: - "$ref": "#/components/schemas/DeleteImageRequest" + $ref: '#/components/schemas/DeleteImageRequest' examples: ex1: value: @@ -17090,7 +16159,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteImageResponse" + $ref: '#/components/schemas/DeleteImageResponse' examples: ex1: value: @@ -17101,23 +16170,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Image - "/DeleteInternetService": + /DeleteInternetService: post: description: |- Deletes an internet service.
@@ -17127,7 +16196,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteInternetServiceRequest" + $ref: '#/components/schemas/DeleteInternetServiceRequest' examples: ex1: value: @@ -17137,7 +16206,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteInternetServiceResponse" + $ref: '#/components/schemas/DeleteInternetServiceResponse' examples: ex1: value: @@ -17148,23 +16217,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - InternetService - "/DeleteKeypair": + /DeleteKeypair: post: description: |- Deletes the specified keypair.
@@ -17174,7 +16243,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteKeypairRequest" + $ref: '#/components/schemas/DeleteKeypairRequest' examples: ex1: summary: Deleting a keypair with its name @@ -17189,7 +16258,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteKeypairResponse" + $ref: '#/components/schemas/DeleteKeypairResponse' examples: ex1: value: @@ -17200,23 +16269,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Keypair - "/DeleteListenerRule": + /DeleteListenerRule: post: description: |- Deletes a listener rule.
@@ -17226,7 +16295,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteListenerRuleRequest" + $ref: '#/components/schemas/DeleteListenerRuleRequest' examples: ex1: value: @@ -17236,7 +16305,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteListenerRuleResponse" + $ref: '#/components/schemas/DeleteListenerRuleResponse' examples: ex1: value: @@ -17245,7 +16314,7 @@ paths: description: The HTTP 200 response (OK). tags: - Listener - "/DeleteLoadBalancer": + /DeleteLoadBalancer: post: description: Deletes a specified load balancer. operationId: DeleteLoadBalancer @@ -17253,7 +16322,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteLoadBalancerRequest" + $ref: '#/components/schemas/DeleteLoadBalancerRequest' examples: ex1: value: @@ -17263,7 +16332,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteLoadBalancerResponse" + $ref: '#/components/schemas/DeleteLoadBalancerResponse' examples: ex1: value: @@ -17272,7 +16341,7 @@ paths: description: The HTTP 200 response (OK). tags: - LoadBalancer - "/DeleteLoadBalancerListeners": + /DeleteLoadBalancerListeners: post: description: Deletes listeners of a specified load balancer. operationId: DeleteLoadBalancerListeners @@ -17280,7 +16349,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteLoadBalancerListenersRequest" + $ref: '#/components/schemas/DeleteLoadBalancerListenersRequest' examples: ex1: value: @@ -17292,7 +16361,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteLoadBalancerListenersResponse" + $ref: '#/components/schemas/DeleteLoadBalancerListenersResponse' examples: ex1: value: @@ -17331,7 +16400,7 @@ paths: description: The HTTP 200 response (OK). tags: - Listener - "/DeleteLoadBalancerPolicy": + /DeleteLoadBalancerPolicy: post: description: |- Deletes a specified policy from a load balancer.
@@ -17341,7 +16410,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteLoadBalancerPolicyRequest" + $ref: '#/components/schemas/DeleteLoadBalancerPolicyRequest' examples: ex1: value: @@ -17352,7 +16421,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteLoadBalancerPolicyResponse" + $ref: '#/components/schemas/DeleteLoadBalancerPolicyResponse' examples: ex1: value: @@ -17396,7 +16465,7 @@ paths: description: The HTTP 200 response (OK). tags: - LoadBalancerPolicy - "/DeleteLoadBalancerTags": + /DeleteLoadBalancerTags: post: description: Deletes one or more tags from the specified load balancers. operationId: DeleteLoadBalancerTags @@ -17404,7 +16473,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteLoadBalancerTagsRequest" + $ref: '#/components/schemas/DeleteLoadBalancerTagsRequest' examples: ex1: value: @@ -17417,7 +16486,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteLoadBalancerTagsResponse" + $ref: '#/components/schemas/DeleteLoadBalancerTagsResponse' examples: ex1: value: @@ -17426,7 +16495,7 @@ paths: description: The HTTP 200 response (OK). tags: - LoadBalancer - "/DeleteNatService": + /DeleteNatService: post: description: |- Deletes a specified network address translation (NAT) service.
@@ -17436,7 +16505,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteNatServiceRequest" + $ref: '#/components/schemas/DeleteNatServiceRequest' examples: ex1: value: @@ -17446,7 +16515,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteNatServiceResponse" + $ref: '#/components/schemas/DeleteNatServiceResponse' examples: ex1: value: @@ -17457,23 +16526,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - NatService - "/DeleteNet": + /DeleteNet: post: description: |- Deletes a specified Net.
@@ -17493,7 +16562,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteNetRequest" + $ref: '#/components/schemas/DeleteNetRequest' examples: ex1: value: @@ -17503,7 +16572,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteNetResponse" + $ref: '#/components/schemas/DeleteNetResponse' examples: ex1: value: @@ -17514,23 +16583,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Net - "/DeleteNetAccessPoint": + /DeleteNetAccessPoint: post: description: |- Deletes a specified Net access point.
@@ -17540,7 +16609,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteNetAccessPointRequest" + $ref: '#/components/schemas/DeleteNetAccessPointRequest' examples: ex1: value: @@ -17550,7 +16619,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteNetAccessPointResponse" + $ref: '#/components/schemas/DeleteNetAccessPointResponse' examples: ex1: value: @@ -17559,7 +16628,7 @@ paths: description: The HTTP 200 response (OK). tags: - NetAccessPoint - "/DeleteNetPeering": + /DeleteNetPeering: post: description: |- Deletes a Net peering.
@@ -17571,7 +16640,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteNetPeeringRequest" + $ref: '#/components/schemas/DeleteNetPeeringRequest' examples: ex1: value: @@ -17581,7 +16650,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteNetPeeringResponse" + $ref: '#/components/schemas/DeleteNetPeeringResponse' examples: ex1: value: @@ -17592,29 +16661,29 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '409': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 409 response (Conflict). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - NetPeering - "/DeleteNic": + /DeleteNic: post: description: |- Deletes the specified network interface card (NIC).
@@ -17624,7 +16693,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteNicRequest" + $ref: '#/components/schemas/DeleteNicRequest' examples: ex1: value: @@ -17634,7 +16703,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteNicResponse" + $ref: '#/components/schemas/DeleteNicResponse' examples: ex1: value: @@ -17645,23 +16714,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Nic - "/DeletePolicy": + /DeletePolicy: post: description: |- Deletes a managed policy.
@@ -17671,7 +16740,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeletePolicyRequest" + $ref: '#/components/schemas/DeletePolicyRequest' examples: ex1: value: @@ -17681,7 +16750,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeletePolicyResponse" + $ref: '#/components/schemas/DeletePolicyResponse' examples: ex1: value: @@ -17690,16 +16759,20 @@ paths: description: The HTTP 200 response (OK). tags: - Policy - "/DeletePolicyVersion": + /DeletePolicyVersion: post: - description: Deletes a specified version of a managed policy, if it is not set - as the default one. + description: |- + Deletes a specified version of a managed policy, if it is not set as the default one. +

+ + **[IMPORTANT]**
+ A delay of up to 15 seconds can occur when attaching, detaching, or updating a managed policy. operationId: DeletePolicyVersion requestBody: content: application/json: schema: - "$ref": "#/components/schemas/DeletePolicyVersionRequest" + $ref: '#/components/schemas/DeletePolicyVersionRequest' examples: ex1: value: @@ -17710,7 +16783,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeletePolicyVersionResponse" + $ref: '#/components/schemas/DeletePolicyVersionResponse' examples: ex1: value: @@ -17719,7 +16792,7 @@ paths: description: The HTTP 200 response (OK). tags: - Policy - "/DeleteProductType": + /DeleteProductType: post: description: |- Deletes a specified product type that belongs to you.
@@ -17732,7 +16805,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteProductTypeRequest" + $ref: '#/components/schemas/DeleteProductTypeRequest' examples: ex1: value: @@ -17742,7 +16815,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteProductTypeResponse" + $ref: '#/components/schemas/DeleteProductTypeResponse' examples: ex1: value: @@ -17753,23 +16826,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - ProductType - "/DeletePublicIp": + /DeletePublicIp: post: description: |- Releases a public IP.
@@ -17779,7 +16852,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeletePublicIpRequest" + $ref: '#/components/schemas/DeletePublicIpRequest' examples: ex1: value: @@ -17789,7 +16862,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeletePublicIpResponse" + $ref: '#/components/schemas/DeletePublicIpResponse' examples: ex1: value: @@ -17800,23 +16873,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - PublicIp - "/DeleteRoute": + /DeleteRoute: post: description: Deletes a route from a specified route table. operationId: DeleteRoute @@ -17824,7 +16897,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteRouteRequest" + $ref: '#/components/schemas/DeleteRouteRequest' examples: ex1: value: @@ -17835,7 +16908,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteRouteResponse" + $ref: '#/components/schemas/DeleteRouteResponse' examples: ex1: value: @@ -17856,23 +16929,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Route - "/DeleteRouteTable": + /DeleteRouteTable: post: description: |- Deletes a specified route table.
@@ -17882,7 +16955,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteRouteTableRequest" + $ref: '#/components/schemas/DeleteRouteTableRequest' examples: ex1: value: @@ -17892,7 +16965,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteRouteTableResponse" + $ref: '#/components/schemas/DeleteRouteTableResponse' examples: ex1: value: @@ -17903,23 +16976,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - RouteTable - "/DeleteSecurityGroup": + /DeleteSecurityGroup: post: description: |- Deletes a specified security group.
@@ -17930,7 +17003,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteSecurityGroupRequest" + $ref: '#/components/schemas/DeleteSecurityGroupRequest' examples: ex1: value: @@ -17940,7 +17013,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteSecurityGroupResponse" + $ref: '#/components/schemas/DeleteSecurityGroupResponse' examples: ex1: value: @@ -17951,35 +17024,38 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - SecurityGroup - "/DeleteSecurityGroupRule": + /DeleteSecurityGroupRule: post: description: |- - Deletes one or more inbound or outbound rules from a security group. For the rule to be deleted, the values specified in the deletion request must exactly match the value of the existing rule.
+ Deletes one or more inbound or outbound rules from a security group.
+ For the rule to be deleted, the values specified in the deletion request must exactly match the value of the existing rule.
In case of TCP and UDP protocols, you have to indicate the destination port or range of ports. In case of ICMP protocol, you have to specify the ICMP type and code numbers.
Rules (IP permissions) consist of the protocol, IP range or source security group.
- To remove outbound access to a destination security group, we recommend to use a set of IP permissions. We also recommend to specify the protocol in a set of IP permissions. + To remove outbound access to a destination security group, we recommend to use a set of IP permissions. We also recommend to specify the protocol in a set of IP permissions.
+ + Alternatively, you can use the `Rules` parameter to delete several rules at the same time. operationId: DeleteSecurityGroupRule requestBody: content: application/json: schema: - "$ref": "#/components/schemas/DeleteSecurityGroupRuleRequest" + $ref: '#/components/schemas/DeleteSecurityGroupRuleRequest' examples: ex1: summary: Deleting an inbound rule from an IP range @@ -18007,7 +17083,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteSecurityGroupRuleResponse" + $ref: '#/components/schemas/DeleteSecurityGroupRuleResponse' examples: ex1: summary: Deleting an inbound rule from an IP range @@ -18017,7 +17093,7 @@ paths: SecurityGroupName: security-group-example OutboundRules: - FromPortRange: -1 - IpProtocol: "-1" + IpProtocol: '-1' ToPortRange: -1 IpRanges: - 0.0.0.0/0 @@ -18036,7 +17112,7 @@ paths: SecurityGroupName: security-group-example OutboundRules: - FromPortRange: -1 - IpProtocol: "-1" + IpProtocol: '-1' ToPortRange: -1 IpRanges: - 0.0.0.0/0 @@ -18052,23 +17128,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - SecurityGroupRule - "/DeleteServerCertificate": + /DeleteServerCertificate: post: description: Deletes a specified server certificate. operationId: DeleteServerCertificate @@ -18076,7 +17152,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteServerCertificateRequest" + $ref: '#/components/schemas/DeleteServerCertificateRequest' examples: ex1: value: @@ -18086,7 +17162,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteServerCertificateResponse" + $ref: '#/components/schemas/DeleteServerCertificateResponse' examples: ex1: value: @@ -18095,7 +17171,7 @@ paths: description: The HTTP 200 response (OK). tags: - ServerCertificate - "/DeleteSnapshot": + /DeleteSnapshot: post: description: |- Deletes a specified snapshot.
@@ -18105,7 +17181,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteSnapshotRequest" + $ref: '#/components/schemas/DeleteSnapshotRequest' examples: ex1: value: @@ -18115,7 +17191,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteSnapshotResponse" + $ref: '#/components/schemas/DeleteSnapshotResponse' examples: ex1: value: @@ -18126,23 +17202,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Snapshot - "/DeleteSubnet": + /DeleteSubnet: post: description: |- Deletes a specified Subnet.
@@ -18157,7 +17233,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteSubnetRequest" + $ref: '#/components/schemas/DeleteSubnetRequest' examples: ex1: value: @@ -18167,7 +17243,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteSubnetResponse" + $ref: '#/components/schemas/DeleteSubnetResponse' examples: ex1: value: @@ -18178,23 +17254,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Subnet - "/DeleteTags": + /DeleteTags: post: description: Deletes one or more tags from the specified resources. operationId: DeleteTags @@ -18202,7 +17278,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteTagsRequest" + $ref: '#/components/schemas/DeleteTagsRequest' examples: ex1: value: @@ -18216,7 +17292,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteTagsResponse" + $ref: '#/components/schemas/DeleteTagsResponse' examples: ex1: value: @@ -18227,32 +17303,31 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Tag - "/DeleteUser": + /DeleteUser: post: - description: Deletes a specified EIM user. The EIM user must not belong to any - group, nor have any key or linked policy. + description: Deletes a specified EIM user. The EIM user must not belong to any group, nor have any key or linked policy. operationId: DeleteUser requestBody: content: application/json: schema: - "$ref": "#/components/schemas/DeleteUserRequest" + $ref: '#/components/schemas/DeleteUserRequest' examples: ex1: value: @@ -18262,7 +17337,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteUserResponse" + $ref: '#/components/schemas/DeleteUserResponse' examples: ex1: value: @@ -18271,7 +17346,7 @@ paths: description: The HTTP 200 response (OK). tags: - User - "/DeleteUserGroup": + /DeleteUserGroup: post: description: |- Deletes a specified user group.
@@ -18284,19 +17359,19 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteUserGroupRequest" + $ref: '#/components/schemas/DeleteUserGroupRequest' examples: ex1: value: Force: false - Path: "/example/" + Path: /example/ UserGroupName: example-usergroup responses: '200': content: application/json: schema: - "$ref": "#/components/schemas/DeleteUserGroupResponse" + $ref: '#/components/schemas/DeleteUserGroupResponse' examples: ex1: value: @@ -18305,27 +17380,32 @@ paths: description: The HTTP 200 response (OK). tags: - UserGroup - "/DeleteUserGroupPolicy": + /DeleteUserGroupPolicy: post: - description: Deletes a specified inline policy from a specific group. + description: |- + Deletes a specified inline policy from a specific group. +

+ + **[IMPORTANT]**
+ A delay of up to 15 seconds can occur when creating or deleting an inline policy. operationId: DeleteUserGroupPolicy requestBody: content: application/json: schema: - "$ref": "#/components/schemas/DeleteUserGroupPolicyRequest" + $ref: '#/components/schemas/DeleteUserGroupPolicyRequest' examples: ex1: value: PolicyName: example-usergroup-policy UserGroupName: example-usergroup - UserGroupPath: "/example/" + UserGroupPath: /example/ responses: '200': content: application/json: schema: - "$ref": "#/components/schemas/DeleteUserGroupPolicyResponse" + $ref: '#/components/schemas/DeleteUserGroupPolicyResponse' examples: ex1: value: @@ -18334,15 +17414,20 @@ paths: description: The HTTP 200 response (OK). tags: - Policy - "/DeleteUserPolicy": + /DeleteUserPolicy: post: - description: Deletes a specified inline policy from a specific user. + description: |- + Deletes a specified inline policy from a specific user. +

+ + **[IMPORTANT]**
+ A delay of up to 15 seconds can occur when creating or deleting an inline policy. operationId: DeleteUserPolicy requestBody: content: application/json: schema: - "$ref": "#/components/schemas/DeleteUserPolicyRequest" + $ref: '#/components/schemas/DeleteUserPolicyRequest' examples: ex1: value: @@ -18353,7 +17438,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteUserPolicyResponse" + $ref: '#/components/schemas/DeleteUserPolicyResponse' examples: ex1: value: @@ -18362,7 +17447,7 @@ paths: description: The HTTP 200 response (OK). tags: - Policy - "/DeleteVirtualGateway": + /DeleteVirtualGateway: post: description: |- Deletes a specified virtual gateway.
@@ -18372,7 +17457,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteVirtualGatewayRequest" + $ref: '#/components/schemas/DeleteVirtualGatewayRequest' examples: ex1: value: @@ -18382,7 +17467,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteVirtualGatewayResponse" + $ref: '#/components/schemas/DeleteVirtualGatewayResponse' examples: ex1: value: @@ -18391,7 +17476,7 @@ paths: description: The HTTP 200 response (OK). tags: - VirtualGateway - "/DeleteVmGroup": + /DeleteVmGroup: post: description: |- > [WARNING]
@@ -18403,7 +17488,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteVmGroupRequest" + $ref: '#/components/schemas/DeleteVmGroupRequest' examples: ex1: value: @@ -18413,7 +17498,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteVmGroupResponse" + $ref: '#/components/schemas/DeleteVmGroupResponse' examples: ex1: value: @@ -18424,23 +17509,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - VmGroup - "/DeleteVmTemplate": + /DeleteVmTemplate: post: description: |- > [WARNING]
@@ -18453,7 +17538,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteVmTemplateRequest" + $ref: '#/components/schemas/DeleteVmTemplateRequest' examples: ex1: value: @@ -18463,7 +17548,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteVmTemplateResponse" + $ref: '#/components/schemas/DeleteVmTemplateResponse' examples: ex1: value: @@ -18472,7 +17557,7 @@ paths: description: The HTTP 200 response (OK). tags: - VmTemplate - "/DeleteVms": + /DeleteVms: post: description: |- Terminates one or more virtual machines (VMs).
@@ -18482,7 +17567,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteVmsRequest" + $ref: '#/components/schemas/DeleteVmsRequest' examples: ex1: value: @@ -18493,7 +17578,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteVmsResponse" + $ref: '#/components/schemas/DeleteVmsResponse' examples: ex1: value: @@ -18508,23 +17593,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Vm - "/DeleteVolume": + /DeleteVolume: post: description: |- Deletes a specified Block Storage Unit (BSU) volume.
@@ -18534,7 +17619,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteVolumeRequest" + $ref: '#/components/schemas/DeleteVolumeRequest' examples: ex1: value: @@ -18544,7 +17629,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteVolumeResponse" + $ref: '#/components/schemas/DeleteVolumeResponse' examples: ex1: value: @@ -18555,23 +17640,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Volume - "/DeleteVpnConnection": + /DeleteVpnConnection: post: description: |- Deletes a specified VPN connection.
@@ -18581,7 +17666,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteVpnConnectionRequest" + $ref: '#/components/schemas/DeleteVpnConnectionRequest' examples: ex1: value: @@ -18591,7 +17676,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteVpnConnectionResponse" + $ref: '#/components/schemas/DeleteVpnConnectionResponse' examples: ex1: value: @@ -18600,16 +17685,15 @@ paths: description: The HTTP 200 response (OK). tags: - VpnConnection - "/DeleteVpnConnectionRoute": + /DeleteVpnConnectionRoute: post: - description: Deletes a static route to a VPN connection previously created using - the CreateVpnConnectionRoute method. + description: Deletes a static route to a VPN connection previously created using the CreateVpnConnectionRoute method. operationId: DeleteVpnConnectionRoute requestBody: content: application/json: schema: - "$ref": "#/components/schemas/DeleteVpnConnectionRouteRequest" + $ref: '#/components/schemas/DeleteVpnConnectionRouteRequest' examples: ex1: value: @@ -18620,7 +17704,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeleteVpnConnectionRouteResponse" + $ref: '#/components/schemas/DeleteVpnConnectionRouteResponse' examples: ex1: value: @@ -18629,7 +17713,7 @@ paths: description: The HTTP 200 response (OK). tags: - VpnConnection - "/DeregisterVmsInLoadBalancer": + /DeregisterVmsInLoadBalancer: post: description: |- > [WARNING]
@@ -18641,7 +17725,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeregisterVmsInLoadBalancerRequest" + $ref: '#/components/schemas/DeregisterVmsInLoadBalancerRequest' examples: ex1: value: @@ -18654,7 +17738,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DeregisterVmsInLoadBalancerResponse" + $ref: '#/components/schemas/DeregisterVmsInLoadBalancerResponse' examples: ex1: value: @@ -18663,19 +17747,15 @@ paths: description: The HTTP 200 response (OK). tags: - LoadBalancer - "/DisableOutscaleLogin": + /DisableOutscaleLogin: post: - description: |- - > [WARNING]
- > This feature is currently in beta.
- - Disables the possibility of logging in using the Outscale credentials of your root account when identity federation is activated. + description: Disables the possibility of logging in using the Outscale credentials of your root account when identity federation is activated. operationId: DisableOutscaleLogin requestBody: content: application/json: schema: - "$ref": "#/components/schemas/DisableOutscaleLoginRequest" + $ref: '#/components/schemas/DisableOutscaleLoginRequest' examples: ex1: value: {} @@ -18684,7 +17764,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DisableOutscaleLoginResponse" + $ref: '#/components/schemas/DisableOutscaleLoginResponse' examples: ex1: value: @@ -18693,19 +17773,15 @@ paths: description: The HTTP 200 response (OK). tags: - IdentityProvider - "/DisableOutscaleLoginForUsers": + /DisableOutscaleLoginForUsers: post: - description: |- - > [WARNING]
- > This feature is currently in beta.
- - Disables the possibility of logging in using the Outscale credentials of your EIM users when identity federation is activated. + description: Disables the possibility of logging in using the Outscale credentials of your EIM users when identity federation is activated. operationId: DisableOutscaleLoginForUsers requestBody: content: application/json: schema: - "$ref": "#/components/schemas/DisableOutscaleLoginRequest" + $ref: '#/components/schemas/DisableOutscaleLoginRequest' examples: ex1: value: {} @@ -18714,7 +17790,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DisableOutscaleLoginResponse" + $ref: '#/components/schemas/DisableOutscaleLoginResponse' examples: ex1: value: @@ -18723,19 +17799,15 @@ paths: description: The HTTP 200 response (OK). tags: - IdentityProvider - "/DisableOutscaleLoginPerUsers": + /DisableOutscaleLoginPerUsers: post: - description: |- - > [WARNING]
- > This feature is currently in beta.
- - Disables the possibility for one or more specific users to log in using their Outscale credentials when identity federation is activated. + description: Disables the possibility for one or more specific users to log in using their Outscale credentials when identity federation is activated. operationId: DisableOutscaleLoginPerUsers requestBody: content: application/json: schema: - "$ref": "#/components/schemas/DisableOutscaleLoginPerUsersRequest" + $ref: '#/components/schemas/DisableOutscaleLoginPerUsersRequest' examples: ex1: value: @@ -18747,7 +17819,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/DisableOutscaleLoginPerUsersResponse" + $ref: '#/components/schemas/DisableOutscaleLoginPerUsersResponse' examples: ex1: value: @@ -18756,19 +17828,15 @@ paths: description: The HTTP 200 response (OK). tags: - IdentityProvider - "/EnableOutscaleLogin": + /EnableOutscaleLogin: post: - description: |- - > [WARNING]
- > This feature is currently in beta.
- - Enables the possibility of logging in using the Outscale credentials of your root account when identity federation is activated. + description: Enables the possibility of logging in using the Outscale credentials of your root account when identity federation is activated. operationId: EnableOutscaleLogin requestBody: content: application/json: schema: - "$ref": "#/components/schemas/EnableOutscaleLoginRequest" + $ref: '#/components/schemas/EnableOutscaleLoginRequest' examples: ex1: value: {} @@ -18777,7 +17845,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/EnableOutscaleLoginResponse" + $ref: '#/components/schemas/EnableOutscaleLoginResponse' examples: ex1: value: @@ -18786,19 +17854,15 @@ paths: description: The HTTP 200 response (OK). tags: - IdentityProvider - "/EnableOutscaleLoginForUsers": + /EnableOutscaleLoginForUsers: post: - description: |- - > [WARNING]
- > This feature is currently in beta.
- - Enables the possibility for all your EIM users to log in using their Outscale credentials when identity federation is activated. + description: Enables the possibility for all your EIM users to log in using their Outscale credentials when identity federation is activated. operationId: EnableOutscaleLoginForUsers requestBody: content: application/json: schema: - "$ref": "#/components/schemas/EnableOutscaleLoginForUsersRequest" + $ref: '#/components/schemas/EnableOutscaleLoginForUsersRequest' examples: ex1: value: {} @@ -18807,7 +17871,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/EnableOutscaleLoginForUsersResponse" + $ref: '#/components/schemas/EnableOutscaleLoginForUsersResponse' examples: ex1: value: @@ -18816,19 +17880,15 @@ paths: description: The HTTP 200 response (OK). tags: - IdentityProvider - "/EnableOutscaleLoginPerUsers": + /EnableOutscaleLoginPerUsers: post: - description: |- - > [WARNING]
- > This feature is currently in beta.
- - Enables the possibility for one or more specific users to log in using their Outscale credentials when identity federation is activated. + description: Enables the possibility for one or more specific users to log in using their Outscale credentials when identity federation is activated. operationId: EnableOutscaleLoginPerUsers requestBody: content: application/json: schema: - "$ref": "#/components/schemas/EnableOutscaleLoginPerUsersRequest" + $ref: '#/components/schemas/EnableOutscaleLoginPerUsersRequest' examples: ex1: value: @@ -18840,7 +17900,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/EnableOutscaleLoginPerUsersResponse" + $ref: '#/components/schemas/EnableOutscaleLoginPerUsersResponse' examples: ex1: value: @@ -18849,7 +17909,7 @@ paths: description: The HTTP 200 response (OK). tags: - IdentityProvider - "/LinkFlexibleGpu": + /LinkFlexibleGpu: post: description: |- Attaches one of your allocated flexible GPUs (fGPUs) to one of your virtual machines (VMs).
@@ -18862,7 +17922,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/LinkFlexibleGpuRequest" + $ref: '#/components/schemas/LinkFlexibleGpuRequest' examples: ex1: value: @@ -18873,7 +17933,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/LinkFlexibleGpuResponse" + $ref: '#/components/schemas/LinkFlexibleGpuResponse' examples: ex1: value: @@ -18882,7 +17942,7 @@ paths: description: The HTTP 200 response (OK). tags: - FlexibleGpu - "/LinkInternetService": + /LinkInternetService: post: description: |- Attaches an internet service to a Net.
@@ -18892,7 +17952,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/LinkInternetServiceRequest" + $ref: '#/components/schemas/LinkInternetServiceRequest' examples: ex1: value: @@ -18903,7 +17963,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/LinkInternetServiceResponse" + $ref: '#/components/schemas/LinkInternetServiceResponse' examples: ex1: value: @@ -18914,23 +17974,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - InternetService - "/LinkLoadBalancerBackendMachines": + /LinkLoadBalancerBackendMachines: post: description: |- Attaches one or more virtual machines (VMs) to a specified load balancer. You need to specify at least the `BackendIps` or the `BackendVmIds` parameter.
@@ -18940,7 +18000,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/LinkLoadBalancerBackendMachinesRequest" + $ref: '#/components/schemas/LinkLoadBalancerBackendMachinesRequest' examples: ex1: summary: Linking VMs to a load balancer @@ -18961,7 +18021,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/LinkLoadBalancerBackendMachinesResponse" + $ref: '#/components/schemas/LinkLoadBalancerBackendMachinesResponse' examples: ex1: summary: Linking VMs to a load balancer @@ -18976,16 +18036,20 @@ paths: description: The HTTP 200 response (OK). tags: - LoadBalancer - "/LinkManagedPolicyToUserGroup": + /LinkManagedPolicyToUserGroup: post: - description: Links a managed policy to a specific group. This policy applies - to all the users contained in this group. + description: |- + Links a managed policy to a specific group. This policy applies to all the users contained in this group. +

+ + **[IMPORTANT]**
+ A delay of up to 15 seconds can occur when attaching, detaching, or updating a managed policy. operationId: LinkManagedPolicyToUserGroup requestBody: content: application/json: schema: - "$ref": "#/components/schemas/LinkManagedPolicyToUserGroupRequest" + $ref: '#/components/schemas/LinkManagedPolicyToUserGroupRequest' examples: ex1: value: @@ -18996,7 +18060,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/LinkManagedPolicyToUserGroupResponse" + $ref: '#/components/schemas/LinkManagedPolicyToUserGroupResponse' examples: ex1: value: @@ -19005,7 +18069,7 @@ paths: description: The HTTP 200 response (OK). tags: - Policy - "/LinkNic": + /LinkNic: post: description: |- Attaches a network interface card (NIC) to a virtual machine (VM).
@@ -19015,7 +18079,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/LinkNicRequest" + $ref: '#/components/schemas/LinkNicRequest' examples: ex1: value: @@ -19027,7 +18091,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/LinkNicResponse" + $ref: '#/components/schemas/LinkNicResponse' examples: ex1: value: @@ -19039,31 +18103,36 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Nic - "/LinkPolicy": + /LinkPolicy: post: - description: Links a managed policy to a specific user. + description: |- + Links a managed policy to a specific user. +

+ + **[IMPORTANT]**
+ A delay of up to 15 seconds can occur when attaching, detaching, or updating a managed policy. operationId: LinkPolicy requestBody: content: application/json: schema: - "$ref": "#/components/schemas/LinkPolicyRequest" + $ref: '#/components/schemas/LinkPolicyRequest' examples: ex1: value: @@ -19074,7 +18143,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/LinkPolicyResponse" + $ref: '#/components/schemas/LinkPolicyResponse' examples: ex1: value: @@ -19083,21 +18152,15 @@ paths: description: The HTTP 200 response (OK). tags: - Policy - "/LinkPrivateIps": + /LinkPrivateIps: post: - description: Assigns one or more secondary private IPs to a specified network - interface card (NIC). This action is only available in a Net. The private - IPs to be assigned can be added individually using the `PrivateIps` parameter, - or you can specify the number of private IPs to be automatically chosen within - the Subnet range using the `SecondaryPrivateIpCount` parameter. You can specify - only one of these two parameters. If none of these parameters are specified, - a private IP is chosen within the Subnet range. + description: Assigns one or more secondary private IPs to a specified network interface card (NIC). This action is only available in a Net. The private IPs to be assigned can be added individually using the `PrivateIps` parameter, or you can specify the number of private IPs to be automatically chosen within the Subnet range using the `SecondaryPrivateIpCount` parameter. You can specify only one of these two parameters. If none of these parameters are specified, a private IP is chosen within the Subnet range. operationId: LinkPrivateIps requestBody: content: application/json: schema: - "$ref": "#/components/schemas/LinkPrivateIpsRequest" + $ref: '#/components/schemas/LinkPrivateIpsRequest' examples: ex1: summary: Linking specific secondary private IPs to a NIC @@ -19116,7 +18179,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/LinkPrivateIpsResponse" + $ref: '#/components/schemas/LinkPrivateIpsResponse' examples: ex1: value: @@ -19127,23 +18190,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Nic - "/LinkPublicIp": + /LinkPublicIp: post: description: |- Associates a public IP with a virtual machine (VM) or a network interface card (NIC), in the public Cloud or in a Net. You can associate a public IP with only one VM or network interface at a time.
@@ -19157,7 +18220,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/LinkPublicIpRequest" + $ref: '#/components/schemas/LinkPublicIpRequest' examples: ex1: summary: Linking a public IP to a VM @@ -19174,7 +18237,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/LinkPublicIpResponse" + $ref: '#/components/schemas/LinkPublicIpResponse' examples: ex1: summary: Linking a public IP to a VM @@ -19193,23 +18256,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - PublicIp - "/LinkRouteTable": + /LinkRouteTable: post: description: |- Associates a Subnet with a route table.
@@ -19219,7 +18282,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/LinkRouteTableRequest" + $ref: '#/components/schemas/LinkRouteTableRequest' examples: ex1: value: @@ -19230,7 +18293,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/LinkRouteTableResponse" + $ref: '#/components/schemas/LinkRouteTableResponse' examples: ex1: value: @@ -19242,23 +18305,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - RouteTable - "/LinkVirtualGateway": + /LinkVirtualGateway: post: description: |- Attaches a virtual gateway to a Net. @@ -19270,7 +18333,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/LinkVirtualGatewayRequest" + $ref: '#/components/schemas/LinkVirtualGatewayRequest' examples: ex1: value: @@ -19281,7 +18344,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/LinkVirtualGatewayResponse" + $ref: '#/components/schemas/LinkVirtualGatewayResponse' examples: ex1: value: @@ -19293,7 +18356,7 @@ paths: description: The HTTP 200 response (OK). tags: - VirtualGateway - "/LinkVolume": + /LinkVolume: post: description: |- Attaches a Block Storage Unit (BSU) volume to a virtual machine (VM).
@@ -19303,19 +18366,19 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/LinkVolumeRequest" + $ref: '#/components/schemas/LinkVolumeRequest' examples: ex1: value: VolumeId: vol-12345678 VmId: i-12345678 - DeviceName: "/dev/sdb" + DeviceName: /dev/sdb responses: '200': content: application/json: schema: - "$ref": "#/components/schemas/LinkVolumeResponse" + $ref: '#/components/schemas/LinkVolumeResponse' examples: ex1: value: @@ -19326,47 +18389,50 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Volume - "/PutUserGroupPolicy": + /PutUserGroupPolicy: post: description: |- Creates or updates an inline policy included in a specified group.
The policy is automatically applied to all the users of the group after its creation. +

+ + **[IMPORTANT]**
+ A delay of up to 15 seconds can occur when creating or deleting an inline policy. operationId: PutUserGroupPolicy requestBody: content: application/json: schema: - "$ref": "#/components/schemas/PutUserGroupPolicyRequest" + $ref: '#/components/schemas/PutUserGroupPolicyRequest' examples: ex1: value: - PolicyDocument: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], - "Resource": ["*"]} ]}' + PolicyDocument: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' PolicyName: example-usergroup-policy UserGroupName: example-usergroup - UserGroupPath: "/example/" + UserGroupPath: /example/ responses: '200': content: application/json: schema: - "$ref": "#/components/schemas/PutUserGroupPolicyResponse" + $ref: '#/components/schemas/PutUserGroupPolicyResponse' examples: ex1: value: @@ -19375,22 +18441,25 @@ paths: description: The HTTP 200 response (OK). tags: - Policy - "/PutUserPolicy": + /PutUserPolicy: post: description: |- Creates or updates an inline policy included in a specified user.
The policy is automatically applied to the user after its creation. +

+ + **[IMPORTANT]**
+ A delay of up to 15 seconds can occur when creating or deleting an inline policy. operationId: PutUserPolicy requestBody: content: application/json: schema: - "$ref": "#/components/schemas/PutUserPolicyRequest" + $ref: '#/components/schemas/PutUserPolicyRequest' examples: ex1: value: - PolicyDocument: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], - "Resource": ["*"]} ]}' + PolicyDocument: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' PolicyName: example-user-policy UserName: example-user responses: @@ -19398,7 +18467,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/PutUserPolicyResponse" + $ref: '#/components/schemas/PutUserPolicyResponse' examples: ex1: value: @@ -19407,16 +18476,15 @@ paths: description: The HTTP 200 response (OK). tags: - Policy - "/ReadAccessKeys": + /ReadAccessKeys: post: - description: Lists the access key IDs of either your root account or an EIM - user. + description: Lists the access key IDs of either your root account or an EIM user. operationId: ReadAccessKeys requestBody: content: application/json: schema: - "$ref": "#/components/schemas/ReadAccessKeysRequest" + $ref: '#/components/schemas/ReadAccessKeysRequest' examples: ex1: value: @@ -19430,7 +18498,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadAccessKeysResponse" + $ref: '#/components/schemas/ReadAccessKeysResponse' examples: ex1: value: @@ -19439,9 +18507,9 @@ paths: AccessKeys: - State: ACTIVE AccessKeyId: ABCDEFGHIJ0123456789 - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 - ExpirationDate: 2063-04-05 00:00:00.000000000 +00:00 - LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 + CreationDate: 2010-10-01T12:34:56.789+0000 + ExpirationDate: 2063-04-05T00:00:00.000+0000 + LastModificationDate: 2010-10-01T12:34:56.789+0000 Tag: Group1 description: The HTTP 200 response (OK). security: @@ -19449,7 +18517,7 @@ paths: - BasicAuth: [] tags: - AccessKey - "/ReadAccounts": + /ReadAccounts: post: description: Gets information about the account that sent the request. operationId: ReadAccounts @@ -19457,7 +18525,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadAccountsRequest" + $ref: '#/components/schemas/ReadAccountsRequest' examples: ex1: value: {} @@ -19466,7 +18534,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadAccountsResponse" + $ref: '#/components/schemas/ReadAccountsResponse' examples: ex1: value: @@ -19485,7 +18553,7 @@ paths: description: The HTTP 200 response (OK). tags: - Account - "/ReadAdminPassword": + /ReadAdminPassword: post: description: |- Gets the administrator password for a Windows running virtual machine (VM).
@@ -19499,7 +18567,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadAdminPasswordRequest" + $ref: '#/components/schemas/ReadAdminPasswordRequest' examples: ex1: value: @@ -19509,36 +18577,36 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadAdminPasswordResponse" + $ref: '#/components/schemas/ReadAdminPasswordResponse' examples: ex1: value: VmId: i-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - AdminPassword: "..." + AdminPassword: ... description: The HTTP 200 response (OK). '400': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Vm - "/ReadApiAccessPolicy": + /ReadApiAccessPolicy: post: description: |- Gets information about the API access policy of your account.

@@ -19548,7 +18616,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadApiAccessPolicyRequest" + $ref: '#/components/schemas/ReadApiAccessPolicyRequest' examples: ex1: value: {} @@ -19557,7 +18625,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadApiAccessPolicyResponse" + $ref: '#/components/schemas/ReadApiAccessPolicyResponse' examples: ex1: value: @@ -19571,26 +18639,26 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). security: - ApiKeyAuthSec: [] - BasicAuth: [] tags: - ApiAccessPolicy - "/ReadApiAccessRules": + /ReadApiAccessRules: post: description: Lists one or more API access rules. operationId: ReadApiAccessRules @@ -19598,7 +18666,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadApiAccessRulesRequest" + $ref: '#/components/schemas/ReadApiAccessRulesRequest' examples: ex1: value: @@ -19610,7 +18678,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadApiAccessRulesResponse" + $ref: '#/components/schemas/ReadApiAccessRulesResponse' examples: ex1: value: @@ -19629,7 +18697,7 @@ paths: - BasicAuth: [] tags: - ApiAccessRule - "/ReadApiLogs": + /ReadApiLogs: post: description: |- Lists the logs of the API calls you have performed with this account. @@ -19643,7 +18711,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadApiLogsRequest" + $ref: '#/components/schemas/ReadApiLogsRequest' examples: ex1: value: @@ -19658,7 +18726,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadApiLogsResponse" + $ref: '#/components/schemas/ReadApiLogsResponse' examples: ex1: value: @@ -19667,7 +18735,7 @@ paths: Logs: - ResponseStatusCode: 200 ResponseSize: 1887 - QueryPayloadRaw: "{}" + QueryPayloadRaw: '{}' QueryApiName: oapi QueryIpAddress: 192.0.2.0 QueryUserAgent: oAPI CLI v0.1 - 2018-09-28 @@ -19680,24 +18748,61 @@ paths: QueryAccessKey: ABCDEFGHIJ0123456789 QueryHeaderSize: 287 QueryDate: '2017-05-10T12:34:56.789Z' - QueryHeaderRaw: 'Host: api.eu-west-2.outscale.com\nAccept: */*\nConnection: - close\nUser-Agent: oAPI CLI v0.1 - 2018-09-28\nX-Osc-Date: - 20170510T000000Z\nContent-Type: application/json; charset=utf-8\nAuthorization: - *****\nContent-Length: 2\nAccept-Encoding: gzip, deflate\nX-Forwarded-For: - 192.0.2.0' + QueryHeaderRaw: 'Host: api.eu-west-2.outscale.com\nAccept: */*\nConnection: close\nUser-Agent: oAPI CLI v0.1 - 2018-09-28\nX-Osc-Date: 20170510T000000Z\nContent-Type: application/json; charset=utf-8\nAuthorization: *****\nContent-Length: 2\nAccept-Encoding: gzip, deflate\nX-Forwarded-For: 192.0.2.0' description: The HTTP 200 response (OK). tags: - ApiLog - "/ReadCas": + /ReadCO2EmissionAccount: + post: + description: Gets information about the estimated carbon footprint of your account for the current Region within the specified time period. + operationId: ReadCO2EmissionAccount + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ReadCO2EmissionAccountRequest' + examples: + ex1: + value: + FromMonth: '2025-05-01' + ToMonth: '2025-06-01' + Overall: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ReadCO2EmissionAccountResponse' + examples: + ex1: + value: + Unit: KG + Value: 2.469 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + CO2EmissionEntries: + - Value: 2.469 + AccountId: '123456789012' + CategoryDistribution: + - Value: 1.2345 + Category: compute + Month: '2025-05-01' + PayingAccountId: '123456789012' + FactorDistribution: + - Value: 1.2345 + Factor: electricity + description: The HTTP 200 response (OK). + tags: + - Account + /ReadCas: post: - description: Gets information about one or more of your Client Certificate Authorities - (CAs). + description: Gets information about one or more of your Client Certificate Authorities (CAs). operationId: ReadCas requestBody: content: application/json: schema: - "$ref": "#/components/schemas/ReadCasRequest" + $ref: '#/components/schemas/ReadCasRequest' examples: ex1: value: @@ -19709,7 +18814,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadCasResponse" + $ref: '#/components/schemas/ReadCasResponse' examples: ex1: value: @@ -19725,7 +18830,7 @@ paths: - BasicAuth: [] tags: - Ca - "/ReadCatalog": + /ReadCatalog: post: description: Returns the price list of OUTSCALE services for the current Region. operationId: ReadCatalog @@ -19733,7 +18838,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadCatalogRequest" + $ref: '#/components/schemas/ReadCatalogRequest' examples: ex1: value: {} @@ -19742,7 +18847,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadCatalogResponse" + $ref: '#/components/schemas/ReadCatalogResponse' examples: ex1: value: @@ -19752,8 +18857,7 @@ paths: Entries: - UnitPrice: 0.04 Type: CustomCore:v5-p1 - Title: Instance - On demand - Unite de vCore pour une instance - Tina v5 CxRy Performance highest - par heure + Title: Instance - On demand - Unite de vCore pour une instance Tina v5 CxRy Performance highest - par heure SubregionName: eu-west-2 Category: compute Service: TinaOS-FCU @@ -19761,16 +18865,15 @@ paths: description: The HTTP 200 response (OK). tags: - Catalog - "/ReadCatalogs": + /ReadCatalogs: post: - description: Returns the price list of OUTSCALE services for the current Region - within a specific time period. + description: Returns the price list of OUTSCALE services for the current Region within a specific time period. operationId: ReadCatalogs requestBody: content: application/json: schema: - "$ref": "#/components/schemas/ReadCatalogsRequest" + $ref: '#/components/schemas/ReadCatalogsRequest' examples: ex1: value: @@ -19783,7 +18886,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadCatalogsResponse" + $ref: '#/components/schemas/ReadCatalogsResponse' examples: ex1: value: @@ -19791,12 +18894,11 @@ paths: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Catalogs: - State: CURRENT - FromDate: 2021-01-01 00:00:00.000000000 +00:00 + FromDate: 2021-01-01T00:00:00.000+0000 Entries: - UnitPrice: 0.04 Type: CustomCore:v5-p1 - Title: Instance - On demand - Unite de vCore pour une instance - Tina v5 CxRy Performance highest - par heure + Title: Instance - On demand - Unite de vCore pour une instance Tina v5 CxRy Performance highest - par heure SubregionName: eu-west-2 Category: compute Service: TinaOS-FCU @@ -19804,7 +18906,7 @@ paths: description: The HTTP 200 response (OK). tags: - Catalog - "/ReadClientGateways": + /ReadClientGateways: post: description: Lists one or more of your client gateways. operationId: ReadClientGateways @@ -19812,7 +18914,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadClientGatewaysRequest" + $ref: '#/components/schemas/ReadClientGatewaysRequest' examples: ex1: value: @@ -19832,7 +18934,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadClientGatewaysResponse" + $ref: '#/components/schemas/ReadClientGatewaysResponse' examples: ex1: value: @@ -19848,7 +18950,7 @@ paths: description: The HTTP 200 response (OK). tags: - ClientGateway - "/ReadConsoleOutput": + /ReadConsoleOutput: post: description: |- Gets the console output for a virtual machine (VM). This console is not in real-time. It is refreshed every two seconds and provides the most recent 64 KiB output.

@@ -19860,7 +18962,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadConsoleOutputRequest" + $ref: '#/components/schemas/ReadConsoleOutputRequest' examples: ex1: value: @@ -19870,92 +18972,130 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadConsoleOutputResponse" + $ref: '#/components/schemas/ReadConsoleOutputResponse' examples: ex1: value: VmId: i-12345678 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 - ConsoleOutput: "..." + ConsoleOutput: ... description: The HTTP 200 response (OK). '400': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Vm - "/ReadConsumptionAccount": + /ReadConsumptionAccount: post: - description: Gets information about the consumption of your account for each - billable resource within the specified time period. + description: Gets information about the consumption of your account for each billable resource within the specified time period. operationId: ReadConsumptionAccount requestBody: content: application/json: schema: - "$ref": "#/components/schemas/ReadConsumptionAccountRequest" + $ref: '#/components/schemas/ReadConsumptionAccountRequest' examples: ex1: + value: + FromDate: '2023-06-01' + ToDate: '2023-07-01' + ShowPrice: false + ShowResourceDetails: false + ex2: value: FromDate: '2023-06-01' ToDate: '2023-07-01' ShowPrice: true + ShowResourceDetails: true responses: '200': content: application/json: schema: - "$ref": "#/components/schemas/ReadConsumptionAccountResponse" + $ref: '#/components/schemas/ReadConsumptionAccountResponse' examples: ex1: + summary: ReadConsumptionAccount with ShowPrice and ShowResourceDetails at false value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ConsumptionEntries: - UnitPrice: 0.18 Type: BoxUsage:tinav5.c4r8p2 - - FromDate: 2023-06-01 00:00:00.000000000 +00:00 + - FromDate: 2023-06-01T00:00:00.000+0000 + SubregionName: eu-west-2a + Value: 1488 + Title: Instance - On demand - tinav5.c4r8 high performance - par heure + Category: compute + ToDate: 2023-06-30T00:00:00.000+0000 + Service: TinaOS-FCU + AccountId: '123456789012' + PayingAccountId: '123456789012' + Operation: RunInstances-OD + Type: BoxUsage:tinav5.c4r8p2 + ex2: + summary: ReadConsumptionAccount with ShowPrice and ShowResourceDetails at true + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Currency: EUR + ConsumptionEntries: + - FromDate: 2023-06-01T00:00:00.000+0000 SubregionName: eu-west-2a Value: 720 - Title: Instance - On demand - tinav4.c2r4 high performance - - par heure + Title: Instance - On demand - tinav5.c4r8 high performance - par heure Category: compute - ToDate: 2023-06-30 00:00:00.000000000 +00:00 + ToDate: 2023-06-30T00:00:00.000+0000 Service: TinaOS-FCU AccountId: '123456789012' PayingAccountId: '123456789012' Operation: RunInstances-OD + Type: BoxUsage:tinav5.c4r8p2 + UnitPrice: 0.18 + Price: 267.84 + ResourceId: i-12345678 + - FromDate: 2023-06-01T00:00:00.000+0000 + SubregionName: eu-west-2a + Value: 1488 + Title: Instance - On demand - tinav5.c4r8p2 high performance - par heure + Category: compute + ToDate: 2023-06-30T00:00:00.000+0000 + Service: TinaOS-FCU + AccountId: '123456789012' + PayingAccountId: '123456789012' + Operation: RunInstances-OD + Type: BoxUsage:tinav5.c4r8p2 + UnitPrice: 0.18 + Price: 267.84 + ResourceId: i-87654321 description: The HTTP 200 response (OK). tags: - Account - "/ReadDedicatedGroups": + /ReadDedicatedGroups: post: - description: |- - > [WARNING]
- > This feature is currently in beta.
- - List one or more dedicated groups of virtual machines (VMs). + description: List one or more dedicated groups of virtual machines (VMs). operationId: ReadDedicatedGroups requestBody: content: application/json: schema: - "$ref": "#/components/schemas/ReadDedicatedGroupsRequest" + $ref: '#/components/schemas/ReadDedicatedGroupsRequest' examples: ex1: summary: Filtering on a specific dedicated group @@ -19976,7 +19116,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadDedicatedGroupsResponse" + $ref: '#/components/schemas/ReadDedicatedGroupsResponse' examples: ex1: value: @@ -19996,32 +19136,31 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - DedicatedGroup - "/ReadDhcpOptions": + /ReadDhcpOptions: post: - description: Gets information about the content of one or more DHCP options - sets. + description: Gets information about the content of one or more DHCP options sets. operationId: ReadDhcpOptions requestBody: content: application/json: schema: - "$ref": "#/components/schemas/ReadDhcpOptionsRequest" + $ref: '#/components/schemas/ReadDhcpOptionsRequest' examples: ex1: value: @@ -20041,7 +19180,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadDhcpOptionsResponse" + $ref: '#/components/schemas/ReadDhcpOptionsResponse' examples: ex1: value: @@ -20061,7 +19200,7 @@ paths: description: The HTTP 200 response (OK). tags: - DhcpOption - "/ReadDirectLinkInterfaces": + /ReadDirectLinkInterfaces: post: description: Lists one or more of your DirectLink interfaces. operationId: ReadDirectLinkInterfaces @@ -20069,7 +19208,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadDirectLinkInterfacesRequest" + $ref: '#/components/schemas/ReadDirectLinkInterfacesRequest' examples: ex1: value: @@ -20081,7 +19220,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadDirectLinkInterfacesResponse" + $ref: '#/components/schemas/ReadDirectLinkInterfacesResponse' examples: ex1: value: @@ -20104,7 +19243,7 @@ paths: description: The HTTP 200 response (OK). tags: - DirectLinkInterface - "/ReadDirectLinks": + /ReadDirectLinks: post: description: Lists all DirectLinks in the Region. operationId: ReadDirectLinks @@ -20112,7 +19251,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadDirectLinksRequest" + $ref: '#/components/schemas/ReadDirectLinksRequest' examples: ex1: value: @@ -20124,7 +19263,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadDirectLinksResponse" + $ref: '#/components/schemas/ReadDirectLinksResponse' examples: ex1: value: @@ -20141,16 +19280,15 @@ paths: description: The HTTP 200 response (OK). tags: - DirectLink - "/ReadEntitiesLinkedToPolicy": + /ReadEntitiesLinkedToPolicy: post: - description: Lists all entities (account, users, or user groups) linked to a - specific managed policy. + description: Lists all entities (account, users, or user groups) linked to a specific managed policy. operationId: ReadEntitiesLinkedToPolicy requestBody: content: application/json: schema: - "$ref": "#/components/schemas/ReadEntitiesLinkedToPolicyRequest" + $ref: '#/components/schemas/ReadEntitiesLinkedToPolicyRequest' examples: ex1: summary: Reading all entities linked to a specific policy @@ -20168,7 +19306,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadEntitiesLinkedToPolicyResponse" + $ref: '#/components/schemas/ReadEntitiesLinkedToPolicyResponse' examples: ex1: summary: Reading all entities linked to a specific policy @@ -20201,7 +19339,7 @@ paths: description: The HTTP 200 response (OK). tags: - Policy - "/ReadFlexibleGpuCatalog": + /ReadFlexibleGpuCatalog: post: description: Lists all flexible GPUs available in the public catalog. operationId: ReadFlexibleGpuCatalog @@ -20209,7 +19347,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadFlexibleGpuCatalogRequest" + $ref: '#/components/schemas/ReadFlexibleGpuCatalogRequest' examples: ex1: value: {} @@ -20218,7 +19356,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadFlexibleGpuCatalogResponse" + $ref: '#/components/schemas/ReadFlexibleGpuCatalogResponse' examples: ex1: value: @@ -20235,7 +19373,7 @@ paths: security: [] tags: - FlexibleGpu - "/ReadFlexibleGpus": + /ReadFlexibleGpus: post: description: Lists one or more flexible GPUs (fGPUs) allocated to your account. operationId: ReadFlexibleGpus @@ -20243,7 +19381,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadFlexibleGpusRequest" + $ref: '#/components/schemas/ReadFlexibleGpusRequest' examples: ex1: value: @@ -20263,7 +19401,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadFlexibleGpusResponse" + $ref: '#/components/schemas/ReadFlexibleGpusResponse' examples: ex1: value: @@ -20281,7 +19419,7 @@ paths: description: The HTTP 200 response (OK). tags: - FlexibleGpu - "/ReadImageExportTasks": + /ReadImageExportTasks: post: description: Lists one or more image export tasks. operationId: ReadImageExportTasks @@ -20289,7 +19427,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadImageExportTasksRequest" + $ref: '#/components/schemas/ReadImageExportTasksRequest' examples: ex1: value: @@ -20301,7 +19439,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadImageExportTasksResponse" + $ref: '#/components/schemas/ReadImageExportTasksResponse' examples: ex1: value: @@ -20321,7 +19459,7 @@ paths: description: The HTTP 200 response (OK). tags: - Image - "/ReadImages": + /ReadImages: post: description: Lists one or more OUTSCALE machine images (OMIs) you can use. operationId: ReadImages @@ -20329,7 +19467,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadImagesRequest" + $ref: '#/components/schemas/ReadImagesRequest' examples: ex1: summary: Reading a specific image @@ -20351,7 +19489,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadImagesResponse" + $ref: '#/components/schemas/ReadImagesResponse' examples: ex1: summary: Reading a specific image @@ -20363,7 +19501,7 @@ paths: StateComment: {} State: available RootDeviceType: bsu - RootDeviceName: "/dev/sda1" + RootDeviceName: /dev/sda1 ProductCodes: - '0001' PermissionsToLaunch: @@ -20374,7 +19512,7 @@ paths: Description: '' ImageId: ami-12345678 BlockDeviceMappings: - - DeviceName: "/dev/sda1" + - DeviceName: /dev/sda1 Bsu: VolumeType: standard DeleteOnVmDeletion: true @@ -20398,7 +19536,7 @@ paths: StateComment: {} State: available RootDeviceType: bsu - RootDeviceName: "/dev/sda1" + RootDeviceName: /dev/sda1 ProductCodes: - '0001' PermissionsToLaunch: @@ -20409,7 +19547,7 @@ paths: Description: '' ImageId: ami-12345678 BlockDeviceMappings: - - DeviceName: "/dev/sda1" + - DeviceName: /dev/sda1 Bsu: VolumeType: standard DeleteOnVmDeletion: true @@ -20425,7 +19563,7 @@ paths: StateComment: {} State: available RootDeviceType: bsu - RootDeviceName: "/dev/sda1" + RootDeviceName: /dev/sda1 ProductCodes: - '0001' PermissionsToLaunch: @@ -20436,7 +19574,7 @@ paths: Description: '' ImageId: ami-12345678 BlockDeviceMappings: - - DeviceName: "/dev/sda1" + - DeviceName: /dev/sda1 Bsu: VolumeType: standard DeleteOnVmDeletion: true @@ -20456,33 +19594,33 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Image - "/ReadInternetServices": + /ReadInternetServices: post: description: |- Lists one or more of your internet services.
- An internet service enables virtual machines (VMs) launched in a Net to connect to the Internet. It allows routing of incoming and outgoing Internet traffic and management of public IP addresses. + An internet service enables virtual machines (VMs) launched in a Net to connect to the Internet. It allows the routing of incoming and outgoing Internet traffic and management of public IPs. operationId: ReadInternetServices requestBody: content: application/json: schema: - "$ref": "#/components/schemas/ReadInternetServicesRequest" + $ref: '#/components/schemas/ReadInternetServicesRequest' examples: ex1: value: @@ -20502,7 +19640,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadInternetServicesResponse" + $ref: '#/components/schemas/ReadInternetServicesResponse' examples: ex1: value: @@ -20520,23 +19658,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - InternetService - "/ReadKeypairs": + /ReadKeypairs: post: description: Lists one or more of your keypairs. operationId: ReadKeypairs @@ -20544,7 +19682,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadKeypairsRequest" + $ref: '#/components/schemas/ReadKeypairsRequest' examples: ex1: value: @@ -20556,7 +19694,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadKeypairsResponse" + $ref: '#/components/schemas/ReadKeypairsResponse' examples: ex1: value: @@ -20572,23 +19710,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Keypair - "/ReadLinkedPolicies": + /ReadLinkedPolicies: post: description: Lists the managed policies linked to a specified user. operationId: ReadLinkedPolicies @@ -20596,12 +19734,12 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadLinkedPoliciesRequest" + $ref: '#/components/schemas/ReadLinkedPoliciesRequest' examples: ex1: value: Filters: - PathPrefix: "/example/" + PathPrefix: /example/ FirstItem: 1 ResultsPerPage: 30 UserName: example-user @@ -20610,7 +19748,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadLinkedPoliciesResponse" + $ref: '#/components/schemas/ReadLinkedPoliciesResponse' examples: ex1: value: @@ -20619,8 +19757,8 @@ paths: HasMoreItems: true Policies: - PolicyName: example-user-policy - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 - LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 + CreationDate: 2010-10-01T12:34:56.789+0000 + LastModificationDate: 2010-10-01T12:34:56.789+0000 Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 MaxResultsLimit: 30 @@ -20628,16 +19766,15 @@ paths: description: The HTTP 200 response (OK). tags: - Policy - "/ReadListenerRules": + /ReadListenerRules: post: - description: Lists one or more listener rules. By default, this action returns - the full list of listener rules for the account. + description: Lists one or more listener rules. By default, this action returns the full list of listener rules for the account. operationId: ReadListenerRules requestBody: content: application/json: schema: - "$ref": "#/components/schemas/ReadListenerRulesRequest" + $ref: '#/components/schemas/ReadListenerRulesRequest' examples: ex1: value: @@ -20649,7 +19786,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadListenerRulesResponse" + $ref: '#/components/schemas/ReadListenerRulesResponse' examples: ex1: value: @@ -20662,12 +19799,12 @@ paths: ListenerRuleName: example-listener-rule Action: forward ListenerId: 123456 - HostNamePattern: "*.example.com" + HostNamePattern: '*.example.com' ListenerRuleId: 1234 description: The HTTP 200 response (OK). tags: - Listener - "/ReadLoadBalancerTags": + /ReadLoadBalancerTags: post: description: Lists the tags associated with one or more specified load balancers. operationId: ReadLoadBalancerTags @@ -20675,7 +19812,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadLoadBalancerTagsRequest" + $ref: '#/components/schemas/ReadLoadBalancerTagsRequest' examples: ex1: value: @@ -20686,7 +19823,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadLoadBalancerTagsResponse" + $ref: '#/components/schemas/ReadLoadBalancerTagsResponse' examples: ex1: value: @@ -20699,7 +19836,7 @@ paths: description: The HTTP 200 response (OK). tags: - LoadBalancer - "/ReadLoadBalancers": + /ReadLoadBalancers: post: description: Lists one or more load balancers and their attributes. operationId: ReadLoadBalancers @@ -20707,7 +19844,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadLoadBalancersRequest" + $ref: '#/components/schemas/ReadLoadBalancersRequest' examples: ex1: value: @@ -20719,7 +19856,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadLoadBalancersResponse" + $ref: '#/components/schemas/ReadLoadBalancersResponse' examples: ex1: value: @@ -20764,7 +19901,7 @@ paths: description: The HTTP 200 response (OK). tags: - LoadBalancer - "/ReadLocations": + /ReadLocations: post: description: |- Lists the locations, corresponding to datacenters, where you can set up a DirectLink.

@@ -20774,7 +19911,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadLocationsRequest" + $ref: '#/components/schemas/ReadLocationsRequest' examples: ex1: value: {} @@ -20783,7 +19920,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadLocationsResponse" + $ref: '#/components/schemas/ReadLocationsResponse' examples: ex1: value: @@ -20798,7 +19935,7 @@ paths: security: [] tags: - Location - "/ReadManagedPoliciesLinkedToUserGroup": + /ReadManagedPoliciesLinkedToUserGroup: post: description: Lists the managed policies linked to a specified group. operationId: ReadManagedPoliciesLinkedToUserGroup @@ -20806,12 +19943,12 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadManagedPoliciesLinkedToUserGroupRequest" + $ref: '#/components/schemas/ReadManagedPoliciesLinkedToUserGroupRequest' examples: ex1: value: Filters: - PathPrefix: "/ex" + PathPrefix: /ex UserGroupIds: - ug-12345678 FirstItem: 1 @@ -20822,7 +19959,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadManagedPoliciesLinkedToUserGroupResponse" + $ref: '#/components/schemas/ReadManagedPoliciesLinkedToUserGroupResponse' examples: ex1: value: @@ -20840,7 +19977,7 @@ paths: description: The HTTP 200 response (OK). tags: - Policy - "/ReadNatServices": + /ReadNatServices: post: description: Lists one or more network address translation (NAT) services. operationId: ReadNatServices @@ -20848,7 +19985,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadNatServicesRequest" + $ref: '#/components/schemas/ReadNatServicesRequest' examples: ex1: value: @@ -20868,7 +20005,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadNatServicesResponse" + $ref: '#/components/schemas/ReadNatServicesResponse' examples: ex1: value: @@ -20888,23 +20025,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - NatService - "/ReadNetAccessPointServices": + /ReadNetAccessPointServices: post: description: |- Lists OUTSCALE services available to create Net access points.
@@ -20914,7 +20051,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadNetAccessPointServicesRequest" + $ref: '#/components/schemas/ReadNetAccessPointServicesRequest' examples: ex1: summary: Listing one or more services according to their service IDs @@ -20934,11 +20071,10 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadNetAccessPointServicesResponse" + $ref: '#/components/schemas/ReadNetAccessPointServicesResponse' examples: ex1: - summary: Listing one or more services according to their service - IDs + summary: Listing one or more services according to their service IDs value: Services: - ServiceName: com.outscale.eu-west-2.api @@ -20954,8 +20090,7 @@ paths: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex2: - summary: Listing one or more services according to their service - names + summary: Listing one or more services according to their service names value: Services: - ServiceName: com.outscale.eu-west-2.api @@ -20968,7 +20103,7 @@ paths: security: [] tags: - NetAccessPoint - "/ReadNetAccessPoints": + /ReadNetAccessPoints: post: description: Lists one or more Net access points. operationId: ReadNetAccessPoints @@ -20976,7 +20111,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadNetAccessPointsRequest" + $ref: '#/components/schemas/ReadNetAccessPointsRequest' examples: ex1: value: @@ -20995,7 +20130,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadNetAccessPointsResponse" + $ref: '#/components/schemas/ReadNetAccessPointsResponse' examples: ex1: value: @@ -21012,7 +20147,7 @@ paths: description: The HTTP 200 response (OK). tags: - NetAccessPoint - "/ReadNetPeerings": + /ReadNetPeerings: post: description: Lists one or more peering connections between two Nets. operationId: ReadNetPeerings @@ -21020,7 +20155,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadNetPeeringsRequest" + $ref: '#/components/schemas/ReadNetPeeringsRequest' examples: ex1: value: @@ -21040,7 +20175,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadNetPeeringsResponse" + $ref: '#/components/schemas/ReadNetPeeringsResponse' examples: ex1: value: @@ -21065,23 +20200,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - NetPeering - "/ReadNets": + /ReadNets: post: description: Lists one or more Nets. operationId: ReadNets @@ -21089,7 +20224,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadNetsRequest" + $ref: '#/components/schemas/ReadNetsRequest' examples: ex1: value: @@ -21106,7 +20241,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadNetsResponse" + $ref: '#/components/schemas/ReadNetsResponse' examples: ex1: value: @@ -21124,23 +20259,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Net - "/ReadNics": + /ReadNics: post: description: |- Lists one or more network interface cards (NICs).
@@ -21150,7 +20285,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadNicsRequest" + $ref: '#/components/schemas/ReadNicsRequest' examples: ex1: value: @@ -21167,7 +20302,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadNicsResponse" + $ref: '#/components/schemas/ReadNicsResponse' examples: ex1: value: @@ -21204,23 +20339,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Nic - "/ReadPolicies": + /ReadPolicies: post: description: Lists all the managed policies available for your account. operationId: ReadPolicies @@ -21228,13 +20363,13 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadPoliciesRequest" + $ref: '#/components/schemas/ReadPoliciesRequest' examples: ex1: value: Filters: OnlyLinked: true - PathPrefix: "/" + PathPrefix: / Scope: OWS FirstItem: 1 ResultsPerPage: 30 @@ -21243,7 +20378,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadPoliciesResponse" + $ref: '#/components/schemas/ReadPoliciesResponse' examples: ex1: value: @@ -21254,19 +20389,19 @@ paths: - ResourcesCount: 1 PolicyName: example-user-policy PolicyDefaultVersionId: v1 - Path: "/example/" - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + Path: /example/ + CreationDate: 2010-10-01T12:34:56.789+0000 Description: Example of description PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy IsLinkable: true - LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 + LastModificationDate: 2010-10-01T12:34:56.789+0000 MaxResultsLimit: 30 MaxResultsTruncated: false description: The HTTP 200 response (OK). tags: - Policy - "/ReadPolicy": + /ReadPolicy: post: description: Lists information about a specified managed policy. operationId: ReadPolicy @@ -21274,7 +20409,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadPolicyRequest" + $ref: '#/components/schemas/ReadPolicyRequest' examples: ex1: value: @@ -21284,7 +20419,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadPolicyResponse" + $ref: '#/components/schemas/ReadPolicyResponse' examples: ex1: value: @@ -21292,19 +20427,19 @@ paths: ResourcesCount: 0 PolicyName: example-user-policy PolicyDefaultVersionId: v1 - Path: "/example/" - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + Path: /example/ + CreationDate: 2010-10-01T12:34:56.789+0000 Description: Example of description PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234 Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy IsLinkable: true - LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 + LastModificationDate: 2010-10-01T12:34:56.789+0000 ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - Policy - "/ReadPolicyVersion": + /ReadPolicyVersion: post: description: Lists information about a specified version of a managed policy. operationId: ReadPolicyVersion @@ -21312,7 +20447,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadPolicyVersionRequest" + $ref: '#/components/schemas/ReadPolicyVersionRequest' examples: ex1: value: @@ -21323,7 +20458,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadPolicyVersionResponse" + $ref: '#/components/schemas/ReadPolicyVersionResponse' examples: ex1: value: @@ -21332,22 +20467,20 @@ paths: PolicyVersion: VersionId: v1 DefaultVersion: true - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 - Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], - "Resource": ["*"]} ]}' + CreationDate: 2010-10-01T12:34:56.789+0000 + Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' description: The HTTP 200 response (OK). tags: - Policy - "/ReadPolicyVersions": + /ReadPolicyVersions: post: - description: Lists information about all the policy versions of a specified - managed policy. + description: Lists information about all the policy versions of a specified managed policy. operationId: ReadPolicyVersions requestBody: content: application/json: schema: - "$ref": "#/components/schemas/ReadPolicyVersionsRequest" + $ref: '#/components/schemas/ReadPolicyVersionsRequest' examples: ex1: value: @@ -21359,7 +20492,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadPolicyVersionsResponse" + $ref: '#/components/schemas/ReadPolicyVersionsResponse' examples: ex1: value: @@ -21369,14 +20502,13 @@ paths: PolicyVersions: - VersionId: v1 DefaultVersion: true - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 - Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], - "Resource": ["*"]} ]}' + CreationDate: 2010-10-01T12:34:56.789+0000 + Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' HasMoreItems: true description: The HTTP 200 response (OK). tags: - Policy - "/ReadProductTypes": + /ReadProductTypes: post: description: Lists one or more product types. operationId: ReadProductTypes @@ -21384,7 +20516,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadProductTypesRequest" + $ref: '#/components/schemas/ReadProductTypesRequest' examples: ex1: value: @@ -21396,7 +20528,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadProductTypesResponse" + $ref: '#/components/schemas/ReadProductTypesResponse' examples: ex1: value: @@ -21409,17 +20541,15 @@ paths: security: [] tags: - ProductType - "/ReadPublicCatalog": + /ReadPublicCatalog: post: - description: Returns the price list of OUTSCALE products and services for the - Region specified in the endpoint of the request. For more information, see - [About Regions and Subregions](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html). + description: Returns the price list of OUTSCALE products and services for the Region specified in the endpoint of the request. For more information, see [About Regions and Subregions](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html). operationId: ReadPublicCatalog requestBody: content: application/json: schema: - "$ref": "#/components/schemas/ReadPublicCatalogRequest" + $ref: '#/components/schemas/ReadPublicCatalogRequest' examples: ex1: value: {} @@ -21428,7 +20558,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadPublicCatalogResponse" + $ref: '#/components/schemas/ReadPublicCatalogResponse' examples: ex1: value: @@ -21438,8 +20568,7 @@ paths: Entries: - UnitPrice: 0.04 Type: CustomCore:v5-p1 - Title: Instance - On demand - Unite de vCore pour une instance - Tina v5 CxRy Performance highest - par heure + Title: Instance - On demand - Unite de vCore pour une instance Tina v5 CxRy Performance highest - par heure SubregionName: eu-west-2 Category: compute Service: TinaOS-FCU @@ -21448,17 +20577,15 @@ paths: security: [] tags: - PublicCatalog - "/ReadPublicIpRanges": + /ReadPublicIpRanges: post: - description: Gets the public IPv4 addresses in CIDR notation for the Region - specified in the endpoint of the request. For more information, see [About - Regions and Subregions](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html). + description: Gets the public IPv4 addresses in CIDR notation for the Region specified in the endpoint of the request. For more information, see [About Regions and Subregions](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html). operationId: ReadPublicIpRanges requestBody: content: application/json: schema: - "$ref": "#/components/schemas/ReadPublicIpRangesRequest" + $ref: '#/components/schemas/ReadPublicIpRangesRequest' examples: ex1: value: {} @@ -21467,7 +20594,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadPublicIpRangesResponse" + $ref: '#/components/schemas/ReadPublicIpRangesResponse' examples: ex1: value: @@ -21480,7 +20607,7 @@ paths: security: [] tags: - PublicIp - "/ReadPublicIps": + /ReadPublicIps: post: description: |- Lists one or more public IPs allocated to your account.
@@ -21490,7 +20617,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadPublicIpsRequest" + $ref: '#/components/schemas/ReadPublicIpsRequest' examples: ex1: value: @@ -21507,7 +20634,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadPublicIpsResponse" + $ref: '#/components/schemas/ReadPublicIpsResponse' examples: ex1: value: @@ -21527,23 +20654,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - PublicIp - "/ReadQuotas": + /ReadQuotas: post: description: |- Lists one or more of your quotas.

@@ -21553,7 +20680,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadQuotasRequest" + $ref: '#/components/schemas/ReadQuotasRequest' examples: ex1: summary: Reading specific quota @@ -21572,7 +20699,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadQuotasResponse" + $ref: '#/components/schemas/ReadQuotasResponse' examples: ex1: summary: Reading specific quota @@ -21616,7 +20743,7 @@ paths: description: The HTTP 200 response (OK). tags: - Quota - "/ReadRegions": + /ReadRegions: post: description: |- Lists one or more Regions of the OUTSCALE Cloud.

@@ -21626,7 +20753,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadRegionsRequest" + $ref: '#/components/schemas/ReadRegionsRequest' examples: ex1: value: {} @@ -21635,7 +20762,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadRegionsResponse" + $ref: '#/components/schemas/ReadRegionsResponse' examples: ex1: value: @@ -21652,7 +20779,7 @@ paths: security: [] tags: - Region - "/ReadRouteTables": + /ReadRouteTables: post: description: |- Lists one or more of your route tables.
@@ -21662,7 +20789,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadRouteTablesRequest" + $ref: '#/components/schemas/ReadRouteTablesRequest' examples: ex1: value: @@ -21681,7 +20808,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadRouteTablesResponse" + $ref: '#/components/schemas/ReadRouteTablesResponse' examples: ex1: value: @@ -21706,23 +20833,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - RouteTable - "/ReadSecurityGroups": + /ReadSecurityGroups: post: description: |- Lists one or more security groups.
@@ -21732,7 +20859,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadSecurityGroupsRequest" + $ref: '#/components/schemas/ReadSecurityGroupsRequest' examples: ex1: value: @@ -21749,7 +20876,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadSecurityGroupsResponse" + $ref: '#/components/schemas/ReadSecurityGroupsResponse' examples: ex1: value: @@ -21758,7 +20885,7 @@ paths: SecurityGroupName: security-group-example OutboundRules: - FromPortRange: -1 - IpProtocol: "-1" + IpProtocol: '-1' ToPortRange: -1 IpRanges: - 0.0.0.0/0 @@ -21780,23 +20907,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - SecurityGroup - "/ReadServerCertificates": + /ReadServerCertificates: post: description: Lists your server certificates. operationId: ReadServerCertificates @@ -21804,24 +20931,24 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadServerCertificatesRequest" + $ref: '#/components/schemas/ReadServerCertificatesRequest' examples: ex1: value: Filters: Paths: - - "/example/" + - /example/ responses: '200': content: application/json: schema: - "$ref": "#/components/schemas/ReadServerCertificatesResponse" + $ref: '#/components/schemas/ReadServerCertificatesResponse' examples: ex1: value: ServerCertificates: - - Path: "/example/" + - Path: /example/ Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ1234 Orn: orn:ows:idauth::012345678910:server-certificate/example/server-cert-example Name: server-cert-example @@ -21830,7 +20957,7 @@ paths: description: The HTTP 200 response (OK). tags: - ServerCertificate - "/ReadSnapshotExportTasks": + /ReadSnapshotExportTasks: post: description: Lists one or more snapshot export tasks. operationId: ReadSnapshotExportTasks @@ -21838,7 +20965,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadSnapshotExportTasksRequest" + $ref: '#/components/schemas/ReadSnapshotExportTasksRequest' examples: ex1: value: @@ -21850,7 +20977,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadSnapshotExportTasksResponse" + $ref: '#/components/schemas/ReadSnapshotExportTasksResponse' examples: ex1: value: @@ -21870,16 +20997,15 @@ paths: description: The HTTP 200 response (OK). tags: - Snapshot - "/ReadSnapshots": + /ReadSnapshots: post: - description: Lists one or more snapshots that are available to you and the permissions - to create volumes from them. + description: Lists one or more snapshots that are available to you and the permissions to create volumes from them. operationId: ReadSnapshots requestBody: content: application/json: schema: - "$ref": "#/components/schemas/ReadSnapshotsRequest" + $ref: '#/components/schemas/ReadSnapshotsRequest' examples: ex1: value: @@ -21899,7 +21025,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadSnapshotsResponse" + $ref: '#/components/schemas/ReadSnapshotsResponse' examples: ex1: value: @@ -21942,23 +21068,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Snapshot - "/ReadSubnets": + /ReadSubnets: post: description: |- Lists one or more of your Subnets.
@@ -21968,7 +21094,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadSubnetsRequest" + $ref: '#/components/schemas/ReadSubnetsRequest' examples: ex1: value: @@ -21988,7 +21114,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadSubnetsResponse" + $ref: '#/components/schemas/ReadSubnetsResponse' examples: ex1: value: @@ -22008,23 +21134,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Subnet - "/ReadSubregions": + /ReadSubregions: post: description: |- Lists one or more of the enabled Subregions that you can access in the current Region.

@@ -22035,7 +21161,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadSubregionsRequest" + $ref: '#/components/schemas/ReadSubregionsRequest' examples: ex1: summary: Listing a specific Subregion in the current Region @@ -22055,7 +21181,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadSubregionsResponse" + $ref: '#/components/schemas/ReadSubregionsResponse' examples: ex1: summary: Listing a specific Subregion in the current Region @@ -22084,7 +21210,7 @@ paths: description: The HTTP 200 response (OK). tags: - Subregion - "/ReadTags": + /ReadTags: post: description: Lists one or more tags for your resources. operationId: ReadTags @@ -22092,7 +21218,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadTagsRequest" + $ref: '#/components/schemas/ReadTagsRequest' examples: ex1: value: @@ -22106,7 +21232,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadTagsResponse" + $ref: '#/components/schemas/ReadTagsResponse' examples: ex1: value: @@ -22122,23 +21248,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Tag - "/ReadUnitPrice": + /ReadUnitPrice: post: description: Gets unit price information for the specified parameters. operationId: ReadUnitPrice @@ -22146,7 +21272,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadUnitPriceRequest" + $ref: '#/components/schemas/ReadUnitPriceRequest' examples: ex1: value: @@ -22158,7 +21284,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadUnitPriceResponse" + $ref: '#/components/schemas/ReadUnitPriceResponse' examples: ex1: value: @@ -22174,7 +21300,7 @@ paths: description: The HTTP 200 response (OK). tags: - Catalog - "/ReadUserGroup": + /ReadUserGroup: post: description: Lists information about a specified user group, including its users. operationId: ReadUserGroup @@ -22182,18 +21308,18 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadUserGroupRequest" + $ref: '#/components/schemas/ReadUserGroupRequest' examples: ex1: value: - Path: "/example/" + Path: /example/ UserGroupName: example-usergroup responses: '200': content: application/json: schema: - "$ref": "#/components/schemas/ReadUserGroupResponse" + $ref: '#/components/schemas/ReadUserGroupResponse' examples: ex1: value: @@ -22204,19 +21330,19 @@ paths: LastModificationDate: '2010-10-01T12:34:56.789Z' Name: example-usergroup Orn: orn:ows:idauth::012345678910:usergroup/example/usergroup-example - Path: "/example/" + Path: /example/ UserGroupId: ug-12345678 Users: - CreationDate: '2010-10-01T12:34:56.789Z' LastModificationDate: '2010-10-01T12:34:56.789Z' - Path: "/example/" + Path: /example/ UserEmail: user@example.com UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 UserName: example-user description: The HTTP 200 response (OK). tags: - UserGroup - "/ReadUserGroupPolicies": + /ReadUserGroupPolicies: post: description: Lists the names of the inline policies embedded in a specific group. operationId: ReadUserGroupPolicies @@ -22224,20 +21350,20 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadUserGroupPoliciesRequest" + $ref: '#/components/schemas/ReadUserGroupPoliciesRequest' examples: ex1: value: FirstItem: 1 ResultsPerPage: 30 UserGroupName: example-usergroup - UserGroupPath: "/example/" + UserGroupPath: /example/ responses: '200': content: application/json: schema: - "$ref": "#/components/schemas/ReadUserGroupPoliciesResponse" + $ref: '#/components/schemas/ReadUserGroupPoliciesResponse' examples: ex1: value: @@ -22247,47 +21373,44 @@ paths: MaxResultsLimit: 30 MaxResultsTruncated: true Policies: - - Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], - "Resource": ["*"]} ]}' + - Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' Name: example-policy description: The HTTP 200 response (OK). tags: - Policy - "/ReadUserGroupPolicy": + /ReadUserGroupPolicy: post: - description: Returns information about an inline policy included in a specified - group. + description: Returns information about an inline policy included in a specified group. operationId: ReadUserGroupPolicy requestBody: content: application/json: schema: - "$ref": "#/components/schemas/ReadUserGroupPolicyRequest" + $ref: '#/components/schemas/ReadUserGroupPolicyRequest' examples: ex1: value: PolicyName: example-policy UserGroupName: example-usergroup - UserGroupPath: "/example/" + UserGroupPath: /example/ responses: '200': content: application/json: schema: - "$ref": "#/components/schemas/ReadUserGroupPolicyResponse" + $ref: '#/components/schemas/ReadUserGroupPolicyResponse' examples: ex1: value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 Policy: - Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], - "Resource": ["*"]} ]}' + Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' Name: example-policy description: The HTTP 200 response (OK). tags: - Policy - "/ReadUserGroups": + /ReadUserGroups: post: description: |- Lists all the user groups of the account.
@@ -22297,12 +21420,12 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadUserGroupsRequest" + $ref: '#/components/schemas/ReadUserGroupsRequest' examples: ex1: value: Filters: - PathPrefix: "/ex" + PathPrefix: /ex UserGroupIds: - ug-12345678 FirstItem: 1 @@ -22312,7 +21435,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadUserGroupsResponse" + $ref: '#/components/schemas/ReadUserGroupsResponse' examples: ex1: value: @@ -22326,12 +21449,12 @@ paths: LastModificationDate: '2010-10-01T12:34:56.789Z' Name: example-usergroup Orn: orn:ows:idauth::012345678910:usergroup/example/usergroup-example - Path: "/example/" + Path: /example/ UserGroupId: ug-12345678 description: The HTTP 200 response (OK). tags: - UserGroup - "/ReadUserGroupsPerUser": + /ReadUserGroupsPerUser: post: description: Lists the groups a specified user belongs to. operationId: ReadUserGroupsPerUser @@ -22339,18 +21462,18 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadUserGroupsPerUserRequest" + $ref: '#/components/schemas/ReadUserGroupsPerUserRequest' examples: ex1: value: UserName: example-user - UserPath: "/example/" + UserPath: /example/ responses: '200': content: application/json: schema: - "$ref": "#/components/schemas/ReadUserGroupsPerUserResponse" + $ref: '#/components/schemas/ReadUserGroupsPerUserResponse' examples: ex1: value: @@ -22361,12 +21484,12 @@ paths: LastModificationDate: '2010-10-01T12:34:56.789Z' Name: example-usergroup Orn: orn:ows:idauth::012345678910:usergroup/example/usergroup-example - Path: "/example/" + Path: /example/ UserGroupId: ug-12345678 description: The HTTP 200 response (OK). tags: - UserGroup - "/ReadUserPolicies": + /ReadUserPolicies: post: description: Lists the names of inline policies included in a specified user. operationId: ReadUserPolicies @@ -22374,7 +21497,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadUserPoliciesRequest" + $ref: '#/components/schemas/ReadUserPoliciesRequest' examples: ex1: value: @@ -22384,7 +21507,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadUserPoliciesResponse" + $ref: '#/components/schemas/ReadUserPoliciesResponse' examples: ex1: value: @@ -22395,16 +21518,15 @@ paths: description: The HTTP 200 response (OK). tags: - Policy - "/ReadUserPolicy": + /ReadUserPolicy: post: - description: Returns information about an inline policy included in a specified - user. + description: Returns information about an inline policy included in a specified user. operationId: ReadUserPolicy requestBody: content: application/json: schema: - "$ref": "#/components/schemas/ReadUserPolicyRequest" + $ref: '#/components/schemas/ReadUserPolicyRequest' examples: ex1: value: @@ -22415,18 +21537,17 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadUserPolicyResponse" + $ref: '#/components/schemas/ReadUserPolicyResponse' examples: ex1: value: - PolicyDocument: '{"Statement": [ {"Effect": "Allow", "Action": - ["*"], "Resource": ["*"]} ]}' + PolicyDocument: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}' PolicyName: example-user-policy UserName: example-user description: The HTTP 200 response (OK). tags: - Policy - "/ReadUsers": + /ReadUsers: post: description: |- Lists all EIM users in the account.
@@ -22436,7 +21557,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadUsersRequest" + $ref: '#/components/schemas/ReadUsersRequest' examples: ex1: value: @@ -22448,7 +21569,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadUsersResponse" + $ref: '#/components/schemas/ReadUsersResponse' examples: ex1: value: @@ -22456,13 +21577,13 @@ paths: - UserEmail: user@example.com UserName: example-user UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 - Path: "/documentation/" + Path: /documentation/ ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - User - "/ReadVirtualGateways": + /ReadVirtualGateways: post: description: Lists one or more virtual gateways. operationId: ReadVirtualGateways @@ -22470,7 +21591,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadVirtualGatewaysRequest" + $ref: '#/components/schemas/ReadVirtualGatewaysRequest' examples: ex1: value: @@ -22490,7 +21611,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadVirtualGatewaysResponse" + $ref: '#/components/schemas/ReadVirtualGatewaysResponse' examples: ex1: value: @@ -22517,7 +21638,7 @@ paths: description: The HTTP 200 response (OK). tags: - VirtualGateway - "/ReadVmGroups": + /ReadVmGroups: post: description: |- > [WARNING]
@@ -22529,7 +21650,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadVmGroupsRequest" + $ref: '#/components/schemas/ReadVmGroupsRequest' examples: ex1: value: @@ -22541,7 +21662,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadVmGroupsResponse" + $ref: '#/components/schemas/ReadVmGroupsResponse' examples: ex1: value: @@ -22552,7 +21673,7 @@ paths: - sg-87654321 VmIds: - i-12345678 - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + CreationDate: 2010-10-01T12:34:56.789+0000 VmCount: 1 VmGroupName: ClusterLog-PPD01 SubnetId: subnet-12345678 @@ -22567,23 +21688,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - VmGroup - "/ReadVmTemplates": + /ReadVmTemplates: post: description: |- > [WARNING]
@@ -22595,7 +21716,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadVmTemplatesRequest" + $ref: '#/components/schemas/ReadVmTemplatesRequest' examples: ex1: value: @@ -22614,14 +21735,14 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadVmTemplatesResponse" + $ref: '#/components/schemas/ReadVmTemplatesResponse' examples: ex1: value: VmTemplates: - VmTemplateName: vmtemplate-example CpuPerformance: high - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + CreationDate: 2010-10-01T12:34:56.789+0000 CpuCores: 2 Tags: [] Description: '' @@ -22634,7 +21755,7 @@ paths: description: The HTTP 200 response (OK). tags: - VmTemplate - "/ReadVmTypes": + /ReadVmTypes: post: description: Lists one or more predefined VM types. operationId: ReadVmTypes @@ -22642,7 +21763,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadVmTypesRequest" + $ref: '#/components/schemas/ReadVmTypesRequest' examples: ex1: value: @@ -22654,7 +21775,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadVmTypesResponse" + $ref: '#/components/schemas/ReadVmTypesResponse' examples: ex1: value: @@ -22671,7 +21792,7 @@ paths: security: [] tags: - Vm - "/ReadVms": + /ReadVms: post: description: |- Lists one or more of your virtual machines (VMs).
@@ -22681,7 +21802,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadVmsRequest" + $ref: '#/components/schemas/ReadVmsRequest' examples: ex1: value: @@ -22701,7 +21822,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadVmsResponse" + $ref: '#/components/schemas/ReadVmsResponse' examples: ex1: value: @@ -22711,7 +21832,7 @@ paths: State: running StateReason: '' RootDeviceType: ebs - RootDeviceName: "/dev/sda1" + RootDeviceName: /dev/sda1 IsSourceDestChecked: true KeypairName: keypair-example ImageId: ami-12345678 @@ -22720,7 +21841,7 @@ paths: Architecture: x86_64 NestedVirtualization: false BlockDeviceMappings: - - DeviceName: "/dev/sda1" + - DeviceName: /dev/sda1 Bsu: VolumeId: vol-12345678 State: attached @@ -22781,32 +21902,31 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Vm - "/ReadVmsHealth": + /ReadVmsHealth: post: - description: Lists the state of one or more backend virtual machines (VMs) registered - with a specified load balancer. + description: Lists the state of one or more backend virtual machines (VMs) registered with a specified load balancer. operationId: ReadVmsHealth requestBody: content: application/json: schema: - "$ref": "#/components/schemas/ReadVmsHealthRequest" + $ref: '#/components/schemas/ReadVmsHealthRequest' examples: ex1: value: @@ -22819,7 +21939,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadVmsHealthResponse" + $ref: '#/components/schemas/ReadVmsHealthResponse' examples: ex1: value: @@ -22835,7 +21955,7 @@ paths: description: The HTTP 200 response (OK). tags: - LoadBalancer - "/ReadVmsState": + /ReadVmsState: post: description: Lists the status of one or more virtual machines (VMs). operationId: ReadVmsState @@ -22843,7 +21963,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadVmsStateRequest" + $ref: '#/components/schemas/ReadVmsStateRequest' examples: ex1: value: @@ -22858,7 +21978,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadVmsStateResponse" + $ref: '#/components/schemas/ReadVmsStateResponse' examples: ex1: value: @@ -22887,23 +22007,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Vm - "/ReadVolumeUpdateTasks": + /ReadVolumeUpdateTasks: post: description: Lists one or more specified tasks of volume update. operationId: ReadVolumeUpdateTasks @@ -22911,7 +22031,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadVolumeUpdateTasksRequest" + $ref: '#/components/schemas/ReadVolumeUpdateTasksRequest' examples: ex1: summary: Read a specific volume update task @@ -22924,7 +22044,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadVolumeUpdateTasksResponse" + $ref: '#/components/schemas/ReadVolumeUpdateTasksResponse' examples: ex1: summary: Read a specific volume update task @@ -22952,24 +22072,24 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). summary: Lists one or more update tasks of volumes tags: - Volume - "/ReadVolumes": + /ReadVolumes: post: description: Lists one or more specified Block Storage Unit (BSU) volumes. operationId: ReadVolumes @@ -22977,7 +22097,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadVolumesRequest" + $ref: '#/components/schemas/ReadVolumesRequest' examples: ex1: value: @@ -22997,7 +22117,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadVolumesResponse" + $ref: '#/components/schemas/ReadVolumesResponse' examples: ex1: value: @@ -23012,7 +22132,7 @@ paths: LinkedVolumes: - VolumeId: vol-12345678 DeleteOnVmDeletion: false - DeviceName: "/dev/sdb" + DeviceName: /dev/sdb State: attached VmId: i-12345678 Size: 10 @@ -23023,23 +22143,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Volume - "/ReadVpnConnections": + /ReadVpnConnections: post: description: Lists one or more VPN connections. operationId: ReadVpnConnections @@ -23047,7 +22167,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadVpnConnectionsRequest" + $ref: '#/components/schemas/ReadVpnConnectionsRequest' examples: ex1: value: @@ -23067,14 +22187,14 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ReadVpnConnectionsResponse" + $ref: '#/components/schemas/ReadVpnConnectionsResponse' examples: ex1: value: VpnConnections: - Routes: [] Tags: [] - ClientGatewayConfiguration: "..." + ClientGatewayConfiguration: ... StaticRoutesOnly: true VirtualGatewayId: vgw-12345678 ConnectionType: ipsec.1 @@ -23091,7 +22211,7 @@ paths: description: The HTTP 200 response (OK). tags: - VpnConnection - "/RebootVms": + /RebootVms: post: description: |- Reboots one or more virtual machines (VMs).
@@ -23101,7 +22221,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/RebootVmsRequest" + $ref: '#/components/schemas/RebootVmsRequest' examples: ex1: value: @@ -23112,7 +22232,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/RebootVmsResponse" + $ref: '#/components/schemas/RebootVmsResponse' examples: ex1: value: @@ -23123,23 +22243,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Vm - "/RegisterVmsInLoadBalancer": + /RegisterVmsInLoadBalancer: post: description: |- > [WARNING]
@@ -23152,7 +22272,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/RegisterVmsInLoadBalancerRequest" + $ref: '#/components/schemas/RegisterVmsInLoadBalancerRequest' examples: ex1: value: @@ -23165,7 +22285,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/RegisterVmsInLoadBalancerResponse" + $ref: '#/components/schemas/RegisterVmsInLoadBalancerResponse' examples: ex1: value: @@ -23174,7 +22294,7 @@ paths: description: The HTTP 200 response (OK). tags: - LoadBalancer - "/RejectNetPeering": + /RejectNetPeering: post: description: |- Rejects a Net peering request.
@@ -23184,7 +22304,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/RejectNetPeeringRequest" + $ref: '#/components/schemas/RejectNetPeeringRequest' examples: ex1: value: @@ -23194,7 +22314,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/RejectNetPeeringResponse" + $ref: '#/components/schemas/RejectNetPeeringResponse' examples: ex1: value: @@ -23205,29 +22325,29 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '409': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 409 response (Conflict). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - NetPeering - "/RemoveUserFromUserGroup": + /RemoveUserFromUserGroup: post: description: Removes a specified user from a specified group. operationId: RemoveUserFromUserGroup @@ -23235,20 +22355,20 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/RemoveUserFromUserGroupRequest" + $ref: '#/components/schemas/RemoveUserFromUserGroupRequest' examples: ex1: value: UserGroupName: example-usergroup - UserGroupPath: "/example/" + UserGroupPath: /example/ UserName: example-user - UserPath: "/example/" + UserPath: /example/ responses: '200': content: application/json: schema: - "$ref": "#/components/schemas/RemoveUserFromUserGroupResponse" + $ref: '#/components/schemas/RemoveUserFromUserGroupResponse' examples: ex1: value: @@ -23257,7 +22377,7 @@ paths: description: The HTTP 200 response (OK). tags: - UserGroup - "/ScaleDownVmGroup": + /ScaleDownVmGroup: post: description: |- > [WARNING]
@@ -23270,7 +22390,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ScaleDownVmGroupRequest" + $ref: '#/components/schemas/ScaleDownVmGroupRequest' examples: ex1: summary: Removing 1 VM from a VM group @@ -23282,7 +22402,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ScaleDownVmGroupResponse" + $ref: '#/components/schemas/ScaleDownVmGroupResponse' examples: ex1: value: @@ -23293,23 +22413,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - VmGroup - "/ScaleUpVmGroup": + /ScaleUpVmGroup: post: description: |- > [WARNING]
@@ -23322,7 +22442,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ScaleUpVmGroupRequest" + $ref: '#/components/schemas/ScaleUpVmGroupRequest' examples: ex1: summary: Adding 2 VMs in a VM group @@ -23334,7 +22454,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ScaleUpVmGroupResponse" + $ref: '#/components/schemas/ScaleUpVmGroupResponse' examples: ex1: value: @@ -23345,33 +22465,37 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - VmGroup - "/SetDefaultPolicyVersion": + /SetDefaultPolicyVersion: post: description: |- Sets a specified version of a managed policy as the default (operative) one.
You can modify the default version of a policy at any time. +

+ + **[IMPORTANT]**
+ A delay of up to 15 seconds can occur when attaching, detaching, or updating a managed policy. operationId: SetDefaultPolicyVersion requestBody: content: application/json: schema: - "$ref": "#/components/schemas/SetDefaultPolicyVersionRequest" + $ref: '#/components/schemas/SetDefaultPolicyVersionRequest' examples: ex1: value: @@ -23382,7 +22506,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/SetDefaultPolicyVersionResponse" + $ref: '#/components/schemas/SetDefaultPolicyVersionResponse' examples: ex1: value: @@ -23391,7 +22515,7 @@ paths: description: The HTTP 200 response (OK). tags: - Policy - "/StartVms": + /StartVms: post: description: |- Start one or more virtual machines (VMs).
@@ -23401,7 +22525,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/StartVmsRequest" + $ref: '#/components/schemas/StartVmsRequest' examples: ex1: value: @@ -23412,7 +22536,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/StartVmsResponse" + $ref: '#/components/schemas/StartVmsResponse' examples: ex1: value: @@ -23427,23 +22551,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Vm - "/StopVms": + /StopVms: post: description: |- Stops one or more running virtual machines (VMs).
@@ -23453,7 +22577,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/StopVmsRequest" + $ref: '#/components/schemas/StopVmsRequest' examples: ex1: value: @@ -23464,7 +22588,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/StopVmsResponse" + $ref: '#/components/schemas/StopVmsResponse' examples: ex1: value: @@ -23479,23 +22603,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Vm - "/UnlinkFlexibleGpu": + /UnlinkFlexibleGpu: post: description: |- Detaches a flexible GPU (fGPU) from a virtual machine (VM).
@@ -23505,7 +22629,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UnlinkFlexibleGpuRequest" + $ref: '#/components/schemas/UnlinkFlexibleGpuRequest' examples: ex1: value: @@ -23515,7 +22639,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UnlinkFlexibleGpuResponse" + $ref: '#/components/schemas/UnlinkFlexibleGpuResponse' examples: ex1: value: @@ -23524,7 +22648,7 @@ paths: description: The HTTP 200 response (OK). tags: - FlexibleGpu - "/UnlinkInternetService": + /UnlinkInternetService: post: description: |- Detaches an internet service from a Net.
@@ -23534,7 +22658,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UnlinkInternetServiceRequest" + $ref: '#/components/schemas/UnlinkInternetServiceRequest' examples: ex1: value: @@ -23545,7 +22669,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UnlinkInternetServiceResponse" + $ref: '#/components/schemas/UnlinkInternetServiceResponse' examples: ex1: value: @@ -23556,33 +22680,31 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - InternetService - "/UnlinkLoadBalancerBackendMachines": + /UnlinkLoadBalancerBackendMachines: post: - description: Detaches one or more backend virtual machines (VMs) from a load - balancer. You need to specify at least the `BackendIps` or the `BackendVmIds` - parameter. + description: Detaches one or more backend virtual machines (VMs) from a load balancer. You need to specify at least the `BackendIps` or the `BackendVmIds` parameter. operationId: UnlinkLoadBalancerBackendMachines requestBody: content: application/json: schema: - "$ref": "#/components/schemas/UnlinkLoadBalancerBackendMachinesRequest" + $ref: '#/components/schemas/UnlinkLoadBalancerBackendMachinesRequest' examples: ex1: summary: Unlinking VMs from a load balancer @@ -23603,7 +22725,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UnlinkLoadBalancerBackendMachinesResponse" + $ref: '#/components/schemas/UnlinkLoadBalancerBackendMachinesResponse' examples: ex1: summary: Unlinking VMs from a load balancer @@ -23618,15 +22740,20 @@ paths: description: The HTTP 200 response (OK). tags: - LoadBalancer - "/UnlinkManagedPolicyFromUserGroup": + /UnlinkManagedPolicyFromUserGroup: post: - description: Unlinks a managed policy from a specific group. + description: |- + Unlinks a managed policy from a specific group. +

+ + **[IMPORTANT]**
+ A delay of up to 15 seconds can occur when attaching, detaching, or updating a managed policy. operationId: UnlinkManagedPolicyFromUserGroup requestBody: content: application/json: schema: - "$ref": "#/components/schemas/UnlinkManagedPolicyFromUserGroupRequest" + $ref: '#/components/schemas/UnlinkManagedPolicyFromUserGroupRequest' examples: ex1: value: @@ -23637,7 +22764,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UnlinkManagedPolicyFromUserGroupResponse" + $ref: '#/components/schemas/UnlinkManagedPolicyFromUserGroupResponse' examples: ex1: value: @@ -23646,7 +22773,7 @@ paths: description: The HTTP 200 response (OK). tags: - Policy - "/UnlinkNic": + /UnlinkNic: post: description: |- Detaches a network interface card (NIC) from a virtual machine (VM).
@@ -23656,7 +22783,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UnlinkNicRequest" + $ref: '#/components/schemas/UnlinkNicRequest' examples: ex1: value: @@ -23666,7 +22793,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UnlinkNicResponse" + $ref: '#/components/schemas/UnlinkNicResponse' examples: ex1: value: @@ -23677,31 +22804,36 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Nic - "/UnlinkPolicy": + /UnlinkPolicy: post: - description: Removes a managed policy from a specific user. + description: |- + Removes a managed policy from a specific user. +

+ + **[IMPORTANT]**
+ A delay of up to 15 seconds can occur when attaching, detaching, or updating a managed policy. operationId: UnlinkPolicy requestBody: content: application/json: schema: - "$ref": "#/components/schemas/UnlinkPolicyRequest" + $ref: '#/components/schemas/UnlinkPolicyRequest' examples: ex1: value: @@ -23712,7 +22844,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UnlinkPolicyResponse" + $ref: '#/components/schemas/UnlinkPolicyResponse' examples: ex1: value: @@ -23721,16 +22853,15 @@ paths: description: The HTTP 200 response (OK). tags: - Policy - "/UnlinkPrivateIps": + /UnlinkPrivateIps: post: - description: Unassigns one or more secondary private IPs from a network interface - card (NIC). + description: Unassigns one or more secondary private IPs from a network interface card (NIC). operationId: UnlinkPrivateIps requestBody: content: application/json: schema: - "$ref": "#/components/schemas/UnlinkPrivateIpsRequest" + $ref: '#/components/schemas/UnlinkPrivateIpsRequest' examples: ex1: value: @@ -23743,7 +22874,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UnlinkPrivateIpsResponse" + $ref: '#/components/schemas/UnlinkPrivateIpsResponse' examples: ex1: value: @@ -23754,23 +22885,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Nic - "/UnlinkPublicIp": + /UnlinkPublicIp: post: description: |- Disassociates a public IP from the virtual machine (VM) or network interface card (NIC) it is associated with.

@@ -23782,7 +22913,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UnlinkPublicIpRequest" + $ref: '#/components/schemas/UnlinkPublicIpRequest' examples: ex1: value: @@ -23792,7 +22923,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UnlinkPublicIpResponse" + $ref: '#/components/schemas/UnlinkPublicIpResponse' examples: ex1: value: @@ -23803,23 +22934,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - PublicIp - "/UnlinkRouteTable": + /UnlinkRouteTable: post: description: |- Disassociates a Subnet from a route table.
@@ -23829,7 +22960,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UnlinkRouteTableRequest" + $ref: '#/components/schemas/UnlinkRouteTableRequest' examples: ex1: value: @@ -23839,7 +22970,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UnlinkRouteTableResponse" + $ref: '#/components/schemas/UnlinkRouteTableResponse' examples: ex1: value: @@ -23850,23 +22981,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - RouteTable - "/UnlinkVirtualGateway": + /UnlinkVirtualGateway: post: description: |- Detaches a virtual gateway from a Net.
@@ -23876,7 +23007,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UnlinkVirtualGatewayRequest" + $ref: '#/components/schemas/UnlinkVirtualGatewayRequest' examples: ex1: value: @@ -23887,7 +23018,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UnlinkVirtualGatewayResponse" + $ref: '#/components/schemas/UnlinkVirtualGatewayResponse' examples: ex1: value: @@ -23896,7 +23027,7 @@ paths: description: The HTTP 200 response (OK). tags: - VirtualGateway - "/UnlinkVolume": + /UnlinkVolume: post: description: |- Detaches a Block Storage Unit (BSU) volume from a virtual machine (VM).
@@ -23906,7 +23037,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UnlinkVolumeRequest" + $ref: '#/components/schemas/UnlinkVolumeRequest' examples: ex1: value: @@ -23916,7 +23047,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UnlinkVolumeResponse" + $ref: '#/components/schemas/UnlinkVolumeResponse' examples: ex1: value: @@ -23927,23 +23058,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Volume - "/UpdateAccessKey": + /UpdateAccessKey: post: description: |- Modifies the attributes of the specified access key of either your root account or an EIM user.

@@ -23953,7 +23084,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateAccessKeyRequest" + $ref: '#/components/schemas/UpdateAccessKeyRequest' examples: ex1: summary: Updating the expiration date of the access key @@ -23962,8 +23093,7 @@ paths: State: ACTIVE ExpirationDate: '2063-04-05' ex2: - summary: Updating the state of one of your own access keys (if you - are the root account or an EIM user) + summary: Updating the state of one of your own access keys (if you are the root account or an EIM user) value: AccessKeyId: ABCDEFGHIJ0123456789 State: ACTIVE @@ -23978,7 +23108,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateAccessKeyResponse" + $ref: '#/components/schemas/UpdateAccessKeyResponse' examples: ex1: summary: Updating an access key when using the parameter ExpirationDate @@ -23988,9 +23118,9 @@ paths: AccessKey: State: ACTIVE AccessKeyId: ABCDEFGHIJ0123456789 - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 - ExpirationDate: 2063-04-05 00:00:00.000000000 +00:00 - LastModificationDate: 2017-05-10 12:34:56.789000000 +00:00 + CreationDate: 2010-10-01T12:34:56.789+0000 + ExpirationDate: 2063-04-05T00:00:00.000+0000 + LastModificationDate: 2017-05-10T12:34:56.789+0000 Tag: Group1 ex2: summary: Updating an access key when not using the parameter ExpirationDate @@ -24000,8 +23130,8 @@ paths: AccessKey: State: ACTIVE AccessKeyId: ABCDEFGHIJ0123456789 - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 - LastModificationDate: 2017-05-10 12:34:56.789000000 +00:00 + CreationDate: 2010-10-01T12:34:56.789+0000 + LastModificationDate: 2017-05-10T12:34:56.789+0000 Tag: Group1 description: The HTTP 200 response (OK). security: @@ -24009,16 +23139,15 @@ paths: - BasicAuth: [] tags: - AccessKey - "/UpdateAccount": + /UpdateAccount: post: - description: Updates the account information for the account that sends the - request. + description: Updates the account information for the account that sends the request. operationId: UpdateAccount requestBody: content: application/json: schema: - "$ref": "#/components/schemas/UpdateAccountRequest" + $ref: '#/components/schemas/UpdateAccountRequest' examples: ex1: value: @@ -24030,7 +23159,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateAccountResponse" + $ref: '#/components/schemas/UpdateAccountResponse' examples: ex1: value: @@ -24052,7 +23181,7 @@ paths: description: The HTTP 200 response (OK). tags: - Account - "/UpdateApiAccessPolicy": + /UpdateApiAccessPolicy: post: description: |- Updates the API access policy of your account.

@@ -24064,7 +23193,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateApiAccessPolicyRequest" + $ref: '#/components/schemas/UpdateApiAccessPolicyRequest' examples: ex1: summary: Require expiration dates of maximum 1 year @@ -24072,14 +23201,12 @@ paths: MaxAccessKeyExpirationSeconds: 31536000 RequireTrustedEnv: false ex2: - summary: Require expiration dates of maximum 100 years and activate - a trusted session + summary: Require expiration dates of maximum 100 years and activate a trusted session value: MaxAccessKeyExpirationSeconds: 3153600000 RequireTrustedEnv: true ex3: - summary: Do not require expiration dates and deactivate a trusted - session + summary: Do not require expiration dates and deactivate a trusted session value: MaxAccessKeyExpirationSeconds: 0 RequireTrustedEnv: false @@ -24088,7 +23215,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateApiAccessPolicyResponse" + $ref: '#/components/schemas/UpdateApiAccessPolicyResponse' examples: ex1: summary: Require expiration dates of maximum 1 year @@ -24099,8 +23226,7 @@ paths: RequireTrustedEnv: false MaxAccessKeyExpirationSeconds: 31536000 ex2: - summary: Require expiration dates of maximum 100 years and activate - a trusted session + summary: Require expiration dates of maximum 100 years and activate a trusted session value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 @@ -24108,8 +23234,7 @@ paths: RequireTrustedEnv: true MaxAccessKeyExpirationSeconds: 3153600000 ex3: - summary: Do not require expiration dates and deactivate a trusted - session + summary: Do not require expiration dates and deactivate a trusted session value: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 @@ -24121,26 +23246,26 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). security: - ApiKeyAuthSec: [] - BasicAuth: [] tags: - ApiAccessPolicy - "/UpdateApiAccessRule": + /UpdateApiAccessRule: post: description: |- Modifies a specified API access rule.

@@ -24153,7 +23278,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateApiAccessRuleRequest" + $ref: '#/components/schemas/UpdateApiAccessRuleRequest' examples: ex1: value: @@ -24166,7 +23291,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateApiAccessRuleResponse" + $ref: '#/components/schemas/UpdateApiAccessRuleResponse' examples: ex1: value: @@ -24185,16 +23310,15 @@ paths: - BasicAuth: [] tags: - ApiAccessRule - "/UpdateCa": + /UpdateCa: post: - description: Modifies the specified attribute of a Client Certificate Authority - (CA). + description: Modifies the specified attribute of a Client Certificate Authority (CA). operationId: UpdateCa requestBody: content: application/json: schema: - "$ref": "#/components/schemas/UpdateCaRequest" + $ref: '#/components/schemas/UpdateCaRequest' examples: ex1: value: @@ -24205,7 +23329,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateCaResponse" + $ref: '#/components/schemas/UpdateCaResponse' examples: ex1: value: @@ -24221,19 +23345,15 @@ paths: - BasicAuth: [] tags: - Ca - "/UpdateDedicatedGroup": + /UpdateDedicatedGroup: post: - description: |- - > [WARNING]
- > This feature is currently in beta.
- - Modifies the name of a specified dedicated group.
+ description: Modifies the name of a specified dedicated group. operationId: UpdateDedicatedGroup requestBody: content: application/json: schema: - "$ref": "#/components/schemas/UpdateDedicatedGroupRequest" + $ref: '#/components/schemas/UpdateDedicatedGroupRequest' examples: ex1: value: @@ -24244,7 +23364,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateDedicatedGroupResponse" + $ref: '#/components/schemas/UpdateDedicatedGroupResponse' examples: ex1: value: @@ -24265,23 +23385,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - DedicatedGroup - "/UpdateDirectLinkInterface": + /UpdateDirectLinkInterface: post: description: Modifies the maximum transmission unit (MTU) of a DirectLink interface. operationId: UpdateDirectLinkInterface @@ -24289,7 +23409,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateDirectLinkInterfaceRequest" + $ref: '#/components/schemas/UpdateDirectLinkInterfaceRequest' examples: ex1: value: @@ -24300,7 +23420,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateDirectLinkInterfaceResponse" + $ref: '#/components/schemas/UpdateDirectLinkInterfaceResponse' examples: ex1: value: @@ -24323,7 +23443,7 @@ paths: description: The HTTP 200 response (OK). tags: - DirectLinkInterface - "/UpdateFlexibleGpu": + /UpdateFlexibleGpu: post: description: Modifies a flexible GPU (fGPU) behavior. operationId: UpdateFlexibleGpu @@ -24331,7 +23451,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateFlexibleGpuRequest" + $ref: '#/components/schemas/UpdateFlexibleGpuRequest' examples: ex1: value: @@ -24342,7 +23462,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateFlexibleGpuResponse" + $ref: '#/components/schemas/UpdateFlexibleGpuResponse' examples: ex1: value: @@ -24359,7 +23479,7 @@ paths: description: The HTTP 200 response (OK). tags: - FlexibleGpu - "/UpdateImage": + /UpdateImage: post: description: |- Modifies the access permissions for an OUTSCALE machine image (OMI).
@@ -24370,7 +23490,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateImageRequest" + $ref: '#/components/schemas/UpdateImageRequest' examples: ex1: summary: Adding permission @@ -24408,7 +23528,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateImageResponse" + $ref: '#/components/schemas/UpdateImageResponse' examples: ex1: summary: Adding permission @@ -24419,7 +23539,7 @@ paths: StateComment: {} State: available RootDeviceType: bsu - RootDeviceName: "/dev/sda1" + RootDeviceName: /dev/sda1 ProductCodes: - '0001' PermissionsToLaunch: @@ -24431,7 +23551,7 @@ paths: Description: '' ImageId: ami-12345678 BlockDeviceMappings: - - DeviceName: "/dev/sda1" + - DeviceName: /dev/sda1 Bsu: VolumeType: standard DeleteOnVmDeletion: true @@ -24451,7 +23571,7 @@ paths: StateComment: {} State: available RootDeviceType: bsu - RootDeviceName: "/dev/sda1" + RootDeviceName: /dev/sda1 ProductCodes: - '0001' PermissionsToLaunch: @@ -24462,7 +23582,7 @@ paths: Description: '' ImageId: ami-12345678 BlockDeviceMappings: - - DeviceName: "/dev/sda1" + - DeviceName: /dev/sda1 Bsu: VolumeType: standard DeleteOnVmDeletion: true @@ -24482,7 +23602,7 @@ paths: StateComment: {} State: available RootDeviceType: bsu - RootDeviceName: "/dev/sda1" + RootDeviceName: /dev/sda1 ProductCodes: - '0001' PermissionsToLaunch: @@ -24493,7 +23613,7 @@ paths: Description: '' ImageId: ami-12345678 BlockDeviceMappings: - - DeviceName: "/dev/sda1" + - DeviceName: /dev/sda1 Bsu: VolumeType: standard DeleteOnVmDeletion: true @@ -24513,7 +23633,7 @@ paths: StateComment: {} State: available RootDeviceType: bsu - RootDeviceName: "/dev/sda1" + RootDeviceName: /dev/sda1 ProductCodes: - '0001' PermissionsToLaunch: @@ -24524,7 +23644,7 @@ paths: Description: Private image ImageId: ami-12345678 BlockDeviceMappings: - - DeviceName: "/dev/sda1" + - DeviceName: /dev/sda1 Bsu: VolumeType: standard DeleteOnVmDeletion: true @@ -24540,23 +23660,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Image - "/UpdateListenerRule": + /UpdateListenerRule: post: description: |- Updates the pattern of the listener rule.
@@ -24566,18 +23686,18 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateListenerRuleRequest" + $ref: '#/components/schemas/UpdateListenerRuleRequest' examples: ex1: value: ListenerRuleName: example-listener-rule - HostPattern: "*.newhost.com" + HostPattern: '*.newhost.com' responses: '200': content: application/json: schema: - "$ref": "#/components/schemas/UpdateListenerRuleResponse" + $ref: '#/components/schemas/UpdateListenerRuleResponse' examples: ex1: value: @@ -24590,12 +23710,12 @@ paths: ListenerRuleName: example-listener-rule Action: forward ListenerId: 123456 - HostNamePattern: "*.newhost.com" + HostNamePattern: '*.newhost.com' ListenerRuleId: 1234 description: The HTTP 200 response (OK). tags: - Listener - "/UpdateLoadBalancer": + /UpdateLoadBalancer: post: description: |- Modifies the specified attribute of a load balancer. You can specify only one attribute at a time.

@@ -24610,7 +23730,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateLoadBalancerRequest" + $ref: '#/components/schemas/UpdateLoadBalancerRequest' examples: ex1: summary: Updating health checks @@ -24619,7 +23739,7 @@ paths: HealthCheck: HealthyThreshold: 10 CheckInterval: 30 - Path: "/index.html" + Path: /index.html Port: 8080 Protocol: HTTPS Timeout: 5 @@ -24651,7 +23771,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateLoadBalancerResponse" + $ref: '#/components/schemas/UpdateLoadBalancerResponse' examples: ex1: summary: Updating health checks @@ -24681,7 +23801,7 @@ paths: UnhealthyThreshold: 5 Timeout: 5 CheckInterval: 30 - Path: "/index.html" + Path: /index.html Protocol: HTTPS HealthyThreshold: 10 Port: 8080 @@ -24825,7 +23945,7 @@ paths: description: The HTTP 200 response (OK). tags: - LoadBalancer - "/UpdateNet": + /UpdateNet: post: description: Associates a DHCP options set with a specified Net. operationId: UpdateNet @@ -24833,7 +23953,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateNetRequest" + $ref: '#/components/schemas/UpdateNetRequest' examples: ex1: value: @@ -24844,7 +23964,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateNetResponse" + $ref: '#/components/schemas/UpdateNetResponse' examples: ex1: value: @@ -24862,23 +23982,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Net - "/UpdateNetAccessPoint": + /UpdateNetAccessPoint: post: description: |- Modifies the attributes of a Net access point.
@@ -24888,7 +24008,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateNetAccessPointRequest" + $ref: '#/components/schemas/UpdateNetAccessPointRequest' examples: ex1: summary: Adding a route table @@ -24907,7 +24027,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateNetAccessPointResponse" + $ref: '#/components/schemas/UpdateNetAccessPointResponse' examples: ex1: summary: Adding a route table @@ -24938,16 +24058,15 @@ paths: description: The HTTP 200 response (OK). tags: - NetAccessPoint - "/UpdateNic": + /UpdateNic: post: - description: Modifies the specified network interface card (NIC). You can specify - only one attribute at a time. + description: Modifies the specified network interface card (NIC). You can specify only one attribute at a time. operationId: UpdateNic requestBody: content: application/json: schema: - "$ref": "#/components/schemas/UpdateNicRequest" + $ref: '#/components/schemas/UpdateNicRequest' examples: ex1: summary: Modifying the DeleteOnVmDeletion value of a NIC @@ -24972,7 +24091,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateNicResponse" + $ref: '#/components/schemas/UpdateNicResponse' examples: ex1: summary: Modifying the DeleteOnVmDeletion value of a NIC @@ -25072,23 +24191,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Nic - "/UpdateRoute": + /UpdateRoute: post: description: |- Replaces an existing route within a route table in a Net.
@@ -25107,7 +24226,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateRouteRequest" + $ref: '#/components/schemas/UpdateRouteRequest' examples: ex1: summary: Updating a route to a virtual gateway @@ -25120,7 +24239,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateRouteResponse" + $ref: '#/components/schemas/UpdateRouteResponse' examples: ex1: summary: Updating a route to a virtual gateway @@ -25150,32 +24269,31 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Route - "/UpdateRoutePropagation": + /UpdateRoutePropagation: post: - description: Configures the propagation of routes to a specified route table - of a Net by a virtual gateway. + description: Configures the propagation of routes to a specified route table of a Net by a virtual gateway. operationId: UpdateRoutePropagation requestBody: content: application/json: schema: - "$ref": "#/components/schemas/UpdateRoutePropagationRequest" + $ref: '#/components/schemas/UpdateRoutePropagationRequest' examples: ex1: value: @@ -25187,7 +24305,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateRoutePropagationResponse" + $ref: '#/components/schemas/UpdateRoutePropagationResponse' examples: ex1: value: @@ -25210,7 +24328,7 @@ paths: description: The HTTP 200 response (OK). tags: - VirtualGateway - "/UpdateRouteTableLink": + /UpdateRouteTableLink: post: description: |- Replaces the route table associated with a specific Subnet in a Net with another one.
@@ -25220,7 +24338,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateRouteTableLinkRequest" + $ref: '#/components/schemas/UpdateRouteTableLinkRequest' examples: ex1: value: @@ -25231,7 +24349,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateRouteTableLinkResponse" + $ref: '#/components/schemas/UpdateRouteTableLinkResponse' examples: ex1: value: @@ -25243,23 +24361,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - RouteTable - "/UpdateServerCertificate": + /UpdateServerCertificate: post: description: Modifies the name and/or the path of a specified server certificate. operationId: UpdateServerCertificate @@ -25267,7 +24385,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateServerCertificateRequest" + $ref: '#/components/schemas/UpdateServerCertificateRequest' examples: ex1: value: @@ -25278,12 +24396,12 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateServerCertificateResponse" + $ref: '#/components/schemas/UpdateServerCertificateResponse' examples: ex1: value: ServerCertificate: - Path: "/example/" + Path: /example/ Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ1234 Name: new-name ResponseContext: @@ -25291,7 +24409,7 @@ paths: description: The HTTP 200 response (OK). tags: - ServerCertificate - "/UpdateSnapshot": + /UpdateSnapshot: post: description: |- Modifies the permissions for a specified snapshot.
@@ -25302,7 +24420,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateSnapshotRequest" + $ref: '#/components/schemas/UpdateSnapshotRequest' examples: ex1: summary: Adding permission @@ -25321,14 +24439,14 @@ paths: AccountIds: - '987654321098' ex3: - summary: Making an image public to everyone + summary: Making a snapshot public to everyone value: SnapshotId: snap-12345678 PermissionsToCreateVolume: Additions: GlobalPermission: true ex4: - summary: Making an image private to everyone + summary: Making a snapshot private to everyone value: SnapshotId: snap-12345678 PermissionsToCreateVolume: @@ -25339,7 +24457,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateSnapshotResponse" + $ref: '#/components/schemas/UpdateSnapshotResponse' examples: ex1: summary: Adding permission @@ -25379,7 +24497,7 @@ paths: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex3: - summary: Making an image public to everyone + summary: Making a snapshot public to everyone value: Snapshot: VolumeSize: 10 @@ -25397,7 +24515,7 @@ paths: ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 ex4: - summary: Making an image private to everyone + summary: Making a snapshot private to everyone value: Snapshot: VolumeSize: 10 @@ -25419,23 +24537,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Snapshot - "/UpdateSubnet": + /UpdateSubnet: post: description: Modifies the specified attribute of a Subnet. operationId: UpdateSubnet @@ -25443,7 +24561,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateSubnetRequest" + $ref: '#/components/schemas/UpdateSubnetRequest' examples: ex1: value: @@ -25454,7 +24572,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateSubnetResponse" + $ref: '#/components/schemas/UpdateSubnetResponse' examples: ex1: value: @@ -25474,23 +24592,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Subnet - "/UpdateUser": + /UpdateUser: post: description: Modifies the name and/or the path of a specified EIM user. operationId: UpdateUser @@ -25498,36 +24616,36 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateUserRequest" + $ref: '#/components/schemas/UpdateUserRequest' examples: ex1: value: UserName: example-user NewUserEmail: user@example.com NewUserName: test-user - NewPath: "/product/" + NewPath: /product/ responses: '200': content: application/json: schema: - "$ref": "#/components/schemas/UpdateUserResponse" + $ref: '#/components/schemas/UpdateUserResponse' examples: ex1: value: User: - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 - LastModificationDate: 2017-05-10 12:34:56.789000000 +00:00 + CreationDate: 2010-10-01T12:34:56.789+0000 + LastModificationDate: 2017-05-10T12:34:56.789+0000 UserEmail: user@example.com UserName: test-user UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 - Path: "/product/" + Path: /product/ ResponseContext: RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 description: The HTTP 200 response (OK). tags: - User - "/UpdateUserGroup": + /UpdateUserGroup: post: description: Modifies the name and/or the path of a specified group. operationId: UpdateUserGroup @@ -25535,20 +24653,20 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateUserGroupRequest" + $ref: '#/components/schemas/UpdateUserGroupRequest' examples: ex1: value: - NewPath: "/new-path/" + NewPath: /new-path/ NewUserGroupName: new-usergroup - Path: "/example/" + Path: /example/ UserGroupName: example-usergroup responses: '200': content: application/json: schema: - "$ref": "#/components/schemas/UpdateUserGroupResponse" + $ref: '#/components/schemas/UpdateUserGroupResponse' examples: ex1: value: @@ -25559,19 +24677,19 @@ paths: LastModificationDate: '2010-10-01T12:34:56.789Z' Name: new-usergroup Orn: orn:ows:idauth::012345678910:usergroup/example/usergroup-example - Path: "/new-path/" + Path: /new-path/ UserGroupId: ug-12345678 Users: - CreationDate: '2010-10-01T12:34:56.789Z' LastModificationDate: '2010-10-01T12:34:56.789Z' - Path: "/example/" + Path: /example/ UserEmail: user@example.com UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 UserName: example-user description: The HTTP 200 response (OK). tags: - UserGroup - "/UpdateVm": + /UpdateVm: post: description: |- Modifies the specified attributes of a virtual machine (VM).
@@ -25587,7 +24705,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateVmRequest" + $ref: '#/components/schemas/UpdateVmRequest' examples: ex1: value: @@ -25596,13 +24714,13 @@ paths: ex2: value: VmId: i-12345678 - UserData: "..." + UserData: ... responses: '200': content: application/json: schema: - "$ref": "#/components/schemas/UpdateVmResponse" + $ref: '#/components/schemas/UpdateVmResponse' examples: ex1: value: @@ -25612,7 +24730,7 @@ paths: State: stopped StateReason: '' RootDeviceType: ebs - RootDeviceName: "/dev/sda1" + RootDeviceName: /dev/sda1 IsSourceDestChecked: true KeypairName: keypair-example ImageId: ami-12345678 @@ -25620,7 +24738,7 @@ paths: Architecture: x86_64 NestedVirtualization: false BlockDeviceMappings: - - DeviceName: "/dev/sda1" + - DeviceName: /dev/sda1 Bsu: VolumeId: vol-12345678 State: attached @@ -25683,7 +24801,7 @@ paths: State: stopped StateReason: '' RootDeviceType: ebs - RootDeviceName: "/dev/sda1" + RootDeviceName: /dev/sda1 IsSourceDestChecked: true KeypairName: keypair-example ImageId: ami-12345678 @@ -25691,7 +24809,7 @@ paths: Architecture: x86_64 NestedVirtualization: false BlockDeviceMappings: - - DeviceName: "/dev/sda1" + - DeviceName: /dev/sda1 Bsu: VolumeId: vol-12345678 State: attached @@ -25706,7 +24824,7 @@ paths: ProductCodes: - '0001' CreationDate: '2010-10-01T12:34:56.789Z' - UserData: "..." + UserData: ... SubnetId: subnet-12345678 PrivateIp: 10.0.0.4 SecurityGroups: @@ -25751,23 +24869,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Vm - "/UpdateVmGroup": + /UpdateVmGroup: post: description: |- > [WARNING]
@@ -25779,7 +24897,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateVmGroupRequest" + $ref: '#/components/schemas/UpdateVmGroupRequest' examples: ex1: summary: Updating the name and description of a VM group @@ -25797,7 +24915,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateVmGroupResponse" + $ref: '#/components/schemas/UpdateVmGroupResponse' examples: ex1: value: @@ -25806,7 +24924,7 @@ paths: SecurityGroupIds: - sg-12345678 VmIds: [] - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + CreationDate: 2010-10-01T12:34:56.789+0000 VmCount: 2 VmGroupName: new-name SubnetId: subnet-12345678 @@ -25822,23 +24940,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - VmGroup - "/UpdateVmTemplate": + /UpdateVmTemplate: post: description: |- > [WARNING]
@@ -25850,7 +24968,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateVmTemplateRequest" + $ref: '#/components/schemas/UpdateVmTemplateRequest' examples: ex1: value: @@ -25862,14 +24980,14 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateVmTemplateResponse" + $ref: '#/components/schemas/UpdateVmTemplateResponse' examples: ex1: value: VmTemplate: VmTemplateName: second-name CpuPerformance: high - CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + CreationDate: 2010-10-01T12:34:56.789+0000 CpuCores: 2 Tags: [] Description: The new description of the VM template @@ -25882,19 +25000,21 @@ paths: description: The HTTP 200 response (OK). tags: - VmTemplate - "/UpdateVolume": + /UpdateVolume: post: description: |- Modifies the specified attributes of a volume.
- **[NOTE]**
- When the modification is not instantaneous, the response displays the previous value. You can use the [ReadVolumeUpdateTasks](#readvolumeupdatetasks) method to see the progression of the update. + **[WARNING]**
+ - We recommend creating a snapshot of your volume before updating it, in case any issue occurs during the process. For more information, see [Creating a Snapshot of a Volume](https://docs.outscale.com/en/userguide/Creating-a-Snapshot-of-a-Volume.html). + - Do not shut down or restart the virtual machine (VM) from within the guest operating system while a volume update is in progress. This interrupts the process and compromises the integrity of the volume. + - When the modification is not instantaneous, the response displays the previous value. You can use the [ReadVolumeUpdateTasks](#readvolumeupdatetasks) method to see the progression of the update.
operationId: UpdateVolume requestBody: content: application/json: schema: - "$ref": "#/components/schemas/UpdateVolumeRequest" + $ref: '#/components/schemas/UpdateVolumeRequest' examples: ex1: summary: Updating the size of a volume @@ -25912,7 +25032,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateVolumeResponse" + $ref: '#/components/schemas/UpdateVolumeResponse' examples: ex1: summary: Updating the size of a volume @@ -25951,23 +25071,23 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - Volume - "/UpdateVpnConnection": + /UpdateVpnConnection: post: description: Modifies the specified attributes of a VPN connection. operationId: UpdateVpnConnection @@ -25975,7 +25095,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateVpnConnectionRequest" + $ref: '#/components/schemas/UpdateVpnConnectionRequest' examples: ex1: value: @@ -25987,7 +25107,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/UpdateVpnConnectionResponse" + $ref: '#/components/schemas/UpdateVpnConnectionResponse' examples: ex1: value: @@ -25996,7 +25116,7 @@ paths: TunnelInsideIpRange: 169.254.254.22/30 Routes: [] Tags: [] - ClientGatewayConfiguration: "..." + ClientGatewayConfiguration: ... StaticRoutesOnly: true VirtualGatewayId: vgw-12345678 ConnectionType: ipsec.1 @@ -26015,19 +25135,19 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 400 response (Bad Request). '401': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 401 response (Unauthorized). '500': content: application/json: schema: - "$ref": "#/components/schemas/ErrorResponse" + $ref: '#/components/schemas/ErrorResponse' description: The HTTP 500 response (Internal Server Error). tags: - VpnConnection diff --git a/pyproject.toml b/pyproject.toml index fc24f37..bea2a6e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "osc_sdk_python" -version = "0.38.0" +version = "0.39.0" description = "Outscale Gateway python SDK" authors = [ { name = "Outscal SAS", email = "opensource@outscale.com" } diff --git a/uv.lock b/uv.lock index a7b593d..5059ea7 100644 --- a/uv.lock +++ b/uv.lock @@ -162,7 +162,7 @@ wheels = [ [[package]] name = "osc-sdk-python" -version = "0.38.0" +version = "0.39.0" source = { editable = "." } dependencies = [ { name = "requests" }, @@ -180,7 +180,7 @@ dev = [ [package.metadata] requires-dist = [ { name = "requests", specifier = ">=2.20.0" }, - { name = "ruamel-yaml", specifier = "==0.18.16" }, + { name = "ruamel-yaml", specifier = "==0.19.1" }, { name = "urllib3", specifier = ">=2.0.0" }, ] @@ -275,67 +275,11 @@ wheels = [ [[package]] name = "ruamel-yaml" -version = "0.18.16" +version = "0.19.1" source = { registry = "https://pypi.org/simple" } -dependencies = [ - { name = "ruamel-yaml-clib", marker = "python_full_version < '3.14' and platform_python_implementation == 'CPython'" }, -] -sdist = { url = "https://files.pythonhosted.org/packages/9f/c7/ee630b29e04a672ecfc9b63227c87fd7a37eb67c1bf30fe95376437f897c/ruamel.yaml-0.18.16.tar.gz", hash = "sha256:a6e587512f3c998b2225d68aa1f35111c29fad14aed561a26e73fab729ec5e5a", size = 147269, upload-time = "2025-10-22T17:54:02.346Z" } -wheels = [ - { url = "https://files.pythonhosted.org/packages/0f/73/bb1bc2529f852e7bf64a2dec885e89ff9f5cc7bbf6c9340eed30ff2c69c5/ruamel.yaml-0.18.16-py3-none-any.whl", hash = "sha256:048f26d64245bae57a4f9ef6feb5b552a386830ef7a826f235ffb804c59efbba", size = 119858, upload-time = "2025-10-22T17:53:59.012Z" }, -] - -[[package]] -name = "ruamel-yaml-clib" -version = "0.2.12" -source = { registry = "https://pypi.org/simple" } -sdist = { url = "https://files.pythonhosted.org/packages/20/84/80203abff8ea4993a87d823a5f632e4d92831ef75d404c9fc78d0176d2b5/ruamel.yaml.clib-0.2.12.tar.gz", hash = "sha256:6c8fbb13ec503f99a91901ab46e0b07ae7941cd527393187039aec586fdfd36f", size = 225315, upload-time = "2024-10-20T10:10:56.22Z" } +sdist = { url = "https://files.pythonhosted.org/packages/c7/3b/ebda527b56beb90cb7652cb1c7e4f91f48649fbcd8d2eb2fb6e77cd3329b/ruamel_yaml-0.19.1.tar.gz", hash = "sha256:53eb66cd27849eff968ebf8f0bf61f46cdac2da1d1f3576dd4ccee9b25c31993", size = 142709, upload-time = "2026-01-02T16:50:31.84Z" } wheels = [ - { url = "https://files.pythonhosted.org/packages/70/57/40a958e863e299f0c74ef32a3bde9f2d1ea8d69669368c0c502a0997f57f/ruamel.yaml.clib-0.2.12-cp310-cp310-macosx_13_0_arm64.whl", hash = "sha256:11f891336688faf5156a36293a9c362bdc7c88f03a8a027c2c1d8e0bcde998e5", size = 131301, upload-time = "2024-10-20T10:12:35.876Z" }, - { url = "https://files.pythonhosted.org/packages/98/a8/29a3eb437b12b95f50a6bcc3d7d7214301c6c529d8fdc227247fa84162b5/ruamel.yaml.clib-0.2.12-cp310-cp310-manylinux2014_aarch64.whl", hash = "sha256:a606ef75a60ecf3d924613892cc603b154178ee25abb3055db5062da811fd969", size = 633728, upload-time = "2024-10-20T10:12:37.858Z" }, - { url = "https://files.pythonhosted.org/packages/35/6d/ae05a87a3ad540259c3ad88d71275cbd1c0f2d30ae04c65dcbfb6dcd4b9f/ruamel.yaml.clib-0.2.12-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:fd5415dded15c3822597455bc02bcd66e81ef8b7a48cb71a33628fc9fdde39df", size = 722230, upload-time = "2024-10-20T10:12:39.457Z" }, - { url = "https://files.pythonhosted.org/packages/7f/b7/20c6f3c0b656fe609675d69bc135c03aac9e3865912444be6339207b6648/ruamel.yaml.clib-0.2.12-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f66efbc1caa63c088dead1c4170d148eabc9b80d95fb75b6c92ac0aad2437d76", size = 686712, upload-time = "2024-10-20T10:12:41.119Z" }, - { url = "https://files.pythonhosted.org/packages/cd/11/d12dbf683471f888d354dac59593873c2b45feb193c5e3e0f2ebf85e68b9/ruamel.yaml.clib-0.2.12-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:22353049ba4181685023b25b5b51a574bce33e7f51c759371a7422dcae5402a6", size = 663936, upload-time = "2024-10-21T11:26:37.419Z" }, - { url = "https://files.pythonhosted.org/packages/72/14/4c268f5077db5c83f743ee1daeb236269fa8577133a5cfa49f8b382baf13/ruamel.yaml.clib-0.2.12-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:932205970b9f9991b34f55136be327501903f7c66830e9760a8ffb15b07f05cd", size = 696580, upload-time = "2024-10-21T11:26:39.503Z" }, - { url = "https://files.pythonhosted.org/packages/30/fc/8cd12f189c6405a4c1cf37bd633aa740a9538c8e40497c231072d0fef5cf/ruamel.yaml.clib-0.2.12-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:a52d48f4e7bf9005e8f0a89209bf9a73f7190ddf0489eee5eb51377385f59f2a", size = 663393, upload-time = "2024-12-11T19:58:13.873Z" }, - { url = "https://files.pythonhosted.org/packages/80/29/c0a017b704aaf3cbf704989785cd9c5d5b8ccec2dae6ac0c53833c84e677/ruamel.yaml.clib-0.2.12-cp310-cp310-win32.whl", hash = "sha256:3eac5a91891ceb88138c113f9db04f3cebdae277f5d44eaa3651a4f573e6a5da", size = 100326, upload-time = "2024-10-20T10:12:42.967Z" }, - { url = "https://files.pythonhosted.org/packages/3a/65/fa39d74db4e2d0cd252355732d966a460a41cd01c6353b820a0952432839/ruamel.yaml.clib-0.2.12-cp310-cp310-win_amd64.whl", hash = "sha256:ab007f2f5a87bd08ab1499bdf96f3d5c6ad4dcfa364884cb4549aa0154b13a28", size = 118079, upload-time = "2024-10-20T10:12:44.117Z" }, - { url = "https://files.pythonhosted.org/packages/fb/8f/683c6ad562f558cbc4f7c029abcd9599148c51c54b5ef0f24f2638da9fbb/ruamel.yaml.clib-0.2.12-cp311-cp311-macosx_13_0_arm64.whl", hash = "sha256:4a6679521a58256a90b0d89e03992c15144c5f3858f40d7c18886023d7943db6", size = 132224, upload-time = "2024-10-20T10:12:45.162Z" }, - { url = "https://files.pythonhosted.org/packages/3c/d2/b79b7d695e2f21da020bd44c782490578f300dd44f0a4c57a92575758a76/ruamel.yaml.clib-0.2.12-cp311-cp311-manylinux2014_aarch64.whl", hash = "sha256:d84318609196d6bd6da0edfa25cedfbabd8dbde5140a0a23af29ad4b8f91fb1e", size = 641480, upload-time = "2024-10-20T10:12:46.758Z" }, - { url = "https://files.pythonhosted.org/packages/68/6e/264c50ce2a31473a9fdbf4fa66ca9b2b17c7455b31ef585462343818bd6c/ruamel.yaml.clib-0.2.12-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bb43a269eb827806502c7c8efb7ae7e9e9d0573257a46e8e952f4d4caba4f31e", size = 739068, upload-time = "2024-10-20T10:12:48.605Z" }, - { url = "https://files.pythonhosted.org/packages/86/29/88c2567bc893c84d88b4c48027367c3562ae69121d568e8a3f3a8d363f4d/ruamel.yaml.clib-0.2.12-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:811ea1594b8a0fb466172c384267a4e5e367298af6b228931f273b111f17ef52", size = 703012, upload-time = "2024-10-20T10:12:51.124Z" }, - { url = "https://files.pythonhosted.org/packages/11/46/879763c619b5470820f0cd6ca97d134771e502776bc2b844d2adb6e37753/ruamel.yaml.clib-0.2.12-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:cf12567a7b565cbf65d438dec6cfbe2917d3c1bdddfce84a9930b7d35ea59642", size = 704352, upload-time = "2024-10-21T11:26:41.438Z" }, - { url = "https://files.pythonhosted.org/packages/02/80/ece7e6034256a4186bbe50dee28cd032d816974941a6abf6a9d65e4228a7/ruamel.yaml.clib-0.2.12-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:7dd5adc8b930b12c8fc5b99e2d535a09889941aa0d0bd06f4749e9a9397c71d2", size = 737344, upload-time = "2024-10-21T11:26:43.62Z" }, - { url = "https://files.pythonhosted.org/packages/f0/ca/e4106ac7e80efbabdf4bf91d3d32fc424e41418458251712f5672eada9ce/ruamel.yaml.clib-0.2.12-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:1492a6051dab8d912fc2adeef0e8c72216b24d57bd896ea607cb90bb0c4981d3", size = 714498, upload-time = "2024-12-11T19:58:15.592Z" }, - { url = "https://files.pythonhosted.org/packages/67/58/b1f60a1d591b771298ffa0428237afb092c7f29ae23bad93420b1eb10703/ruamel.yaml.clib-0.2.12-cp311-cp311-win32.whl", hash = "sha256:bd0a08f0bab19093c54e18a14a10b4322e1eacc5217056f3c063bd2f59853ce4", size = 100205, upload-time = "2024-10-20T10:12:52.865Z" }, - { url = "https://files.pythonhosted.org/packages/b4/4f/b52f634c9548a9291a70dfce26ca7ebce388235c93588a1068028ea23fcc/ruamel.yaml.clib-0.2.12-cp311-cp311-win_amd64.whl", hash = "sha256:a274fb2cb086c7a3dea4322ec27f4cb5cc4b6298adb583ab0e211a4682f241eb", size = 118185, upload-time = "2024-10-20T10:12:54.652Z" }, - { url = "https://files.pythonhosted.org/packages/48/41/e7a405afbdc26af961678474a55373e1b323605a4f5e2ddd4a80ea80f628/ruamel.yaml.clib-0.2.12-cp312-cp312-macosx_14_0_arm64.whl", hash = "sha256:20b0f8dc160ba83b6dcc0e256846e1a02d044e13f7ea74a3d1d56ede4e48c632", size = 133433, upload-time = "2024-10-20T10:12:55.657Z" }, - { url = "https://files.pythonhosted.org/packages/ec/b0/b850385604334c2ce90e3ee1013bd911aedf058a934905863a6ea95e9eb4/ruamel.yaml.clib-0.2.12-cp312-cp312-manylinux2014_aarch64.whl", hash = "sha256:943f32bc9dedb3abff9879edc134901df92cfce2c3d5c9348f172f62eb2d771d", size = 647362, upload-time = "2024-10-20T10:12:57.155Z" }, - { url = "https://files.pythonhosted.org/packages/44/d0/3f68a86e006448fb6c005aee66565b9eb89014a70c491d70c08de597f8e4/ruamel.yaml.clib-0.2.12-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:95c3829bb364fdb8e0332c9931ecf57d9be3519241323c5274bd82f709cebc0c", size = 754118, upload-time = "2024-10-20T10:12:58.501Z" }, - { url = "https://files.pythonhosted.org/packages/52/a9/d39f3c5ada0a3bb2870d7db41901125dbe2434fa4f12ca8c5b83a42d7c53/ruamel.yaml.clib-0.2.12-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:749c16fcc4a2b09f28843cda5a193e0283e47454b63ec4b81eaa2242f50e4ccd", size = 706497, upload-time = "2024-10-20T10:13:00.211Z" }, - { url = "https://files.pythonhosted.org/packages/b0/fa/097e38135dadd9ac25aecf2a54be17ddf6e4c23e43d538492a90ab3d71c6/ruamel.yaml.clib-0.2.12-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:bf165fef1f223beae7333275156ab2022cffe255dcc51c27f066b4370da81e31", size = 698042, upload-time = "2024-10-21T11:26:46.038Z" }, - { url = "https://files.pythonhosted.org/packages/ec/d5/a659ca6f503b9379b930f13bc6b130c9f176469b73b9834296822a83a132/ruamel.yaml.clib-0.2.12-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:32621c177bbf782ca5a18ba4d7af0f1082a3f6e517ac2a18b3974d4edf349680", size = 745831, upload-time = "2024-10-21T11:26:47.487Z" }, - { url = "https://files.pythonhosted.org/packages/db/5d/36619b61ffa2429eeaefaab4f3374666adf36ad8ac6330d855848d7d36fd/ruamel.yaml.clib-0.2.12-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:b82a7c94a498853aa0b272fd5bc67f29008da798d4f93a2f9f289feb8426a58d", size = 715692, upload-time = "2024-12-11T19:58:17.252Z" }, - { url = "https://files.pythonhosted.org/packages/b1/82/85cb92f15a4231c89b95dfe08b09eb6adca929ef7df7e17ab59902b6f589/ruamel.yaml.clib-0.2.12-cp312-cp312-win32.whl", hash = "sha256:e8c4ebfcfd57177b572e2040777b8abc537cdef58a2120e830124946aa9b42c5", size = 98777, upload-time = "2024-10-20T10:13:01.395Z" }, - { url = "https://files.pythonhosted.org/packages/d7/8f/c3654f6f1ddb75daf3922c3d8fc6005b1ab56671ad56ffb874d908bfa668/ruamel.yaml.clib-0.2.12-cp312-cp312-win_amd64.whl", hash = "sha256:0467c5965282c62203273b838ae77c0d29d7638c8a4e3a1c8bdd3602c10904e4", size = 115523, upload-time = "2024-10-20T10:13:02.768Z" }, - { url = "https://files.pythonhosted.org/packages/29/00/4864119668d71a5fa45678f380b5923ff410701565821925c69780356ffa/ruamel.yaml.clib-0.2.12-cp313-cp313-macosx_14_0_arm64.whl", hash = "sha256:4c8c5d82f50bb53986a5e02d1b3092b03622c02c2eb78e29bec33fd9593bae1a", size = 132011, upload-time = "2024-10-20T10:13:04.377Z" }, - { url = "https://files.pythonhosted.org/packages/7f/5e/212f473a93ae78c669ffa0cb051e3fee1139cb2d385d2ae1653d64281507/ruamel.yaml.clib-0.2.12-cp313-cp313-manylinux2014_aarch64.whl", hash = "sha256:e7e3736715fbf53e9be2a79eb4db68e4ed857017344d697e8b9749444ae57475", size = 642488, upload-time = "2024-10-20T10:13:05.906Z" }, - { url = "https://files.pythonhosted.org/packages/1f/8f/ecfbe2123ade605c49ef769788f79c38ddb1c8fa81e01f4dbf5cf1a44b16/ruamel.yaml.clib-0.2.12-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:0b7e75b4965e1d4690e93021adfcecccbca7d61c7bddd8e22406ef2ff20d74ef", size = 745066, upload-time = "2024-10-20T10:13:07.26Z" }, - { url = "https://files.pythonhosted.org/packages/e2/a9/28f60726d29dfc01b8decdb385de4ced2ced9faeb37a847bd5cf26836815/ruamel.yaml.clib-0.2.12-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:96777d473c05ee3e5e3c3e999f5d23c6f4ec5b0c38c098b3a5229085f74236c6", size = 701785, upload-time = "2024-10-20T10:13:08.504Z" }, - { url = "https://files.pythonhosted.org/packages/84/7e/8e7ec45920daa7f76046578e4f677a3215fe8f18ee30a9cb7627a19d9b4c/ruamel.yaml.clib-0.2.12-cp313-cp313-musllinux_1_1_i686.whl", hash = "sha256:3bc2a80e6420ca8b7d3590791e2dfc709c88ab9152c00eeb511c9875ce5778bf", size = 693017, upload-time = "2024-10-21T11:26:48.866Z" }, - { url = "https://files.pythonhosted.org/packages/c5/b3/d650eaade4ca225f02a648321e1ab835b9d361c60d51150bac49063b83fa/ruamel.yaml.clib-0.2.12-cp313-cp313-musllinux_1_1_x86_64.whl", hash = "sha256:e188d2699864c11c36cdfdada94d781fd5d6b0071cd9c427bceb08ad3d7c70e1", size = 741270, upload-time = "2024-10-21T11:26:50.213Z" }, - { url = "https://files.pythonhosted.org/packages/87/b8/01c29b924dcbbed75cc45b30c30d565d763b9c4d540545a0eeecffb8f09c/ruamel.yaml.clib-0.2.12-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:4f6f3eac23941b32afccc23081e1f50612bdbe4e982012ef4f5797986828cd01", size = 709059, upload-time = "2024-12-11T19:58:18.846Z" }, - { url = "https://files.pythonhosted.org/packages/30/8c/ed73f047a73638257aa9377ad356bea4d96125b305c34a28766f4445cc0f/ruamel.yaml.clib-0.2.12-cp313-cp313-win32.whl", hash = "sha256:6442cb36270b3afb1b4951f060eccca1ce49f3d087ca1ca4563a6eb479cb3de6", size = 98583, upload-time = "2024-10-20T10:13:09.658Z" }, - { url = "https://files.pythonhosted.org/packages/b0/85/e8e751d8791564dd333d5d9a4eab0a7a115f7e349595417fd50ecae3395c/ruamel.yaml.clib-0.2.12-cp313-cp313-win_amd64.whl", hash = "sha256:e5b8daf27af0b90da7bb903a876477a9e6d7270be6146906b276605997c7e9a3", size = 115190, upload-time = "2024-10-20T10:13:10.66Z" }, - { url = "https://files.pythonhosted.org/packages/e5/46/ccdef7a84ad745c37cb3d9a81790f28fbc9adf9c237dba682017b123294e/ruamel.yaml.clib-0.2.12-cp39-cp39-macosx_12_0_arm64.whl", hash = "sha256:fc4b630cd3fa2cf7fce38afa91d7cfe844a9f75d7f0f36393fa98815e911d987", size = 131834, upload-time = "2024-10-20T10:13:11.72Z" }, - { url = "https://files.pythonhosted.org/packages/29/09/932360f30ad1b7b79f08757e0a6fb8c5392a52cdcc182779158fe66d25ac/ruamel.yaml.clib-0.2.12-cp39-cp39-manylinux2014_aarch64.whl", hash = "sha256:bc5f1e1c28e966d61d2519f2a3d451ba989f9ea0f2307de7bc45baa526de9e45", size = 636120, upload-time = "2024-10-20T10:13:12.84Z" }, - { url = "https://files.pythonhosted.org/packages/a2/2a/5b27602e7a4344c1334e26bf4739746206b7a60a8acdba33a61473468b73/ruamel.yaml.clib-0.2.12-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5a0e060aace4c24dcaf71023bbd7d42674e3b230f7e7b97317baf1e953e5b519", size = 724914, upload-time = "2024-10-20T10:13:14.605Z" }, - { url = "https://files.pythonhosted.org/packages/da/1c/23497017c554fc06ff5701b29355522cff850f626337fff35d9ab352cb18/ruamel.yaml.clib-0.2.12-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:e2f1c3765db32be59d18ab3953f43ab62a761327aafc1594a2a1fbe038b8b8a7", size = 689072, upload-time = "2024-10-20T10:13:15.939Z" }, - { url = "https://files.pythonhosted.org/packages/68/e6/f3d4ff3223f9ea49c3b7169ec0268e42bd49f87c70c0e3e853895e4a7ae2/ruamel.yaml.clib-0.2.12-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:d85252669dc32f98ebcd5d36768f5d4faeaeaa2d655ac0473be490ecdae3c285", size = 667091, upload-time = "2024-10-21T11:26:52.274Z" }, - { url = "https://files.pythonhosted.org/packages/84/62/ead07043527642491e5011b143f44b81ef80f1025a96069b7210e0f2f0f3/ruamel.yaml.clib-0.2.12-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:e143ada795c341b56de9418c58d028989093ee611aa27ffb9b7f609c00d813ed", size = 699111, upload-time = "2024-10-21T11:26:54.294Z" }, - { url = "https://files.pythonhosted.org/packages/52/b3/fe4d84446f7e4887e3bea7ceff0a7df23790b5ed625f830e79ace88ebefb/ruamel.yaml.clib-0.2.12-cp39-cp39-musllinux_1_2_aarch64.whl", hash = "sha256:2c59aa6170b990d8d2719323e628aaf36f3bfbc1c26279c0eeeb24d05d2d11c7", size = 666365, upload-time = "2024-12-11T19:58:20.444Z" }, - { url = "https://files.pythonhosted.org/packages/6e/b3/7feb99a00bfaa5c6868617bb7651308afde85e5a0b23cd187fe5de65feeb/ruamel.yaml.clib-0.2.12-cp39-cp39-win32.whl", hash = "sha256:beffaed67936fbbeffd10966a4eb53c402fafd3d6833770516bf7314bc6ffa12", size = 100863, upload-time = "2024-10-20T10:13:17.244Z" }, - { url = "https://files.pythonhosted.org/packages/93/07/de635108684b7a5bb06e432b0930c5a04b6c59efe73bd966d8db3cc208f2/ruamel.yaml.clib-0.2.12-cp39-cp39-win_amd64.whl", hash = "sha256:040ae85536960525ea62868b642bdb0c2cc6021c9f9d507810c0c604e66f5a7b", size = 118653, upload-time = "2024-10-20T10:13:18.289Z" }, + { url = "https://files.pythonhosted.org/packages/b8/0c/51f6841f1d84f404f92463fc2b1ba0da357ca1e3db6b7fbda26956c3b82a/ruamel_yaml-0.19.1-py3-none-any.whl", hash = "sha256:27592957fedf6e0b62f281e96effd28043345e0e66001f97683aa9a40c667c93", size = 118102, upload-time = "2026-01-02T16:50:29.201Z" }, ] [[package]]