Skip to content

Commit

Permalink
osc-sdk-rust v1.12.0
Browse files Browse the repository at this point in the history
Signed-off-by: Outscale Bot <[email protected]>
Signed-off-by: Thiery Ouattara <[email protected]>
  • Loading branch information
Open-Source-Bot authored and jfbus committed Jan 21, 2025
1 parent 9b95f81 commit f14104d
Show file tree
Hide file tree
Showing 699 changed files with 1,627 additions and 1,583 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "outscale_api"
version = "1.11.0"
version = "1.12.0"
authors = ["Outscale SAS <[email protected]>"]
edition = "2021"
license = "BSD-3-Clause"
Expand Down
2 changes: 1 addition & 1 deletion api_version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v1.33.1
v1.34.0
29 changes: 0 additions & 29 deletions docs/AccessKeyApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ Method | HTTP request | Description
[**create_access_key**](AccessKeyApi.md#create_access_key) | **POST** /CreateAccessKey |
[**delete_access_key**](AccessKeyApi.md#delete_access_key) | **POST** /DeleteAccessKey |
[**read_access_keys**](AccessKeyApi.md#read_access_keys) | **POST** /ReadAccessKeys |
[**read_secret_access_key**](AccessKeyApi.md#read_secret_access_key) | **POST** /ReadSecretAccessKey |
[**update_access_key**](AccessKeyApi.md#update_access_key) | **POST** /UpdateAccessKey |


Expand Down Expand Up @@ -96,34 +95,6 @@ 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_secret_access_key

> crate::models::ReadSecretAccessKeyResponse read_secret_access_key(read_secret_access_key_request)

### Parameters


Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**read_secret_access_key_request** | Option<[**ReadSecretAccessKeyRequest**](ReadSecretAccessKeyRequest.md)> | | |

### Return type

[**crate::models::ReadSecretAccessKeyResponse**](ReadSecretAccessKeyResponse.md)

### Authorization

[ApiKeyAuthSec](../README.md#ApiKeyAuthSec), [BasicAuth](../README.md#BasicAuth)

### 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)


## update_access_key

> crate::models::UpdateAccessKeyResponse update_access_key(update_access_key_request)
Expand Down
2 changes: 1 addition & 1 deletion docs/CreateClientGatewayRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,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. |
**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`, except `50624`, `53306`, and `132418`. <br/> If you do not have an ASN, you can choose one between `64512` and `65534` (both included), or between `4200000000` and `4294967295` (both included). |
**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. |
Expand Down
16 changes: 8 additions & 8 deletions docs/CreateImageRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,18 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**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]
**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)> | **(required) 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 [Creating a Pre-signed URL](https://docs.outscale.com/en/userguide/Creating-a-Pre-Signed-URL.html). | [optional]
**file_location** | Option<**String**> | **(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). | [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]
**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)** 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]
**root_device_name** | Option<**String**> | **(required) When registering from a snapshot:** The name of the root device for the new OMI. | [optional]
**source_image_id** | Option<**String**> | **(required) When copying an OMI:** The ID of the OMI you want to copy. | [optional]
**source_region_name** | Option<**String**> | **(required) When copying an OMI:** The name of the source Region (always the same as the Region of your account). | [optional]
**vm_id** | Option<**String**> | **(required) When creating from a VM:** The ID of the VM from which you want to create the OMI. | [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)

Expand Down
4 changes: 2 additions & 2 deletions docs/CreateNetPeeringRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

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]
**accepter_net_id** | **String** | The ID of the Net you want to connect with. <br/ > <br/ > If the Net does not belong to you, you must also specify the `AccepterOwnerId` parameter with the account ID owning 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. <br /><br/ > This parameter is required if the Net you want to connect with does not belong to you. | [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. |

Expand Down
2 changes: 1 addition & 1 deletion docs/CreatePolicyRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html). |
**document** | **String** | 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). |
**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. |
Expand Down
2 changes: 1 addition & 1 deletion docs/CreatePolicyVersionRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html). |
**document** | **String** | 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). |
**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]

Expand Down
2 changes: 1 addition & 1 deletion docs/CreateRouteRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**destination_ip_range** | **String** | The IP range used for the destination match, in CIDR notation (for example, `10.0.0.0/24`). |
**dry_run** | Option<**bool**> | If true, checks whether you have the required permissions to perform the action. | [optional]
**gateway_id** | Option<**String**> | The ID of an Internet service or virtual gateway attached to your Net. | [optional]
**gateway_id** | Option<**String**> | The ID of an internet service or virtual gateway attached to your Net. | [optional]
**nat_service_id** | Option<**String**> | The ID of a NAT service. | [optional]
**net_peering_id** | Option<**String**> | The ID of a Net peering. | [optional]
**nic_id** | Option<**String**> | The ID of a NIC. | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/DeleteInternetServiceRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**dry_run** | Option<**bool**> | If true, checks whether you have the required permissions to perform the action. | [optional]
**internet_service_id** | **String** | The ID of the Internet service you want to delete. |
**internet_service_id** | **String** | The ID of the internet service you want to delete. |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
3 changes: 2 additions & 1 deletion docs/DeleteKeypairRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**dry_run** | Option<**bool**> | If true, checks whether you have the required permissions to perform the action. | [optional]
**keypair_name** | **String** | The name of the keypair you want to delete. |
**keypair_id** | Option<**String**> | The ID of the keypair you want to delete. | [optional]
**keypair_name** | Option<**String**> | The name of the keypair you want to delete. | [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)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# ReadSecretAccessKeyRequest
# DeleteProductTypeRequest

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_key_id** | **String** | The ID of the access key. |
**dry_run** | Option<**bool**> | If true, checks whether you have the required permissions to perform the action. | [optional]
**force** | Option<**bool**> | If true, forces the deletion of the product type associated with one or more OMIs. | [optional]
**product_type_id** | **String** | The ID of the product type you want to delete. |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
# ReadSecretAccessKeyResponse
# DeleteProductTypeResponse

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_key** | Option<[**crate::models::AccessKeySecretKey**](AccessKeySecretKey.md)> | | [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)
Expand Down
12 changes: 6 additions & 6 deletions docs/FiltersInternetService.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**internet_service_ids** | Option<**Vec<String>**> | The IDs of the Internet services. | [optional]
**link_net_ids** | Option<**Vec<String>**> | The IDs of the Nets the Internet services are attached to. | [optional]
**link_states** | Option<**Vec<String>**> | The current states of the attachments between the Internet services and the Nets (only `available`, if the Internet gateway is attached to a Net). | [optional]
**tag_keys** | Option<**Vec<String>**> | The keys of the tags associated with the Internet services. | [optional]
**tag_values** | Option<**Vec<String>**> | The values of the tags associated with the Internet services. | [optional]
**tags** | Option<**Vec<String>**> | The key/value combination of the tags associated with the Internet services, in the following format: &quot;Filters&quot;:{&quot;Tags&quot;:[&quot;TAGKEY=TAGVALUE&quot;]}. | [optional]
**internet_service_ids** | Option<**Vec<String>**> | The IDs of the internet services. | [optional]
**link_net_ids** | Option<**Vec<String>**> | The IDs of the Nets the internet services are attached to. | [optional]
**link_states** | Option<**Vec<String>**> | The current states of the attachments between the internet services and the Nets (only `available`, if the internet gateway is attached to a Net). | [optional]
**tag_keys** | Option<**Vec<String>**> | The keys of the tags associated with the internet services. | [optional]
**tag_values** | Option<**Vec<String>**> | The values of the tags associated with the internet services. | [optional]
**tags** | Option<**Vec<String>**> | The key/value combination of the tags associated with the internet services, in the following format: &quot;Filters&quot;:{&quot;Tags&quot;:[&quot;TAGKEY=TAGVALUE&quot;]}. | [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)

Expand Down
4 changes: 4 additions & 0 deletions docs/FiltersKeypair.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,12 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**keypair_fingerprints** | Option<**Vec<String>**> | The fingerprints of the keypairs. | [optional]
**keypair_ids** | Option<**Vec<String>**> | The IDs of the keypairs. | [optional]
**keypair_names** | Option<**Vec<String>**> | The names of the keypairs. | [optional]
**keypair_types** | Option<**Vec<String>**> | The types of the keypairs (`ssh-rsa`, `ssh-ed25519`, `ecdsa-sha2-nistp256`, `ecdsa-sha2-nistp384`, or `ecdsa-sha2-nistp521`). | [optional]
**tag_keys** | Option<**Vec<String>**> | The keys of the tags associated with the keypairs. | [optional]
**tag_values** | Option<**Vec<String>**> | The values of the tags associated with the keypairs. | [optional]
**tags** | Option<**Vec<String>**> | The key/value combination of the tags associated with the keypairs, in the following format: &quot;Filters&quot;:{&quot;Tags&quot;:[&quot;TAGKEY=TAGVALUE&quot;]}. | [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)

Expand Down
2 changes: 1 addition & 1 deletion docs/FiltersTag.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**keys** | Option<**Vec<String>**> | 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. | [optional]
**resource_ids** | Option<**Vec<String>**> | The IDs of the resources with which the tags are associated. | [optional]
**resource_types** | Option<**Vec<String>**> | The resource type (`vm` \\| `image` \\| `volume` \\| `snapshot` \\| `public-ip` \\| `security-group` \\| `route-table` \\| `nic` \\| `net` \\| `subnet` \\| `net-peering` \\| `net-access-point` \\| `nat-service` \\| `internet-service` \\| `client-gateway` \\| `virtual-gateway` \\| `vpn-connection` \\| `dhcp-options` \\| `task`). | [optional]
**resource_types** | Option<**Vec<String>**> | The resource type (`customer-gateway` \\| `dhcpoptions` \\| `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`). | [optional]
**values** | Option<**Vec<String>**> | 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. | [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)
Expand Down
Loading

0 comments on commit f14104d

Please sign in to comment.