osc-sdk-rust v1.11.0

Signed-off-by: Outscale Bot <[email protected]>
outscale · Oct 1, 2024 · 9b95f81 · 9b95f81
1 parent 1bd9a7a
commit 9b95f81
Show file tree

Hide file tree

Showing 732 changed files with 2,116 additions and 1,431 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "outscale_api"
-version = "1.10.0"
+version = "1.11.0"
 authors = ["Outscale SAS <[email protected]>"]
 edition = "2021"
 license = "BSD-3-Clause"

diff --git a/api_version b/api_version
@@ -1 +1 @@
-1.30.0
+v1.33.1
diff --git a/docs/CatalogApi.md b/docs/CatalogApi.md
@@ -6,6 +6,7 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**read_catalog**](CatalogApi.md#read_catalog) | **POST** /ReadCatalog | 
 [**read_catalogs**](CatalogApi.md#read_catalogs) | **POST** /ReadCatalogs | 
+[**read_unit_price**](CatalogApi.md#read_unit_price) | **POST** /ReadUnitPrice | 
 
 
 
@@ -64,3 +65,31 @@ Name | Type | Description  | Required | Notes
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+
+## read_unit_price
+
+> crate::models::ReadUnitPriceResponse read_unit_price(read_unit_price_request)
+
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**read_unit_price_request** | Option<[**ReadUnitPriceRequest**](ReadUnitPriceRequest.md)> |  |  |
+
+### Return type
+
+[**crate::models::ReadUnitPriceResponse**](ReadUnitPriceResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
diff --git a/docs/CatalogEntry.md b/docs/CatalogEntry.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **subregion_name** | Option<**String**> | The Subregion associated with the catalog entry. | [optional]
 **title** | Option<**String**> | The description of the catalog entry. | [optional]
 **_type** | Option<**String**> | The type of resource associated with the catalog entry. | [optional]
-**unit_price** | Option<**f32**> | The unit price of the catalog entry, in the currency of the Region's catalog. | [optional]
+**unit_price** | Option<**f32**> | The unit price of the catalog entry in the currency of your account, in the ISO-4217 format (for example, `EUR`). | [optional]
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/ConsumptionEntry.md b/docs/ConsumptionEntry.md
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
 **title** | Option<**String**> | A description of the consumed resource. | [optional]
 **to_date** | Option<**String**> | The end of the time period (UTC). | [optional]
 **_type** | Option<**String**> | The type of resource, depending on the API call. | [optional]
-**unit_price** | Option<**f64**> | The unit price of the consumed resource, in the currency of the Region's catalog. | [optional]
+**unit_price** | Option<**f64**> | The unit price of the consumed resource in the currency of your account, in the ISO-4217 format (for example, `EUR`). | [optional]
 **value** | Option<**f64**> | The consumed amount for the resource. The unit depends on the resource type. For more information, see the `Title` element. | [optional]
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

diff --git a/docs/CreateImageRequest.md b/docs/CreateImageRequest.md
@@ -4,15 +4,15 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**architecture** | Option<**String**> | **(when registering from a snapshot, or from a bucket without using a manifest file)** The architecture of the OMI (`i386` or `x86_64`). | [optional]
-**block_device_mappings** | Option<[**Vec<crate::models::BlockDeviceMappingImage>**](BlockDeviceMappingImage.md)> | **(when registering from a snapshot, or from a bucket without using a manifest file)** One or more block device mappings. | [optional]
+**architecture** | Option<**String**> | **(when registering from a snapshot)** The architecture of the OMI (`i386` or `x86_64`). | [optional]
+**block_device_mappings** | Option<[**Vec<crate::models::BlockDeviceMappingImage>**](BlockDeviceMappingImage.md)> | **(when registering from a snapshot)** One or more block device mappings. | [optional]
 **description** | Option<**String**> | A description for the new OMI. | [optional]
 **dry_run** | Option<**bool**> | If true, checks whether you have the required permissions to perform the action. | [optional]
-**file_location** | Option<**String**> | **(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 [Configuring a Pre-signed URL](https://docs.outscale.com/en/userguide/Configuring-a-Pre-signed-URL.html) or [Managing Access to Your Buckets and Objects](https://docs.outscale.com/en/userguide/Managing-Access-to-Your-Buckets-and-Objects.html).<br /> You can also specify the normal URL of the OMI if you have permission on the OOS bucket, without using the manifest file, but in that case, you need to manually specify through the other parameters all the information that would otherwise be read from the manifest file. | [optional]
+**file_location** | Option<**String**> | **(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). | [optional]
 **image_name** | Option<**String**> | A unique name for the new OMI.<br /> Constraints: 3-128 alphanumeric characters, underscores (`_`), spaces (` `), parentheses (`()`), slashes (`/`), periods (`.`), or dashes (`-`). | [optional]
 **no_reboot** | Option<**bool**> | **(when creating from a VM)** If false, the VM shuts down before creating the OMI and then reboots. If true, the VM does not. | [optional]
 **product_codes** | Option<**Vec<String>**> | The product codes associated with the OMI. | [optional]
-**root_device_name** | Option<**String**> | **(when registering from a snapshot, or from a bucket without using a manifest file)** The name of the root device for the new OMI. | [optional]
+**root_device_name** | Option<**String**> | **(when registering from a snapshot)** The name of the root device for the new OMI. | [optional]
 **source_image_id** | Option<**String**> | **(when copying an OMI)** The ID of the OMI you want to copy. | [optional]
 **source_region_name** | Option<**String**> | **(when copying an OMI)** The name of the source Region (always the same as the Region of your account). | [optional]
 **vm_id** | Option<**String**> | **(when creating from a VM)** The ID of the VM from which you want to create the OMI. | [optional]

diff --git a/docs/CreateLoadBalancerPolicyRequest.md b/docs/CreateLoadBalancerPolicyRequest.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **cookie_name** | Option<**String**> | 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. | [optional]
 **dry_run** | Option<**bool**> | If true, checks whether you have the required permissions to perform the action. | [optional]
 **load_balancer_name** | **String** | The name of the load balancer for which you want to create a policy. | 
-**policy_name** | **String** | The unique name of the policy, with a maximum length of 32 alphanumeric characters and dashes (-). | 
+**policy_name** | **String** | The unique name of the policy, with a maximum length of 32 alphanumeric characters and dashes (`-`). | 
 **policy_type** | **String** | The type of stickiness policy you want to create: `app` or `load_balancer`. | 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

diff --git a/docs/CreateLoadBalancerRequest.md b/docs/CreateLoadBalancerRequest.md
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **dry_run** | Option<**bool**> | If true, checks whether you have the required permissions to perform the action. | [optional]
 **listeners** | [**Vec<crate::models::ListenerForCreation>**](ListenerForCreation.md) | One or more listeners to create. | 
-**load_balancer_name** | **String** | 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. | 
+**load_balancer_name** | **String** | 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. | 
 **load_balancer_type** | Option<**String**> | The type of load balancer: `internet-facing` or `internal`. Use this parameter only for load balancers in a Net. | [optional]
 **public_ip** | Option<**String**> | (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. | [optional]
 **security_groups** | Option<**Vec<String>**> | (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. | [optional]

diff --git a/docs/CreateNetPeeringRequest.md b/docs/CreateNetPeeringRequest.md
@@ -5,6 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **accepter_net_id** | **String** | The ID of the Net you want to connect with. | 
+**accepter_owner_id** | Option<**String**> | The account ID of the owner of the Net you want to connect with. By default, the account ID of the owner of the Net from which the peering request is sent. | [optional]
 **dry_run** | Option<**bool**> | If true, checks whether you have the required permissions to perform the action. | [optional]
 **source_net_id** | **String** | The ID of the Net you send the peering request from. | 
 

diff --git a/docs/CreateServerCertificateRequest.md b/docs/CreateServerCertificateRequest.md
@@ -7,8 +7,8 @@ Name | Type | Description | Notes
 **body** | **String** | The PEM-encoded X509 certificate.<br />With OSC CLI, use the following syntax to make sure your certificate file is correctly parsed: `--Body=&quot;$(cat FILENAME)&quot;`. | 
 **chain** | Option<**String**> | The PEM-encoded intermediate certification authorities.<br />With OSC CLI, use the following syntax to make sure your certificate chain file is correctly parsed: `--Chain=&quot;$(cat FILENAME)&quot;`. | [optional]
 **dry_run** | Option<**bool**> | If true, checks whether you have the required permissions to perform the action. | [optional]
-**name** | **String** | A unique name for the certificate. Constraints: 1-128 alphanumeric characters, pluses (+), equals (=), commas (,), periods (.), at signs (@), minuses (-), or underscores (_). | 
-**path** | Option<**String**> | The path to the server certificate, set to a slash (/) if not specified. | [optional]
+**name** | **String** | A unique name for the certificate. Constraints: 1-128 alphanumeric characters, pluses (`+`), equals (`=`), commas (`,`), periods (`.`), at signs (`@`), minuses (`-`), or underscores (`_`). | 
+**path** | Option<**String**> | The path to the server certificate, set to a slash (`/`) if not specified. | [optional]
 **private_key** | **String** | The PEM-encoded private key matching the certificate.<br />With OSC CLI, use the following syntax to make sure your key file is correctly parsed: `--PrivateKey=&quot;$(cat FILENAME)&quot;`. | 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

diff --git a/docs/CreateSnapshotRequest.md b/docs/CreateSnapshotRequest.md
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **description** | Option<**String**> | A description for the snapshot. | [optional]
 **dry_run** | Option<**bool**> | If true, checks whether you have the required permissions to perform the action. | [optional]
-**file_location** | Option<**String**> | **(when importing from a bucket)** The pre-signed URL of the snapshot you want to import, or the normal URL of the snapshot if you have permission on the OOS bucket. For more information, see [Configuring a Pre-signed URL](https://docs.outscale.com/en/userguide/Configuring-a-Pre-signed-URL.html) or [Managing Access to Your Buckets and Objects](https://docs.outscale.com/en/userguide/Managing-Access-to-Your-Buckets-and-Objects.html). | [optional]
+**file_location** | Option<**String**> | **(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). | [optional]
 **snapshot_size** | Option<**i64**> | **(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. | [optional]
 **source_region_name** | Option<**String**> | **(when copying a snapshot)** The name of the source Region, which must be the same as the Region of your account. | [optional]
 **source_snapshot_id** | Option<**String**> | **(when copying a snapshot)** The ID of the snapshot you want to copy. | [optional]

diff --git a/docs/CreateUserRequest.md b/docs/CreateUserRequest.md
@@ -5,8 +5,9 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **dry_run** | Option<**bool**> | If true, checks whether you have the required permissions to perform the action. | [optional]
-**path** | Option<**String**> | 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 (_). | [optional]
-**user_name** | **String** | 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 (_). | 
+**path** | Option<**String**> | 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 (`_`). | [optional]
+**user_email** | Option<**String**> | The email address of the EIM user. | [optional]
+**user_name** | **String** | 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 (`_`). | 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/CreateVmsRequest.md b/docs/CreateVmsRequest.md
@@ -22,7 +22,7 @@ Name | Type | Description | Notes
 **security_group_ids** | Option<**Vec<String>**> | One or more IDs of security group for the VMs. | [optional]
 **security_groups** | Option<**Vec<String>**> | One or more names of security groups for the VMs. | [optional]
 **subnet_id** | Option<**String**> | 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. | [optional]
-**user_data** | Option<**String**> | Data or script used to add a specific configuration to the VM. It must be Base64-encoded and is limited to 500 kibibytes (KiB). | [optional]
+**user_data** | Option<**String**> | 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). | [optional]
 **vm_initiated_shutdown_behavior** | Option<**String**> | The VM behavior when you stop it. By default or 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. | [optional][default to stop]
 **vm_type** | Option<**String**> | The type of VM. You can specify a TINA type (in the `tinavW.cXrYpZ` or `tinavW.cXrY` format), or an AWS type (for example, `t2.small`, which is the default value).<br /> If you specify an AWS type, it is converted in the background to its corresponding TINA type, but the AWS type is still returned. If the specified or converted TINA type includes a performance flag, this performance flag is applied regardless of the value you may have provided in the `Performance` parameter. For more information, see [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html). | [optional]
 

diff --git a/docs/FiltersUsers.md b/docs/FiltersUsers.md
@@ -0,0 +1,11 @@
+# FiltersUsers
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_ids** | Option<**Vec<String>**> | The IDs of the users. | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/FiltersVm.md b/docs/FiltersVm.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **block_device_mapping_states** | Option<**Vec<String>**> | The states for the BSU volumes (`attaching` \\| `attached` \\| `detaching` \\| `detached`). | [optional]
 **block_device_mapping_volume_ids** | Option<**Vec<String>**> | The volume IDs of the BSU volumes. | [optional]
 **client_tokens** | Option<**Vec<String>**> | The idempotency tokens provided when launching the VMs. | [optional]
-**creation_dates** | Option<[**Vec<String>**](string.md)> | The dates when the VMs were launched. | [optional]
+**creation_dates** | Option<**Vec<String>**> | The dates when the VMs were launched. | [optional]
 **image_ids** | Option<**Vec<String>**> | The IDs of the OMIs used to launch the VMs. | [optional]
 **is_source_dest_checked** | Option<**bool**> | Whether the source/destination checking is enabled (true) or disabled (false). | [optional]
 **keypair_names** | Option<**Vec<String>**> | The names of the keypairs used when launching the VMs. | [optional]

diff --git a/docs/ListenerRule.md b/docs/ListenerRule.md
@@ -5,11 +5,11 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **action** | Option<**String**> | The type of action for the rule (always `forward`). | [optional]
-**host_name_pattern** | Option<**String**> | 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 [-.?]. | [optional]
+**host_name_pattern** | Option<**String**> | 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 `-.?`. | [optional]
 **listener_id** | Option<**i32**> | The ID of the listener. | [optional]
 **listener_rule_id** | Option<**i32**> | The ID of the listener rule. | [optional]
 **listener_rule_name** | Option<**String**> | A human-readable name for the listener rule. | [optional]
-**path_pattern** | Option<**String**> | 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 [_-.$/~&quot;'@:+?]. | [optional]
+**path_pattern** | Option<**String**> | 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 `_-.$/~&quot;'@:+?`. | [optional]
 **priority** | Option<**i32**> | 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. | [optional]
 **vm_ids** | Option<**Vec<String>**> | The IDs of the backend VMs. | [optional]