osc-sdk-rust v1.10.0

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

Hide file tree

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

diff --git a/api_version b/api_version
@@ -1 +1 @@
-1.28.7
+1.30.0
diff --git a/docs/AccessKey.md b/docs/AccessKey.md
@@ -5,9 +5,9 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **access_key_id** | Option<**String**> | The ID of the access key. | [optional]
-**creation_date** | Option<**String**> | The date and time (UTC) of creation of the access key. | [optional]
-**expiration_date** | Option<**String**> | The date (UTC) at which the access key expires. | [optional]
-**last_modification_date** | Option<**String**> | The date and time (UTC) of the last modification of the access key. | [optional]
+**creation_date** | Option<**String**> | The date and time (UTC) at which the access key was created. | [optional]
+**expiration_date** | Option<**String**> | The date and time (UTC) at which the access key expires. | [optional]
+**last_modification_date** | Option<**String**> | The date and time (UTC) at which the access key was last modified. | [optional]
 **state** | Option<**String**> | The state of the access key (`ACTIVE` if the key is valid for API calls, or `INACTIVE` if not). | [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/AccessKeySecretKey.md b/docs/AccessKeySecretKey.md
@@ -5,10 +5,10 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **access_key_id** | Option<**String**> | The ID of the access key. | [optional]
-**creation_date** | Option<**String**> | The date and time (UTC) of creation of the access key. | [optional]
+**creation_date** | Option<**String**> | The date and time (UTC) at which the access key was created. | [optional]
 **expiration_date** | Option<**String**> | The date and time (UTC) at which the access key expires. | [optional]
-**last_modification_date** | Option<**String**> | The date and time (UTC) of the last modification of the access key. | [optional]
-**secret_key** | Option<**String**> | The access key that enables you to send requests. | [optional]
+**last_modification_date** | Option<**String**> | The date and time (UTC) at which the access key was last modified. | [optional]
+**secret_key** | Option<**String**> | The secret key that enables you to send requests. | [optional]
 **state** | Option<**String**> | The state of the access key (`ACTIVE` if the key is valid for API calls, or `INACTIVE` if not). | [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/AddUserToUserGroupRequest.md b/docs/AddUserToUserGroupRequest.md
@@ -0,0 +1,15 @@
+# AddUserToUserGroupRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**dry_run** | Option<**bool**> | If true, checks whether you have the required permissions to perform the action. | [optional]
+**user_group_name** | **String** | The name of the group you want to add a user to. | 
+**user_group_path** | Option<**String**> | The path to the group. If not specified, it is set to a slash (`/`). | [optional]
+**user_name** | **String** | The name of the user you want to add to the group. | 
+**user_path** | Option<**String**> | The path to the user. If not specified, it is set to a slash (`/`). | [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/Phase2OptionsToUpdate.md → docs/AddUserToUserGroupResponse.md b/docs/Phase2OptionsToUpdate.md → docs/AddUserToUserGroupResponse.md
@@ -1,10 +1,10 @@
-# Phase2OptionsToUpdate
+# AddUserToUserGroupResponse
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**pre_shared_key** | Option<**String**> | 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 (&quot;). | [optional]
+**response_context** | Option<[**crate::models::ResponseContext**](ResponseContext.md)> |  | [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/ApiAccessRule.md b/docs/ApiAccessRule.md
@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**api_access_rule_id** | Option<**String**> |  The ID of the API access rule. | [optional]
+**api_access_rule_id** | Option<**String**> | The ID of the API access rule. | [optional]
 **ca_ids** | Option<**Vec<String>**> | One or more IDs of Client Certificate Authorities (CAs) used for the API access rule. | [optional]
 **cns** | Option<**Vec<String>**> | One or more Client Certificate Common Names (CNs). | [optional]
 **description** | Option<**String**> | The description of the API access rule. | [optional]

diff --git a/docs/BackendVmHealth.md b/docs/BackendVmHealth.md
@@ -4,10 +4,10 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**description** | Option<**String**> | The description of the state of the back-end VM. | [optional]
-**state** | Option<**String**> | The state of the back-end VM (`InService` \\| `OutOfService` \\| `Unknown`). | [optional]
+**description** | Option<**String**> | The description of the state of the backend VM. | [optional]
+**state** | Option<**String**> | The state of the backend VM (`InService` \\| `OutOfService` \\| `Unknown`). | [optional]
 **state_reason** | Option<**String**> | Information about the cause of `OutOfService` VMs.<br /> Specifically, whether the cause is Elastic Load Balancing or the VM (`ELB` \\| `Instance` \\| `N/A`). | [optional]
-**vm_id** | Option<**String**> | The ID of the back-end VM. | [optional]
+**vm_id** | Option<**String**> | The ID of the backend VM. | [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/BsuCreated.md b/docs/BsuCreated.md
@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **delete_on_vm_deletion** | Option<**bool**> | If true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM. | [optional]
-**link_date** | Option<[**String**](string.md)> | The date and time of attachment of the volume to the VM, in ISO 8601 date-time format. | [optional]
+**link_date** | Option<[**String**](string.md)> | The date and time (UTC) at which the volume was attached to the VM, in ISO 8601 date-time format. | [optional]
 **state** | Option<**String**> | The state of the volume. | [optional]
 **volume_id** | Option<**String**> | The ID of the volume. | [optional]
 

diff --git a/docs/Catalogs.md b/docs/Catalogs.md
@@ -5,9 +5,9 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **entries** | Option<[**Vec<crate::models::CatalogEntry>**](CatalogEntry.md)> | One or more catalog entries. | [optional]
-**from_date** | Option<**String**> | The beginning of the time period, in ISO 8601 date-time format. | [optional]
+**from_date** | Option<**String**> | The beginning of the time period (UTC). | [optional]
 **state** | Option<**String**> | The state of the catalog (`CURRENT` \\| `OBSOLETE`). | [optional]
-**to_date** | Option<**String**> | The end of the time period, in ISO 8601 date-time format. | [optional]
+**to_date** | Option<**String**> | The end of the time period (UTC). | [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/ClientGateway.md b/docs/ClientGateway.md
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **bgp_asn** | Option<**i32**> | The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your client gateway through the Internet. | [optional]
 **client_gateway_id** | Option<**String**> | The ID of the client gateway. | [optional]
-**connection_type** | Option<**String**> | The type of communication tunnel used by the client gateway (only `ipsec.1` is supported). | [optional]
+**connection_type** | Option<**String**> | The type of communication tunnel used by the client gateway (always `ipsec.1`). | [optional]
 **public_ip** | Option<**String**> | The public IPv4 address of the client gateway (must be a fixed address into a NATed network). | [optional]
 **state** | Option<**String**> | The state of the client gateway (`pending` \\| `available` \\| `deleting` \\| `deleted`). | [optional]
 **tags** | Option<[**Vec<crate::models::ResourceTag>**](ResourceTag.md)> | One or more tags associated with the client gateway. | [optional]

diff --git a/docs/ConsumptionEntry.md b/docs/ConsumptionEntry.md
@@ -6,14 +6,14 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **account_id** | Option<**String**> | The ID of your TINA account. | [optional]
 **category** | Option<**String**> | The category of the resource (for example, `network`). | [optional]
-**from_date** | Option<**String**> | The beginning of the time period, in ISO 8601 date-time format. | [optional]
+**from_date** | Option<**String**> | The beginning of the time period (UTC). | [optional]
 **operation** | Option<**String**> | The API call that triggered the resource consumption (for example, `RunInstances` or `CreateVolume`). | [optional]
 **paying_account_id** | Option<**String**> | The ID of the TINA account which is billed for your consumption. It can be different from your account in the `AccountId` parameter. | [optional]
 **price** | Option<**f64**> | The total price of the consumed resource during the specified time period, in the currency of the Region's catalog. | [optional]
 **service** | Option<**String**> | The service of the API call (`TinaOS-FCU`, `TinaOS-LBU`, `TinaOS-DirectLink`, `TinaOS-OOS`, or `TinaOS-OSU`). | [optional]
 **subregion_name** | Option<**String**> | The name of the Subregion. | [optional]
 **title** | Option<**String**> | A description of the consumed resource. | [optional]
-**to_date** | Option<**String**> | The end of the time period, in ISO 8601 date-time format. | [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]
 **value** | Option<**f64**> | The consumed amount for the resource. The unit depends on the resource type. For more information, see the `Title` element. | [optional]

diff --git a/docs/CreateApiAccessRuleRequest.md b/docs/CreateApiAccessRuleRequest.md
@@ -4,11 +4,11 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**ca_ids** | Option<**Vec<String>**> |  One or more IDs of Client Certificate Authorities (CAs). | [optional]
+**ca_ids** | Option<**Vec<String>**> | One or more IDs of Client Certificate Authorities (CAs). | [optional]
 **cns** | Option<**Vec<String>**> | One or more Client Certificate Common Names (CNs). If this parameter is specified, you must also specify the `CaIds` parameter. | [optional]
 **description** | Option<**String**> | A description for the API access rule. | [optional]
 **dry_run** | Option<**bool**> | If true, checks whether you have the required permissions to perform the action. | [optional]
-**ip_ranges** | Option<**Vec<String>**> | One or more IP addresses or CIDR blocks (for example, `192.0.2.0/16`). | [optional]
+**ip_ranges** | Option<**Vec<String>**> | One or more IPs or CIDR blocks (for example, `192.0.2.0/16`). | [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/CreateClientGatewayRequest.md b/docs/CreateClientGatewayRequest.md
@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **bgp_asn** | **i32** | The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your client gateway through the Internet. <br/> This number must be between `1` and `4294967295`. If you do not have an ASN, you can choose one between 64512 and 65534, or between 4200000000 and 4294967294. | 
-**connection_type** | **String** | The communication protocol used to establish tunnel with your client gateway (only `ipsec.1` is supported). | 
+**connection_type** | **String** | The communication protocol used to establish tunnel with your client gateway (always `ipsec.1`). | 
 **dry_run** | Option<**bool**> | If true, checks whether you have the required permissions to perform the action. | [optional]
 **public_ip** | **String** | The public fixed IPv4 address of your client gateway. | 
 

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 name of the policy. This name must be unique and consist of 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 (32 alphanumeric or hyphen characters maximum, but cannot start or end with a hyphen). | 
+**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/CreateNatServiceRequest.md b/docs/CreateNatServiceRequest.md
@@ -4,6 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**client_token** | Option<**String**> | A unique identifier which enables you to manage the idempotency. | [optional]
 **dry_run** | Option<**bool**> | If true, checks whether you have the required permissions to perform the action. | [optional]
 **public_ip_id** | **String** | The allocation ID of the public IP to associate with the NAT service.<br /> If the public IP is already associated with another resource, you must first disassociate it. | 
 **subnet_id** | **String** | The ID of the Subnet in which you want to create the NAT service. | 

diff --git a/docs/CreatePolicyRequest.md b/docs/CreatePolicyRequest.md
@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **description** | Option<**String**> | A description for the policy. | [optional]
-**document** | **String** | 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). | 
+**document** | **String** | 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). | 
 **dry_run** | Option<**bool**> | If true, checks whether you have the required permissions to perform the action. | [optional]
 **path** | Option<**String**> | The path of the policy. | [optional]
 **policy_name** | **String** | The name of the policy. | 

diff --git a/docs/CreatePolicyVersionRequest.md b/docs/CreatePolicyVersionRequest.md
@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**document** | **String** | 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). | 
+**document** | **String** | 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). | 
 **policy_orn** | **String** | The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). | 
 **set_as_default** | Option<**bool**> | If set to true, the new policy version is set as the default version and becomes the operative one. | [optional]
 

diff --git a/docs/CreateServerCertificateRequest.md b/docs/CreateServerCertificateRequest.md
@@ -4,12 +4,12 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**body** | **String** | The PEM-encoded X509 certificate.<br />With OSC CLI, use the following syntax to make sure your CA file is correctly parsed: `--CaPem=&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 CA file is correctly parsed: `--CaPem=&quot;$(cat FILENAME)&quot;`. | [optional]
+**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]
-**private_key** | **String** | The PEM-encoded private key matching the certificate.<br />With OSC CLI, use the following syntax to make sure your CA file is correctly parsed: `--CaPem=&quot;$(cat FILENAME)&quot;`. | 
+**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)