diff --git a/api_version b/api_version index 5db08bf2d..82a5f3bba 100644 --- a/api_version +++ b/api_version @@ -1 +1 @@ -1.27.0 +1.28.5 diff --git a/changelog.md b/changelog.md index 1e1a7dae8..7d385a989 100644 --- a/changelog.md +++ b/changelog.md @@ -1,3 +1,7 @@ +# 2.19.0 + + - SDK update for Outscale API v1.28.5 + # 2.18.2 - init profile for configEnv diff --git a/sdk_version b/sdk_version index 61dc3342f..ef0f38abe 100644 --- a/sdk_version +++ b/sdk_version @@ -1 +1 @@ -2.18.2 +2.19.0 diff --git a/v2/.openapi-generator/FILES b/v2/.openapi-generator/FILES index bb6c4b4f9..c4fb7137a 100644 --- a/v2/.openapi-generator/FILES +++ b/v2/.openapi-generator/FILES @@ -11,6 +11,7 @@ api_api_log.go api_ca.go api_catalog.go api_client_gateway.go +api_dedicated_group.go api_dhcp_option.go api_direct_link.go api_direct_link_interface.go @@ -27,6 +28,7 @@ api_net.go api_net_access_point.go api_net_peering.go api_nic.go +api_policy.go api_product_type.go api_public_catalog.go api_public_ip.go @@ -95,6 +97,8 @@ docs/CreateCaRequest.md docs/CreateCaResponse.md docs/CreateClientGatewayRequest.md docs/CreateClientGatewayResponse.md +docs/CreateDedicatedGroupRequest.md +docs/CreateDedicatedGroupResponse.md docs/CreateDhcpOptionsRequest.md docs/CreateDhcpOptionsResponse.md docs/CreateDirectLinkInterfaceRequest.md @@ -131,6 +135,12 @@ docs/CreateNetRequest.md docs/CreateNetResponse.md docs/CreateNicRequest.md docs/CreateNicResponse.md +docs/CreatePolicyRequest.md +docs/CreatePolicyResponse.md +docs/CreatePolicyVersionRequest.md +docs/CreatePolicyVersionResponse.md +docs/CreateProductTypeRequest.md +docs/CreateProductTypeResponse.md docs/CreatePublicIpRequest.md docs/CreatePublicIpResponse.md docs/CreateRouteRequest.md @@ -167,6 +177,8 @@ docs/CreateVpnConnectionRequest.md docs/CreateVpnConnectionResponse.md docs/CreateVpnConnectionRouteRequest.md docs/CreateVpnConnectionRouteResponse.md +docs/DedicatedGroup.md +docs/DedicatedGroupApi.md docs/DeleteAccessKeyRequest.md docs/DeleteAccessKeyResponse.md docs/DeleteApiAccessRuleRequest.md @@ -175,6 +187,8 @@ docs/DeleteCaRequest.md docs/DeleteCaResponse.md docs/DeleteClientGatewayRequest.md docs/DeleteClientGatewayResponse.md +docs/DeleteDedicatedGroupRequest.md +docs/DeleteDedicatedGroupResponse.md docs/DeleteDhcpOptionsRequest.md docs/DeleteDhcpOptionsResponse.md docs/DeleteDirectLinkInterfaceRequest.md @@ -211,6 +225,10 @@ docs/DeleteNetRequest.md docs/DeleteNetResponse.md docs/DeleteNicRequest.md docs/DeleteNicResponse.md +docs/DeletePolicyRequest.md +docs/DeletePolicyResponse.md +docs/DeletePolicyVersionRequest.md +docs/DeletePolicyVersionResponse.md docs/DeletePublicIpRequest.md docs/DeletePublicIpResponse.md docs/DeleteRouteRequest.md @@ -262,6 +280,7 @@ docs/FiltersApiLog.md docs/FiltersCa.md docs/FiltersCatalogs.md docs/FiltersClientGateway.md +docs/FiltersDedicatedGroup.md docs/FiltersDhcpOptions.md docs/FiltersDirectLink.md docs/FiltersDirectLinkInterface.md @@ -319,6 +338,8 @@ docs/LinkNicLight.md docs/LinkNicRequest.md docs/LinkNicResponse.md docs/LinkNicToUpdate.md +docs/LinkPolicyRequest.md +docs/LinkPolicyResponse.md docs/LinkPrivateIpsRequest.md docs/LinkPrivateIpsResponse.md docs/LinkPublicIp.md @@ -332,6 +353,7 @@ docs/LinkVirtualGatewayRequest.md docs/LinkVirtualGatewayResponse.md docs/LinkVolumeRequest.md docs/LinkVolumeResponse.md +docs/LinkedPolicy.md docs/LinkedVolume.md docs/Listener.md docs/ListenerApi.md @@ -370,7 +392,11 @@ docs/PermissionsOnResource.md docs/PermissionsOnResourceCreation.md docs/Phase1Options.md docs/Phase2Options.md +docs/Phase2OptionsToUpdate.md docs/Placement.md +docs/Policy.md +docs/PolicyApi.md +docs/PolicyVersion.md docs/PrivateIp.md docs/PrivateIpLight.md docs/PrivateIpLightForVm.md @@ -407,6 +433,8 @@ docs/ReadConsoleOutputRequest.md docs/ReadConsoleOutputResponse.md docs/ReadConsumptionAccountRequest.md docs/ReadConsumptionAccountResponse.md +docs/ReadDedicatedGroupsRequest.md +docs/ReadDedicatedGroupsResponse.md docs/ReadDhcpOptionsRequest.md docs/ReadDhcpOptionsResponse.md docs/ReadDirectLinkInterfacesRequest.md @@ -425,6 +453,9 @@ docs/ReadInternetServicesRequest.md docs/ReadInternetServicesResponse.md docs/ReadKeypairsRequest.md docs/ReadKeypairsResponse.md +docs/ReadLinkedPoliciesFilters.md +docs/ReadLinkedPoliciesRequest.md +docs/ReadLinkedPoliciesResponse.md docs/ReadListenerRulesRequest.md docs/ReadListenerRulesResponse.md docs/ReadLoadBalancerTagsRequest.md @@ -445,6 +476,15 @@ docs/ReadNetsRequest.md docs/ReadNetsResponse.md docs/ReadNicsRequest.md docs/ReadNicsResponse.md +docs/ReadPoliciesFilters.md +docs/ReadPoliciesRequest.md +docs/ReadPoliciesResponse.md +docs/ReadPolicyRequest.md +docs/ReadPolicyResponse.md +docs/ReadPolicyVersionRequest.md +docs/ReadPolicyVersionResponse.md +docs/ReadPolicyVersionsRequest.md +docs/ReadPolicyVersionsResponse.md docs/ReadProductTypesRequest.md docs/ReadProductTypesResponse.md docs/ReadPublicCatalogRequest.md @@ -503,8 +543,6 @@ docs/RegisterVmsInLoadBalancerRequest.md docs/RegisterVmsInLoadBalancerResponse.md docs/RejectNetPeeringRequest.md docs/RejectNetPeeringResponse.md -docs/ResetAccountPasswordRequest.md -docs/ResetAccountPasswordResponse.md docs/ResourceLoadBalancerTag.md docs/ResourceTag.md docs/ResponseContext.md @@ -524,11 +562,11 @@ docs/SecurityGroupLight.md docs/SecurityGroupRule.md docs/SecurityGroupRuleApi.md docs/SecurityGroupsMember.md -docs/SendResetPasswordEmailRequest.md -docs/SendResetPasswordEmailResponse.md docs/ServerCertificate.md docs/ServerCertificateApi.md docs/Service.md +docs/SetDefaultPolicyVersionRequest.md +docs/SetDefaultPolicyVersionResponse.md docs/Snapshot.md docs/SnapshotApi.md docs/SnapshotExportTask.md @@ -554,6 +592,8 @@ docs/UnlinkLoadBalancerBackendMachinesRequest.md docs/UnlinkLoadBalancerBackendMachinesResponse.md docs/UnlinkNicRequest.md docs/UnlinkNicResponse.md +docs/UnlinkPolicyRequest.md +docs/UnlinkPolicyResponse.md docs/UnlinkPrivateIpsRequest.md docs/UnlinkPrivateIpsResponse.md docs/UnlinkPublicIpRequest.md @@ -574,6 +614,8 @@ docs/UpdateApiAccessRuleRequest.md docs/UpdateApiAccessRuleResponse.md docs/UpdateCaRequest.md docs/UpdateCaResponse.md +docs/UpdateDedicatedGroupRequest.md +docs/UpdateDedicatedGroupResponse.md docs/UpdateDirectLinkInterfaceRequest.md docs/UpdateDirectLinkInterfaceResponse.md docs/UpdateFlexibleGpuRequest.md @@ -594,6 +636,8 @@ docs/UpdateRoutePropagationRequest.md docs/UpdateRoutePropagationResponse.md docs/UpdateRouteRequest.md docs/UpdateRouteResponse.md +docs/UpdateRouteTableLinkRequest.md +docs/UpdateRouteTableLinkResponse.md docs/UpdateServerCertificateRequest.md docs/UpdateServerCertificateResponse.md docs/UpdateSnapshotRequest.md @@ -631,6 +675,7 @@ docs/VolumeApi.md docs/VpnConnection.md docs/VpnConnectionApi.md docs/VpnOptions.md +docs/VpnOptionsToUpdate.md docs/With.md git_push.sh go.mod @@ -671,6 +716,8 @@ model_create_ca_request.go model_create_ca_response.go model_create_client_gateway_request.go model_create_client_gateway_response.go +model_create_dedicated_group_request.go +model_create_dedicated_group_response.go model_create_dhcp_options_request.go model_create_dhcp_options_response.go model_create_direct_link_interface_request.go @@ -707,6 +754,12 @@ model_create_net_request.go model_create_net_response.go model_create_nic_request.go model_create_nic_response.go +model_create_policy_request.go +model_create_policy_response.go +model_create_policy_version_request.go +model_create_policy_version_response.go +model_create_product_type_request.go +model_create_product_type_response.go model_create_public_ip_request.go model_create_public_ip_response.go model_create_route_request.go @@ -743,6 +796,7 @@ model_create_vpn_connection_request.go model_create_vpn_connection_response.go model_create_vpn_connection_route_request.go model_create_vpn_connection_route_response.go +model_dedicated_group.go model_delete_access_key_request.go model_delete_access_key_response.go model_delete_api_access_rule_request.go @@ -751,6 +805,8 @@ model_delete_ca_request.go model_delete_ca_response.go model_delete_client_gateway_request.go model_delete_client_gateway_response.go +model_delete_dedicated_group_request.go +model_delete_dedicated_group_response.go model_delete_dhcp_options_request.go model_delete_dhcp_options_response.go model_delete_direct_link_interface_request.go @@ -787,6 +843,10 @@ model_delete_net_request.go model_delete_net_response.go model_delete_nic_request.go model_delete_nic_response.go +model_delete_policy_request.go +model_delete_policy_response.go +model_delete_policy_version_request.go +model_delete_policy_version_response.go model_delete_public_ip_request.go model_delete_public_ip_response.go model_delete_route_request.go @@ -835,6 +895,7 @@ model_filters_api_log.go model_filters_ca.go model_filters_catalogs.go model_filters_client_gateway.go +model_filters_dedicated_group.go model_filters_dhcp_options.go model_filters_direct_link.go model_filters_direct_link_interface.go @@ -888,6 +949,8 @@ model_link_nic_light.go model_link_nic_request.go model_link_nic_response.go model_link_nic_to_update.go +model_link_policy_request.go +model_link_policy_response.go model_link_private_ips_request.go model_link_private_ips_response.go model_link_public_ip.go @@ -901,6 +964,7 @@ model_link_virtual_gateway_request.go model_link_virtual_gateway_response.go model_link_volume_request.go model_link_volume_response.go +model_linked_policy.go model_linked_volume.go model_listener.go model_listener_for_creation.go @@ -930,7 +994,10 @@ model_permissions_on_resource.go model_permissions_on_resource_creation.go model_phase1_options.go model_phase2_options.go +model_phase2_options_to_update.go model_placement.go +model_policy.go +model_policy_version.go model_private_ip.go model_private_ip_light.go model_private_ip_light_for_vm.go @@ -963,6 +1030,8 @@ model_read_console_output_request.go model_read_console_output_response.go model_read_consumption_account_request.go model_read_consumption_account_response.go +model_read_dedicated_groups_request.go +model_read_dedicated_groups_response.go model_read_dhcp_options_request.go model_read_dhcp_options_response.go model_read_direct_link_interfaces_request.go @@ -981,6 +1050,9 @@ model_read_internet_services_request.go model_read_internet_services_response.go model_read_keypairs_request.go model_read_keypairs_response.go +model_read_linked_policies_filters.go +model_read_linked_policies_request.go +model_read_linked_policies_response.go model_read_listener_rules_request.go model_read_listener_rules_response.go model_read_load_balancer_tags_request.go @@ -1001,6 +1073,15 @@ model_read_nets_request.go model_read_nets_response.go model_read_nics_request.go model_read_nics_response.go +model_read_policies_filters.go +model_read_policies_request.go +model_read_policies_response.go +model_read_policy_request.go +model_read_policy_response.go +model_read_policy_version_request.go +model_read_policy_version_response.go +model_read_policy_versions_request.go +model_read_policy_versions_response.go model_read_product_types_request.go model_read_product_types_response.go model_read_public_catalog_request.go @@ -1058,8 +1139,6 @@ model_register_vms_in_load_balancer_request.go model_register_vms_in_load_balancer_response.go model_reject_net_peering_request.go model_reject_net_peering_response.go -model_reset_account_password_request.go -model_reset_account_password_response.go model_resource_load_balancer_tag.go model_resource_tag.go model_response_context.go @@ -1075,10 +1154,10 @@ model_security_group.go model_security_group_light.go model_security_group_rule.go model_security_groups_member.go -model_send_reset_password_email_request.go -model_send_reset_password_email_response.go model_server_certificate.go model_service.go +model_set_default_policy_version_request.go +model_set_default_policy_version_response.go model_snapshot.go model_snapshot_export_task.go model_source_net.go @@ -1099,6 +1178,8 @@ model_unlink_load_balancer_backend_machines_request.go model_unlink_load_balancer_backend_machines_response.go model_unlink_nic_request.go model_unlink_nic_response.go +model_unlink_policy_request.go +model_unlink_policy_response.go model_unlink_private_ips_request.go model_unlink_private_ips_response.go model_unlink_public_ip_request.go @@ -1119,6 +1200,8 @@ model_update_api_access_rule_request.go model_update_api_access_rule_response.go model_update_ca_request.go model_update_ca_response.go +model_update_dedicated_group_request.go +model_update_dedicated_group_response.go model_update_direct_link_interface_request.go model_update_direct_link_interface_response.go model_update_flexible_gpu_request.go @@ -1139,6 +1222,8 @@ model_update_route_propagation_request.go model_update_route_propagation_response.go model_update_route_request.go model_update_route_response.go +model_update_route_table_link_request.go +model_update_route_table_link_response.go model_update_server_certificate_request.go model_update_server_certificate_response.go model_update_snapshot_request.go @@ -1169,6 +1254,7 @@ model_vm_type.go model_volume.go model_vpn_connection.go model_vpn_options.go +model_vpn_options_to_update.go model_with.go response.go utils.go diff --git a/v2/README.md b/v2/README.md index 92d18f6cf..475ffc39f 100644 --- a/v2/README.md +++ b/v2/README.md @@ -2,16 +2,47 @@ Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

+Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
+Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

-An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). +An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
+# Authentication Schemes +### Access Key/Secret Key +The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
+The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

+In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
+ +> For example, if you use OSC CLI: +> 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. +> 2. You then specify the `--profile` option when executing OSC CLI commands. +> +> For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). + +See the code samples in each section of this documentation for specific examples in different programming languages.
+For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). +### Login/Password +For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
+This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
+In most cases, however, you can use the Cockpit web interface to retrieve them.
+ +> For example, if you use OSC CLI: +> 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). +> 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. + +See the code samples in each section of this documentation for specific examples in different programming languages. +### No Authentication +A few API actions do not require any authentication. They are indicated as such in this documentation.
+### Other Security Mechanisms +In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
+For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). ## Overview This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client. -- API version: 1.27 -- Package version: 2.18.2 +- API version: 1.28.5 +- Package version: 2.19.0 - Build package: org.openapitools.codegen.languages.GoClientCodegen ## Installation @@ -92,8 +123,6 @@ Class | Method | HTTP request | Description *AccountApi* | [**CreateAccount**](docs/AccountApi.md#createaccount) | **Post** /CreateAccount | *AccountApi* | [**ReadAccounts**](docs/AccountApi.md#readaccounts) | **Post** /ReadAccounts | *AccountApi* | [**ReadConsumptionAccount**](docs/AccountApi.md#readconsumptionaccount) | **Post** /ReadConsumptionAccount | -*AccountApi* | [**ResetAccountPassword**](docs/AccountApi.md#resetaccountpassword) | **Post** /ResetAccountPassword | -*AccountApi* | [**SendResetPasswordEmail**](docs/AccountApi.md#sendresetpasswordemail) | **Post** /SendResetPasswordEmail | *AccountApi* | [**UpdateAccount**](docs/AccountApi.md#updateaccount) | **Post** /UpdateAccount | *ApiAccessPolicyApi* | [**ReadApiAccessPolicy**](docs/ApiAccessPolicyApi.md#readapiaccesspolicy) | **Post** /ReadApiAccessPolicy | *ApiAccessPolicyApi* | [**UpdateApiAccessPolicy**](docs/ApiAccessPolicyApi.md#updateapiaccesspolicy) | **Post** /UpdateApiAccessPolicy | @@ -111,6 +140,10 @@ Class | Method | HTTP request | Description *ClientGatewayApi* | [**CreateClientGateway**](docs/ClientGatewayApi.md#createclientgateway) | **Post** /CreateClientGateway | *ClientGatewayApi* | [**DeleteClientGateway**](docs/ClientGatewayApi.md#deleteclientgateway) | **Post** /DeleteClientGateway | *ClientGatewayApi* | [**ReadClientGateways**](docs/ClientGatewayApi.md#readclientgateways) | **Post** /ReadClientGateways | +*DedicatedGroupApi* | [**CreateDedicatedGroup**](docs/DedicatedGroupApi.md#creatededicatedgroup) | **Post** /CreateDedicatedGroup | +*DedicatedGroupApi* | [**DeleteDedicatedGroup**](docs/DedicatedGroupApi.md#deletededicatedgroup) | **Post** /DeleteDedicatedGroup | +*DedicatedGroupApi* | [**ReadDedicatedGroups**](docs/DedicatedGroupApi.md#readdedicatedgroups) | **Post** /ReadDedicatedGroups | +*DedicatedGroupApi* | [**UpdateDedicatedGroup**](docs/DedicatedGroupApi.md#updatededicatedgroup) | **Post** /UpdateDedicatedGroup | *DhcpOptionApi* | [**CreateDhcpOptions**](docs/DhcpOptionApi.md#createdhcpoptions) | **Post** /CreateDhcpOptions | *DhcpOptionApi* | [**DeleteDhcpOptions**](docs/DhcpOptionApi.md#deletedhcpoptions) | **Post** /DeleteDhcpOptions | *DhcpOptionApi* | [**ReadDhcpOptions**](docs/DhcpOptionApi.md#readdhcpoptions) | **Post** /ReadDhcpOptions | @@ -188,6 +221,19 @@ Class | Method | HTTP request | Description *NicApi* | [**UnlinkNic**](docs/NicApi.md#unlinknic) | **Post** /UnlinkNic | *NicApi* | [**UnlinkPrivateIps**](docs/NicApi.md#unlinkprivateips) | **Post** /UnlinkPrivateIps | *NicApi* | [**UpdateNic**](docs/NicApi.md#updatenic) | **Post** /UpdateNic | +*PolicyApi* | [**CreatePolicy**](docs/PolicyApi.md#createpolicy) | **Post** /CreatePolicy | +*PolicyApi* | [**CreatePolicyVersion**](docs/PolicyApi.md#createpolicyversion) | **Post** /CreatePolicyVersion | +*PolicyApi* | [**DeletePolicy**](docs/PolicyApi.md#deletepolicy) | **Post** /DeletePolicy | +*PolicyApi* | [**DeletePolicyVersion**](docs/PolicyApi.md#deletepolicyversion) | **Post** /DeletePolicyVersion | +*PolicyApi* | [**LinkPolicy**](docs/PolicyApi.md#linkpolicy) | **Post** /LinkPolicy | +*PolicyApi* | [**ReadLinkedPolicies**](docs/PolicyApi.md#readlinkedpolicies) | **Post** /ReadLinkedPolicies | +*PolicyApi* | [**ReadPolicies**](docs/PolicyApi.md#readpolicies) | **Post** /ReadPolicies | +*PolicyApi* | [**ReadPolicy**](docs/PolicyApi.md#readpolicy) | **Post** /ReadPolicy | +*PolicyApi* | [**ReadPolicyVersion**](docs/PolicyApi.md#readpolicyversion) | **Post** /ReadPolicyVersion | +*PolicyApi* | [**ReadPolicyVersions**](docs/PolicyApi.md#readpolicyversions) | **Post** /ReadPolicyVersions | +*PolicyApi* | [**SetDefaultPolicyVersion**](docs/PolicyApi.md#setdefaultpolicyversion) | **Post** /SetDefaultPolicyVersion | +*PolicyApi* | [**UnlinkPolicy**](docs/PolicyApi.md#unlinkpolicy) | **Post** /UnlinkPolicy | +*ProductTypeApi* | [**CreateProductType**](docs/ProductTypeApi.md#createproducttype) | **Post** /CreateProductType | *ProductTypeApi* | [**ReadProductTypes**](docs/ProductTypeApi.md#readproducttypes) | **Post** /ReadProductTypes | *PublicCatalogApi* | [**ReadPublicCatalog**](docs/PublicCatalogApi.md#readpubliccatalog) | **Post** /ReadPublicCatalog | *PublicIpApi* | [**CreatePublicIp**](docs/PublicIpApi.md#createpublicip) | **Post** /CreatePublicIp | @@ -206,6 +252,7 @@ Class | Method | HTTP request | Description *RouteTableApi* | [**LinkRouteTable**](docs/RouteTableApi.md#linkroutetable) | **Post** /LinkRouteTable | *RouteTableApi* | [**ReadRouteTables**](docs/RouteTableApi.md#readroutetables) | **Post** /ReadRouteTables | *RouteTableApi* | [**UnlinkRouteTable**](docs/RouteTableApi.md#unlinkroutetable) | **Post** /UnlinkRouteTable | +*RouteTableApi* | [**UpdateRouteTableLink**](docs/RouteTableApi.md#updateroutetablelink) | **Post** /UpdateRouteTableLink | *SecurityGroupApi* | [**CreateSecurityGroup**](docs/SecurityGroupApi.md#createsecuritygroup) | **Post** /CreateSecurityGroup | *SecurityGroupApi* | [**DeleteSecurityGroup**](docs/SecurityGroupApi.md#deletesecuritygroup) | **Post** /DeleteSecurityGroup | *SecurityGroupApi* | [**ReadSecurityGroups**](docs/SecurityGroupApi.md#readsecuritygroups) | **Post** /ReadSecurityGroups | @@ -313,6 +360,8 @@ Class | Method | HTTP request | Description - [CreateCaResponse](docs/CreateCaResponse.md) - [CreateClientGatewayRequest](docs/CreateClientGatewayRequest.md) - [CreateClientGatewayResponse](docs/CreateClientGatewayResponse.md) + - [CreateDedicatedGroupRequest](docs/CreateDedicatedGroupRequest.md) + - [CreateDedicatedGroupResponse](docs/CreateDedicatedGroupResponse.md) - [CreateDhcpOptionsRequest](docs/CreateDhcpOptionsRequest.md) - [CreateDhcpOptionsResponse](docs/CreateDhcpOptionsResponse.md) - [CreateDirectLinkInterfaceRequest](docs/CreateDirectLinkInterfaceRequest.md) @@ -349,6 +398,12 @@ Class | Method | HTTP request | Description - [CreateNetResponse](docs/CreateNetResponse.md) - [CreateNicRequest](docs/CreateNicRequest.md) - [CreateNicResponse](docs/CreateNicResponse.md) + - [CreatePolicyRequest](docs/CreatePolicyRequest.md) + - [CreatePolicyResponse](docs/CreatePolicyResponse.md) + - [CreatePolicyVersionRequest](docs/CreatePolicyVersionRequest.md) + - [CreatePolicyVersionResponse](docs/CreatePolicyVersionResponse.md) + - [CreateProductTypeRequest](docs/CreateProductTypeRequest.md) + - [CreateProductTypeResponse](docs/CreateProductTypeResponse.md) - [CreatePublicIpRequest](docs/CreatePublicIpRequest.md) - [CreatePublicIpResponse](docs/CreatePublicIpResponse.md) - [CreateRouteRequest](docs/CreateRouteRequest.md) @@ -385,6 +440,7 @@ Class | Method | HTTP request | Description - [CreateVpnConnectionResponse](docs/CreateVpnConnectionResponse.md) - [CreateVpnConnectionRouteRequest](docs/CreateVpnConnectionRouteRequest.md) - [CreateVpnConnectionRouteResponse](docs/CreateVpnConnectionRouteResponse.md) + - [DedicatedGroup](docs/DedicatedGroup.md) - [DeleteAccessKeyRequest](docs/DeleteAccessKeyRequest.md) - [DeleteAccessKeyResponse](docs/DeleteAccessKeyResponse.md) - [DeleteApiAccessRuleRequest](docs/DeleteApiAccessRuleRequest.md) @@ -393,6 +449,8 @@ Class | Method | HTTP request | Description - [DeleteCaResponse](docs/DeleteCaResponse.md) - [DeleteClientGatewayRequest](docs/DeleteClientGatewayRequest.md) - [DeleteClientGatewayResponse](docs/DeleteClientGatewayResponse.md) + - [DeleteDedicatedGroupRequest](docs/DeleteDedicatedGroupRequest.md) + - [DeleteDedicatedGroupResponse](docs/DeleteDedicatedGroupResponse.md) - [DeleteDhcpOptionsRequest](docs/DeleteDhcpOptionsRequest.md) - [DeleteDhcpOptionsResponse](docs/DeleteDhcpOptionsResponse.md) - [DeleteDirectLinkInterfaceRequest](docs/DeleteDirectLinkInterfaceRequest.md) @@ -429,6 +487,10 @@ Class | Method | HTTP request | Description - [DeleteNetResponse](docs/DeleteNetResponse.md) - [DeleteNicRequest](docs/DeleteNicRequest.md) - [DeleteNicResponse](docs/DeleteNicResponse.md) + - [DeletePolicyRequest](docs/DeletePolicyRequest.md) + - [DeletePolicyResponse](docs/DeletePolicyResponse.md) + - [DeletePolicyVersionRequest](docs/DeletePolicyVersionRequest.md) + - [DeletePolicyVersionResponse](docs/DeletePolicyVersionResponse.md) - [DeletePublicIpRequest](docs/DeletePublicIpRequest.md) - [DeletePublicIpResponse](docs/DeletePublicIpResponse.md) - [DeleteRouteRequest](docs/DeleteRouteRequest.md) @@ -477,6 +539,7 @@ Class | Method | HTTP request | Description - [FiltersCa](docs/FiltersCa.md) - [FiltersCatalogs](docs/FiltersCatalogs.md) - [FiltersClientGateway](docs/FiltersClientGateway.md) + - [FiltersDedicatedGroup](docs/FiltersDedicatedGroup.md) - [FiltersDhcpOptions](docs/FiltersDhcpOptions.md) - [FiltersDirectLink](docs/FiltersDirectLink.md) - [FiltersDirectLinkInterface](docs/FiltersDirectLinkInterface.md) @@ -530,6 +593,8 @@ Class | Method | HTTP request | Description - [LinkNicRequest](docs/LinkNicRequest.md) - [LinkNicResponse](docs/LinkNicResponse.md) - [LinkNicToUpdate](docs/LinkNicToUpdate.md) + - [LinkPolicyRequest](docs/LinkPolicyRequest.md) + - [LinkPolicyResponse](docs/LinkPolicyResponse.md) - [LinkPrivateIpsRequest](docs/LinkPrivateIpsRequest.md) - [LinkPrivateIpsResponse](docs/LinkPrivateIpsResponse.md) - [LinkPublicIp](docs/LinkPublicIp.md) @@ -543,6 +608,7 @@ Class | Method | HTTP request | Description - [LinkVirtualGatewayResponse](docs/LinkVirtualGatewayResponse.md) - [LinkVolumeRequest](docs/LinkVolumeRequest.md) - [LinkVolumeResponse](docs/LinkVolumeResponse.md) + - [LinkedPolicy](docs/LinkedPolicy.md) - [LinkedVolume](docs/LinkedVolume.md) - [Listener](docs/Listener.md) - [ListenerForCreation](docs/ListenerForCreation.md) @@ -572,7 +638,10 @@ Class | Method | HTTP request | Description - [PermissionsOnResourceCreation](docs/PermissionsOnResourceCreation.md) - [Phase1Options](docs/Phase1Options.md) - [Phase2Options](docs/Phase2Options.md) + - [Phase2OptionsToUpdate](docs/Phase2OptionsToUpdate.md) - [Placement](docs/Placement.md) + - [Policy](docs/Policy.md) + - [PolicyVersion](docs/PolicyVersion.md) - [PrivateIp](docs/PrivateIp.md) - [PrivateIpLight](docs/PrivateIpLight.md) - [PrivateIpLightForVm](docs/PrivateIpLightForVm.md) @@ -605,6 +674,8 @@ Class | Method | HTTP request | Description - [ReadConsoleOutputResponse](docs/ReadConsoleOutputResponse.md) - [ReadConsumptionAccountRequest](docs/ReadConsumptionAccountRequest.md) - [ReadConsumptionAccountResponse](docs/ReadConsumptionAccountResponse.md) + - [ReadDedicatedGroupsRequest](docs/ReadDedicatedGroupsRequest.md) + - [ReadDedicatedGroupsResponse](docs/ReadDedicatedGroupsResponse.md) - [ReadDhcpOptionsRequest](docs/ReadDhcpOptionsRequest.md) - [ReadDhcpOptionsResponse](docs/ReadDhcpOptionsResponse.md) - [ReadDirectLinkInterfacesRequest](docs/ReadDirectLinkInterfacesRequest.md) @@ -623,6 +694,9 @@ Class | Method | HTTP request | Description - [ReadInternetServicesResponse](docs/ReadInternetServicesResponse.md) - [ReadKeypairsRequest](docs/ReadKeypairsRequest.md) - [ReadKeypairsResponse](docs/ReadKeypairsResponse.md) + - [ReadLinkedPoliciesFilters](docs/ReadLinkedPoliciesFilters.md) + - [ReadLinkedPoliciesRequest](docs/ReadLinkedPoliciesRequest.md) + - [ReadLinkedPoliciesResponse](docs/ReadLinkedPoliciesResponse.md) - [ReadListenerRulesRequest](docs/ReadListenerRulesRequest.md) - [ReadListenerRulesResponse](docs/ReadListenerRulesResponse.md) - [ReadLoadBalancerTagsRequest](docs/ReadLoadBalancerTagsRequest.md) @@ -643,6 +717,15 @@ Class | Method | HTTP request | Description - [ReadNetsResponse](docs/ReadNetsResponse.md) - [ReadNicsRequest](docs/ReadNicsRequest.md) - [ReadNicsResponse](docs/ReadNicsResponse.md) + - [ReadPoliciesFilters](docs/ReadPoliciesFilters.md) + - [ReadPoliciesRequest](docs/ReadPoliciesRequest.md) + - [ReadPoliciesResponse](docs/ReadPoliciesResponse.md) + - [ReadPolicyRequest](docs/ReadPolicyRequest.md) + - [ReadPolicyResponse](docs/ReadPolicyResponse.md) + - [ReadPolicyVersionRequest](docs/ReadPolicyVersionRequest.md) + - [ReadPolicyVersionResponse](docs/ReadPolicyVersionResponse.md) + - [ReadPolicyVersionsRequest](docs/ReadPolicyVersionsRequest.md) + - [ReadPolicyVersionsResponse](docs/ReadPolicyVersionsResponse.md) - [ReadProductTypesRequest](docs/ReadProductTypesRequest.md) - [ReadProductTypesResponse](docs/ReadProductTypesResponse.md) - [ReadPublicCatalogRequest](docs/ReadPublicCatalogRequest.md) @@ -700,8 +783,6 @@ Class | Method | HTTP request | Description - [RegisterVmsInLoadBalancerResponse](docs/RegisterVmsInLoadBalancerResponse.md) - [RejectNetPeeringRequest](docs/RejectNetPeeringRequest.md) - [RejectNetPeeringResponse](docs/RejectNetPeeringResponse.md) - - [ResetAccountPasswordRequest](docs/ResetAccountPasswordRequest.md) - - [ResetAccountPasswordResponse](docs/ResetAccountPasswordResponse.md) - [ResourceLoadBalancerTag](docs/ResourceLoadBalancerTag.md) - [ResourceTag](docs/ResourceTag.md) - [ResponseContext](docs/ResponseContext.md) @@ -717,10 +798,10 @@ Class | Method | HTTP request | Description - [SecurityGroupLight](docs/SecurityGroupLight.md) - [SecurityGroupRule](docs/SecurityGroupRule.md) - [SecurityGroupsMember](docs/SecurityGroupsMember.md) - - [SendResetPasswordEmailRequest](docs/SendResetPasswordEmailRequest.md) - - [SendResetPasswordEmailResponse](docs/SendResetPasswordEmailResponse.md) - [ServerCertificate](docs/ServerCertificate.md) - [Service](docs/Service.md) + - [SetDefaultPolicyVersionRequest](docs/SetDefaultPolicyVersionRequest.md) + - [SetDefaultPolicyVersionResponse](docs/SetDefaultPolicyVersionResponse.md) - [Snapshot](docs/Snapshot.md) - [SnapshotExportTask](docs/SnapshotExportTask.md) - [SourceNet](docs/SourceNet.md) @@ -741,6 +822,8 @@ Class | Method | HTTP request | Description - [UnlinkLoadBalancerBackendMachinesResponse](docs/UnlinkLoadBalancerBackendMachinesResponse.md) - [UnlinkNicRequest](docs/UnlinkNicRequest.md) - [UnlinkNicResponse](docs/UnlinkNicResponse.md) + - [UnlinkPolicyRequest](docs/UnlinkPolicyRequest.md) + - [UnlinkPolicyResponse](docs/UnlinkPolicyResponse.md) - [UnlinkPrivateIpsRequest](docs/UnlinkPrivateIpsRequest.md) - [UnlinkPrivateIpsResponse](docs/UnlinkPrivateIpsResponse.md) - [UnlinkPublicIpRequest](docs/UnlinkPublicIpRequest.md) @@ -761,6 +844,8 @@ Class | Method | HTTP request | Description - [UpdateApiAccessRuleResponse](docs/UpdateApiAccessRuleResponse.md) - [UpdateCaRequest](docs/UpdateCaRequest.md) - [UpdateCaResponse](docs/UpdateCaResponse.md) + - [UpdateDedicatedGroupRequest](docs/UpdateDedicatedGroupRequest.md) + - [UpdateDedicatedGroupResponse](docs/UpdateDedicatedGroupResponse.md) - [UpdateDirectLinkInterfaceRequest](docs/UpdateDirectLinkInterfaceRequest.md) - [UpdateDirectLinkInterfaceResponse](docs/UpdateDirectLinkInterfaceResponse.md) - [UpdateFlexibleGpuRequest](docs/UpdateFlexibleGpuRequest.md) @@ -781,6 +866,8 @@ Class | Method | HTTP request | Description - [UpdateRoutePropagationResponse](docs/UpdateRoutePropagationResponse.md) - [UpdateRouteRequest](docs/UpdateRouteRequest.md) - [UpdateRouteResponse](docs/UpdateRouteResponse.md) + - [UpdateRouteTableLinkRequest](docs/UpdateRouteTableLinkRequest.md) + - [UpdateRouteTableLinkResponse](docs/UpdateRouteTableLinkResponse.md) - [UpdateServerCertificateRequest](docs/UpdateServerCertificateRequest.md) - [UpdateServerCertificateResponse](docs/UpdateServerCertificateResponse.md) - [UpdateSnapshotRequest](docs/UpdateSnapshotRequest.md) @@ -811,6 +898,7 @@ Class | Method | HTTP request | Description - [Volume](docs/Volume.md) - [VpnConnection](docs/VpnConnection.md) - [VpnOptions](docs/VpnOptions.md) + - [VpnOptionsToUpdate](docs/VpnOptionsToUpdate.md) - [With](docs/With.md) diff --git a/v2/api/openapi.yaml b/v2/api/openapi.yaml index f537afa2d..36dec4572 100644 --- a/v2/api/openapi.yaml +++ b/v2/api/openapi.yaml @@ -2,19 +2,55 @@ openapi: 3.0.0 info: contact: email: support@outscale.com - description: |- - Welcome to the OUTSCALE API documentation.
- The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

- You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

- Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
- You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

- An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + description: "Welcome to the OUTSCALE API documentation.
\nThe OUTSCALE API\ + \ enables you to manage your resources in the OUTSCALE Cloud. This documentation\ + \ describes the different actions available along with code examples.
\nThrottling: To protect against overloads, the number of identical requests\ + \ allowed in a given time period is limited.
\nBrute force: To protect against\ + \ brute force attacks, the number of failed authentication attempts in a given\ + \ time period is limited.

\nYou can learn more about errors returned\ + \ by the API in the dedicated [errors page](api/errors).

\nNote that\ + \ the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there\ + \ are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html)\ + \ between AWS and the OUTSCALE API.
\nYou can also manage your resources\ + \ using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html)\ + \ web interface.

\nAn OpenAPI description of the OUTSCALE API is also\ + \ available in this [GitHub repository](https://github.com/outscale/osc-api).\n# Authentication Schemes\n### Access Key/Secret Key\nThe main way to authenticate\ + \ your requests to the OUTSCALE API is to use an access key and a secret key.\nThe mechanism behind this is based on AWS Signature Version 4, whose technical\ + \ implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).
\nIn practice, the way to specify your access key and secret key depends\ + \ on the tool or SDK you want to use to interact with the API.
\n\n> For\ + \ example, if you use OSC CLI:\n> 1. You need to create an **~/.osc/config.json**\ + \ file to specify your access key, secret key, and the Region of your account.\n\ + > 2. You then specify the `--profile` option when executing OSC CLI commands.\n\ + > \n> For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html).\n\ + \nSee the code samples in each section of this documentation for specific examples\ + \ in different programming languages.
\nFor more information about access\ + \ keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html).\n\ + ### Login/Password\nFor certain API actions, you can also use basic authentication\ + \ with the login (email address) and password of your TINA account.
\nThis\ + \ is useful only in special circumstances, for example if you do not know your\ + \ access key/secret key and want to retrieve them programmatically.
\nIn\ + \ most cases, however, you can use the Cockpit web interface to retrieve them.\n\n> For example, if you use OSC CLI:\n> 1. You need to create an **~/.osc/config.json**\ + \ file to specify the Region of your account, but you leave the access key value\ + \ and secret key value empty (`""`).\n> 2. You then specify the `--profile`,\ + \ `--authentication-method`, `--login`, and `--password` options when executing\ + \ OSC CLI commands.\n\nSee the code samples in each section of this documentation\ + \ for specific examples in different programming languages.\n### No Authentication\n\ + A few API actions do not require any authentication. They are indicated as such\ + \ in this documentation.
\n### Other Security Mechanisms\nIn parallel with\ + \ the authentication schemes, you can add other security mechanisms to your OUTSCALE\ + \ account, for example to restrict API requests by IP or other criteria.
\n\ + For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html)." license: name: BSD 3 Clause url: https://opensource.org/licenses/BSD-3-Clause termsOfService: https://en.outscale.com/terms-of-service/ title: 3DS OUTSCALE API - version: "1.27" + version: 1.28.5 servers: - url: https://api.{region}.outscale.com/api/v1 variables: @@ -26,12 +62,6 @@ servers: - eu-west-2 - us-east-2 - us-west-1 -- url: https://api.{region}.outscale.jp/api/v1 - variables: - region: - default: ap-northeast-1 - enum: - - ap-northeast-1 security: - ApiKeyAuth: [] paths: @@ -39,6 +69,7 @@ paths: description: |- Accepts a Net peering request.
To accept this request, you must be the owner of the peer Net. If you do not accept the request within 7 days, the state of the Net peering becomes `expired`.

+ **[NOTE]**
A peering connection between two Nets works both ways. Therefore, when an A-to-B peering connection is accepted, any pending B-to-A peering connection is automatically rejected as redundant. post: @@ -46,12 +77,35 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + NetPeeringId: pcx-12345678 schema: $ref: '#/components/schemas/AcceptNetPeeringRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + NetPeering: + Tags: [] + SourceNet: + NetId: vpc-12345678 + IpRange: 10.0.0.0/16 + AccountId: "123456789012" + NetPeeringId: pcx-12345678 + AccepterNet: + NetId: vpc-12345678 + IpRange: 172.16.0.0/16 + AccountId: "123456789012" + State: + Name: active + Message: Active schema: $ref: '#/components/schemas/AcceptNetPeeringResponse' description: The HTTP 200 response (OK). @@ -88,31 +142,58 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + Login: example@example.com + Password: $OSC_PASSWORD schema: $ref: '#/components/schemas/CheckAuthenticationRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/CheckAuthenticationResponse' description: The HTTP 200 response (OK). tags: - Account /CreateAccessKey: - description: Creates an access key for either your root account or an EIM user. - The new key is automatically set to `ACTIVE`. + description: |- + Creates an access key for either your root account or an EIM user. The new key is automatically set to `ACTIVE`.

+ For more information, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). post: operationId: CreateAccessKey requestBody: content: application/json: + examples: + ex1: + value: + ExpirationDate: 2063-04-05 schema: $ref: '#/components/schemas/CreateAccessKeyRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + 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 + SecretKey: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 schema: $ref: '#/components/schemas/CreateAccessKeyResponse' description: The HTTP 200 response (OK). @@ -125,20 +206,47 @@ paths: description: |- Creates an OUTSCALE account.

- **[NOTE]**
+ **[IMPORTANT]**
* You need OUTSCALE credentials and the appropriate quotas to create an account via API. To get quotas, you can send an email to sales@outscale.com.
* If you want to pass a numeral value as a string instead of an integer, you must wrap your string in additional quotes (for example, `'"92000"'`). + + For more information, see [About Your Account](https://docs.outscale.com/en/userguide/About-Your-Account.html). post: operationId: CreateAccount requestBody: content: application/json: + examples: + ex1: + value: + City: SAINT-CLOUD + CompanyName: EXAMPLE SAS + Country: FRANCE + CustomerId: "87654321" + Email: example@example.com + FirstName: JEAN + LastName: DUPONT + ZipCode: "92210" schema: $ref: '#/components/schemas/CreateAccountRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Account: + ZipCode: "92210" + CompanyName: EXAMPLE SAS + FirstName: JEAN + City: SAINT-CLOUD + Country: FRANCE + LastName: DUPONT + AccountId: "123456789012" + Email: example@example.com schema: $ref: '#/components/schemas/CreateAccountResponse' description: The HTTP 200 response (OK). @@ -150,18 +258,66 @@ paths: You need to specify at least the `CaIds` or the `IpRanges` parameter.

**[NOTE]**
- By default, your account has a set of rules allowing global access that you can delete. For more information, see [About API Access Rules](https://docs.outscale.com/en/userguide/About-API-Access-Rules.html). + By default, your account has a set of rules allowing global access, that you can delete.

+ For more information, see [About API Access Rules](https://docs.outscale.com/en/userguide/About-API-Access-Rules.html). post: operationId: CreateApiAccessRule requestBody: content: application/json: + examples: + ex1: + summary: Creating an API access rule based on IPs + value: + IpRanges: + - 192.0.2.0 + - 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) + value: + IpRanges: + - 192.0.2.0 + - 198.51.100.0/24 + CaIds: + - ca-fedcba0987654321fedcba0987654321 + Description: API Access Rule with IPs and CA schema: $ref: '#/components/schemas/CreateApiAccessRuleRequest' responses: "200": content: application/json: + examples: + ex1: + summary: Creating an API access rule based on IPs + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ApiAccessRule: + IpRanges: + - 192.0.2.0 + - 198.51.100.0/24 + ApiAccessRuleId: aar-fedcba0987654321fedcba0987654321 + CaIds: [] + Cns: [] + Description: Basic API Access Rule with IPs + ex2: + summary: Creating an API access rule based on IPs and Certificate + Authority (CA) + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ApiAccessRule: + IpRanges: + - 192.0.2.0 + - 198.51.100.0/24 + ApiAccessRuleId: aar-fedcba0987654321fedcba0987654321 + CaIds: + - ca-fedcba0987654321fedcba0987654321 + Cns: [] + Description: API Access Rule with IPs and CA schema: $ref: '#/components/schemas/CreateApiAccessRuleResponse' description: The HTTP 200 response (OK). @@ -171,18 +327,34 @@ paths: tags: - ApiAccessRule /CreateCa: - description: Creates a Client Certificate Authority (CA). + description: |- + Creates a Client Certificate Authority (CA).

+ For more information, see [About API Access Rules](https://docs.outscale.com/en/userguide/About-API-Access-Rules.html). post: operationId: CreateCa requestBody: content: application/json: + examples: + ex1: + value: + CaPem: XXXX + Description: CA example schema: $ref: '#/components/schemas/CreateCaRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Ca: + Description: CA example + CaId: ca-fedcba0987654321fedcba0987654321 + CaFingerprint: 1234567890abcdef1234567890abcdef12345678 schema: $ref: '#/components/schemas/CreateCaResponse' description: The HTTP 200 response (OK). @@ -195,56 +367,182 @@ paths: description: |- Provides information about your client gateway.
This action registers information to identify the client gateway that you deployed in your network.
- To open a tunnel to the client gateway, you must provide the communication protocol type, the fixed public IP of the gateway, and an Autonomous System Number (ASN). + To open a tunnel to the client gateway, you must provide the communication protocol type, the fixed public IP of the gateway, and an Autonomous System Number (ASN).

+ For more information, see [About Client Gateways](https://docs.outscale.com/en/userguide/About-Client-Gateways.html). post: operationId: CreateClientGateway requestBody: content: application/json: + examples: + ex1: + value: + ConnectionType: ipsec.1 + PublicIp: 192.0.2.0 + BgpAsn: 65000 schema: $ref: '#/components/schemas/CreateClientGatewayRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ClientGateway: + State: available + BgpAsn: 65000 + Tags: [] + ClientGatewayId: cgw-12345678 + ConnectionType: ipsec.1 + PublicIp: 192.0.2.0 schema: $ref: '#/components/schemas/CreateClientGatewayResponse' description: The HTTP 200 response (OK). tags: - ClientGateway + /CreateDedicatedGroup: + 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). + post: + operationId: CreateDedicatedGroup + requestBody: + content: + application/json: + examples: + ex1: + value: + CpuGeneration: 4 + Name: dedicated-group-example + SubregionName: eu-west-2a + schema: + $ref: '#/components/schemas/CreateDedicatedGroupRequest' + responses: + "200": + content: + application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + DedicatedGroup: + VmIds: [] + NetIds: [] + AccountId: "123456789012" + CpuGeneration: 4 + Name: dedicated-group-example + SubregionName: eu-west-2a + DedicatedGroupId: ded-12345678 + schema: + $ref: '#/components/schemas/CreateDedicatedGroupResponse' + description: The HTTP 200 response (OK). + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + description: The HTTP 400 response (Bad Request). + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + description: The HTTP 401 response (Unauthorized). + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + description: The HTTP 500 response (Internal Server Error). + tags: + - DedicatedGroup /CreateDhcpOptions: - description: Creates a set of DHCP options, that you can then associate with a - Net using the [UpdateNet](#updatenet) method. + description: |- + Creates a set of DHCP options, that you can then associate with a Net using the [UpdateNet](#updatenet) method.

+ For more information, see [About DHCP Options](https://docs.outscale.com/en/userguide/About-DHCP-Options.html). post: operationId: CreateDhcpOptions requestBody: content: application/json: + examples: + ex1: + value: + DomainName: example.com + DomainNameServers: + - 192.0.2.0 + - 198.51.100.0 + NtpServers: + - 203.0.113.0 + - 203.0.113.1 schema: $ref: '#/components/schemas/CreateDhcpOptionsRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + DhcpOptionsSet: + Tags: [] + NtpServers: + - 203.0.113.0 + - 203.0.113.1 + Default: false + DhcpOptionsSetId: dopt-12345678 + DomainName: example.com + DomainNameServers: + - 192.0.2.0 + - 198.51.100.0 schema: $ref: '#/components/schemas/CreateDhcpOptionsResponse' description: The HTTP 200 response (OK). tags: - DhcpOption /CreateDirectLink: - description: Creates a DirectLink between a customer network and a specified DirectLink - location. + description: |- + Creates a DirectLink between a customer network and a specified DirectLink location.

+ For more information, see [About DirectLink](https://docs.outscale.com/en/userguide/About-DirectLink.html). post: operationId: CreateDirectLink requestBody: content: application/json: + examples: + ex1: + value: + Location: PAR1 + Bandwidth: 1Gbps + DirectLinkName: Connection to Outscale schema: $ref: '#/components/schemas/CreateDirectLinkRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + DirectLink: + AccountId: "123456789012" + Bandwidth: 1Gbps + DirectLinkId: dxcon-12345678 + DirectLinkName: Connection to Outscale + Location: PAR1 + RegionName: eu-west-2 + State: requested schema: $ref: '#/components/schemas/CreateDirectLinkResponse' description: The HTTP 200 response (OK). @@ -253,18 +551,50 @@ paths: /CreateDirectLinkInterface: description: |- Creates a DirectLink interface.
- DirectLink interfaces enable you to reach one of your Nets through a virtual gateway. + DirectLink interfaces enable you to reach one of your Nets through a virtual gateway.

+ For more information, see [About DirectLink](https://docs.outscale.com/en/userguide/About-DirectLink.html). post: operationId: CreateDirectLinkInterface requestBody: content: application/json: + examples: + ex1: + value: + DirectLinkId: dxcon-12345678 + DirectLinkInterface: + DirectLinkInterfaceName: MyDirectLinkInterface + Vlan: 101 + BgpAsn: 65000 + BgpKey: tgyn26example + OutscalePrivateIp: 172.16.0.4/30 + ClientPrivateIp: 172.16.0.5/30 + VirtualGatewayId: vgw-12345678 schema: $ref: '#/components/schemas/CreateDirectLinkInterfaceRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + DirectLinkInterface: + Vlan: 101 + OutscalePrivateIp: 172.16.0.4/30 + DirectLinkInterfaceId: dxvif-12345678 + BgpAsn: 65000 + AccountId: "123456789012" + ClientPrivateIp: 172.16.0.5/30 + VirtualGatewayId: vgw-12345678 + DirectLinkInterfaceName: MyDirectLinkInterface + DirectLinkId: dxcon-12345678 + Mtu: 1500 + State: pending + InterfaceType: private + Location: PAR1 schema: $ref: '#/components/schemas/CreateDirectLinkInterfaceResponse' description: The HTTP 200 response (OK). @@ -273,18 +603,38 @@ paths: /CreateFlexibleGpu: description: |- Allocates a flexible GPU (fGPU) to your account.
- You can then attach this fGPU to a virtual machine (VM). + You can then attach this fGPU to a virtual machine (VM).

+ For more information, see [About Flexible GPUs](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html). post: operationId: CreateFlexibleGpu requestBody: content: application/json: + examples: + ex1: + value: + ModelName: nvidia-p100 + Generation: v5 + SubregionName: eu-west-2a + DeleteOnVmDeletion: true schema: $ref: '#/components/schemas/CreateFlexibleGpuRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + FlexibleGpu: + SubregionName: eu-west-2a + DeleteOnVmDeletion: true + Generation: v5 + ModelName: nvidia-p100 + State: allocated + FlexibleGpuId: fgpu-12345678 schema: $ref: '#/components/schemas/CreateFlexibleGpuResponse' description: The HTTP 200 response (OK). @@ -292,28 +642,186 @@ paths: - FlexibleGpu /CreateImage: description: |- - Creates an OUTSCALE machine image (OMI) from an existing virtual machine (VM) which is either running or stopped.
- This action also creates a snapshot of the root volume of the VM, as well as a snapshot of each Block Storage Unit (BSU) volume attached to the VM. For more information, see [About OMIs](https://docs.outscale.com/en/userguide/About-OMIs.html).

+ Creates an OUTSCALE machine image (OMI).
+ You can use this method in different ways: + * **Creating from a VM**: You create an OMI from one of your virtual machines (VMs).
+ * **Copying an OMI**: You copy an existing OMI. The source OMI can be one of your own OMIs, or an OMI owned by another account that has granted you permission via the [UpdateImage](#updateimage) method.
+ * **Registering from a snapshot**: You register an OMI from an existing snapshot. The source snapshot can be one of your own snapshots, or a snapshot owned by another account that has granted you permission via the [UpdateSnapshot](#updatesnapshot) method.
+ * **Registering from a bucket by using a manifest file**: You register an OMI from the manifest file of an OMI that was exported to an OUTSCALE Object Storage (OOS) bucket. First, the owner of the source OMI must export it to the bucket by using the [CreateImageExportTask](#createimageexporttask) method. Then, they must grant you permission to read the manifest file via a pre-signed URL or Access Control Lists. For more information, see [Managing Access to Your Buckets and Objects](https://docs.outscale.com/en/userguide/Managing-Access-to-Your-Buckets-and-Objects.html).
+ * **Registering from a bucket without using a manifest file**: This is similar to the previous case but you manually specify all the information that would be in a manifest file instead of using a manifest file. - You can also use this method to copy an OMI to your account, from an account in the same Region. To do so, the owner of the source OMI must share it with your account. For more information about how to share an OMI with another account in the same Region, see [UpdateImage](#updateimage).
- To copy an OMI between accounts in different Regions, the owner of the source OMI must first export it to an OUTSCALE Object Storage (OOS) bucket using the [CreateImageExportTask](#createimageexporttask) method, and then you need to create a copy of the image in your account.
- The copy of the source OMI is independent and belongs to you.

+ **[TIP]**
+ Registering from a bucket enables you to copy an OMI across Regions. - You can also use this method to register an OMI to finalize its creation process.
- You can register an OMI from a snapshot of a root device to create an OMI based on this snapshot. You can also register an OMI that has been exported to an S3-compatible bucket to create a copy of it in your account. For more information about OMI export to an OOS bucket, see [CreateImageExportTask](#createimageexporttask).
- You can register an OMI using a pre-signed URL of the manifest file of the OMI. You do not need any permission for this OMI, or the bucket in which it is contained. The manifest file is obsolete seven days after a completed export as it contains pre-signed URLs to the appropriate snapshots (pre-signed URLs are valid for only seven days).
- Once the OMI is registered, you can launch a VM from this OMI. The copy of the source OMI is independent and belongs to you. + For more information, see [About OMIs](https://docs.outscale.com/en/userguide/About-OMIs.html). post: operationId: CreateImage requestBody: content: application/json: + examples: + ex1: + summary: Creating from a VM + value: + ImageName: create-image-example + VmId: i-12345678 + NoReboot: true + ex2: + summary: Copying an OMI + value: + ImageName: copy-image-example + SourceImageId: ami-12345678 + SourceRegionName: eu-west-2 + ex3: + summary: Registering from a snapshot + value: + ImageName: register-image-from-snapshot-example + BlockDeviceMappings: + - DeviceName: /dev/sda1 + Bsu: + SnapshotId: snap-12345678 + VolumeSize: 120 + VolumeType: io1 + Iops: 150 + DeleteOnVmDeletion: true + RootDeviceName: /dev/sda1 + ex4: + summary: Registering from a bucket by using a manifest file + value: + ImageName: register-image-from-bucket-example + FileLocation: https://oos.eu-west-2.outscale.com/BUCKET/KEY?AWSAccessKeyId=ABCDEFGHIJ0123456789&Expires=1493372309&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX schema: $ref: '#/components/schemas/CreateImageRequest' responses: "200": content: application/json: + examples: + ex1: + summary: Creating from a VM + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Image: + StateComment: {} + State: pending + RootDeviceType: bsu + RootDeviceName: /dev/sda1 + ProductCodes: + - "0001" + PermissionsToLaunch: + GlobalPermission: false + AccountIds: [] + AccountId: "123456789012" + Tags: [] + Description: "" + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: /dev/sda1 + Bsu: + VolumeType: standard + DeleteOnVmDeletion: true + VolumeSize: 50 + SnapshotId: snap-12345678 + ImageType: machine + CreationDate: 2010-10-01T12:34:56.789Z + FileLocation: 123456789012/create-image-example + Architecture: x86_64 + ImageName: create-image-example + ex2: + summary: Copying an OMI + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Image: + StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: /dev/sda1 + ProductCodes: + - "0001" + PermissionsToLaunch: + GlobalPermission: false + AccountIds: [] + AccountId: "123456789012" + Tags: [] + Description: "" + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: /dev/sda1 + Bsu: + VolumeType: standard + DeleteOnVmDeletion: true + VolumeSize: 50 + SnapshotId: snap-12345678 + ImageType: machine + CreationDate: 2010-10-01T12:34:56.789Z + FileLocation: 123456789012/copy-image-example + Architecture: x86_64 + ImageName: copy-image-example + ex3: + summary: Registering from a snapshot + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Image: + StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: /dev/sda1 + ProductCodes: + - "0001" + PermissionsToLaunch: + GlobalPermission: false + AccountIds: [] + AccountId: "123456789012" + Tags: [] + Description: "" + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: /dev/sda1 + Bsu: + VolumeType: io1 + DeleteOnVmDeletion: true + VolumeSize: 120 + Iops: 150 + SnapshotId: snap-12345678 + ImageType: machine + CreationDate: 2010-10-01T12:34:56.789Z + FileLocation: 123456789012/register-image-from-snapshot-example + Architecture: x86_64 + ImageName: register-image-from-snapshot-example + ex4: + summary: Registering from a bucket by using a manifest file + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Image: + StateComment: {} + State: pending + RootDeviceType: bsu + RootDeviceName: /dev/sda1 + ProductCodes: + - "0001" + PermissionsToLaunch: + GlobalPermission: false + AccountIds: [] + AccountId: "123456789012" + Tags: [] + Description: "" + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: /dev/sda1 + Bsu: + VolumeType: standard + DeleteOnVmDeletion: true + VolumeSize: 50 + SnapshotId: snap-12345678 + ImageType: machine + CreationDate: 2010-10-01T12:34:56.789Z + FileLocation: https://oos.eu-west-2.outscale.com/BUCKET/KEY?AWSAccessKeyId=ABCDEFGHIJ0123456789&Expires=1493372309&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + Architecture: x86_64 + ImageName: register-image-from-bucket-example schema: $ref: '#/components/schemas/CreateImageResponse' description: The HTTP 200 response (OK). @@ -343,19 +851,44 @@ paths: This action enables you to copy an OMI between accounts in different Regions. To copy an OMI in the same Region, you can also use the [CreateImage](#createimage) method.
The copy of the OMI belongs to you and is independent from the source OMI.

- **[NOTE]**
- You cannot export a shared or public OMI, as they do not belong to you. To do so, you must first copy it to your account. The copy then belongs to you and you can export it. + **[IMPORTANT]**
+ You cannot export a shared or public OMI, as they do not belong to you. To do so, you must first copy it to your account. The copy then belongs to you and you can export it.

+ For more information, see [About OMIs](https://docs.outscale.com/en/userguide/About-OMIs.html). post: operationId: CreateImageExportTask requestBody: content: application/json: + examples: + ex1: + value: + ImageId: ami-12345678 + OsuExport: + DiskImageFormat: qcow2 + OsuBucket: BUCKET + OsuPrefix: PREFIX schema: $ref: '#/components/schemas/CreateImageExportTaskRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ImageExportTask: + Tags: [] + ImageId: ami-12345678 + TaskId: image-export-12345678 + Comment: Export of image ami-12345678 + OsuExport: + OsuPrefix: PREFIX/ami-12345678/ + OsuBucket: BUCKET + DiskImageFormat: qcow2 + State: pending/queued + Progress: 0 schema: $ref: '#/components/schemas/CreateImageExportTaskResponse' description: The HTTP 200 response (OK). @@ -364,18 +897,30 @@ paths: /CreateInternetService: description: |- Creates an Internet service you can use with a Net.
- An Internet service enables your virtual machines (VMs) launched in a Net to connect to the Internet. By default, a Net includes an Internet service, and each Subnet is public. Every VM launched within a default Subnet has a private IP and a public IP. + An Internet service enables your virtual machines (VMs) launched in a Net to connect to the Internet. By default, a Net includes an Internet service, and each Subnet is public. Every VM launched within a default Subnet has a private IP and a public IP.

+ For more information, see [About Internet Services](https://docs.outscale.com/en/userguide/About-Internet-Services.html). post: operationId: CreateInternetService requestBody: content: application/json: + examples: + ex1: + value: {} schema: $ref: '#/components/schemas/CreateInternetServiceRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + InternetService: + Tags: [] + InternetServiceId: igw-12345678 schema: $ref: '#/components/schemas/CreateInternetServiceResponse' description: The HTTP 200 response (OK). @@ -401,22 +946,55 @@ paths: - InternetService /CreateKeypair: description: |- - Creates a 2048-bit RSA keypair with a specified name.
- This action returns the private key that you need to save. The public key is stored by 3DS OUTSCALE.

+ Creates a keypair to use with your virtual machines (VMs).
+ You can use this method in two different ways: + * **Creating a keypair**: In that case, 3DS OUTSCALE creates a 2048-bit RSA keypair, stores its public key in your account, and returns its private key in the response of the call so that you can save it in a file.
+ When you save the returned private key, make sure you replace the `\n` escape sequences with real line breaks. + * **Importing a keypair created locally**: If you already have a keypair that you have created locally with a third-party tool, you can import its public key in your account. The following types of key can be imported: RSA (2048 bits or preferably 4096 bits), ECDSA (256 bits), and Ed25519. The following formats can be used: PEM, PKCS8, RFC4716, and OpenSSH. - You can also import a public key. The following types of key can be imported: RSA (minimum 2048 bits, recommended 4096 bits), ECDSA (minimum and recommended 256 bits), and Ed25519. The following formats can be used: PEM, PKCS8, RFC4716, and OpenSSH.
- This action imports the public key of a keypair created by a third-party tool and uses it to create a keypair. The private key is never provided to 3DS OUTSCALE. + For more information, see [About Keypairs](https://docs.outscale.com/en/userguide/About-Keypairs.html). post: operationId: CreateKeypair requestBody: content: application/json: + examples: + ex1: + summary: Creating a keypair + value: + KeypairName: create-keypair-example + ex2: + summary: Importing a keypair created locally + value: + KeypairName: import-keypair-example + PublicKey: '...' schema: $ref: '#/components/schemas/CreateKeypairRequest' responses: "200": content: application/json: + examples: + ex1: + summary: Creating a keypair + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Keypair: + PrivateKey: |- + -----BEGIN RSA PRIVATE KEY----- + ... + -----END RSA PRIVATE KEY----- + KeypairName: create-keypair-example + KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff + ex2: + summary: Importing a keypair created locally + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Keypair: + KeypairName: create-keypair-example + KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff schema: $ref: '#/components/schemas/CreateKeypairResponse' description: The HTTP 200 response (OK). @@ -449,18 +1027,75 @@ paths: /CreateListenerRule: 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.
- Once the rule is created, you need to register backend VMs with it. For more information, see the [RegisterVmsInLoadBalancer](#registervmsinloadbalancer) method. + Once the rule is created, you need to register backend VMs with it. For more information, see the [RegisterVmsInLoadBalancer](#registervmsinloadbalancer) method.

+ For more information, see [About Load Balancers](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). post: operationId: CreateListenerRule requestBody: content: application/json: + examples: + ex1: + summary: Creating a listener rule based on a host pattern + value: + Listener: + LoadBalancerName: example-lbu + LoadBalancerPort: 80 + ListenerRule: + Action: forward + HostNamePattern: '*.example.com' + ListenerRuleName: example-listener-rule + Priority: 10 + VmIds: + - i-12345678 + ex2: + summary: Creating a listener rule based on a path pattern + value: + Listener: + LoadBalancerName: example-lbu + LoadBalancerPort: 80 + ListenerRule: + Action: forward + PathPattern: /docs/* + ListenerRuleName: example-listener-rule + Priority: 100 + VmIds: + - i-12345678 schema: $ref: '#/components/schemas/CreateListenerRuleRequest' responses: "200": content: application/json: + examples: + ex1: + summary: Creating a listener rule based on a host pattern + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ListenerRule: + Priority: 10 + VmIds: + - i-12345678 + ListenerRuleName: example-listener-rule + Action: forward + ListenerId: 123456 + HostNamePattern: '*.example.com' + ListenerRuleId: 1234 + ex2: + summary: Creating a listener rule based on a path pattern + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ListenerRule: + Priority: 100 + VmIds: + - i-12345678 + ListenerRuleName: example-listener-rule + Action: forward + ListenerId: 123456 + PathPattern: /docs/* + ListenerRuleId: 1234 schema: $ref: '#/components/schemas/CreateListenerRuleResponse' description: The HTTP 200 response (OK). @@ -471,36 +1106,250 @@ paths: Creates a load balancer.
The load balancer is created with a unique Domain Name Service (DNS) name. It receives the incoming traffic and routes it to its registered virtual machines (VMs).
By default, this action creates an Internet-facing load balancer, resolving to public IPs. To create an internal load balancer in a Net, resolving to private IPs, use the `LoadBalancerType` parameter.
- You must specify either the `Subnets` or the `SubregionNames` parameters. + You must specify either the `Subnets` or the `SubregionNames` parameters.

+ For more information, see [About Load Balancers](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). post: operationId: CreateLoadBalancer requestBody: content: application/json: + examples: + ex1: + summary: Creating an internal load balancer in a Net + value: + LoadBalancerName: private-lb-example + Listeners: + - BackendPort: 80 + BackendProtocol: TCP + LoadBalancerPort: 80 + LoadBalancerProtocol: TCP + Subnets: + - subnet-12345678 + SecurityGroups: + - sg-12345678 + LoadBalancerType: internal + ex2: + summary: Creating an internet-facing load balancer in a Net + value: + LoadBalancerName: private-lb-example + Listeners: + - BackendPort: 80 + BackendProtocol: HTTP + LoadBalancerPort: 443 + LoadBalancerProtocol: HTTPS + ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate + Subnets: + - subnet-12345678 + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing + PublicIp: 192.0.2.0 + ex3: + summary: Creating an internet-facing load balancer in the public Cloud + value: + LoadBalancerName: public-lb-example + SubregionNames: + - eu-west-2a + Listeners: + - BackendPort: 8080 + BackendProtocol: HTTP + LoadBalancerPort: 8080 + LoadBalancerProtocol: HTTP schema: $ref: '#/components/schemas/CreateLoadBalancerRequest' responses: "200": content: application/json: + examples: + ex1: + summary: Creating an internal load balancer in a Net + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: security-group-example + SecurityGroupAccountId: "123456789012" + SecuredCookies: false + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internal + AccessLog: + PublicationInterval: 60 + IsEnabled: false + DnsName: internal-private-lb-example.123456789.eu-west-2.lbu.outscale.com + HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 + CheckInterval: 30 + Protocol: TCP + HealthyThreshold: 10 + Port: 80 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a + Listeners: + - BackendPort: 80 + BackendProtocol: TCP + LoadBalancerPort: 80 + LoadBalancerProtocol: TCP + LoadBalancerName: private-lb-example + ex2: + summary: Creating an internet-facing load balancer in a Net + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: security-group-example + SecurityGroupAccountId: "123456789012" + SecuredCookies: false + PublicIp: 192.0.2.0 + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing + AccessLog: + PublicationInterval: 60 + IsEnabled: false + DnsName: private-lb-example.123456789.eu-west-2.lbu.outscale.com + HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 + CheckInterval: 30 + Protocol: TCP + HealthyThreshold: 10 + Port: 80 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a + Listeners: + - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate + BackendPort: 80 + BackendProtocol: HTTP + LoadBalancerPort: 443 + LoadBalancerProtocol: HTTPS + LoadBalancerName: private-lb-example + ex3: + summary: Creating an internet-facing load balancer in the public + Cloud + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: outscale-elb-sg + SecurityGroupAccountId: outscale-elb + SecuredCookies: false + Subnets: [] + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + LoadBalancerType: internet-facing + AccessLog: + PublicationInterval: 60 + IsEnabled: false + DnsName: public-lb-example.123456789.eu-west-2.lbu.outscale.com + HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 + CheckInterval: 30 + Protocol: TCP + HealthyThreshold: 10 + Port: 8080 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a + Listeners: + - BackendPort: 8080 + BackendProtocol: HTTP + LoadBalancerPort: 8080 + LoadBalancerProtocol: HTTP + LoadBalancerName: public-lb-example schema: $ref: '#/components/schemas/CreateLoadBalancerResponse' description: The HTTP 200 response (OK). tags: - LoadBalancer /CreateLoadBalancerListeners: - description: Creates one or more listeners for a specified load balancer. + description: |- + Creates one or more listeners for a specified load balancer.

+ For more information, see [About Load Balancers](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). post: operationId: CreateLoadBalancerListeners requestBody: content: application/json: + examples: + ex1: + value: + LoadBalancerName: example-lbu + Listeners: + - BackendPort: 58 + BackendProtocol: TCP + LoadBalancerPort: 62 + LoadBalancerProtocol: TCP schema: $ref: '#/components/schemas/CreateLoadBalancerListenersRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: security-group-example + SecurityGroupAccountId: "123456789012" + SecuredCookies: false + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internal + AccessLog: + PublicationInterval: 60 + IsEnabled: false + DnsName: internal-example-lbu.123456789.eu-west-2.lbu.outscale.com + HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 + CheckInterval: 30 + Protocol: TCP + HealthyThreshold: 10 + Port: 80 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a + Listeners: + - BackendPort: 58 + BackendProtocol: TCP + LoadBalancerPort: 62 + LoadBalancerProtocol: TCP + - BackendPort: 80 + BackendProtocol: TCP + LoadBalancerPort: 80 + LoadBalancerProtocol: TCP + LoadBalancerName: example-lbu schema: $ref: '#/components/schemas/CreateLoadBalancerListenersResponse' description: The HTTP 200 response (OK). @@ -514,18 +1363,114 @@ paths: You can also create a stickiness policy with sticky session lifetimes following the lifetime of an application-generated cookie.
Unlike the other type of stickiness policy, the lifetime of the special Load Balancer Unit (LBU) cookie follows the lifetime of the application-generated cookie specified in the policy configuration. The load balancer inserts a new stickiness cookie only when the application response includes a new application cookie.
- The session stops being sticky if the application cookie is removed or expires, until a new application cookie is issued. + The session stops being sticky if the application cookie is removed or expires, until a new application cookie is issued.

+ For more information, see [About Load Balancers](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). post: operationId: CreateLoadBalancerPolicy requestBody: content: application/json: + examples: + ex1: + summary: Creating a load balancer policy based on browser + value: + LoadBalancerName: example-lbu + PolicyName: example-browser-policy + PolicyType: load_balancer + ex2: + summary: Creating a load balancer policy based on application cookie + value: + LoadBalancerName: example-lbu + PolicyName: example-app-policy + PolicyType: app + CookieName: example-cookie schema: $ref: '#/components/schemas/CreateLoadBalancerPolicyRequest' responses: "200": content: application/json: + examples: + ex1: + summary: Creating a load balancer policy based on browser + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: default + SecurityGroupAccountId: "123456789012" + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing + AccessLog: + PublicationInterval: 60 + IsEnabled: false + DnsName: example-lbu-123456789.eu-west-2.lbu.outscale.com + HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 + CheckInterval: 30 + Protocol: TCP + HealthyThreshold: 10 + Port: 80 + LoadBalancerStickyCookiePolicies: + - PolicyName: example-browser-policy + CookieExpirationPeriod: 1 + SubregionNames: + - eu-west-2a + Listeners: + - BackendPort: 80 + BackendProtocol: HTTP + LoadBalancerPort: 80 + LoadBalancerProtocol: HTTP + LoadBalancerName: example-lbu + ex2: + summary: Creating a load balancer policy based on application cookie + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: default + SecurityGroupAccountId: "123456789012" + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: + - PolicyName: example-app-policy + CookieName: example-cookie + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing + AccessLog: + PublicationInterval: 60 + IsEnabled: false + DnsName: example-lbu-123456789.eu-west-2.lbu.outscale.com + HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 + CheckInterval: 30 + Protocol: TCP + HealthyThreshold: 10 + Port: 80 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a + Listeners: + - BackendPort: 80 + BackendProtocol: HTTP + LoadBalancerPort: 80 + LoadBalancerProtocol: HTTP + LoadBalancerName: example-lbu schema: $ref: '#/components/schemas/CreateLoadBalancerPolicyResponse' description: The HTTP 200 response (OK). @@ -534,18 +1479,32 @@ paths: /CreateLoadBalancerTags: description: |- Adds one or more tags to the specified load balancers.
- If a tag with the same key already exists for the load balancer, the tag value is replaced. + If a tag with the same key already exists for the load balancer, the tag value is replaced.

+ For more information, see [About Tags](https://docs.outscale.com/en/userguide/About-Tags.html). post: operationId: CreateLoadBalancerTags requestBody: content: application/json: + examples: + ex1: + value: + LoadBalancerNames: + - private-lb-example + Tags: + - Key: key1 + Value: value1 schema: $ref: '#/components/schemas/CreateLoadBalancerTagsRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/CreateLoadBalancerTagsResponse' description: The HTTP 200 response (OK). @@ -558,19 +1517,39 @@ paths: When creating a NAT service, you specify the allocation ID of the public IP you want to use as public IP for the NAT service. Once the NAT service is created, you need to create a route in the route table of the private Subnet, with 0.0.0.0/0 as destination and the ID of the NAT service as target. For more information, see [LinkPublicIP](#linkpublicip) and [CreateRoute](#createroute).
This action also enables you to create multiple NAT services in the same Net (one per public Subnet).

- **[NOTE]**
- You cannot modify the public IP associated with a NAT service after its creation. To do so, you need to delete the NAT service and create a new one with another public IP. + **[IMPORTANT]**
+ You cannot modify the public IP associated with a NAT service after its creation. To do so, you need to delete the NAT service and create a new one with another public IP.

+ For more information, see [About NAT Services](https://docs.outscale.com/en/userguide/About-NAT-Services.html). post: operationId: CreateNatService requestBody: content: application/json: + examples: + ex1: + value: + SubnetId: subnet-12345678 + PublicIpId: eipalloc-12345678 schema: $ref: '#/components/schemas/CreateNatServiceRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + NatService: + Tags: [] + SubnetId: subnet-12345678 + NatServiceId: nat-12345678 + PublicIps: + - PublicIpId: eipalloc-12345678 + PublicIp: 192.0.2.0 + NetId: vpc-12345678 + State: available schema: $ref: '#/components/schemas/CreateNatServiceResponse' description: The HTTP 200 response (OK). @@ -597,18 +1576,35 @@ paths: /CreateNet: description: |- Creates a Net with a specified IP range.
- The IP range (network range) of your Net must be between a /28 netmask (16 IPs) and a /16 netmask (65536 IPs). + The IP range (network range) of your Net must be between a /28 netmask (16 IPs) and a /16 netmask (65536 IPs).

+ For more information, see [About Nets](https://docs.outscale.com/en/userguide/About-Nets.html). post: operationId: CreateNet requestBody: content: application/json: + examples: + ex1: + value: + IpRange: 10.0.0.0/16 schema: $ref: '#/components/schemas/CreateNetRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Net: + Tags: [] + DhcpOptionsSetId: dopt-12345678 + IpRange: 10.0.0.0/16 + Tenancy: default + NetId: vpc-12345678 + State: available schema: $ref: '#/components/schemas/CreateNetResponse' description: The HTTP 200 response (OK). @@ -642,18 +1638,39 @@ paths: description: |- Creates a Net access point to access an OUTSCALE service from this Net without using the Internet and public IPs.
You specify the service using its name. For more information about the available services, see [ReadNetAccessPointServices](#readnetaccesspointservices).
- To control the routing of traffic between the Net and the specified service, you can specify one or more route tables. Virtual machines placed in Subnets associated with the specified route table thus use the Net access point to access the service. When you specify a route table, a route is automatically added to it with the destination set to the prefix list ID of the service, and the target set to the ID of the access point. + To control the routing of traffic between the Net and the specified service, you can specify one or more route tables. Virtual machines placed in Subnets associated with the specified route table thus use the Net access point to access the service. When you specify a route table, a route is automatically added to it with the destination set to the prefix list ID of the service, and the target set to the ID of the access point.

+ For more information, see [About Net Access Points](https://docs.outscale.com/en/userguide/About-Net-Access-Points.html). post: operationId: CreateNetAccessPoint requestBody: content: application/json: + examples: + ex1: + value: + NetId: vpc-12345678 + RouteTableIds: + - rtb-12345678 + ServiceName: com.outscale.eu-west-2.oos schema: $ref: '#/components/schemas/CreateNetAccessPointRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + NetAccessPoint: + Tags: [] + NetAccessPointId: vpce-12345678 + RouteTableIds: + - rtb-12345678 + State: pending + NetId: vpc-12345678 + ServiceName: com.outscale.eu-west-2.oos schema: $ref: '#/components/schemas/CreateNetAccessPointResponse' description: The HTTP 200 response (OK). @@ -664,21 +1681,47 @@ paths: Requests a Net peering between a Net you own and a peer Net that belongs to you or another account.
This action creates a Net peering that remains in the `pending-acceptance` state until it is accepted by the owner of the peer Net. If the owner of the peer Net does not accept the request within 7 days, the state of the Net peering becomes `expired`. For more information, see [AcceptNetPeering](#acceptnetpeering).

- **[NOTE]**
+ **[IMPORTANT]**
* Peered Nets must contain at least one virtual machine (VM) each before the creation of the Net peering.
* The two Nets must not have overlapping IP ranges. Otherwise, the Net peering is in the `failed` state.
* A peering connection between two Nets works both ways. Therefore, you do not need to create a B-to-A connection if an A-to-B connection is created and accepted. + + For more information, see [About Net Peerings](https://docs.outscale.com/en/userguide/About-Net-Peerings.html). post: operationId: CreateNetPeering requestBody: content: application/json: + examples: + ex1: + value: + SourceNetId: vpc-12345678 + AccepterNetId: vpc-87654321 schema: $ref: '#/components/schemas/CreateNetPeeringRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + NetPeering: + Tags: [] + SourceNet: + NetId: vpc-12345678 + IpRange: 10.0.0.0/16 + AccountId: "123456789012" + NetPeeringId: pcx-12345678 + AccepterNet: + NetId: vpc-12345678 + IpRange: 172.16.0.0/16 + AccountId: "123456789012" + State: + Name: pending-acceptance + Message: Pending acceptance by 123456789012 schema: $ref: '#/components/schemas/CreateNetPeeringResponse' description: The HTTP 200 response (OK). @@ -703,18 +1746,91 @@ paths: tags: - NetPeering /CreateNic: - description: Creates a network interface card (NIC) in the specified Subnet. + description: |- + Creates a network interface card (NIC) in the specified Subnet.

+ For more information, see [About NICs](https://docs.outscale.com/en/userguide/About-NICs.html). post: operationId: CreateNic requestBody: content: application/json: + examples: + ex1: + summary: Creating a NIC + value: + SubnetId: subnet-12345678 + SecurityGroupIds: + - sg-12345678 + ex2: + summary: Creating a NIC with specific private IPs + value: + Description: Terraform nic with private IPs + SubnetId: subnet-12345678 + SecurityGroupIds: + - sg-12345678 + PrivateIps: + - IsPrimary: true + PrivateIp: 10.0.0.4 + - IsPrimary: false + PrivateIp: 10.0.0.5 schema: $ref: '#/components/schemas/CreateNicRequest' responses: "200": content: application/json: + examples: + ex1: + summary: Creating a NIC + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Nic: + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + State: available + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Tags: [] + Description: "" + AccountId: "123456789012" + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 + MacAddress: A1:B2:C3:D4:E5:F6 + NetId: vpc-12345678 + NicId: eni-12345678 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true + ex2: + summary: Creating a NIC with specific private IPs + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Nic: + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + State: available + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Tags: [] + Description: "" + AccountId: "123456789012" + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 + MacAddress: A1:B2:C3:D4:E5:F6 + NetId: vpc-12345678 + NicId: eni-12345678 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true + - PrivateDnsName: ip-10-0-0-5.eu-west-2.compute.internal + PrivateIp: 10.0.0.5 + IsPrimary: false schema: $ref: '#/components/schemas/CreateNicResponse' description: The HTTP 200 response (OK). @@ -738,21 +1854,149 @@ paths: description: The HTTP 500 response (Internal Server Error). tags: - Nic + /CreatePolicy: + description: |- + Creates a managed policy to apply to a user.
+ This action creates a policy version and sets v1 as the default one. + post: + operationId: CreatePolicy + requestBody: + content: + application/json: + examples: + ex1: + value: + Description: Example of description + Document: '{"Statement": [ {"Action": ["*"],"Effect","Allow","Resource": + ["*"]} ]}' + Path: /example/ + PolicyName: example-user-policy + schema: + $ref: '#/components/schemas/CreatePolicyRequest' + responses: + "200": + content: + application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Policy: + CreationDate: 2010-10-01T12:34:56.789Z + Description: Example of description + IsLinkable: true + LastModificationDate: 2010-10-01T12:34:56.789Z + Orn: orn:ows:idauth::012345678910:user-policy/Policy + Path: /example/ + PolicyDefaultVersionId: version-12345678 + PolicyId: policy-12345678 + PolicyName: example-user-policy + ResourcesCount: 0 + schema: + $ref: '#/components/schemas/CreatePolicyResponse' + description: The HTTP 200 response (OK). + tags: + - Policy + /CreatePolicyVersion: + description: |- + Creates a version of a specified managed policy.
+ A managed policy can have up to five versions. + post: + operationId: CreatePolicyVersion + requestBody: + content: + application/json: + examples: + ex1: + value: + Document: '{"Statement": [ {"Action": ["*"],"Effect","Allow","Resource": + ["*"]} ]}' + PolicyOrn: orn:ows:idauth::012345678910:user-policy/Policy + SetAsDefault: true + schema: + $ref: '#/components/schemas/CreatePolicyVersionRequest' + responses: + "200": + content: + application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + PolicyVersion: + Body: '{"Statement": [ {"Action": ["*"],"Effect","Allow","Resource": + ["*"]} ]}' + CreationDate: 2010-10-01T12:34:56.789Z + DefaultVersion: true + VersionId: version-12345678 + schema: + $ref: '#/components/schemas/CreatePolicyVersionResponse' + description: The HTTP 200 response (OK). + tags: + - Policy + /CreateProductType: + description: Creates a product type you can associate with an OMI for consumption + monitoring and billing purposes. + post: + operationId: CreateProductType + requestBody: + content: + application/json: + examples: + ex1: + value: + Vendor: vendor-name + Description: Example of description + schema: + $ref: '#/components/schemas/CreateProductTypeRequest' + responses: + "200": + content: + application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ProductType: + Vendor: vendor-name + ProductTypeId: pty-12345678 + Description: Example of description + schema: + $ref: '#/components/schemas/CreateProductTypeResponse' + description: The HTTP 200 response (OK). + tags: + - ProductType /CreatePublicIp: description: |- Acquires a public IP for your account.
- A public IP is a static IP designed for dynamic Cloud computing. It can be associated with a virtual machine (VM) in the public Cloud or in a Net, a network interface card (NIC), a NAT service. + A public IP is a static IP designed for dynamic Cloud computing. It can be associated with a virtual machine (VM) in the public Cloud or in a Net, a network interface card (NIC), a NAT service.

+ For more information, see [About Public IPs](https://docs.outscale.com/en/userguide/About-Public-IPs.html). post: operationId: CreatePublicIp requestBody: content: application/json: + examples: + ex1: + value: {} schema: $ref: '#/components/schemas/CreatePublicIpRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + PublicIp: + Tags: [] + PublicIpId: eipalloc-12345678 + PublicIp: 192.0.2.0 schema: $ref: '#/components/schemas/CreatePublicIpResponse' description: The HTTP 200 response (OK). @@ -788,18 +2032,46 @@ paths: * NAT service
* Network interface card (NIC)

- The routing algorithm is based on the most specific match. + The routing algorithm is based on the most specific match.

+ For more information, see [About Route Tables](https://docs.outscale.com/en/userguide/About-Route-Tables.html). post: operationId: CreateRoute requestBody: content: application/json: + examples: + ex1: + summary: Creating a route to an Internet service + value: + RouteTableId: rtb-12345678 + DestinationIpRange: 0.0.0.0/0 + GatewayId: igw-12345678 schema: $ref: '#/components/schemas/CreateRouteRequest' responses: "200": content: application/json: + examples: + ex1: + summary: Creating a route to an Internet service + value: + RouteTable: + Routes: + - DestinationIpRange: 10.0.0.0/16 + CreationMethod: CreateRouteTable + State: active + - GatewayId: igw-12345678 + DestinationIpRange: 0.0.0.0/0 + CreationMethod: CreateRoute + State: active + LinkRouteTables: [] + NetId: vpc-12345678 + Tags: [] + RoutePropagatingVirtualGateways: [] + RouteTableId: rtb-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/CreateRouteResponse' description: The HTTP 200 response (OK). @@ -826,18 +2098,38 @@ paths: /CreateRouteTable: description: |- Creates a route table for a specified Net.
- You can then add routes and associate this route table with a Subnet. + You can then add routes and associate this route table with a Subnet.

+ For more information, see [About Route Tables](https://docs.outscale.com/en/userguide/About-Route-Tables.html). post: operationId: CreateRouteTable requestBody: content: application/json: + examples: + ex1: + value: + NetId: vpc-12345678 schema: $ref: '#/components/schemas/CreateRouteTableRequest' responses: "200": content: application/json: + examples: + ex1: + value: + RouteTable: + Routes: + - DestinationIpRange: 10.0.0.0/16 + CreationMethod: CreateRouteTable + State: active + LinkRouteTables: [] + NetId: vpc-12345678 + Tags: [] + RoutePropagatingVirtualGateways: [] + RouteTableId: rtb-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/CreateRouteTableResponse' description: The HTTP 200 response (OK). @@ -868,18 +2160,44 @@ paths: When launching a virtual machine (VM), if no security group is explicitly specified, the appropriate default security group is assigned to the VM. Default security groups include a default rule granting VMs network access to each other.
When creating a security group, you specify a name. Two security groups for use in the public Cloud or for use in a Net cannot have the same name.
You can have up to 500 security groups in the public Cloud. You can create up to 500 security groups per Net.
- To add or remove rules, use the [CreateSecurityGroupRule](#createsecuritygrouprule) method. + To add or remove rules, use the [CreateSecurityGroupRule](#createsecuritygrouprule) method.

+ For more information, see [About Security Groups](https://docs.outscale.com/en/userguide/About-Security-Groups.html). post: operationId: CreateSecurityGroup requestBody: content: application/json: + examples: + ex1: + value: + NetId: vpc-12345678 + SecurityGroupName: security-group-example + Description: Security group example schema: $ref: '#/components/schemas/CreateSecurityGroupRequest' responses: "200": content: application/json: + examples: + ex1: + value: + SecurityGroup: + Tags: [] + SecurityGroupName: security-group-example + OutboundRules: + - FromPortRange: -1 + IpProtocol: -1 + ToPortRange: -1 + IpRanges: + - 0.0.0.0/0 + SecurityGroupId: sg-12345678 + AccountId: "123456789012" + Description: Example of security group + InboundRules: [] + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/CreateSecurityGroupResponse' description: The HTTP 200 response (OK). @@ -919,17 +2237,92 @@ paths: **[NOTE]**
* The modifications are effective as quickly as possible, but a small delay may occur.
* By default, traffic between two security groups is allowed through both public and private IPs. To restrict traffic to private IPs only, contact our Support team at support@outscale.com. + + For more information, see [About Security Group Rules](https://docs.outscale.com/en/userguide/About-Security-Group-Rules.html). post: operationId: CreateSecurityGroupRule requestBody: content: application/json: + examples: + ex1: + summary: Creating an inbound rule from an IP range + value: + Flow: Inbound + SecurityGroupId: sg-12345678 + FromPortRange: 80 + ToPortRange: 80 + IpProtocol: tcp + IpRange: 10.0.0.0/16 + ex2: + summary: Creating an inbound rule from another security group + value: + Flow: Inbound + SecurityGroupId: sg-12345678 + Rules: + - FromPortRange: 22 + ToPortRange: 22 + IpProtocol: tcp + SecurityGroupsMembers: + - AccountId: "123456789012" + SecurityGroupName: another-security-group schema: $ref: '#/components/schemas/CreateSecurityGroupRuleRequest' responses: "200": content: application/json: + examples: + ex1: + summary: Creating an inbound rule from an IP range + value: + SecurityGroup: + Tags: [] + SecurityGroupName: security-group-example + OutboundRules: + - FromPortRange: -1 + IpProtocol: -1 + ToPortRange: -1 + IpRanges: + - 0.0.0.0/0 + SecurityGroupId: sg-12345678 + AccountId: "123456789012" + Description: Example of security group + InboundRules: + - FromPortRange: 80 + IpProtocol: tcp + ToPortRange: 80 + IpRanges: + - 10.0.0.0/16 + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Creating an inbound rule from another security group + value: + SecurityGroup: + Tags: [] + SecurityGroupName: security-group-example + OutboundRules: + - FromPortRange: -1 + IpProtocol: -1 + ToPortRange: -1 + IpRanges: + - 0.0.0.0/0 + SecurityGroupId: sg-12345678 + AccountId: "123456789012" + Description: Example of security group + InboundRules: + - FromPortRange: 22 + IpProtocol: tcp + ToPortRange: 22 + SecurityGroupsMembers: + - SecurityGroupName: another-security-group + SecurityGroupId: sg-87654321 + AccountId: "987654321098" + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/CreateSecurityGroupRuleResponse' description: The HTTP 200 response (OK). @@ -960,18 +2353,37 @@ paths: You can also specify the chain of intermediate certification authorities if your certificate is not directly signed by a root one. You can specify multiple intermediate certification authorities in the `CertificateChain` parameter. To do so, concatenate all certificates in the correct order (the first certificate must be the authority of your certificate, the second must the the authority of the first one, and so on).

The private key must be a RSA key in PKCS1 form. To check this, open the PEM file and ensure its header reads as follows: BEGIN RSA PRIVATE KEY.

[IMPORTANT]

- This private key must not be protected by a password or a passphrase. + This private key must not be protected by a password or a passphrase.

+ For more information, see [About Server Certificates in EIM](https://docs.outscale.com/en/userguide/About-Server-Certificates-in-EIM.html). post: operationId: CreateServerCertificate requestBody: content: application/json: + examples: + ex1: + value: + Name: server-cert-example + Body: '...' + Chain: '...' + PrivateKey: '...' + Path: /example/ schema: $ref: '#/components/schemas/CreateServerCertificateRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ServerCertificate: + Path: /example/ + Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ1234 + Orn: orn:ows:idauth::012345678910:server-certificate/example/server-cert-example + Name: server-cert-example + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/CreateServerCertificateResponse' description: The HTTP 200 response (OK). @@ -981,20 +2393,95 @@ paths: 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.
You can use this method in three different ways: - * **Creating**: You create a snapshot from one of your volumes.
- * **Copying**: You copy an existing snapshot. The source snapshot can be one of your own snapshots, or a snapshot owned by another account that has granted you permission via the [UpdateSnapshot](#updatesnapshot) method.
- * **Importing**: You import a snapshot located in an OUTSCALE Object Storage (OOS) bucket. First, the owner of the source snapshot must export it to the bucket by using the [CreateSnapshotExportTask](#createsnapshotexporttask) method. Then, they must grant you read permission on the bucket via a pre-signed URL or Access Control Lists. For more information, see [Managing Access to Your Buckets and Objects](https://docs.outscale.com/en/userguide/Managing-Access-to-Your-Buckets-and-Objects.html). + * **Creating from a volume**: You create a snapshot from one of your volumes.
+ * **Copying a snapshot**: You copy an existing snapshot. The source snapshot can be one of your own snapshots, or a snapshot owned by another account that has granted you permission via the [UpdateSnapshot](#updatesnapshot) method.
+ * **Importing from a bucket**: You import a snapshot located in an OUTSCALE Object Storage (OOS) bucket. First, the owner of the source snapshot must export it to the bucket by using the [CreateSnapshotExportTask](#createsnapshotexporttask) method. Then, they must grant you permission to read the snapshot via a pre-signed URL or Access Control Lists. For more information, see [Managing Access to Your Buckets and Objects](https://docs.outscale.com/en/userguide/Managing-Access-to-Your-Buckets-and-Objects.html). + + For more information, see [About Snapshots](https://docs.outscale.com/en/userguide/About-Snapshots.html). post: operationId: CreateSnapshot requestBody: content: application/json: + examples: + ex1: + summary: Creating from a volume + value: + VolumeId: vol-12345678 + Description: Snapshot created from a volume + ex2: + summary: Copying a snapshot + value: + SourceSnapshotId: snap-12345678 + SourceRegionName: eu-west-2 + Description: Snapshot created from another snapshot + ex3: + summary: Importing from a bucket + value: + FileLocation: https://oos.eu-west-2.outscale.com/BUCKET/KEY?AWSAccessKeyId=ABCDEFGHIJ0123456789&Expires=1493372309&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + SnapshotSize: 10737418240 + Description: Snapshot imported from a bucket schema: $ref: '#/components/schemas/CreateSnapshotRequest' responses: "200": content: application/json: + examples: + ex1: + summary: Creating from a volume + value: + Snapshot: + VolumeSize: 10 + AccountId: "123456789012" + VolumeId: vol-12345678 + CreationDate: 2010-10-01T12:34:56.789Z + PermissionsToCreateVolume: + GlobalPermission: false + AccountIds: [] + Progress: 0 + SnapshotId: snap-12345678 + State: pending/queued + Description: Snapshot created from a volume + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Copying a snapshot + value: + Snapshot: + VolumeSize: 10 + AccountId: "123456789012" + VolumeId: vol-12345678 + CreationDate: 2010-10-01T12:34:56.789Z + PermissionsToCreateVolume: + GlobalPermission: false + AccountIds: [] + Progress: 100 + SnapshotId: snap-12345678 + State: completed + Description: Snapshot copied from another snapshot + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex3: + summary: Importing from a bucket + value: + Snapshot: + VolumeSize: 10 + AccountId: "123456789012" + VolumeId: vol-12345678 + CreationDate: 2010-10-01T12:34:56.789Z + PermissionsToCreateVolume: + GlobalPermission: false + AccountIds: [] + Progress: 0 + SnapshotId: snap-12345678 + State: importing + Description: Snapshot imported from a bucket + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/CreateSnapshotResponse' description: The HTTP 200 response (OK). @@ -1021,19 +2508,44 @@ paths: /CreateSnapshotExportTask: description: |- Exports a snapshot to an OUTSCALE Object Storage (OOS) bucket.
- This action enables you to create a backup of your snapshot or to copy it to another account. You, or other users you send a pre-signed URL to, can then download this snapshot from the bucket using the [CreateSnapshot](#createsnapshot) method.
- This procedure enables you to copy a snapshot between accounts within the same Region or in different Regions. To copy a snapshot within the same Region, you can also use the [CreateSnapshot](#createsnapshot) direct method. The copy of the source snapshot is independent and belongs to you. + This action enables you to create a backup of your snapshot or to copy it to another account. You, or other accounts you send a pre-signed URL to, can then download this snapshot from the bucket using the [CreateSnapshot](#createsnapshot) method.
+ This procedure enables you to copy a snapshot between accounts within the same Region or in different Regions. To copy a snapshot within the same Region, you can also use the [CreateSnapshot](#createsnapshot) direct method. The copy of the source snapshot is independent and belongs to you.

+ For more information, see [About Snapshots](https://docs.outscale.com/en/userguide/About-Snapshots.html). post: operationId: CreateSnapshotExportTask requestBody: content: application/json: + examples: + ex1: + value: + SnapshotId: snap-12345678 + OsuExport: + DiskImageFormat: qcow2 + OsuBucket: BUCKET + OsuPrefix: PREFIX schema: $ref: '#/components/schemas/CreateSnapshotExportTaskRequest' responses: "200": content: application/json: + examples: + ex1: + value: + SnapshotExportTask: + Tags: [] + TaskId: snap-export-12345678 + Comment: Export of snapshot snap-12345678 + OsuExport: + OsuPrefix: PREFIX + OsuBucket: BUCKET + DiskImageFormat: qcow2 + State: pending + SnapshotId: snap-12345678 + Progress: 0 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/CreateSnapshotExportTaskResponse' description: The HTTP 200 response (OK). @@ -1042,18 +2554,38 @@ paths: /CreateSubnet: description: |- Creates a Subnet in an existing Net.
- To create a Subnet in a Net, you have to provide the ID of the Net and the IP range for the Subnet (its network range). Once the Subnet is created, you cannot modify its IP range. + To create a Subnet in a Net, you have to provide the ID of the Net and the IP range for the Subnet (its network range). Once the Subnet is created, you cannot modify its IP range.

+ For more information, see [About Nets](https://docs.outscale.com/en/userguide/About-Nets.html). post: operationId: CreateSubnet requestBody: content: application/json: + examples: + ex1: + value: + NetId: vpc-12345678 + IpRange: 10.0.0.0/18 schema: $ref: '#/components/schemas/CreateSubnetRequest' responses: "200": content: application/json: + examples: + ex1: + value: + Subnet: + Tags: [] + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + AvailableIpsCount: 16379 + IpRange: 10.0.0.0/18 + MapPublicIpOnLaunch: false + State: available + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/CreateSubnetResponse' description: The HTTP 200 response (OK). @@ -1109,17 +2641,32 @@ paths: * DHCP options (dopt-xxxxxxxx)
* OMI export tasks (image-export-xxxxxxxx)
* Snapshot export tasks (snap-export-xxxxxxxx) + + For more information, see [About Tags](https://docs.outscale.com/en/userguide/About-Tags.html). post: operationId: CreateTags requestBody: content: application/json: + examples: + ex1: + value: + ResourceIds: + - i-12345678 + Tags: + - Key: key1 + Value: value1 schema: $ref: '#/components/schemas/CreateTagsRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/CreateTagsResponse' description: The HTTP 200 response (OK). @@ -1144,18 +2691,34 @@ paths: tags: - Tag /CreateUser: - description: Creates an EIM user for your account. + description: |- + Creates an EIM user for your account.

+ For more information, see [About EIM Users](https://docs.outscale.com/en/userguide/About-EIM-Users.html). post: operationId: CreateUser requestBody: content: application/json: + examples: + ex1: + value: + UserName: example-user + Path: /documentation/ schema: $ref: '#/components/schemas/CreateUserRequest' responses: "200": content: application/json: + examples: + ex1: + value: + User: + UserName: example-user + UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 + Path: /documentation/ + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/CreateUserResponse' description: The HTTP 200 response (OK). @@ -1164,18 +2727,34 @@ paths: /CreateVirtualGateway: description: |- Creates a virtual gateway.
- A virtual gateway is the access point on the Net side of a VPN connection. + A virtual gateway is the access point on the Net side of a VPN connection.

+ For more information, see [About Virtual Gateways](https://docs.outscale.com/en/userguide/About-Virtual-Gateways.html). post: operationId: CreateVirtualGateway requestBody: content: application/json: + examples: + ex1: + value: + ConnectionType: ipsec.1 schema: $ref: '#/components/schemas/CreateVirtualGatewayRequest' responses: "200": content: application/json: + examples: + ex1: + value: + VirtualGateway: + VirtualGatewayId: vgw-12345678 + ConnectionType: ipsec.1 + NetToVirtualGatewayLinks: [] + State: available + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/CreateVirtualGatewayResponse' description: The HTTP 200 response (OK). @@ -1193,12 +2772,47 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + Description: Production log collector + PositioningStrategy: attract + SecurityGroupIds: + - sg-12345678 + SubnetId: subnet-12345678 + Tags: + - Key: key1 + Value: value1 + VmCount: 2 + VmGroupName: ClusterLog-PPD01 + VmTemplateId: vmtemplate-98765432109876543210987654321012 schema: $ref: '#/components/schemas/CreateVmGroupRequest' responses: "200": content: application/json: + examples: + ex1: + value: + VmGroup: + CreationDate: 2010-10-01T12:34:56.789Z + Description: Production log collector + PositioningStrategy: attract + SecurityGroupIds: + - sg-12345678 + State: available + SubnetId: subnet-12345678 + Tags: + - Key: key1 + Value: value1 + VmCount: 2 + VmGroupId: vmgroup-12345678901234567890123456789012 + VmGroupName: ClusterLog-PPD01 + VmIds: [] + VmTemplateId: vmtemplate-98765432109876543210987654321012 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/CreateVmGroupResponse' description: The HTTP 200 response (OK). @@ -1234,12 +2848,43 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + CpuCores: 2 + CpuGeneration: v4 + CpuPerformance: high + Description: Log collector template + ImageId: ami-12345678 + KeypairName: keypair-example + Ram: 2 + Tags: + - Key: key1 + Value: value1 + VmTemplateName: vmtemplate-example schema: $ref: '#/components/schemas/CreateVmTemplateRequest' responses: "200": content: application/json: + examples: + ex1: + value: + VmTemplateName: vmtemplate-example + CpuPerformance: high + CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + CpuCores: 2 + Tags: + - Key: key1 + Value: value1 + Description: Log collector template + ImageId: ami-12345678 + CpuGeneration: v4 + VmTemplateId: vmtemplate-98765432109876543210987654321012 + Ram: 2 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/CreateVmTemplateResponse' description: The HTTP 200 response (OK). @@ -1252,18 +2897,319 @@ paths: 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.
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. + 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.

+ For more information, see [About VMs](https://docs.outscale.com/en/userguide/About-VMs.html). post: operationId: CreateVms requestBody: content: application/json: + examples: + ex1: + summary: Creating a VM (minimal syntax) + value: + ImageId: ami-12345678 + ex2: + summary: Creating a VM in a Net + value: + ImageId: ami-12345678 + VmType: tinav5.c1r1p2 + KeypairName: keypair-example + SecurityGroupIds: + - sg-12345678 + SubnetId: subnet-12345678 + UserData: '...' + ex3: + summary: Creating a VM with block device mappings + value: + ImageId: ami-12345678 + VmType: tinav5.c1r1p2 + KeypairName: keypair-example + SecurityGroupIds: + - sg-12345678 + SubnetId: subnet-12345678 + UserData: '...' + BlockDeviceMappings: + - DeviceName: /dev/sda1 + Bsu: + VolumeSize: 15 + VolumeType: gp2 + - DeviceName: /dev/sdb + Bsu: + SnapshotId: snap-12345678 + VolumeSize: 22 + VolumeType: io1 + Iops: 150 + ex4: + summary: Creating a VM with a NIC + value: + ImageId: ami-12345678 + VmType: tinav5.c1r1p2 + KeypairName: keypair-example + UserData: '...' + Nics: + - DeviceNumber: 0 + NicId: eni-12345678 schema: $ref: '#/components/schemas/CreateVmsRequest' responses: "200": content: application/json: + examples: + ex1: + summary: Creating a VM (minimal syntax) + value: + Vms: + - VmType: t2.small + VmInitiatedShutdownBehavior: stop + State: pending + StateReason: "" + RootDeviceType: ebs + RootDeviceName: /dev/sda1 + IsSourceDestChecked: true + ImageId: ami-12345678 + DeletionProtection: false + Architecture: x86_64 + NestedVirtualization: false + BlockDeviceMappings: + - DeviceName: /dev/sda1 + Bsu: + VolumeId: vol-12345678 + State: attaching + LinkDate: 2010-10-01T12:34:56.789Z + DeleteOnVmDeletion: true + VmId: i-12345678 + ReservationId: r-12345678 + Hypervisor: xen + Placement: + Tenancy: default + SubregionName: eu-west-2a + ProductCodes: + - "0001" + CreationDate: 2010-10-01T12:34:56.789Z + UserData: '...' + PrivateIp: 10.0.0.4 + SecurityGroups: + - SecurityGroupName: default + SecurityGroupId: sg-12345678 + BsuOptimized: false + LaunchNumber: 0 + Performance: medium + Tags: [] + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Creating a VM in a Net + value: + Vms: + - VmType: tinav5.c1r1p2 + VmInitiatedShutdownBehavior: stop + State: pending + StateReason: "" + RootDeviceType: ebs + RootDeviceName: /dev/sda1 + IsSourceDestChecked: true + KeypairName: keypair-example + ImageId: ami-12345678 + DeletionProtection: false + Architecture: x86_64 + NestedVirtualization: false + BlockDeviceMappings: + - DeviceName: /dev/sda1 + Bsu: + VolumeId: vol-12345678 + State: attaching + LinkDate: 2010-10-01T12:34:56.789Z + DeleteOnVmDeletion: true + VmId: i-12345678 + ReservationId: r-12345678 + Hypervisor: xen + Placement: + Tenancy: default + SubregionName: eu-west-2a + ProductCodes: + - "0001" + CreationDate: 2010-10-01T12:34:56.789Z + UserData: '...' + SubnetId: subnet-12345678 + PrivateIp: 10.0.0.4 + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 + BsuOptimized: false + LaunchNumber: 0 + NetId: vpc-12345678 + Nics: + - SubnetId: subnet-12345678 + State: in-use + LinkNic: + State: attached + DeviceNumber: 0 + LinkNicId: eni-attach-12345678 + DeleteOnVmDeletion: true + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Description: Primary network interface + AccountId: "123456789012" + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 + MacAddress: A1:B2:C3:D4:E5:F6 + NetId: vpc-12345678 + NicId: eni-12345678 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true + Performance: high + Tags: [] + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex3: + summary: Creating a VM with block device mappings + value: + Vms: + - VmType: tinav5.c1r1p2 + VmInitiatedShutdownBehavior: stop + State: pending + StateReason: "" + RootDeviceType: ebs + RootDeviceName: /dev/sda1 + IsSourceDestChecked: true + KeypairName: keypair-example + ImageId: ami-12345678 + DeletionProtection: false + Architecture: x86_64 + NestedVirtualization: false + BlockDeviceMappings: + - DeviceName: /dev/sda1 + Bsu: + VolumeId: vol-12345678 + State: attaching + LinkDate: 2010-10-01T12:34:56.789Z + DeleteOnVmDeletion: true + - DeviceName: /dev/sda1 + Bsu: + VolumeId: vol-87654321 + State: attaching + LinkDate: 2010-10-01T12:34:56.789Z + DeleteOnVmDeletion: true + VmId: i-12345678 + ReservationId: r-12345678 + Hypervisor: xen + Placement: + Tenancy: default + SubregionName: eu-west-2a + ProductCodes: + - "0001" + CreationDate: 2010-10-01T12:34:56.789Z + UserData: '...' + SubnetId: subnet-12345678 + PrivateIp: 10.0.0.4 + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 + BsuOptimized: false + LaunchNumber: 0 + NetId: vpc-12345678 + Nics: + - SubnetId: subnet-12345678 + State: in-use + LinkNic: + State: attached + DeviceNumber: 0 + LinkNicId: eni-attach-12345678 + DeleteOnVmDeletion: true + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Description: Primary network interface + AccountId: "123456789012" + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 + MacAddress: A1:B2:C3:D4:E5:F6 + NetId: vpc-12345678 + NicId: eni-12345678 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true + Performance: high + Tags: [] + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex4: + summary: Creating a VM with a NIC + value: + Vms: + - VmType: tinav5.c1r1p2 + VmInitiatedShutdownBehavior: stop + State: pending + StateReason: "" + RootDeviceType: ebs + RootDeviceName: /dev/sda1 + IsSourceDestChecked: true + KeypairName: keypair-example + ImageId: ami-12345678 + DeletionProtection: false + Architecture: x86_64 + NestedVirtualization: false + BlockDeviceMappings: + - DeviceName: /dev/sda1 + Bsu: + VolumeId: vol-12345678 + State: attaching + LinkDate: 2010-10-01T12:34:56.789Z + DeleteOnVmDeletion: true + VmId: i-12345678 + ReservationId: r-12345678 + Hypervisor: xen + Placement: + Tenancy: default + SubregionName: eu-west-2a + ProductCodes: + - "0001" + CreationDate: 2010-10-01T12:34:56.789Z + UserData: '...' + SubnetId: subnet-12345678 + PrivateIp: 10.0.0.4 + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 + BsuOptimized: false + LaunchNumber: 0 + NetId: vpc-12345678 + Nics: + - SubnetId: subnet-12345678 + State: in-use + LinkNic: + State: attached + DeviceNumber: 0 + LinkNicId: eni-attach-12345678 + DeleteOnVmDeletion: true + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Description: Example NIC + AccountId: "123456789012" + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 + MacAddress: A1:B2:C3:D4:E5:F6 + NetId: vpc-12345678 + NicId: eni-12345678 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true + Performance: high + Tags: [] + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/CreateVmsResponse' description: The HTTP 200 response (OK). @@ -1291,18 +3237,66 @@ paths: description: |- Creates a Block Storage Unit (BSU) volume in a specified Region.
BSU volumes can be attached to a virtual machine (VM) in the same Subregion. You can create an empty volume or restore a volume from an existing snapshot.
- You can create the following volume types: Enterprise (`io1`) for provisioned IOPS SSD volumes, Performance (`gp2`) for general purpose SSD volumes, or Magnetic (`standard`) volumes. + You can create the following volume types: Enterprise (`io1`) for provisioned IOPS SSD volumes, Performance (`gp2`) for general purpose SSD volumes, or Magnetic (`standard`) volumes.

+ For more information, see [About Volumes](https://docs.outscale.com/en/userguide/About-Volumes.html). post: operationId: CreateVolume requestBody: content: application/json: + examples: + ex1: + summary: Creating an io1 volume + value: + VolumeType: io1 + SubregionName: eu-west-2a + Size: 10 + Iops: 100 + ex2: + summary: Creating a volume from a snapshot + value: + SnapshotId: snap-12345678 + VolumeType: gp2 + SubregionName: eu-west-2a + Size: 10 schema: $ref: '#/components/schemas/CreateVolumeRequest' responses: "200": content: application/json: + examples: + ex1: + summary: Creating an io1 volume + value: + Volume: + VolumeId: vol-12345678 + Tags: [] + VolumeType: io1 + SubregionName: eu-west-2a + State: creating + CreationDate: 2010-10-01T12:34:56.789Z + Iops: 100 + LinkedVolumes: [] + Size: 10 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Creating a volume from a snapshot + value: + Volume: + VolumeId: vol-12345678 + Tags: [] + VolumeType: gp2 + SubregionName: eu-west-2a + State: creating + SnapshotId: snap-12345678 + CreationDate: 2010-10-01T12:34:56.789Z + Iops: 100 + LinkedVolumes: [] + Size: 10 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/CreateVolumeResponse' description: The HTTP 200 response (OK). @@ -1329,18 +3323,49 @@ paths: /CreateVpnConnection: description: |- Creates a VPN connection between a specified virtual gateway and a specified client gateway.
- You can create only one VPN connection between a virtual gateway and a client gateway. + You can create only one VPN connection between a virtual gateway and a client gateway.

+ + **[IMPORTANT]**
+ This action can be done only if the virtual gateway is in the `available` state.

+ For more information, see [About VPN Connections](https://docs.outscale.com/en/userguide/About-VPN-Connections.html). post: operationId: CreateVpnConnection requestBody: content: application/json: + examples: + ex1: + value: + ClientGatewayId: cgw-12345678 + VirtualGatewayId: vgw-12345678 + ConnectionType: ipsec.1 + StaticRoutesOnly: true schema: $ref: '#/components/schemas/CreateVpnConnectionRequest' responses: "200": content: application/json: + examples: + ex1: + value: + VpnConnection: + Routes: [] + Tags: [] + ClientGatewayConfiguration: '...' + StaticRoutesOnly: true + VirtualGatewayId: vgw-12345678 + ConnectionType: ipsec.1 + ClientGatewayId: cgw-12345678 + State: pending + VgwTelemetries: + - StateDescription: IPSEC IS DOWN + AcceptedRouteCount: 0 + LastStateChangeDate: 2017-05-10T12:34:56.789Z + OutsideIpAddress: 192.0.2.0 + VpnConnectionId: vpn-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/CreateVpnConnectionResponse' description: The HTTP 200 response (OK). @@ -1349,18 +3374,29 @@ paths: /CreateVpnConnectionRoute: description: |- Creates a static route to a VPN connection.
- This enables you to select the network flows sent by the virtual gateway to the target VPN connection. + This enables you to select the network flows sent by the virtual gateway to the target VPN connection.

+ For more information, see [About Routing Configuration for VPN Connections](https://docs.outscale.com/en/userguide/About-Routing-Configuration-for-VPN-Connections.html). post: operationId: CreateVpnConnectionRoute requestBody: content: application/json: + examples: + ex1: + value: + VpnConnectionId: vpn-12345678 + DestinationIpRange: 10.0.0.0/16 schema: $ref: '#/components/schemas/CreateVpnConnectionRouteRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/CreateVpnConnectionRouteResponse' description: The HTTP 200 response (OK). @@ -1369,20 +3405,34 @@ paths: /DeleteAccessKey: description: |- Deletes the specified access key of either your root account or an EIM user.

- - **[NOTE]**
- To protect against brute force attacks, the number of requests allowed for this method in a given time period is limited. + The access key of an EIM user must be in the `INACTIVE` state to be deleted. post: operationId: DeleteAccessKey requestBody: content: application/json: + examples: + ex1: + summary: Deleting one of your own access keys (if you are the root + account or an EIM user) + value: + AccessKeyId: ABCDEFGHIJ0123456789 + ex2: + summary: Deleting the access key of a specific EIM user + value: + AccessKeyId: ABCDEFGHIJ0123456789 + UserName: example-user schema: $ref: '#/components/schemas/DeleteAccessKeyRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteAccessKeyResponse' description: The HTTP 200 response (OK). @@ -1392,7 +3442,7 @@ paths: tags: - AccessKey /DeleteApiAccessRule: - description: "Deletes a specified API access rule.

\n\n**[NOTE]**
\n\n**[IMPORTANT]** \nYou cannot delete the last remaining API access rule. However, if you\ \ delete all the API access rules that allow you to access the APIs, you need\ \ to contact the Support team to regain access. For more information, see [Technical\ @@ -1402,12 +3452,21 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef schema: $ref: '#/components/schemas/DeleteApiAccessRuleRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteApiAccessRuleResponse' description: The HTTP 200 response (OK). @@ -1423,12 +3482,21 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + CaId: ca-fedcba0987654321fedcba0987654321 schema: $ref: '#/components/schemas/DeleteCaRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteCaResponse' description: The HTTP 200 response (OK). @@ -1446,35 +3514,115 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + ClientGatewayId: cgw-12345678 schema: $ref: '#/components/schemas/DeleteClientGatewayRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteClientGatewayResponse' description: The HTTP 200 response (OK). tags: - ClientGateway + /DeleteDedicatedGroup: + description: |- + > [WARNING]
+ > This feature is currently in beta.
+ + Deletes a specified dedicated group of virtual machines (VMs).
+ + **[WARNING]**
+ A dedicated group can be deleted only if no VM or Net is in the dedicated group. Otherwise, you need to force the deletion.
+ If you force the deletion:
+ - all VMs are terminated.
+ - all Nets are deleted, and all resources associated with Nets are detached. + post: + operationId: DeleteDedicatedGroup + requestBody: + content: + application/json: + 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. + value: + DedicatedGroupId: ded-12345678 + Force: true + schema: + $ref: '#/components/schemas/DeleteDedicatedGroupRequest' + responses: + "200": + content: + application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + $ref: '#/components/schemas/DeleteDedicatedGroupResponse' + description: The HTTP 200 response (OK). + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + description: The HTTP 400 response (Bad Request). + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + description: The HTTP 401 response (Unauthorized). + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + description: The HTTP 500 response (Internal Server Error). + tags: + - DedicatedGroup /DeleteDhcpOptions: description: |- Deletes a specified DHCP options set.
Before deleting a DHCP options set, you must disassociate it from the Nets you associated it with. To do so, you need to associate with each Net a new set of DHCP options, or the `default` one if you do not want to associate any DHCP options with the Net.

- **[NOTE]**
+ **[IMPORTANT]**
You cannot delete the `default` set. post: operationId: DeleteDhcpOptions requestBody: content: application/json: + examples: + ex1: + value: + DhcpOptionsSetId: dopt-12345678 schema: $ref: '#/components/schemas/DeleteDhcpOptionsRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteDhcpOptionsResponse' description: The HTTP 200 response (OK). @@ -1489,12 +3637,21 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + DirectLinkId: dxcon-12345678 schema: $ref: '#/components/schemas/DeleteDirectLinkRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteDirectLinkResponse' description: The HTTP 200 response (OK). @@ -1507,12 +3664,21 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + DirectLinkInterfaceId: dxvif-12345678 schema: $ref: '#/components/schemas/DeleteDirectLinkInterfaceRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteDirectLinkInterfaceResponse' description: The HTTP 200 response (OK). @@ -1527,12 +3693,32 @@ paths: requestBody: content: application/json: + examples: + ex1: + summary: Deleting an image export task + value: + ExportTaskId: image-export-12345678 + ex2: + summary: Deleting a snapshot export task + value: + ExportTaskId: snap-export-12345678 schema: $ref: '#/components/schemas/DeleteExportTaskRequest' responses: "200": content: application/json: + examples: + ex1: + summary: Deleting an image export task + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Deleting a snapshot export task + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteExportTaskResponse' description: The HTTP 200 response (OK). @@ -1547,12 +3733,21 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + FlexibleGpuId: fgpu-12345678 schema: $ref: '#/components/schemas/DeleteFlexibleGpuRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteFlexibleGpuResponse' description: The HTTP 200 response (OK). @@ -1567,12 +3762,21 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + ImageId: ami-12345678 schema: $ref: '#/components/schemas/DeleteImageRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteImageResponse' description: The HTTP 200 response (OK). @@ -1605,12 +3809,21 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + InternetServiceId: igw-12345678 schema: $ref: '#/components/schemas/DeleteInternetServiceRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteInternetServiceResponse' description: The HTTP 200 response (OK). @@ -1643,12 +3856,21 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + KeypairName: keypair-example schema: $ref: '#/components/schemas/DeleteKeypairRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteKeypairResponse' description: The HTTP 200 response (OK). @@ -1681,12 +3903,21 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + ListenerRuleName: example-listener-rule schema: $ref: '#/components/schemas/DeleteListenerRuleRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteListenerRuleResponse' description: The HTTP 200 response (OK). @@ -1699,12 +3930,21 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + LoadBalancerName: example-lbu schema: $ref: '#/components/schemas/DeleteLoadBalancerRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteLoadBalancerResponse' description: The HTTP 200 response (OK). @@ -1717,12 +3957,53 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + LoadBalancerName: example-lbu + LoadBalancerPorts: + - 80 schema: $ref: '#/components/schemas/DeleteLoadBalancerListenersRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: security-group-example + SecurityGroupAccountId: "123456789012" + SecuredCookies: false + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internal + AccessLog: + PublicationInterval: 60 + IsEnabled: false + DnsName: internal-example-lbu.123456789.eu-west-2.lbu.outscale.com + HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 + CheckInterval: 30 + Protocol: TCP + HealthyThreshold: 10 + Port: 80 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a + Listeners: [] + LoadBalancerName: example-lbu schema: $ref: '#/components/schemas/DeleteLoadBalancerListenersResponse' description: The HTTP 200 response (OK). @@ -1737,12 +4018,57 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + LoadBalancerName: example-lbu + PolicyName: example-browser-policy schema: $ref: '#/components/schemas/DeleteLoadBalancerPolicyRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: default + SecurityGroupAccountId: "123456789012" + SecuredCookies: false + PublicIp: 192.0.2.0 + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing + AccessLog: + PublicationInterval: 60 + IsEnabled: false + DnsName: example-lbu-123456789.eu-west-2.lbu.outscale.com + HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 + CheckInterval: 30 + Protocol: TCP + HealthyThreshold: 10 + Port: 80 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a + Listeners: + - BackendPort: 80 + BackendProtocol: HTTP + LoadBalancerPort: 80 + LoadBalancerProtocol: HTTP + LoadBalancerName: example-lbu schema: $ref: '#/components/schemas/DeleteLoadBalancerPolicyResponse' description: The HTTP 200 response (OK). @@ -1755,12 +4081,24 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + LoadBalancerNames: + - example-lbu + Tags: + - Key: key1 schema: $ref: '#/components/schemas/DeleteLoadBalancerTagsRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteLoadBalancerTagsResponse' description: The HTTP 200 response (OK). @@ -1775,12 +4113,21 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + NatServiceId: nat-12345678 schema: $ref: '#/components/schemas/DeleteNatServiceRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteNatServiceResponse' description: The HTTP 200 response (OK). @@ -1823,12 +4170,21 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + NetId: vpc-12345678 schema: $ref: '#/components/schemas/DeleteNetRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteNetResponse' description: The HTTP 200 response (OK). @@ -1861,12 +4217,21 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + NetAccessPointId: vpce-12345678 schema: $ref: '#/components/schemas/DeleteNetAccessPointRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteNetAccessPointResponse' description: The HTTP 200 response (OK). @@ -1883,12 +4248,21 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + NetPeeringId: pcx-12345678 schema: $ref: '#/components/schemas/DeleteNetPeeringRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteNetPeeringResponse' description: The HTTP 200 response (OK). @@ -1927,12 +4301,21 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + NicId: eni-12345678 schema: $ref: '#/components/schemas/DeleteNicRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteNicResponse' description: The HTTP 200 response (OK). @@ -1956,6 +4339,64 @@ paths: description: The HTTP 500 response (Internal Server Error). tags: - Nic + /DeletePolicy: + description: |- + Deletes a managed policy.
+ Before deleting a managed policy, you must unlink all users linked to it and delete all the versions of the policy using the `DeletePolicyVersion` method. + post: + operationId: DeletePolicy + requestBody: + content: + application/json: + examples: + ex1: + value: + PolicyOrn: orn:ows:idauth::012345678910:user-policy/Policy + schema: + $ref: '#/components/schemas/DeletePolicyRequest' + responses: + "200": + content: + application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + $ref: '#/components/schemas/DeletePolicyResponse' + description: The HTTP 200 response (OK). + tags: + - Policy + /DeletePolicyVersion: + description: Deletes a specified version of a managed policy, if it is not set + as the default one. + post: + operationId: DeletePolicyVersion + requestBody: + content: + application/json: + examples: + ex1: + value: + PolicyOrn: orn:ows:idauth::012345678910:user-policy/Policy + VersionId: version-12345678 + schema: + $ref: '#/components/schemas/DeletePolicyVersionRequest' + responses: + "200": + content: + application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + $ref: '#/components/schemas/DeletePolicyVersionResponse' + description: The HTTP 200 response (OK). + tags: + - Policy /DeletePublicIp: description: |- Releases a public IP.
@@ -1965,12 +4406,21 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + PublicIp: 192.0.2.0 schema: $ref: '#/components/schemas/DeletePublicIpRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeletePublicIpResponse' description: The HTTP 200 response (OK). @@ -2001,12 +4451,32 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + RouteTableId: rtb-12345678 + DestinationIpRange: 198.51.100.0/24 schema: $ref: '#/components/schemas/DeleteRouteRequest' responses: "200": content: application/json: + examples: + ex1: + value: + RouteTable: + Routes: + - DestinationIpRange: 10.0.0.0/16 + CreationMethod: CreateRouteTable + State: active + LinkRouteTables: [] + NetId: vpc-12345678 + Tags: [] + RoutePropagatingVirtualGateways: [] + RouteTableId: rtb-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteRouteResponse' description: The HTTP 200 response (OK). @@ -2039,12 +4509,21 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + RouteTableId: rtb-12345678 schema: $ref: '#/components/schemas/DeleteRouteTableRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteRouteTableResponse' description: The HTTP 200 response (OK). @@ -2078,12 +4557,21 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + SecurityGroupId: sg-12345678 schema: $ref: '#/components/schemas/DeleteSecurityGroupRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteSecurityGroupResponse' description: The HTTP 200 response (OK). @@ -2118,12 +4606,73 @@ paths: requestBody: content: application/json: + examples: + ex1: + summary: Deleting an inbound rule from an IP range + value: + Flow: Inbound + SecurityGroupId: sg-12345678 + FromPortRange: 80 + ToPortRange: 80 + IpProtocol: tcp + IpRange: 10.0.0.0/16 + ex2: + summary: Deleting an inbound rule from another security group + value: + Flow: Inbound + SecurityGroupId: sg-12345678 + Rules: + - FromPortRange: 22 + ToPortRange: 22 + IpProtocol: tcp + SecurityGroupsMembers: + - AccountId: "123456789012" + SecurityGroupName: another-security-group schema: $ref: '#/components/schemas/DeleteSecurityGroupRuleRequest' responses: "200": content: application/json: + examples: + ex1: + summary: Deleting an inbound rule from an IP range + value: + SecurityGroup: + Tags: [] + SecurityGroupName: security-group-example + OutboundRules: + - FromPortRange: -1 + IpProtocol: -1 + ToPortRange: -1 + IpRanges: + - 0.0.0.0/0 + SecurityGroupId: sg-12345678 + AccountId: "123456789012" + Description: Example of security group + InboundRules: [] + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Creating an inbound rule from another security group + value: + SecurityGroup: + Tags: [] + SecurityGroupName: security-group-example + OutboundRules: + - FromPortRange: -1 + IpProtocol: -1 + ToPortRange: -1 + IpRanges: + - 0.0.0.0/0 + SecurityGroupId: sg-12345678 + AccountId: "123456789012" + Description: Example of security group + InboundRules: [] + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteSecurityGroupRuleResponse' description: The HTTP 200 response (OK). @@ -2154,12 +4703,21 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + Name: server-cert-example schema: $ref: '#/components/schemas/DeleteServerCertificateRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteServerCertificateResponse' description: The HTTP 200 response (OK). @@ -2174,12 +4732,21 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + SnapshotId: snap-12345678 schema: $ref: '#/components/schemas/DeleteSnapshotRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteSnapshotResponse' description: The HTTP 200 response (OK). @@ -2210,19 +4777,28 @@ paths: * Virtual machines (VMs)
* Network Interface Cards (NICs)
- * Network Address Translation (NAT) gateways
+ * NAT services
* Load balancers post: operationId: DeleteSubnet requestBody: content: application/json: + examples: + ex1: + value: + SubnetId: subnet-12345678 schema: $ref: '#/components/schemas/DeleteSubnetRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteSubnetResponse' description: The HTTP 200 response (OK). @@ -2253,12 +4829,25 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + ResourceIds: + - i-12345678 + Tags: + - Key: key1 + Value: value1 schema: $ref: '#/components/schemas/DeleteTagsRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteTagsResponse' description: The HTTP 200 response (OK). @@ -2284,18 +4873,27 @@ paths: - Tag /DeleteUser: description: Deletes a specified EIM user. The EIM user must not belong to any - group and have any key, signing certificate or attached policy. + group, nor have any key or attached policy. post: operationId: DeleteUser requestBody: content: application/json: + examples: + ex1: + value: + UserName: example-user schema: $ref: '#/components/schemas/DeleteUserRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteUserResponse' description: The HTTP 200 response (OK). @@ -2310,12 +4908,21 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + VirtualGatewayId: vgw-12345678 schema: $ref: '#/components/schemas/DeleteVirtualGatewayRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteVirtualGatewayResponse' description: The HTTP 200 response (OK). @@ -2332,12 +4939,21 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + VmGroupId: vmgroup-12345678901234567890123456789012 schema: $ref: '#/components/schemas/DeleteVmGroupRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteVmGroupResponse' description: The HTTP 200 response (OK). @@ -2373,12 +4989,21 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + VmTemplateId: vmtemplate-98765432109876543210987654321012 schema: $ref: '#/components/schemas/DeleteVmTemplateRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteVmTemplateResponse' description: The HTTP 200 response (OK). @@ -2393,12 +5018,26 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + VmIds: + - i-12345678 schema: $ref: '#/components/schemas/DeleteVmsRequest' responses: "200": content: application/json: + examples: + ex1: + value: + Vms: + - VmId: i-12345678 + PreviousState: running + CurrentState: shutting-down + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteVmsResponse' description: The HTTP 200 response (OK). @@ -2431,12 +5070,21 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + VolumeId: vol-12345678 schema: $ref: '#/components/schemas/DeleteVolumeRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteVolumeResponse' description: The HTTP 200 response (OK). @@ -2469,12 +5117,21 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + VpnConnectionId: vpn-12345678 schema: $ref: '#/components/schemas/DeleteVpnConnectionRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteVpnConnectionResponse' description: The HTTP 200 response (OK). @@ -2488,12 +5145,22 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + VpnConnectionId: vpn-12345678 + DestinationIpRange: 10.0.0.0/16 schema: $ref: '#/components/schemas/DeleteVpnConnectionRouteRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeleteVpnConnectionRouteResponse' description: The HTTP 200 response (OK). @@ -2506,12 +5173,24 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + LoadBalancerName: example-lbu + BackendVmIds: + - i-12345678 + - i-87654321 schema: $ref: '#/components/schemas/DeregisterVmsInLoadBalancerRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/DeregisterVmsInLoadBalancerResponse' description: The HTTP 200 response (OK). @@ -2526,12 +5205,22 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + FlexibleGpuId: fgpu-12345678 + VmId: i-12345678 schema: $ref: '#/components/schemas/LinkFlexibleGpuRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/LinkFlexibleGpuResponse' description: The HTTP 200 response (OK). @@ -2546,12 +5235,22 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + InternetServiceId: igw-12345678 + NetId: vpc-12345678 schema: $ref: '#/components/schemas/LinkInternetServiceRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/LinkInternetServiceResponse' description: The HTTP 200 response (OK). @@ -2584,12 +5283,38 @@ paths: requestBody: content: application/json: + examples: + ex1: + summary: Linking VMs to a load balancer + value: + LoadBalancerName: example-lbu + BackendVmIds: + - i-12345678 + - i-87654321 + ex2: + summary: Linking public IPs to a load balancer + value: + LoadBalancerName: example-lbu + BackendIps: + - 192.0.2.0 + - 198.51.100.0 schema: $ref: '#/components/schemas/LinkLoadBalancerBackendMachinesRequest' responses: "200": content: application/json: + examples: + ex1: + summary: Linking VMs to a load balancer + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Linking public IPs to a load balancer + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/LinkLoadBalancerBackendMachinesResponse' description: The HTTP 200 response (OK). @@ -2598,18 +5323,30 @@ paths: /LinkNic: description: |- Attaches a network interface card (NIC) to a virtual machine (VM).
- The interface and the VM must be in the same Subregion. The VM can be either `running` or `stopped`. The NIC must be in the `available` state. For more information, see [Attaching an FNI to an Instance](https://docs.outscale.com/en/userguide/Attaching-an-FNI-to-an-Instance.html). + The interface and the VM must be in the same Subregion. The VM can be either `running` or `stopped`. The NIC must be in the `available` state. For more information, see [Attaching a NIC to a VM](https://docs.outscale.com/en/userguide/Attaching-a-NIC-to-a-VM.html). post: operationId: LinkNic requestBody: content: application/json: + examples: + ex1: + value: + NicId: eni-12345678 + VmId: i-12345678 + DeviceNumber: 1 schema: $ref: '#/components/schemas/LinkNicRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + LinkNicId: eni-attach-12345678 schema: $ref: '#/components/schemas/LinkNicResponse' description: The HTTP 200 response (OK). @@ -2633,6 +5370,34 @@ paths: description: The HTTP 500 response (Internal Server Error). tags: - Nic + /LinkPolicy: + description: Links a managed policy to a specific user. + post: + operationId: LinkPolicy + requestBody: + content: + application/json: + examples: + ex1: + value: + PolicyOrn: orn:ows:idauth::012345678910:user-policy/Policy + UserName: example-user + schema: + $ref: '#/components/schemas/LinkPolicyRequest' + responses: + "200": + content: + application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + $ref: '#/components/schemas/LinkPolicyResponse' + description: The HTTP 200 response (OK). + tags: + - Policy /LinkPrivateIps: 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 @@ -2646,12 +5411,30 @@ paths: requestBody: content: application/json: + examples: + ex1: + summary: Linking specific secondary private IPs to a NIC + value: + NicId: eni-12345678 + PrivateIps: + - 10.0.0.6 + - 10.0.0.7 + ex2: + summary: Linking a number of random secondary private IPs to a NIC + value: + NicId: eni-12345678 + SecondaryPrivateIpCount: 3 schema: $ref: '#/components/schemas/LinkPrivateIpsRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/LinkPrivateIpsResponse' description: The HTTP 200 response (OK). @@ -2681,19 +5464,43 @@ paths: To associate a public IP in a Net, ensure that the Net has an Internet service attached. For more information, see the [LinkInternetService](#linkinternetservice) method.
By default, the public IP is disassociated every time you stop and start the VM. For a persistent association, you can add the `osc.fcu.eip.auto-attach` tag to the VM with the public IP as value. For more information, see the [CreateTags](#createtags) method.

- **[NOTE]**
+ **[IMPORTANT]**
You can associate a public IP with a network address translation (NAT) service only when creating the NAT service. To modify its public IP, you need to delete the NAT service and re-create it with the new public IP. For more information, see the [CreateNatService](#createnatservice) method. post: operationId: LinkPublicIp requestBody: content: application/json: + examples: + ex1: + summary: Linking a public IP to a VM + value: + PublicIp: 192.0.2.0 + VmId: i-12345678 + ex2: + summary: Linking a public IP to a NIC + value: + PublicIp: 192.0.2.0 + NicId: eni-12345678 schema: $ref: '#/components/schemas/LinkPublicIpRequest' responses: "200": content: application/json: + examples: + ex1: + summary: Linking a public IP to a VM + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + LinkPublicIpId: eipassoc-12345678 + ex2: + summary: Linking a public IP to a NIC + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + LinkPublicIpId: eipassoc-12345678 schema: $ref: '#/components/schemas/LinkPublicIpResponse' description: The HTTP 200 response (OK). @@ -2726,12 +5533,23 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + RouteTableId: rtb-12345678 + SubnetId: subnet-12345678 schema: $ref: '#/components/schemas/LinkRouteTableRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + LinkRouteTableId: rtbassoc-12345678 schema: $ref: '#/components/schemas/LinkRouteTableResponse' description: The HTTP 200 response (OK). @@ -2756,18 +5574,35 @@ paths: tags: - RouteTable /LinkVirtualGateway: - description: Attaches a virtual gateway to a Net. + description: |- + Attaches a virtual gateway to a Net. + + **[IMPORTANT]**
+ This action can be done only if the virtual gateway is in the `available` state. post: operationId: LinkVirtualGateway requestBody: content: application/json: + examples: + ex1: + value: + VirtualGatewayId: vgw-12345678 + NetId: vpc-12345678 schema: $ref: '#/components/schemas/LinkVirtualGatewayRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + NetToVirtualGatewayLink: + State: attached + NetId: vpc-12345678 schema: $ref: '#/components/schemas/LinkVirtualGatewayResponse' description: The HTTP 200 response (OK). @@ -2782,12 +5617,23 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + VolumeId: vol-12345678 + VmId: i-12345678 + DeviceName: /dev/sdb schema: $ref: '#/components/schemas/LinkVolumeRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/LinkVolumeResponse' description: The HTTP 200 response (OK). @@ -2818,12 +5664,29 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + Filters: + States: + - ACTIVE schema: $ref: '#/components/schemas/ReadAccessKeysRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + 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 schema: $ref: '#/components/schemas/ReadAccessKeysResponse' description: The HTTP 200 response (OK). @@ -2839,12 +5702,30 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: {} schema: $ref: '#/components/schemas/ReadAccountsRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Accounts: + - ZipCode: "92210" + CompanyName: EXAMPLE SAS + FirstName: JEAN + City: SAINT-CLOUD + Country: FRANCE + LastName: DUPONT + AccountId: "123456789012" + CustomerId: "87654321" + Email: example@example.com schema: $ref: '#/components/schemas/ReadAccountsResponse' description: The HTTP 200 response (OK). @@ -2855,19 +5736,31 @@ paths: Gets the administrator password for a Windows running virtual machine (VM).
The administrator password is encrypted using the keypair you specified when launching the VM.

- **[NOTE]**
- The administrator password is generated only on the first boot of the Windows VM. It is not returned after the first boot. + **[IMPORTANT]**
+ * Only RSA keypairs can decrypt the password of a Windows VM.
+ * The administrator password is generated only on the first boot of the Windows VM. It is not returned after the first boot. post: operationId: ReadAdminPassword requestBody: content: application/json: + examples: + ex1: + value: + VmId: i-12345678 schema: $ref: '#/components/schemas/ReadAdminPasswordRequest' responses: "200": content: application/json: + examples: + ex1: + value: + VmId: i-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + AdminPassword: '...' schema: $ref: '#/components/schemas/ReadAdminPasswordResponse' description: The HTTP 200 response (OK). @@ -2892,18 +5785,31 @@ paths: tags: - Vm /ReadApiAccessPolicy: - description: Gets information about the API access policy of your account. + description: |- + Gets information about the API access policy of your account.

+ For more information, see [About Your API Access Policy](https://docs.outscale.com/en/userguide/About-Your-API-Access-Policy.html). post: operationId: ReadApiAccessPolicy requestBody: content: application/json: + examples: + ex1: + value: {} schema: $ref: '#/components/schemas/ReadApiAccessPolicyRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ApiAccessPolicy: + RequireTrustedEnv: false + MaxAccessKeyExpirationSeconds: 0 schema: $ref: '#/components/schemas/ReadApiAccessPolicyResponse' description: The HTTP 200 response (OK). @@ -2937,12 +5843,36 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + Filters: + ApiAccessRuleIds: + - aar-1234567890abcdef1234567890abcdef schema: $ref: '#/components/schemas/ReadApiAccessRulesRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ApiAccessRules: + - IpRanges: + - 0.0.0.0/0 + ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef + CaIds: [] + Cns: [] + Description: Allows all IPv4 domain + - IpRanges: + - 46.231.144.178/32 + ApiAccessRuleId: aar-abcdef1234567890abcdef1234567890 + CaIds: [] + Cns: [] + Description: Allows Outscale Cockpit of this region schema: $ref: '#/components/schemas/ReadApiAccessRulesResponse' description: The HTTP 200 response (OK). @@ -2953,22 +5883,58 @@ paths: - ApiAccessRule /ReadApiLogs: description: |- - Lists the logs of the API calls you have performed with this account. For more information, see [About OUTSCALE Monitoring Services (OMS)](https://docs.outscale.com/en/userguide/About-OUTSCALE-Monitoring-Services-(OMS).html).

+ Lists the logs of the API calls you have performed with this account. - **[NOTE]**
+ **[IMPORTANT]**
Past logs are accessible for up to 32 days.
- By default, the retrieved interval is 48 hours. If neither of the `QueryDateBefore` nor `QueryDateAfter` parameters are specified, logs from the past 48 hours are retrieved. If you only specify one of two, logs are retrieved from a 2-day interval based on the date you provided. To retrieve logs beyond a 2-day interval, specify both parameters. + By default, the retrieved interval is 48 hours. If neither of the `QueryDateBefore` nor `QueryDateAfter` parameters are specified, logs from the past 48 hours are retrieved. If you only specify one of two, logs are retrieved from a 2-day interval based on the date you provided. To retrieve logs beyond a 2-day interval, specify both parameters.

+ For more information, see [About OUTSCALE Monitoring Services (OMS)](https://docs.outscale.com/en/userguide/About-OUTSCALE-Monitoring-Services-OMS.html). post: operationId: ReadApiLogs requestBody: content: application/json: + examples: + ex1: + value: + Filters: + QueryIpAddresses: + - 192.0.2.0 + - 198.51.100.0 + QueryDateAfter: 2017-05-10 + QueryDateBefore: 2017-05-10 schema: $ref: '#/components/schemas/ReadApiLogsRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Logs: + - ResponseStatusCode: 200 + ResponseSize: 1887 + QueryPayloadRaw: '{}' + QueryApiName: oapi + QueryIpAddress: 192.0.2.0 + QueryUserAgent: oAPI CLI v0.1 - 2018-09-28 + CallDuration: 47 + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + QueryApiVersion: "1.27" + AccountId: "123456789012" + QueryPayloadSize: 2 + QueryCallName: ReadAccessKeys + 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' schema: $ref: '#/components/schemas/ReadApiLogsResponse' description: The HTTP 200 response (OK). @@ -2982,12 +5948,27 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + Filters: + CaIds: + - ca-fedcba0987654321fedcba0987654321 schema: $ref: '#/components/schemas/ReadCasRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Cas: + - Description: CA example + CaId: ca-fedcba0987654321fedcba0987654321 + CaFingerprint: 1234567890abcdef1234567890abcdef12345678 schema: $ref: '#/components/schemas/ReadCasResponse' description: The HTTP 200 response (OK). @@ -2997,60 +5978,123 @@ paths: tags: - Ca /ReadCatalog: - description: Returns the price list of OUTSCALE products and services for the - current Region. + description: Returns the price list of OUTSCALE services for the current Region. post: operationId: ReadCatalog requestBody: content: application/json: + examples: + ex1: + value: {} schema: $ref: '#/components/schemas/ReadCatalogRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Catalog: + 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 + SubregionName: eu-west-2 + Category: compute + Service: TinaOS-FCU + Operation: RunInstances-OD schema: $ref: '#/components/schemas/ReadCatalogResponse' description: The HTTP 200 response (OK). tags: - Catalog /ReadCatalogs: - description: Returns the price list of OUTSCALE products and 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. post: operationId: ReadCatalogs requestBody: content: application/json: + examples: + ex1: + value: + Filters: + CurrentCatalogOnly: true + FromDate: 2021-01-01 + ToDate: 2023-01-01 schema: $ref: '#/components/schemas/ReadCatalogsRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Catalogs: + - State: CURRENT + FromDate: 2021-01-01 00:00:00.000000000 +00:00 + 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 + SubregionName: eu-west-2 + Category: compute + Service: TinaOS-FCU + Operation: RunInstances-OD schema: $ref: '#/components/schemas/ReadCatalogsResponse' description: The HTTP 200 response (OK). tags: - Catalog /ReadClientGateways: - description: |- - Lists one or more of your client gateways.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more of your client gateways. post: operationId: ReadClientGateways requestBody: content: application/json: + examples: + ex1: + value: + Filters: + ClientGatewayIds: + - cgw-12345678 + ex2: + value: + Filters: + BgpAsns: + - 65000 + PublicIps: + - 192.0.2.0 + - 198.51.100.0 schema: $ref: '#/components/schemas/ReadClientGatewaysRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ClientGateways: + - State: available + BgpAsn: 65000 + Tags: [] + ClientGatewayId: cgw-12345678 + ConnectionType: ipsec.1 + PublicIp: 192.0.2.0 schema: $ref: '#/components/schemas/ReadClientGatewaysResponse' description: The HTTP 200 response (OK). @@ -3060,19 +6104,30 @@ paths: description: |- Gets the console output for a virtual machine (VM). This console provides the most recent 64 KiB output.

- **[NOTE]**
+ **[IMPORTANT]**
On Windows VMs, the console is handled only on the first boot. It returns no output after the first boot. post: operationId: ReadConsoleOutput requestBody: content: application/json: + examples: + ex1: + value: + VmId: i-12345678 schema: $ref: '#/components/schemas/ReadConsoleOutputRequest' responses: "200": content: application/json: + examples: + ex1: + value: + VmId: i-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ConsoleOutput: '...' schema: $ref: '#/components/schemas/ReadConsoleOutputResponse' description: The HTTP 200 response (OK). @@ -3097,110 +6152,272 @@ paths: tags: - Vm /ReadConsumptionAccount: - description: |- - Gets information about the consumption of your account for each billable resource within the specified time period.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `Throttling` error message is returned. + description: Gets information about the consumption of your account for each billable + resource within the specified time period. post: operationId: ReadConsumptionAccount requestBody: content: application/json: + examples: + ex1: + value: + FromDate: 2023-06-01 + ToDate: 2023-07-01 schema: $ref: '#/components/schemas/ReadConsumptionAccountRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ConsumptionEntries: + - FromDate: 2023-06-01 00:00:00.000000000 +00:00 + SubregionName: eu-west-2a + Value: 720.0 + Title: Instance - On demand - tinav4.c2r4 high performance - + par heure + Category: compute + ToDate: 2023-06-30 00:00:00.000000000 +00:00 + Service: TinaOS-FCU + AccountId: "123456789012" + PayingAccountId: "123456789012" + Operation: RunInstances-OD + Type: BoxUsage:tinav4.c2r4p2 schema: $ref: '#/components/schemas/ReadConsumptionAccountResponse' description: The HTTP 200 response (OK). tags: - Account - /ReadDhcpOptions: + /ReadDedicatedGroups: description: |- - Gets information about the content of one or more DHCP options sets.

+ > [WARNING]
+ > This feature is currently in beta.
- **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + List one or more dedicated groups of virtual machines (VMs). + post: + operationId: ReadDedicatedGroups + requestBody: + content: + application/json: + examples: + ex1: + summary: Filtering on a specific dedicated group + value: + Filters: + DedicatedGroupIds: + - ded-12345678 + ex2: + summary: Filtering on a specific Subregion and CPU generation + value: + Filters: + SubregionNames: + - eu-west-2a + CpuGenerations: + - 4 + schema: + $ref: '#/components/schemas/ReadDedicatedGroupsRequest' + responses: + "200": + content: + application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + DedicatedGroups: + - VmIds: + - i-12345678 + NetIds: [] + AccountId: "123456789012" + CpuGeneration: 4 + Name: dedicated-group-example + SubregionName: eu-west-2a + DedicatedGroupId: ded-12345678 + schema: + $ref: '#/components/schemas/ReadDedicatedGroupsResponse' + description: The HTTP 200 response (OK). + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + description: The HTTP 400 response (Bad Request). + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + description: The HTTP 401 response (Unauthorized). + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + description: The HTTP 500 response (Internal Server Error). + tags: + - DedicatedGroup + /ReadDhcpOptions: + description: Gets information about the content of one or more DHCP options sets. post: operationId: ReadDhcpOptions requestBody: content: application/json: + examples: + ex1: + value: + Filters: + DhcpOptionsSetIds: + - dopt-12345678 + ex2: + value: + Filters: + DomainNameServers: + - 192.0.2.0 + - 198.51.100.0 + DomainNames: + - example.com schema: $ref: '#/components/schemas/ReadDhcpOptionsRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + DhcpOptionsSets: + - Tags: [] + NtpServers: + - 203.0.113.0 + - 203.0.113.1 + Default: false + DhcpOptionsSetId: dopt-12345678 + DomainName: example.com + DomainNameServers: + - 192.0.2.0 + - 198.51.100.0 schema: $ref: '#/components/schemas/ReadDhcpOptionsResponse' description: The HTTP 200 response (OK). tags: - DhcpOption /ReadDirectLinkInterfaces: - description: |- - Lists one or more of your DirectLink interfaces.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `Throttling` error message is returned. + description: Lists one or more of your DirectLink interfaces. post: operationId: ReadDirectLinkInterfaces requestBody: content: application/json: + examples: + ex1: + value: + Filters: + DirectLinkInterfaceIds: + - dxvif-12345678 schema: $ref: '#/components/schemas/ReadDirectLinkInterfacesRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + DirectLinkInterfaces: + - Vlan: 101 + OutscalePrivateIp: 172.16.0.4/30 + DirectLinkInterfaceId: dxvif-12345678 + BgpAsn: 65000 + AccountId: "123456789012" + ClientPrivateIp: 172.16.0.5/30 + VirtualGatewayId: vgw-12345678 + DirectLinkInterfaceName: MyDirectLinkInterface + DirectLinkId: dxcon-12345678 + Mtu: 1500 + State: available + InterfaceType: private + Location: PAR1 schema: $ref: '#/components/schemas/ReadDirectLinkInterfacesResponse' description: The HTTP 200 response (OK). tags: - DirectLinkInterface /ReadDirectLinks: - description: |- - Lists all DirectLinks in the Region.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `Throttling` error message is returned. + description: Lists all DirectLinks in the Region. post: operationId: ReadDirectLinks requestBody: content: application/json: + examples: + ex1: + value: + Filters: + DirectLinkIds: + - dxcon-12345678 schema: $ref: '#/components/schemas/ReadDirectLinksRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + DirectLinks: + - AccountId: "123456789012" + Bandwidth: 1Gbps + DirectLinkId: dxcon-12345678 + DirectLinkName: Connection to Outscale + Location: PAR1 + RegionName: eu-west-2 + State: available schema: $ref: '#/components/schemas/ReadDirectLinksResponse' description: The HTTP 200 response (OK). tags: - DirectLink /ReadFlexibleGpuCatalog: - description: |- - Lists all flexible GPUs available in the public catalog.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists all flexible GPUs available in the public catalog. post: operationId: ReadFlexibleGpuCatalog requestBody: content: application/json: + examples: + ex1: + value: {} schema: $ref: '#/components/schemas/ReadFlexibleGpuCatalogRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + FlexibleGpuCatalog: + - VRam: 16000 + Generations: + - v5 + MaxCpu: 80 + MaxRam: 512 + ModelName: nvidia-p100 schema: $ref: '#/components/schemas/ReadFlexibleGpuCatalogResponse' description: The HTTP 200 response (OK). @@ -3208,66 +6425,209 @@ paths: tags: - FlexibleGpu /ReadFlexibleGpus: - description: |- - Lists one or more flexible GPUs (fGPUs) allocated to your account.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more flexible GPUs (fGPUs) allocated to your account. post: operationId: ReadFlexibleGpus requestBody: content: application/json: + examples: + ex1: + value: + Filters: + FlexibleGpuIds: + - fgpu-12345678 + ex2: + value: + Filters: + ModelNames: + - nvidia-p6 + - nvidia-p100 + States: + - attached schema: $ref: '#/components/schemas/ReadFlexibleGpusRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + FlexibleGpus: + - DeleteOnVmDeletion: true + FlexibleGpuId: fgpu-12345678 + Generation: v5 + ModelName: nvidia-p100 + State: attached + SubregionName: eu-west-2a + VmId: i-12345678 schema: $ref: '#/components/schemas/ReadFlexibleGpusResponse' description: The HTTP 200 response (OK). tags: - FlexibleGpu /ReadImageExportTasks: - description: |- - Lists one or more image export tasks.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more image export tasks. post: operationId: ReadImageExportTasks requestBody: content: application/json: + examples: + ex1: + value: + Filters: + TaskIds: + - image-export-12345678 schema: $ref: '#/components/schemas/ReadImageExportTasksRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ImageExportTasks: + - Tags: [] + ImageId: ami-12345678 + TaskId: image-export-12345678 + Comment: Export of image ami-12345678 + OsuExport: + OsuPrefix: PREFIX/ami-12345678/ + OsuBucket: BUCKET + DiskImageFormat: qcow2 + State: pending/queued + Progress: 0 schema: $ref: '#/components/schemas/ReadImageExportTasksResponse' description: The HTTP 200 response (OK). tags: - Image /ReadImages: - description: |- - Lists one or more OUTSCALE machine images (OMIs) you can use.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more OUTSCALE machine images (OMIs) you can use. post: operationId: ReadImages requestBody: content: application/json: + examples: + ex1: + summary: Reading a specific image + value: + Filters: + ImageIds: + - ami-12345678 + ex2: + summary: Reading Ubuntu and RockyLinux images created by Outscale + value: + Filters: + AccountAliases: + - Outscale + ImageNames: + - Ubuntu* + - RockyLinux* schema: $ref: '#/components/schemas/ReadImagesRequest' responses: "200": content: application/json: + examples: + ex1: + summary: Reading a specific image + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Images: + - StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: /dev/sda1 + ProductCodes: + - "0001" + PermissionsToLaunch: + GlobalPermission: false + AccountIds: [] + AccountId: "123456789012" + Tags: [] + Description: "" + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: /dev/sda1 + Bsu: + VolumeType: standard + DeleteOnVmDeletion: true + VolumeSize: 50 + SnapshotId: snap-12345678 + ImageType: machine + CreationDate: 2010-10-01T12:34:56.789Z + FileLocation: 123456789012/create-image-example + Architecture: x86_64 + ImageName: create-image-example + ex2: + summary: Reading Ubuntu and RockyLinux images created by Outscale + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Images: + - StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: /dev/sda1 + ProductCodes: + - "0001" + PermissionsToLaunch: + GlobalPermission: true + AccountIds: [] + AccountId: "123456789012" + Tags: [] + Description: "" + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: /dev/sda1 + Bsu: + VolumeType: standard + DeleteOnVmDeletion: true + VolumeSize: 10 + SnapshotId: snap-12345678 + ImageType: machine + AccountAlias: Outscale + CreationDate: 2010-10-01T12:34:56.789Z + FileLocation: Outscale/Ubuntu-2010.10.01-0 + Architecture: x86_64 + ImageName: Ubuntu-2010.10.01-0 + - StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: /dev/sda1 + ProductCodes: + - "0001" + PermissionsToLaunch: + GlobalPermission: true + AccountIds: [] + AccountId: "123456789012" + Tags: [] + Description: "" + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: /dev/sda1 + Bsu: + VolumeType: standard + DeleteOnVmDeletion: true + VolumeSize: 10 + SnapshotId: snap-12345678 + ImageType: machine + AccountAlias: Outscale + CreationDate: 2010-10-01T12:34:56.789Z + FileLocation: Outscale/RockyLinux-2010.10.01-0 + Architecture: x86_64 + ImageName: RockyLinux-2010.10.01-0 schema: $ref: '#/components/schemas/ReadImagesResponse' description: The HTTP 200 response (OK). @@ -3294,21 +6654,44 @@ paths: /ReadInternetServices: description: |- Lists one or more of your Internet services.
- An Internet service enables your virtual machines (VMs) launched in a Net to connect to the Internet. By default, a Net includes an Internet service, and each Subnet is public. Every VM launched within a default Subnet has a private IP and a public IP.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + An Internet service enables your virtual machines (VMs) launched in a Net to connect to the Internet. By default, a Net includes an Internet service, and each Subnet is public. Every VM launched within a default Subnet has a private IP and a public IP. post: operationId: ReadInternetServices requestBody: content: application/json: + examples: + ex1: + value: + Filters: + InternetServiceIds: + - igw-12345678 + ex2: + value: + Filters: + TagKeys: + - env + TagValues: + - prod + - test schema: $ref: '#/components/schemas/ReadInternetServicesRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + InternetServices: + - Tags: + - Value: prod + Key: env + State: available + NetId: vpc-12345678 + InternetServiceId: igw-12345678 schema: $ref: '#/components/schemas/ReadInternetServicesResponse' description: The HTTP 200 response (OK). @@ -3333,22 +6716,32 @@ paths: tags: - InternetService /ReadKeypairs: - description: |- - Lists one or more of your keypairs.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more of your keypairs. post: operationId: ReadKeypairs requestBody: content: application/json: + examples: + ex1: + value: + Filters: + KeypairNames: + - keypair-example schema: $ref: '#/components/schemas/ReadKeypairsRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Keypairs: + - KeypairName: keypair-example + KeypairFingerprint: 11:22:33:44:55:66:77:88:99:00:aa:bb:cc:dd:ee:ff schema: $ref: '#/components/schemas/ReadKeypairsResponse' description: The HTTP 200 response (OK). @@ -3372,6 +6765,47 @@ paths: description: The HTTP 500 response (Internal Server Error). tags: - Keypair + /ReadLinkedPolicies: + description: Lists the managed policies linked to a specified user. + post: + operationId: ReadLinkedPolicies + requestBody: + content: + application/json: + examples: + ex1: + value: + Filters: + PathPrefix: + - / + FirstItem: 1 + ResultsPerPage: 30 + UserName: example-user + schema: + $ref: '#/components/schemas/ReadLinkedPoliciesRequest' + responses: + "200": + content: + application/json: + examples: + ex1: + value: + HasMoreItems: true + MaxResultsLimit: 30 + MaxResultsTruncated: false + Policies: + CreationDate: 2010-10-01T12:34:56.789Z + LastModificationDate: 2010-10-01T12:34:56.789Z + Orn: orn:ows:idauth::012345678910:user-policy/Policy + PolicyId: policy-12345678 + PolicyName: example-user-policy + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + $ref: '#/components/schemas/ReadLinkedPoliciesResponse' + description: The HTTP 200 response (OK). + tags: + - Policy /ReadListenerRules: description: Lists one or more listener rules. By default, this action returns the full list of listener rules for the account. @@ -3380,56 +6814,129 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + Filters: + ListenerRuleNames: + - example-listener-rule schema: $ref: '#/components/schemas/ReadListenerRulesRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ListenerRules: + - Priority: 10 + VmIds: + - i-12345678 + ListenerRuleName: example-listener-rule + Action: forward + ListenerId: 123456 + HostNamePattern: '*.example.com' + ListenerRuleId: 1234 schema: $ref: '#/components/schemas/ReadListenerRulesResponse' description: The HTTP 200 response (OK). tags: - Listener /ReadLoadBalancerTags: - description: |- - Lists the tags associated with one or more specified load balancers.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `Throttling` error message is returned. + description: Lists the tags associated with one or more specified load balancers. post: operationId: ReadLoadBalancerTags requestBody: content: application/json: + examples: + ex1: + value: + LoadBalancerNames: + - private-lb-example schema: $ref: '#/components/schemas/ReadLoadBalancerTagsRequest' responses: "200": content: application/json: + examples: + ex1: + value: + Tags: + - Value: value1 + LoadBalancerName: private-lb-example + Key: key1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/ReadLoadBalancerTagsResponse' description: The HTTP 200 response (OK). tags: - LoadBalancer /ReadLoadBalancers: - description: |- - Lists one or more load balancers and their attributes.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more load balancers and their attributes. post: operationId: ReadLoadBalancers requestBody: content: application/json: + examples: + ex1: + value: + Filters: + LoadBalancerNames: + - private* schema: $ref: '#/components/schemas/ReadLoadBalancersRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + LoadBalancers: + - Tags: [] + SourceSecurityGroup: + SecurityGroupName: security-group-example + SecurityGroupAccountId: "123456789012" + SecuredCookies: false + PublicIp: 192.0.2.0 + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing + AccessLog: + PublicationInterval: 60 + IsEnabled: false + DnsName: private-lb-example.123456789.eu-west-2.lbu.outscale.com + HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 + CheckInterval: 30 + Protocol: TCP + HealthyThreshold: 10 + Port: 80 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a + Listeners: + - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate + BackendPort: 80 + BackendProtocol: HTTP + LoadBalancerPort: 443 + LoadBalancerProtocol: HTTPS + LoadBalancerName: private-lb-example schema: $ref: '#/components/schemas/ReadLoadBalancersResponse' description: The HTTP 200 response (OK). @@ -3438,20 +6945,31 @@ paths: /ReadLocations: description: |- Lists the locations, corresponding to datacenters, where you can set up a DirectLink.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `Throttling` error message is returned. + For more information, see [About DirectLink](https://docs.outscale.com/en/userguide/About-DirectLink.html). post: operationId: ReadLocations requestBody: content: application/json: + examples: + ex1: + value: {} schema: $ref: '#/components/schemas/ReadLocationsRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Locations: + - Name: Telehouse 3, France + Code: PAR1 + - Name: Equinix Pantin, France + Code: PAR4 schema: $ref: '#/components/schemas/ReadLocationsResponse' description: The HTTP 200 response (OK). @@ -3459,22 +6977,46 @@ paths: tags: - Location /ReadNatServices: - description: |- - Lists one or more network address translation (NAT) services.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more network address translation (NAT) services. post: operationId: ReadNatServices requestBody: content: application/json: + examples: + ex1: + value: + Filters: + NatServiceIds: + - nat-12345678 + ex2: + value: + Filters: + NetIds: + - vpc-12345678 + - vpc-87654321 + SubnetIds: + - subnet-12345678 schema: $ref: '#/components/schemas/ReadNatServicesRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + NatServices: + - Tags: [] + SubnetId: subnet-12345678 + NatServiceId: nat-12345678 + PublicIps: + - PublicIpId: eipalloc-12345678 + PublicIp: 192.0.2.0 + NetId: vpc-12345678 + State: available schema: $ref: '#/components/schemas/ReadNatServicesResponse' description: The HTTP 200 response (OK). @@ -3501,21 +7043,61 @@ paths: /ReadNetAccessPointServices: description: |- Lists OUTSCALE services available to create Net access points.
- For more information, see [CreateNetAccessPoint](#createnetaccesspoint).

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + For more information, see [CreateNetAccessPoint](#createnetaccesspoint). post: operationId: ReadNetAccessPointServices requestBody: content: application/json: + examples: + ex1: + summary: Listing one or more services according to their service IDs + value: + Filters: + ServiceIds: + - pl-12345678 + - pl-87654321 + ex2: + summary: Listing one or more services according to their service names + value: + Filters: + ServiceNames: + - com.outscale.eu-west-2.api schema: $ref: '#/components/schemas/ReadNetAccessPointServicesRequest' responses: "200": content: application/json: + examples: + ex1: + summary: Listing one or more services according to their service + IDs + value: + Services: + - ServiceName: com.outscale.eu-west-2.api + ServiceId: pl-12345678 + IpRanges: + - 192.0.2.0 + - ServiceName: com.outscale.eu-west-2.oos + ServiceId: pl-87654321 + IpRanges: + - 198.51.100.0 + - 203.0.113.0 + - 203.0.113.1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Listing one or more services according to their service + names + value: + Services: + - ServiceName: com.outscale.eu-west-2.api + ServiceId: pl-12345678 + IpRanges: + - 192.0.2.0 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/ReadNetAccessPointServicesResponse' description: The HTTP 200 response (OK). @@ -3523,44 +7105,95 @@ paths: tags: - NetAccessPoint /ReadNetAccessPoints: - description: |- - Lists one or more Net access points.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more Net access points. post: operationId: ReadNetAccessPoints requestBody: content: application/json: + examples: + ex1: + value: + Filters: + NetAccessPointIds: + - vpce-12345678 + ex2: + value: + Filters: + NetIds: + - vpc-12345678 + States: + - available schema: $ref: '#/components/schemas/ReadNetAccessPointsRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + NetAccessPoints: + - Tags: [] + NetAccessPointId: vpce-12345678 + RouteTableIds: + - rtb-12345678 + State: available + NetId: vpc-12345678 + ServiceName: com.outscale.eu-west-2.oos schema: $ref: '#/components/schemas/ReadNetAccessPointsResponse' description: The HTTP 200 response (OK). tags: - NetAccessPoint /ReadNetPeerings: - description: |- - Lists one or more peering connections between two Nets.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more peering connections between two Nets. post: operationId: ReadNetPeerings requestBody: content: application/json: + examples: + ex1: + value: + Filters: + NetPeeringIds: + - pcx-12345678 + ex2: + value: + Filters: + SourceNetNetIds: + - vpc-12345678 + StateNames: + - active + - pending-acceptance schema: $ref: '#/components/schemas/ReadNetPeeringsRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + NetPeerings: + - Tags: [] + SourceNet: + NetId: vpc-12345678 + IpRange: 10.0.0.0/16 + AccountId: "123456789012" + NetPeeringId: pcx-12345678 + AccepterNet: + NetId: vpc-12345678 + IpRange: 172.16.0.0/16 + AccountId: "123456789012" + State: + Name: active + Message: Active schema: $ref: '#/components/schemas/ReadNetPeeringsResponse' description: The HTTP 200 response (OK). @@ -3585,22 +7218,41 @@ paths: tags: - NetPeering /ReadNets: - description: |- - Lists one or more Nets.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more Nets. post: operationId: ReadNets requestBody: content: application/json: + examples: + ex1: + value: + Filters: + NetIds: + - vpc-12345678 + ex2: + value: + Filters: + States: + - available schema: $ref: '#/components/schemas/ReadNetsRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Nets: + - Tags: [] + DhcpOptionsSetId: dopt-12345678 + IpRange: 10.0.0.0/16 + Tenancy: default + NetId: vpc-12345678 + State: available schema: $ref: '#/components/schemas/ReadNetsResponse' description: The HTTP 200 response (OK). @@ -3627,21 +7279,60 @@ paths: /ReadNics: description: |- Lists one or more network interface cards (NICs).
- A NIC is a virtual network interface that you can attach to a virtual machine (VM) in a Net.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + A NIC is a virtual network interface that you can attach to a virtual machine (VM) in a Net. post: operationId: ReadNics requestBody: content: application/json: + examples: + ex1: + value: + Filters: + NicIds: + - eni-12345678 + ex2: + value: + Filters: + LinkNicVmIds: + - i-12345678 schema: $ref: '#/components/schemas/ReadNicsRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Nics: + - SubregionName: eu-west-2a + SubnetId: subnet-12345678 + State: in-use + LinkNic: + VmId: i-12345678 + LinkNicId: eni-attach-12345678 + VmAccountId: "123456789012" + DeleteOnVmDeletion: false + DeviceNumber: 0 + State: attached + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Tags: [] + Description: Primary network interface + AccountId: "123456789012" + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 + MacAddress: A1:B2:C3:D4:E5:F6 + NetId: vpc-12345678 + NicId: eni-12345678 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true schema: $ref: '#/components/schemas/ReadNicsResponse' description: The HTTP 200 response (OK). @@ -3665,23 +7356,192 @@ paths: description: The HTTP 500 response (Internal Server Error). tags: - Nic + /ReadPolicies: + description: Lists all the managed policies available for your account. + post: + operationId: ReadPolicies + requestBody: + content: + application/json: + examples: + ex1: + value: + Filters: + OnlyLinked: + - true + PathPrefix: + - / + Scope: + - ALL + FirstItem: 1 + ResultsPerPage: 30 + schema: + $ref: '#/components/schemas/ReadPoliciesRequest' + responses: + "200": + content: + application/json: + examples: + ex1: + value: + HasMoreItems: true + MaxResultsLimit: 30 + MaxResultsTruncated: false + Policies: + CreationDate: 2010-10-01T12:34:56.789Z + Description: Example of description + IsLinkable: true + LastModificationDate: 2010-10-01T12:34:56.789Z + Orn: orn:ows:idauth::012345678910:user-policy/Policy + Path: /example/ + PolicyDefaultVersionId: version-12345678 + PolicyId: policy-12345678 + PolicyName: example-user-policy + ResourcesCount: 0 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + $ref: '#/components/schemas/ReadPoliciesResponse' + description: The HTTP 200 response (OK). + tags: + - Policy + /ReadPolicy: + description: Lists information about a specified managed policy. + post: + operationId: ReadPolicy + requestBody: + content: + application/json: + examples: + ex1: + value: + PolicyOrn: orn:ows:idauth::012345678910:user-policy/Policy + schema: + $ref: '#/components/schemas/ReadPolicyRequest' + responses: + "200": + content: + application/json: + examples: + ex1: + value: + Policy: + CreationDate: 2010-10-01T12:34:56.789Z + Description: Example of description + IsLinkable: true + LastModificationDate: 2010-10-01T12:34:56.789Z + Orn: orn:ows:idauth::012345678910:user-policy/Policy + Path: /example/ + PolicyDefaultVersionId: version-12345678 + PolicyId: policy-12345678 + PolicyName: example-user-policy + ResourcesCount: 0 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + $ref: '#/components/schemas/ReadPolicyResponse' + description: The HTTP 200 response (OK). + tags: + - Policy + /ReadPolicyVersion: + description: Lists information about a specified version of a managed policy. + post: + operationId: ReadPolicyVersion + requestBody: + content: + application/json: + examples: + ex1: + value: + PolicyOrn: orn:ows:idauth::012345678910:user-policy/Policy + VersionId: version-12345678 + schema: + $ref: '#/components/schemas/ReadPolicyVersionRequest' + responses: + "200": + content: + application/json: + examples: + ex1: + value: + PolicyVersion: + Body: '{"Statement": [ {"Action": ["*"],"Effect","Allow","Resource": + ["*"]} ]}' + CreationDate: 2010-10-01T12:34:56.789Z + DefaultVersion: true + VersionId: version-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + $ref: '#/components/schemas/ReadPolicyVersionResponse' + description: The HTTP 200 response (OK). + tags: + - Policy + /ReadPolicyVersions: + description: Lists information about all the policy versions of a specified managed + policy. + post: + operationId: ReadPolicyVersions + requestBody: + content: + application/json: + examples: + ex1: + value: + FirstItem: 1 + PolicyOrn: orn:ows:idauth::012345678910:user-policy/Policy + ResultsPerPage: 30 + schema: + $ref: '#/components/schemas/ReadPolicyVersionsRequest' + responses: + "200": + content: + application/json: + examples: + ex1: + value: + HasMoreItems: true + MaxResultsLimit: 30 + PolicyVersions: + Body: '{"Statement": [ {"Action": ["*"],"Effect","Allow","Resource": + ["*"]} ]}' + CreationDate: 2010-10-01T12:34:56.789Z + DefaultVersion: true + VersionId: version-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + $ref: '#/components/schemas/ReadPolicyVersionsResponse' + description: The HTTP 200 response (OK). + tags: + - Policy /ReadProductTypes: - description: |- - Lists one or more product types.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more product types. post: operationId: ReadProductTypes requestBody: content: application/json: + examples: + ex1: + value: + Filters: + ProductTypeIds: + - "0001" schema: $ref: '#/components/schemas/ReadProductTypesRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ProductTypes: + - ProductTypeId: "0001" + Description: Linux schema: $ref: '#/components/schemas/ReadProductTypesResponse' description: The HTTP 200 response (OK). @@ -3691,18 +7551,36 @@ paths: /ReadPublicCatalog: description: Returns the price list of OUTSCALE products and services for the Region specified in the endpoint of the request. For more information, see [Regions, - Endpoints and Availability Zones Reference](https://docs.outscale.com/en/userguide/Regions-Endpoints-and-Availability-Zones-Reference.html). + Endpoints, and Subregions Reference](https://docs.outscale.com/en/userguide/Regions-Endpoints-and-Subregions-Reference.html). post: operationId: ReadPublicCatalog requestBody: content: application/json: + examples: + ex1: + value: {} schema: $ref: '#/components/schemas/ReadPublicCatalogRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Catalog: + 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 + SubregionName: eu-west-2 + Category: compute + Service: TinaOS-FCU + Operation: RunInstances-OD schema: $ref: '#/components/schemas/ReadPublicCatalogResponse' description: The HTTP 200 response (OK). @@ -3711,19 +7589,30 @@ paths: - PublicCatalog /ReadPublicIpRanges: description: Gets the public IPv4 addresses in CIDR notation for the Region specified - in the endpoint of the request. For more information, see [Regions, Endpoints - and Availability Zones Reference](https://docs.outscale.com/en/userguide/Regions-Endpoints-and-Availability-Zones-Reference.html). + in the endpoint of the request. For more information, see [Regions, Endpoints, + and Subregions Reference](https://docs.outscale.com/en/userguide/Regions-Endpoints-and-Subregions-Reference.html). post: operationId: ReadPublicIpRanges requestBody: content: application/json: + examples: + ex1: + value: {} schema: $ref: '#/components/schemas/ReadPublicIpRangesRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + PublicIps: + - 198.51.100.0/24 + - 203.0.113.0/24 schema: $ref: '#/components/schemas/ReadPublicIpRangesResponse' description: The HTTP 200 response (OK). @@ -3733,21 +7622,43 @@ paths: /ReadPublicIps: description: |- Lists one or more public IPs allocated to your account.
- By default, this action returns information about all your public IPs: available or associated with a virtual machine (VM), a network interface card (NIC) or a NAT service.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + By default, this action returns information about all your public IPs: available or associated with a virtual machine (VM), a network interface card (NIC) or a NAT service. post: operationId: ReadPublicIps requestBody: content: application/json: + examples: + ex1: + value: + Filters: + PublicIps: + - 192.0.2.0 + ex2: + value: + Filters: + VmIds: + - i-12345678 schema: $ref: '#/components/schemas/ReadPublicIpsRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + PublicIps: + - VmId: i-12345678 + Tags: [] + PublicIpId: eipalloc-12345678 + PublicIp: 192.0.2.0 + LinkPublicIpId: eipassoc-12345678 + NicAccountId: "123456789012" + NicId: eni-12345678 + PrivateIp: 10.0.0.4 schema: $ref: '#/components/schemas/ReadPublicIpsResponse' description: The HTTP 200 response (OK). @@ -3774,38 +7685,106 @@ paths: /ReadQuotas: description: |- Lists one or more of your quotas.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + For more information, see [About Your Account](https://docs.outscale.com/en/userguide/About-Your-Account.html). post: operationId: ReadQuotas requestBody: content: application/json: + examples: + ex1: + summary: Reading specific quota + value: + Filters: + QuotaNames: + - lb_limit + ex2: + summary: Reading collection of quotas + value: + Filters: + Collections: + - VPC schema: $ref: '#/components/schemas/ReadQuotasRequest' responses: "200": content: application/json: + examples: + ex1: + summary: Reading specific quota + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + QuotaTypes: + - Quotas: + - ShortDescription: Load Balancer Limit + QuotaCollection: LBU + AccountId: "123456789012" + Description: Maximum number of load balancers per region + MaxValue: 20 + UsedValue: 0 + Name: lb_limit + QuotaType: global + ex2: + summary: Reading collection of quotas + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + QuotaTypes: + - Quotas: + - ShortDescription: Example Limit + QuotaCollection: VPC + AccountId: "123456789012" + Description: Maximum number of examples + MaxValue: 5 + UsedValue: 0 + Name: example_limit + QuotaType: global + - Quotas: + - ShortDescription: Other Example Limit + QuotaCollection: VPC + AccountId: "123456789012" + Description: Maximum number of other examples + MaxValue: 50 + UsedValue: 1 + Name: other_example_limit + QuotaType: vpc-12345678 schema: $ref: '#/components/schemas/ReadQuotasResponse' description: The HTTP 200 response (OK). tags: - Quota /ReadRegions: - description: Lists one or more Regions of the OUTSCALE Cloud. + description: |- + Lists one or more Regions of the OUTSCALE Cloud.

+ For more information, see [About Regions, Endpoints, and Subregions](https://docs.outscale.com/en/userguide/About-Regions-Endpoints-and-Subregions.html). post: operationId: ReadRegions requestBody: content: application/json: + examples: + ex1: + value: {} schema: $ref: '#/components/schemas/ReadRegionsRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Regions: + - RegionName: eu-west-2 + Endpoint: api.eu-west-2.outscale.com + - RegionName: us-east-2 + Endpoint: api.us-east-2.outscale.com + - RegionName: us-west-1 + Endpoint: api.us-west-1.outscale.com schema: $ref: '#/components/schemas/ReadRegionsResponse' description: The HTTP 200 response (OK). @@ -3815,21 +7794,49 @@ paths: /ReadRouteTables: description: |- Lists one or more of your route tables.
- In your Net, each Subnet must be associated with a route table. If a Subnet is not explicitly associated with a route table, it is implicitly associated with the main route table of the Net.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + In your Net, each Subnet must be associated with a route table. If a Subnet is not explicitly associated with a route table, it is implicitly associated with the main route table of the Net. post: operationId: ReadRouteTables requestBody: content: application/json: + examples: + ex1: + value: + Filters: + RouteTableIds: + - rtb-12345678 + ex2: + value: + Filters: + NetIds: + - vpc-12345678 + - vpc-87654321 + LinkRouteTableMain: true schema: $ref: '#/components/schemas/ReadRouteTablesRequest' responses: "200": content: application/json: + examples: + ex1: + value: + RouteTables: + - Routes: + - DestinationIpRange: 10.0.0.0/16 + CreationMethod: CreateRouteTable + State: active + LinkRouteTables: + - RouteTableId: rtb-12345678 + Main: true + LinkRouteTableId: rtbassoc-12345678 + NetId: vpc-12345678 + Tags: [] + RoutePropagatingVirtualGateways: [] + RouteTableId: rtb-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/ReadRouteTablesResponse' description: The HTTP 200 response (OK). @@ -3861,12 +7868,28 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + AccessKeyId: ABCDEFGHIJ0123456789 schema: $ref: '#/components/schemas/ReadSecretAccessKeyRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + 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 + SecretKey: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00 schema: $ref: '#/components/schemas/ReadSecretAccessKeyResponse' description: The HTTP 200 response (OK). @@ -3878,21 +7901,54 @@ paths: /ReadSecurityGroups: description: |- Lists one or more security groups.
- You can specify either the name of the security groups or their IDs.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + You can specify either the name of the security groups or their IDs. post: operationId: ReadSecurityGroups requestBody: content: application/json: + examples: + ex1: + value: + Filters: + SecurityGroupIds: + - sg-12345678 + ex2: + value: + Filters: + InboundRuleIpRanges: + - 192.0.2.0 schema: $ref: '#/components/schemas/ReadSecurityGroupsRequest' responses: "200": content: application/json: + examples: + ex1: + value: + SecurityGroups: + - Tags: [] + SecurityGroupName: security-group-example + OutboundRules: + - FromPortRange: -1 + IpProtocol: -1 + ToPortRange: -1 + IpRanges: + - 0.0.0.0/0 + SecurityGroupId: sg-12345678 + AccountId: "123456789012" + Description: Example of security group + InboundRules: + - FromPortRange: 22 + IpProtocol: tcp + ToPortRange: 22 + IpRanges: + - 192.0.2.0 + - 198.51.100.0 + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/ReadSecurityGroupsResponse' description: The HTTP 200 response (OK). @@ -3923,56 +7979,138 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + Filters: + Paths: + - /example/ schema: $ref: '#/components/schemas/ReadServerCertificatesRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ServerCertificates: + - Path: /example/ + Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ1234 + Orn: orn:ows:idauth::012345678910:server-certificate/example/server-cert-example + Name: server-cert-example + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/ReadServerCertificatesResponse' description: The HTTP 200 response (OK). tags: - ServerCertificate /ReadSnapshotExportTasks: - description: |- - Lists one or more snapshot export tasks.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more snapshot export tasks. post: operationId: ReadSnapshotExportTasks requestBody: content: application/json: + examples: + ex1: + value: + Filters: + TaskIds: + - snap-export-12345678 schema: $ref: '#/components/schemas/ReadSnapshotExportTasksRequest' responses: "200": content: application/json: + examples: + ex1: + value: + SnapshotExportTasks: + - Tags: [] + TaskId: snap-export-12345678 + Comment: Export of snapshot snap-12345678 + OsuExport: + OsuPrefix: PREFIX + OsuBucket: BUCKET + DiskImageFormat: qcow2 + State: pending + SnapshotId: snap-12345678 + Progress: 99 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/ReadSnapshotExportTasksResponse' description: The HTTP 200 response (OK). tags: - Snapshot /ReadSnapshots: - description: |- - Lists one or more snapshots that are available to you and the permissions to create volumes from them.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more snapshots that are available to you and the permissions + to create volumes from them. post: operationId: ReadSnapshots requestBody: content: application/json: + examples: + ex1: + value: + Filters: + SnapshotIds: + - snap-12345678 + ex2: + value: + Filters: + TagKeys: + - env + TagValues: + - prod + - test schema: $ref: '#/components/schemas/ReadSnapshotsRequest' responses: "200": content: application/json: + examples: + ex1: + value: + Snapshots: + - VolumeSize: 10 + AccountId: "123456789012" + VolumeId: vol-12345678 + CreationDate: 2010-10-01T12:34:56.789Z + PermissionsToCreateVolume: + GlobalPermission: false + AccountIds: [] + Progress: 100 + SnapshotId: snap-12345678 + State: completed + Description: Snapshot created from a volume + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + value: + Snapshots: + - VolumeSize: 10 + AccountId: "123456789012" + VolumeId: vol-12345678 + CreationDate: 2010-10-01T12:34:56.789Z + PermissionsToCreateVolume: + GlobalPermission: false + AccountIds: [] + Progress: 100 + SnapshotId: snap-12345678 + State: completed + Description: Test snapshot + Tags: + - Value: test + Key: env + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/ReadSnapshotsResponse' description: The HTTP 200 response (OK). @@ -3999,21 +8137,46 @@ paths: /ReadSubnets: description: |- Lists one or more of your Subnets.
- If you do not specify any Subnet ID, this action describes all of your Subnets.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + If you do not specify any Subnet ID, this action describes all of your Subnets. post: operationId: ReadSubnets requestBody: content: application/json: + examples: + ex1: + value: + Filters: + NetIds: + - vpc-12345678 + ex2: + value: + Filters: + States: + - available + - pending + SubregionNames: + - eu-west-2a schema: $ref: '#/components/schemas/ReadSubnetsRequest' responses: "200": content: application/json: + examples: + ex1: + value: + Subnets: + - Tags: [] + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + AvailableIpsCount: 16379 + IpRange: 10.0.0.0/18 + MapPublicIpOnLaunch: false + State: available + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/ReadSubnetsResponse' description: The HTTP 200 response (OK). @@ -4041,42 +8204,93 @@ paths: description: |- Lists one or more of the enabled Subregions that you can access in the current Region.

- **[NOTE]**
- - If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned.
- - You can use this command to get information about Subregions only in a Region for which you have an account. Otherwise, the `AuthFailure` error message is returned. + For more information, see [About Regions, Endpoints, and Subregions](https://docs.outscale.com/en/userguide/About-Regions-Endpoints-and-Subregions.html). post: operationId: ReadSubregions requestBody: content: application/json: + examples: + ex1: + summary: Listing a specific Subregion in the current Region + value: + Filters: + SubregionNames: + - eu-west-2a + ex2: + summary: Listing two specific Subregions in the current Region + value: + Filters: + SubregionNames: + - eu-west-2a + - eu-west-2b schema: $ref: '#/components/schemas/ReadSubregionsRequest' responses: "200": content: application/json: + examples: + ex1: + summary: Listing a specific Subregion in the current Region + value: + Subregions: + - State: available + RegionName: eu-west-2 + SubregionName: eu-west-2a + LocationCode: PAR1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Listing two specific Subregions in the current Region + value: + Subregions: + - State: available + RegionName: eu-west-2 + SubregionName: eu-west-2a + LocationCode: PAR1 + - State: available + RegionName: eu-west-2 + SubregionName: eu-west-2b + LocationCode: PAR4 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/ReadSubregionsResponse' description: The HTTP 200 response (OK). tags: - Subregion /ReadTags: - description: |- - Lists one or more tags for your resources.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more tags for your resources. post: operationId: ReadTags requestBody: content: application/json: + examples: + ex1: + value: + Filters: + ResourceTypes: + - snapshot + Keys: + - key1 schema: $ref: '#/components/schemas/ReadTagsRequest' responses: "200": content: application/json: + examples: + ex1: + value: + Tags: + - Value: value1 + ResourceType: snapshot + ResourceId: snap-12345678 + Key: key1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/ReadTagsResponse' description: The HTTP 200 response (OK). @@ -4101,40 +8315,87 @@ paths: tags: - Tag /ReadUsers: - description: Lists all EIM users that have a specified path.
+ description: |- + Lists all EIM users that have a specified path.
+ If you do not specify a path, this action returns a list of all users in the account (or an empty list if there are none). post: operationId: ReadUsers requestBody: content: application/json: + examples: + ex1: + value: {} schema: $ref: '#/components/schemas/ReadUsersRequest' responses: "200": content: application/json: + examples: + ex1: + value: + Users: + - UserName: example-user + UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 + Path: /documentation/ + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/ReadUsersResponse' description: The HTTP 200 response (OK). tags: - User /ReadVirtualGateways: - description: |- - Lists one or more virtual gateways.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more virtual gateways. post: operationId: ReadVirtualGateways requestBody: content: application/json: + examples: + ex1: + value: + Filters: + VirtualGatewayIds: + - vgw-12345678 + ex2: + value: + Filters: + States: + - available + LinkStates: + - attached + - detached schema: $ref: '#/components/schemas/ReadVirtualGatewaysRequest' responses: "200": content: application/json: + examples: + ex1: + value: + VirtualGateways: + - VirtualGatewayId: vgw-12345678 + ConnectionType: ipsec.1 + NetToVirtualGatewayLinks: [] + State: available + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + value: + VirtualGateways: + - VirtualGatewayId: vgw-12345678 + ConnectionType: ipsec.1 + NetToVirtualGatewayLinks: + - State: attached + NetId: vpc-12345678 + State: available + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/ReadVirtualGatewaysResponse' description: The HTTP 200 response (OK). @@ -4151,12 +8412,36 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + Filters: + VmGroupIds: + - vmgroup-12345678901234567890123456789012 schema: $ref: '#/components/schemas/ReadVmGroupsRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + VmGroups: + SecurityGroupsIds: sg-87654321 + VmIds: i-12345678 + CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + VmCount: 1 + VmGroupName: ClusterLog-PPD01 + SubnetId: subnet-12345678 + PositioningStrategy: attract + State: available + VmGroupId: vmgroup-12345678901234567890123456789012 + Tags: + - Value: value1 + Key: key1 schema: $ref: '#/components/schemas/ReadVmGroupsResponse' description: The HTTP 200 response (OK). @@ -4191,34 +8476,75 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + Filters: + VmTemplateNames: + - vmtemplate-example + ex2: + value: + Filters: + CpuCores: + - 2 + CpuGeneration: + - v4 schema: $ref: '#/components/schemas/ReadVmTemplatesRequest' responses: "200": content: application/json: + examples: + ex1: + value: + VmTemplates: + VmTemplateName: vmtemplate-example + CpuPerformance: high + CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + CpuCores: 2 + Tags: [] + Description: "" + ImageId: ami-12345678 + CpuGeneration: v4 + VmTemplateId: vmtemplate-98765432109876543210987654321012 + Ram: 2 schema: $ref: '#/components/schemas/ReadVmTemplatesResponse' description: The HTTP 200 response (OK). tags: - VmTemplate /ReadVmTypes: - description: |- - Lists one or more predefined VM types.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more predefined VM types. post: operationId: ReadVmTypes requestBody: content: application/json: + examples: + ex1: + value: + Filters: + VmTypeNames: + - t2.small schema: $ref: '#/components/schemas/ReadVmTypesRequest' responses: "200": content: application/json: + examples: + ex1: + value: + VmTypes: + - VolumeCount: 0 + VmTypeName: t2.small + BsuOptimized: false + MaxPrivateIps: 4 + MemorySize: 2.0 + VcoreCount: 1 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/ReadVmTypesResponse' description: The HTTP 200 response (OK). @@ -4228,21 +8554,102 @@ paths: /ReadVms: description: |- Lists one or more of your virtual machines (VMs).
- If you provide one or more VM IDs, this action returns a description for all of these VMs. If you do not provide any VM ID, this action returns a description for all of the VMs that belong to you. If you provide an invalid VM ID, an error is returned. If you provide the ID of a VM that does not belong to you, the description of this VM is not included in the response. The refresh interval for data returned by this action is one hour, meaning that a terminated VM may appear in the response.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + If you provide one or more VM IDs, this action returns a description for all of these VMs. If you do not provide any VM ID, this action returns a description for all of the VMs that belong to you. If you provide an invalid VM ID, an error is returned. If you provide the ID of a VM that does not belong to you, the description of this VM is not included in the response. The refresh interval for data returned by this action is one hour, meaning that a terminated VM may appear in the response. post: operationId: ReadVms requestBody: content: application/json: + examples: + ex1: + value: + Filters: + VmIds: + - i-12345678 + ex2: + value: + Filters: + TagKeys: + - env + TagValues: + - prod + - test schema: $ref: '#/components/schemas/ReadVmsRequest' responses: "200": content: application/json: + examples: + ex1: + value: + Vms: + - VmType: tinav5.c1r1p2 + VmInitiatedShutdownBehavior: stop + State: running + StateReason: "" + RootDeviceType: ebs + RootDeviceName: /dev/sda1 + IsSourceDestChecked: true + KeypairName: keypair-example + ImageId: ami-12345678 + DeletionProtection: false + Architecture: x86_64 + NestedVirtualization: false + BlockDeviceMappings: + - DeviceName: /dev/sda1 + Bsu: + VolumeId: vol-12345678 + State: attached + LinkDate: 2010-10-01T12:34:56.789Z + DeleteOnVmDeletion: true + VmId: i-12345678 + ReservationId: r-12345678 + Hypervisor: xen + Placement: + Tenancy: default + SubregionName: eu-west-2a + ProductCodes: + - "0001" + CreationDate: 2010-10-01T12:34:56.789Z + UserData: "" + SubnetId: subnet-12345678 + PrivateIp: 10.0.0.4 + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 + BsuOptimized: false + LaunchNumber: 0 + NetId: vpc-12345678 + Nics: + - SubnetId: subnet-12345678 + State: in-use + LinkNic: + State: attached + DeviceNumber: 0 + LinkNicId: eni-attach-12345678 + DeleteOnVmDeletion: true + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Description: Primary network interface + AccountId: "123456789012" + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 + MacAddress: A1:B2:C3:D4:E5:F6 + NetId: vpc-12345678 + NicId: eni-12345678 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true + Performance: high + Tags: + - Value: prod + Key: env + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/ReadVmsResponse' description: The HTTP 200 response (OK). @@ -4267,44 +8674,88 @@ paths: tags: - Vm /ReadVmsHealth: - description: |- - Lists the state of one or more back-end virtual machines (VMs) registered with a specified load balancer.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `Throttling` error message is returned. + description: Lists the state of one or more back-end virtual machines (VMs) registered + with a specified load balancer. post: operationId: ReadVmsHealth requestBody: content: application/json: + examples: + ex1: + value: + LoadBalancerName: example-lbu + BackendVmIds: + - i-12345678 + - i-87654321 schema: $ref: '#/components/schemas/ReadVmsHealthRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + BackendVmHealth: + - VmId: i-12345678 + State: UP + - VmId: i-87654321 + StateReason: ELB + State: DOWN + Description: Instance registration is pending schema: $ref: '#/components/schemas/ReadVmsHealthResponse' description: The HTTP 200 response (OK). tags: - LoadBalancer /ReadVmsState: - description: |- - Lists the status of one or more virtual machines (VMs).

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists the status of one or more virtual machines (VMs). post: operationId: ReadVmsState requestBody: content: application/json: + examples: + ex1: + value: + AllVms: true + ex2: + value: + Filters: + SubregionNames: + - eu-west-2a schema: $ref: '#/components/schemas/ReadVmsStateRequest' responses: "200": content: application/json: + examples: + ex1: + value: + VmStates: + - VmId: i-12345678 + VmState: running + SubregionName: eu-west-2a + MaintenanceEvents: [] + - VmId: i-87654321 + VmState: stopped + SubregionName: eu-west-2a + MaintenanceEvents: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + value: + VmStates: + - VmId: i-12345678 + VmState: running + SubregionName: eu-west-2a + MaintenanceEvents: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/ReadVmsStateResponse' description: The HTTP 200 response (OK). @@ -4329,22 +8780,52 @@ paths: tags: - Vm /ReadVolumes: - description: |- - Lists one or more specified Block Storage Unit (BSU) volumes.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more specified Block Storage Unit (BSU) volumes. post: operationId: ReadVolumes requestBody: content: application/json: + examples: + ex1: + value: + Filters: + VolumeIds: + - vol-12345678 + ex2: + value: + Filters: + VolumeStates: + - in-use + VolumeTypes: + - gp2 + - io1 schema: $ref: '#/components/schemas/ReadVolumesRequest' responses: "200": content: application/json: + examples: + ex1: + value: + Volumes: + - VolumeId: vol-12345678 + Tags: [] + VolumeType: gp2 + SubregionName: eu-west-2a + State: in-use + CreationDate: 2010-10-01T12:34:56.789Z + Iops: 100 + LinkedVolumes: + - VolumeId: vol-12345678 + DeleteOnVmDeletion: false + DeviceName: /dev/sdb + State: attached + VmId: i-12345678 + Size: 10 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/ReadVolumesResponse' description: The HTTP 200 response (OK). @@ -4369,22 +8850,52 @@ paths: tags: - Volume /ReadVpnConnections: - description: |- - Lists one or more VPN connections.

- - **[NOTE]**
- If you exceed the number of identical requests allowed for a configured time period, the `RequestLimitExceeded` error message is returned. + description: Lists one or more VPN connections. post: operationId: ReadVpnConnections requestBody: content: application/json: + examples: + ex1: + value: + Filters: + VpnConnectionIds: + - vpn-12345678 + ex2: + value: + Filters: + ClientGatewayIds: + - cgw-12345678 + VirtualGatewayIds: + - vgw-12345678 + - vgw-87654321 schema: $ref: '#/components/schemas/ReadVpnConnectionsRequest' responses: "200": content: application/json: + examples: + ex1: + value: + VpnConnections: + - Routes: [] + Tags: [] + ClientGatewayConfiguration: '...' + StaticRoutesOnly: true + VirtualGatewayId: vgw-12345678 + ConnectionType: ipsec.1 + ClientGatewayId: cgw-12345678 + State: pending + VgwTelemetries: + - StateDescription: IPSEC IS DOWN + AcceptedRouteCount: 0 + LastStateChangeDate: 2017-05-10T12:34:56.789Z + OutsideIpAddress: 192.0.2.0 + VpnConnectionId: vpn-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/ReadVpnConnectionsResponse' description: The HTTP 200 response (OK). @@ -4399,12 +8910,22 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + VmIds: + - i-12345678 schema: $ref: '#/components/schemas/RebootVmsRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/RebootVmsResponse' description: The HTTP 200 response (OK). @@ -4437,12 +8958,24 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + LoadBalancerName: example-lbu + BackendVmIds: + - i-12345678 + - i-87654321 schema: $ref: '#/components/schemas/RegisterVmsInLoadBalancerRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/RegisterVmsInLoadBalancerResponse' description: The HTTP 200 response (OK). @@ -4457,12 +8990,21 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + NetPeeringId: pcx-12345678 schema: $ref: '#/components/schemas/RejectNetPeeringRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/RejectNetPeeringResponse' description: The HTTP 200 response (OK). @@ -4492,30 +9034,6 @@ paths: description: The HTTP 500 response (Internal Server Error). tags: - NetPeering - /ResetAccountPassword: - description: |- - Replaces the account password with the new one you provide.
- You must also provide the token you received by email when asking for a password reset using the SendResetPasswordEmail method.

- Password strength is tested through heuristic algorithms. For more information, see the [zxcvbn GitHub](https://github.com/dropbox/zxcvbn).

- **[NOTE]**
- To protect against brute force attacks, the number of requests allowed for this method in a given time period is limited. - post: - operationId: ResetAccountPassword - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ResetAccountPasswordRequest' - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/ResetAccountPasswordResponse' - description: The HTTP 200 response (OK). - security: [] - tags: - - Account /ScaleDownVmGroup: description: |- > [WARNING]
@@ -4528,12 +9046,23 @@ paths: requestBody: content: application/json: + examples: + ex1: + summary: Removing 1 VM from a VM group + value: + VmGroupId: vmgroup-12345678901234567890123456789012 + VmSubtraction: 1 schema: $ref: '#/components/schemas/ScaleDownVmGroupRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/ScaleDownVmGroupResponse' description: The HTTP 200 response (OK). @@ -4569,12 +9098,23 @@ paths: requestBody: content: application/json: + examples: + ex1: + summary: Adding 2 VMs in a VM group + value: + VmGroupId: vmgroup-12345678901234567890123456789012 + VmAddition: 2 schema: $ref: '#/components/schemas/ScaleUpVmGroupRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/ScaleUpVmGroupResponse' description: The HTTP 200 response (OK). @@ -4598,29 +9138,36 @@ paths: description: The HTTP 500 response (Internal Server Error). tags: - VmGroup - /SendResetPasswordEmail: + /SetDefaultPolicyVersion: description: |- - Sends an email to the email address provided for the account with a token to reset your password.
- You need to provide this token when updating the account password using the ResetAccountPassword method.

- **[NOTE]**
- To protect against brute force attacks, the number of requests allowed for this method in a given time period is limited. + 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. post: - operationId: SendResetPasswordEmail + operationId: SetDefaultPolicyVersion requestBody: content: application/json: + examples: + ex1: + value: + PolicyOrn: orn:ows:idauth::012345678910:user-policy/Policy + VersionId: version-12345678 schema: - $ref: '#/components/schemas/SendResetPasswordEmailRequest' + $ref: '#/components/schemas/SetDefaultPolicyVersionRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: - $ref: '#/components/schemas/SendResetPasswordEmailResponse' + $ref: '#/components/schemas/SetDefaultPolicyVersionResponse' description: The HTTP 200 response (OK). - security: [] tags: - - Account + - Policy /StartVms: description: |- Start one or more virtual machines (VMs).
@@ -4630,12 +9177,26 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + VmIds: + - i-12345678 schema: $ref: '#/components/schemas/StartVmsRequest' responses: "200": content: application/json: + examples: + ex1: + value: + Vms: + - VmId: i-12345678 + PreviousState: stopped + CurrentState: pending + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/StartVmsResponse' description: The HTTP 200 response (OK). @@ -4668,12 +9229,26 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + VmIds: + - i-12345678 schema: $ref: '#/components/schemas/StopVmsRequest' responses: "200": content: application/json: + examples: + ex1: + value: + Vms: + - VmId: i-12345678 + PreviousState: running + CurrentState: stopping + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/StopVmsResponse' description: The HTTP 200 response (OK). @@ -4706,12 +9281,21 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + FlexibleGpuId: fgpu-12345678 schema: $ref: '#/components/schemas/UnlinkFlexibleGpuRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/UnlinkFlexibleGpuResponse' description: The HTTP 200 response (OK). @@ -4726,12 +9310,22 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + InternetServiceId: igw-12345678 + NetId: vpc-12345678 schema: $ref: '#/components/schemas/UnlinkInternetServiceRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/UnlinkInternetServiceResponse' description: The HTTP 200 response (OK). @@ -4764,12 +9358,38 @@ paths: requestBody: content: application/json: + examples: + ex1: + summary: Unlinking VMs from a load balancer + value: + LoadBalancerName: example-lbu + BackendVmIds: + - i-12345678 + - i-87654321 + ex2: + summary: Unlinking public IPs from a load balancer + value: + LoadBalancerName: example-lbu + BackendIps: + - 192.0.2.0 + - 198.51.100.0 schema: $ref: '#/components/schemas/UnlinkLoadBalancerBackendMachinesRequest' responses: "200": content: application/json: + examples: + ex1: + summary: Unlinking VMs from a load balancer + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Unlinking public IPs from a load balancer + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/UnlinkLoadBalancerBackendMachinesResponse' description: The HTTP 200 response (OK). @@ -4784,12 +9404,21 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + LinkNicId: eni-attach-12345678 schema: $ref: '#/components/schemas/UnlinkNicRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/UnlinkNicResponse' description: The HTTP 200 response (OK). @@ -4813,6 +9442,34 @@ paths: description: The HTTP 500 response (Internal Server Error). tags: - Nic + /UnlinkPolicy: + description: Removes a managed policy from a specific user. + post: + operationId: UnlinkPolicy + requestBody: + content: + application/json: + examples: + ex1: + value: + PolicyOrn: orn:ows:idauth::012345678910:user-policy/Policy + UserName: example-user + schema: + $ref: '#/components/schemas/UnlinkPolicyRequest' + responses: + "200": + content: + application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + schema: + $ref: '#/components/schemas/UnlinkPolicyResponse' + description: The HTTP 200 response (OK). + tags: + - Policy /UnlinkPrivateIps: description: Unassigns one or more secondary private IPs from a network interface card (NIC). @@ -4821,12 +9478,24 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + NicId: eni-12345678 + PrivateIps: + - 10.0.0.6 + - 10.0.0.7 schema: $ref: '#/components/schemas/UnlinkPrivateIpsRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/UnlinkPrivateIpsResponse' description: The HTTP 200 response (OK). @@ -4854,19 +9523,28 @@ paths: description: |- Disassociates a public IP from the virtual machine (VM) or network interface card (NIC) it is associated with.

- **[NOTE]**
+ **[IMPORTANT]**
To disassociate the public IP from a NAT service, you need to delete the NAT service. For more information, see the [DeleteNatService](#deletenatservice) method. post: operationId: UnlinkPublicIp requestBody: content: application/json: + examples: + ex1: + value: + PublicIp: 192.0.2.0 schema: $ref: '#/components/schemas/UnlinkPublicIpRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/UnlinkPublicIpResponse' description: The HTTP 200 response (OK). @@ -4899,12 +9577,21 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + LinkRouteTableId: rtbassoc-12345678 schema: $ref: '#/components/schemas/UnlinkRouteTableRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/UnlinkRouteTableResponse' description: The HTTP 200 response (OK). @@ -4937,12 +9624,22 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + VirtualGatewayId: vgw-12345678 + NetId: vpc-12345678 schema: $ref: '#/components/schemas/UnlinkVirtualGatewayRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/UnlinkVirtualGatewayResponse' description: The HTTP 200 response (OK). @@ -4957,12 +9654,21 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + VolumeId: vol-12345678 schema: $ref: '#/components/schemas/UnlinkVolumeRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/UnlinkVolumeResponse' description: The HTTP 200 response (OK). @@ -4987,22 +9693,49 @@ paths: tags: - Volume /UpdateAccessKey: - description: |- - Modifies the attributes of the specified access key of either your root account or an EIM user.

- - **[NOTE]**
- To protect against brute force attacks, the number of requests allowed for this method in a given time period is limited. + description: Modifies the attributes of the specified access key of either your + root account or an EIM user. post: operationId: UpdateAccessKey requestBody: content: application/json: + examples: + ex1: + summary: Updating the expiration date of the access key + value: + AccessKeyId: ABCDEFGHIJ0123456789 + State: ACTIVE + ExpirationDate: 2063-04-05 + ex2: + summary: Updating one of your own access keys (if you are the root + account or an EIM user) + value: + AccessKeyId: ABCDEFGHIJ0123456789 + State: ACTIVE + ex3: + summary: Updating the access key of a specific EIM user + value: + AccessKeyId: ABCDEFGHIJ0123456789 + State: ACTIVE + UserName: example-user schema: $ref: '#/components/schemas/UpdateAccessKeyRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + 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 schema: $ref: '#/components/schemas/UpdateAccessKeyResponse' description: The HTTP 200 response (OK). @@ -5018,12 +9751,36 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + AdditionalEmails: + - another@example.com + - yet.another@example.com schema: $ref: '#/components/schemas/UpdateAccountRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Account: + ZipCode: "92210" + CompanyName: EXAMPLE SAS + FirstName: JEAN + AdditionalEmails: + - another@example.com + - yet.another@example.com + City: SAINT-CLOUD + Country: FRANCE + LastName: DUPONT + AccountId: "123456789012" + CustomerId: "87654321" + Email: example@example.com schema: $ref: '#/components/schemas/UpdateAccountResponse' description: The HTTP 200 response (OK). @@ -5033,19 +9790,64 @@ paths: description: |- Updates the API access policy of your account.

- **[NOTE]**
+ **[IMPORTANT]**
Only one API access policy can be associated with your account. post: operationId: UpdateApiAccessPolicy requestBody: content: application/json: + examples: + ex1: + summary: Require expiration dates of maximum 1 year + value: + MaxAccessKeyExpirationSeconds: 31536000 + RequireTrustedEnv: false + ex2: + 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 + value: + MaxAccessKeyExpirationSeconds: 0 + RequireTrustedEnv: false schema: $ref: '#/components/schemas/UpdateApiAccessPolicyRequest' responses: "200": content: application/json: + examples: + ex1: + summary: Require expiration dates of maximum 1 year + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ApiAccessPolicy: + RequireTrustedEnv: false + MaxAccessKeyExpirationSeconds: 31536000 + ex2: + summary: Require expiration dates of maximum 100 years and activate + a trusted session + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ApiAccessPolicy: + RequireTrustedEnv: true + MaxAccessKeyExpirationSeconds: 3153600000 + ex3: + summary: Do not require expiration dates and deactivate a trusted + session + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ApiAccessPolicy: + RequireTrustedEnv: false + MaxAccessKeyExpirationSeconds: 0 schema: $ref: '#/components/schemas/UpdateApiAccessPolicyResponse' description: The HTTP 200 response (OK). @@ -5073,7 +9875,7 @@ paths: tags: - ApiAccessPolicy /UpdateApiAccessRule: - description: "Modifies a specified API access rule.

\n\n**[NOTE]**
\n\n**[WARNING]** \n- The new rule you specify fully replaces the old rule. Therefore, for\ \ a parameter that is not specified, any previously set value is deleted.\n- If, as result of your modification, you no longer have access to the\ @@ -5084,12 +9886,31 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef + IpRanges: + - 0.0.0.0/0 + Description: Allows all Ipv4 domain schema: $ref: '#/components/schemas/UpdateApiAccessRuleRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ApiAccessRule: + IpRanges: + - 0.0.0.0/0 + ApiAccessRuleId: aar-1234567890abcdef1234567890abcdef + CaIds: [] + Cns: [] + Description: Allows all IPv4 domain schema: $ref: '#/components/schemas/UpdateApiAccessRuleResponse' description: The HTTP 200 response (OK). @@ -5106,12 +9927,26 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + CaId: ca-fedcba0987654321fedcba0987654321 + Description: New description schema: $ref: '#/components/schemas/UpdateCaRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Ca: + Description: New description + CaId: ca-fedcba0987654321fedcba0987654321 + CaFingerprint: 1234567890abcdef1234567890abcdef12345678 schema: $ref: '#/components/schemas/UpdateCaResponse' description: The HTTP 200 response (OK). @@ -5120,6 +9955,66 @@ paths: - BasicAuth: [] tags: - Ca + /UpdateDedicatedGroup: + description: |- + > [WARNING]
+ > This feature is currently in beta.
+ + Modifies the name of a specified dedicated group.
+ post: + operationId: UpdateDedicatedGroup + requestBody: + content: + application/json: + examples: + ex1: + value: + DedicatedGroupId: ded-12345678 + Name: New-dedicated-group-name + schema: + $ref: '#/components/schemas/UpdateDedicatedGroupRequest' + responses: + "200": + content: + application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + DedicatedGroup: + VmIds: + - i-12345678 + NetIds: + - vpc-12345678 + AccountId: "123456789012" + CpuGeneration: 4 + Name: New-dedicated-group-name + SubregionName: eu-west-2a + DedicatedGroupId: ded-12345678 + schema: + $ref: '#/components/schemas/UpdateDedicatedGroupResponse' + description: The HTTP 200 response (OK). + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + description: The HTTP 400 response (Bad Request). + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + description: The HTTP 401 response (Unauthorized). + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + description: The HTTP 500 response (Internal Server Error). + tags: + - DedicatedGroup /UpdateDirectLinkInterface: description: Modifies the maximum transmission unit (MTU) of a DirectLink interface. post: @@ -5127,12 +10022,36 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + DirectLinkInterfaceId: dxvif-12345678 + Mtu: 1500 schema: $ref: '#/components/schemas/UpdateDirectLinkInterfaceRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + DirectLinkInterface: + Vlan: 101 + OutscalePrivateIp: 172.16.0.4/30 + DirectLinkInterfaceId: dxvif-12345678 + BgpAsn: 65000 + AccountId: "123456789012" + ClientPrivateIp: 172.16.0.5/30 + VirtualGatewayId: vgw-12345678 + DirectLinkInterfaceName: MyDirectLinkInterface + DirectLinkId: dxcon-12345678 + Mtu: 1500 + State: available + InterfaceType: private + Location: PAR1 schema: $ref: '#/components/schemas/UpdateDirectLinkInterfaceResponse' description: The HTTP 200 response (OK). @@ -5145,12 +10064,29 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + FlexibleGpuId: fgpu-12345678 + DeleteOnVmDeletion: false schema: $ref: '#/components/schemas/UpdateFlexibleGpuRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + FlexibleGpu: + DeleteOnVmDeletion: false + FlexibleGpuId: fgpu-12345678 + Generation: v5 + ModelName: nvidia-p100 + State: allocated + SubregionName: eu-west-2a schema: $ref: '#/components/schemas/UpdateFlexibleGpuResponse' description: The HTTP 200 response (OK). @@ -5166,12 +10102,169 @@ paths: requestBody: content: application/json: + examples: + ex1: + summary: Adding permission + value: + ImageId: ami-12345678 + PermissionsToLaunch: + Additions: + AccountIds: + - "987654321098" + ex2: + summary: Removing permission + value: + ImageId: ami-12345678 + PermissionsToLaunch: + Removals: + AccountIds: + - "987654321098" + ex3: + summary: Making an image public to everyone + value: + ImageId: ami-12345678 + PermissionsToLaunch: + Additions: + GlobalPermission: true + ex4: + summary: Making an image private to everyone + value: + ImageId: ami-12345678 + PermissionsToLaunch: + Removals: + GlobalPermission: true schema: $ref: '#/components/schemas/UpdateImageRequest' responses: "200": content: application/json: + examples: + ex1: + summary: Adding permission + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Image: + StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: /dev/sda1 + ProductCodes: + - "0001" + PermissionsToLaunch: + GlobalPermission: false + AccountIds: + - "987654321098" + AccountId: "123456789012" + Tags: [] + Description: "" + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: /dev/sda1 + Bsu: + VolumeType: standard + DeleteOnVmDeletion: true + VolumeSize: 50 + SnapshotId: snap-12345678 + ImageType: machine + CreationDate: 2010-10-01T12:34:56.789Z + FileLocation: 123456789012/image-example + Architecture: x86_64 + ImageName: image-example + ex2: + summary: Removing permission + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Image: + StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: /dev/sda1 + ProductCodes: + - "0001" + PermissionsToLaunch: + GlobalPermission: false + AccountIds: [] + AccountId: "123456789012" + Tags: [] + Description: "" + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: /dev/sda1 + Bsu: + VolumeType: standard + DeleteOnVmDeletion: true + VolumeSize: 50 + SnapshotId: snap-12345678 + ImageType: machine + CreationDate: 2010-10-01T12:34:56.789Z + FileLocation: 123456789012/image-example + Architecture: x86_64 + ImageName: image-example + ex3: + summary: Making an image public to everyone + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Image: + StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: /dev/sda1 + ProductCodes: + - "0001" + PermissionsToLaunch: + GlobalPermission: true + AccountIds: [] + AccountId: "123456789012" + Tags: [] + Description: "" + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: /dev/sda1 + Bsu: + VolumeType: standard + DeleteOnVmDeletion: true + VolumeSize: 50 + SnapshotId: snap-12345678 + ImageType: machine + CreationDate: 2010-10-01T12:34:56.789Z + FileLocation: 123456789012/image-example + Architecture: x86_64 + ImageName: image-example + ex4: + summary: Making an image private to everyone + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Image: + StateComment: {} + State: available + RootDeviceType: bsu + RootDeviceName: /dev/sda1 + ProductCodes: + - "0001" + PermissionsToLaunch: + GlobalPermission: false + AccountIds: [] + AccountId: "123456789012" + Tags: [] + Description: "" + ImageId: ami-12345678 + BlockDeviceMappings: + - DeviceName: /dev/sda1 + Bsu: + VolumeType: standard + DeleteOnVmDeletion: true + VolumeSize: 50 + SnapshotId: snap-12345678 + ImageType: machine + CreationDate: 2010-10-01T12:34:56.789Z + FileLocation: 123456789012/image-example + Architecture: x86_64 + ImageName: image-example schema: $ref: '#/components/schemas/UpdateImageResponse' description: The HTTP 200 response (OK). @@ -5204,12 +10297,31 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + ListenerRuleName: example-listener-rule + HostPattern: '*.newhost.com' schema: $ref: '#/components/schemas/UpdateListenerRuleRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ListenerRule: + Priority: 10 + VmIds: + - i-12345678 + ListenerRuleName: example-listener-rule + Action: forward + ListenerId: 123456 + HostNamePattern: '*.newhost.com' + ListenerRuleId: 1234 schema: $ref: '#/components/schemas/UpdateListenerRuleResponse' description: The HTTP 200 response (OK). @@ -5229,12 +10341,217 @@ paths: requestBody: content: application/json: + examples: + ex1: + summary: Updating health checks + value: + LoadBalancerName: private-lb-example + HealthCheck: + HealthyThreshold: 10 + CheckInterval: 30 + Path: /index.html + Port: 8080 + Protocol: HTTPS + Timeout: 5 + UnhealthyThreshold: 5 + ex2: + summary: Updating access logs + value: + LoadBalancerName: private-lb-example + AccessLog: + PublicationInterval: 5 + IsEnabled: true + OsuBucketName: BUCKET + OsuBucketPrefix: PREFIX + ex3: + summary: Updating policies + value: + LoadBalancerName: private-lb-example + LoadBalancerPort: 443 + PolicyNames: + - example-browser-policy + ex4: + summary: Updating SSL certificate + value: + LoadBalancerName: private-lb-example + LoadBalancerPort: 443 + ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/AnotherCertificate schema: $ref: '#/components/schemas/UpdateLoadBalancerRequest' responses: "200": content: application/json: + examples: + ex1: + summary: Updating health checks + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: security-group-example + SecurityGroupAccountId: "123456789012" + SecuredCookies: false + PublicIp: 192.0.2.0 + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing + AccessLog: + PublicationInterval: 60 + IsEnabled: false + DnsName: private-lb-example.123456789.eu-west-2.lbu.outscale.com + HealthCheck: + UnhealthyThreshold: 5 + Timeout: 5 + CheckInterval: 30 + Path: /index.html + Protocol: HTTPS + HealthyThreshold: 10 + Port: 8080 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a + Listeners: + - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate + BackendPort: 80 + BackendProtocol: HTTP + LoadBalancerPort: 443 + LoadBalancerProtocol: HTTPS + LoadBalancerName: private-lb-example + ex2: + summary: Updating access logs + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: security-group-example + SecurityGroupAccountId: "123456789012" + SecuredCookies: false + PublicIp: 192.0.2.0 + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing + AccessLog: + PublicationInterval: 5 + OsuBucketPrefix: PREFIX + OsuBucketName: BUCKET + IsEnabled: true + DnsName: private-lb-example.123456789.eu-west-2.lbu.outscale.com + HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 + CheckInterval: 30 + Protocol: TCP + HealthyThreshold: 10 + Port: 80 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a + Listeners: + - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate + BackendPort: 80 + BackendProtocol: HTTP + LoadBalancerPort: 443 + LoadBalancerProtocol: HTTPS + LoadBalancerName: private-lb-example + ex3: + summary: Updating policies + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: security-group-example + SecurityGroupAccountId: "123456789012" + SecuredCookies: false + PublicIp: 192.0.2.0 + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing + AccessLog: + PublicationInterval: 60 + IsEnabled: false + DnsName: private-lb-example.123456789.eu-west-2.lbu.outscale.com + HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 + CheckInterval: 30 + Protocol: TCP + HealthyThreshold: 10 + Port: 80 + LoadBalancerStickyCookiePolicies: + - PolicyName: example-browser-policy + CookieExpirationPeriod: 1 + SubregionNames: + - eu-west-2a + Listeners: + - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/Certificate + BackendPort: 80 + BackendProtocol: HTTP + LoadBalancerPort: 443 + LoadBalancerProtocol: HTTPS + LoadBalancerName: private-lb-example + ex4: + summary: Updating SSL certificate + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + LoadBalancer: + Tags: [] + SourceSecurityGroup: + SecurityGroupName: security-group-example + SecurityGroupAccountId: "123456789012" + SecuredCookies: false + PublicIp: 192.0.2.0 + Subnets: + - subnet-12345678 + NetId: vpc-12345678 + BackendVmIds: [] + ApplicationStickyCookiePolicies: [] + SecurityGroups: + - sg-12345678 + LoadBalancerType: internet-facing + AccessLog: + PublicationInterval: 60 + IsEnabled: false + DnsName: private-lb-example.123456789.eu-west-2.lbu.outscale.com + HealthCheck: + UnhealthyThreshold: 2 + Timeout: 5 + CheckInterval: 30 + Protocol: TCP + HealthyThreshold: 10 + Port: 80 + LoadBalancerStickyCookiePolicies: [] + SubregionNames: + - eu-west-2a + Listeners: + - ServerCertificateId: orn:ows:idauth::012345678910:server-certificate/AnotherCertificate + BackendPort: 80 + BackendProtocol: HTTP + LoadBalancerPort: 443 + LoadBalancerProtocol: HTTPS + LoadBalancerName: private-lb-example schema: $ref: '#/components/schemas/UpdateLoadBalancerResponse' description: The HTTP 200 response (OK). @@ -5247,12 +10564,29 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + NetId: vpc-12345678 + DhcpOptionsSetId: dopt-12345678 schema: $ref: '#/components/schemas/UpdateNetRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Net: + Tags: [] + DhcpOptionsSetId: dopt-12345678 + IpRange: 10.0.0.0/16 + Tenancy: default + NetId: vpc-12345678 + State: available schema: $ref: '#/components/schemas/UpdateNetResponse' description: The HTTP 200 response (OK). @@ -5285,12 +10619,52 @@ paths: requestBody: content: application/json: + examples: + ex1: + summary: Adding a route table + value: + NetAccessPointId: vpce-12345678 + AddRouteTableIds: + - rtb-87654321 + ex2: + summary: Removing a route table + value: + NetAccessPointId: vpce-12345678 + RemoveRouteTableIds: + - rtb-12345678 schema: $ref: '#/components/schemas/UpdateNetAccessPointRequest' responses: "200": content: application/json: + examples: + ex1: + summary: Adding a route table + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + NetAccessPoint: + Tags: [] + NetAccessPointId: vpce-12345678 + RouteTableIds: + - rtb-12345678 + - rtb-87654321 + State: available + NetId: vpc-12345678 + ServiceName: com.outscale.eu-west-2.oos + ex2: + summary: Removing a route table + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + NetAccessPoint: + Tags: [] + NetAccessPointId: vpce-12345678 + RouteTableIds: [] + State: available + NetId: vpc-12345678 + ServiceName: com.outscale.eu-west-2.oos schema: $ref: '#/components/schemas/UpdateNetAccessPointResponse' description: The HTTP 200 response (OK). @@ -5304,12 +10678,125 @@ paths: requestBody: content: application/json: + examples: + ex1: + summary: Modifying the DeleteOnVmDeletion value of a NIC + value: + NicId: eni-12345678 + LinkNic: + DeleteOnVmDeletion: false + LinkNicId: eni-attach-12345678 + ex2: + summary: Modifying the security groups of a NIC + value: + NicId: eni-12345678 + SecurityGroupIds: + - sg-12345678 + ex3: + summary: Modifying the description of a NIC + value: + NicId: eni-12345678 + Description: Example of description schema: $ref: '#/components/schemas/UpdateNicRequest' responses: "200": content: application/json: + examples: + ex1: + summary: Modifying the DeleteOnVmDeletion value of a NIC + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Nic: + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + State: in-use + LinkNic: + VmId: i-12345678 + LinkNicId: eni-attach-12345678 + VmAccountId: "123456789012" + DeleteOnVmDeletion: false + DeviceNumber: 0 + State: attached + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Tags: [] + Description: Primary network interface + AccountId: "123456789012" + SecurityGroups: + - SecurityGroupName: default + SecurityGroupId: sg-12345678 + MacAddress: A1:B2:C3:D4:E5:F6 + NetId: vpc-12345678 + NicId: eni-12345678 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true + ex2: + summary: Modifying the security groups of a NIC + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Nic: + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + State: in-use + LinkNic: + VmId: i-12345678 + LinkNicId: eni-attach-12345678 + VmAccountId: "123456789012" + DeleteOnVmDeletion: true + DeviceNumber: 0 + State: attached + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Tags: [] + Description: Primary network interface + AccountId: "123456789012" + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 + MacAddress: A1:B2:C3:D4:E5:F6 + NetId: vpc-12345678 + NicId: eni-12345678 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true + ex3: + summary: Modifying the description of a NIC + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + Nic: + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + State: in-use + LinkNic: + VmId: i-12345678 + LinkNicId: eni-attach-12345678 + VmAccountId: "123456789012" + DeleteOnVmDeletion: true + DeviceNumber: 0 + State: attached + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Tags: [] + Description: Example of description + AccountId: "123456789012" + SecurityGroups: + - SecurityGroupName: default + SecurityGroupId: sg-12345678 + MacAddress: A1:B2:C3:D4:E5:F6 + NetId: vpc-12345678 + NicId: eni-12345678 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true schema: $ref: '#/components/schemas/UpdateNicResponse' description: The HTTP 200 response (OK). @@ -5351,12 +10838,43 @@ paths: requestBody: content: application/json: + examples: + ex1: + summary: Updating a route to a virtual gateway + value: + RouteTableId: rtb-12345678 + DestinationIpRange: 198.51.100.0/24 + GatewayId: vgw-12345678 schema: $ref: '#/components/schemas/UpdateRouteRequest' responses: "200": content: application/json: + examples: + ex1: + summary: Updating a route to a virtual gateway + value: + RouteTable: + Routes: + - DestinationIpRange: 10.0.0.0/16 + CreationMethod: CreateRouteTable + State: active + - GatewayId: vgw-12345678 + DestinationIpRange: 198.51.100.0/24 + CreationMethod: CreateRoute + State: active + LinkRouteTables: + - RouteTableId: rtb-12345678 + Main: false + SubnetId: subnet-12345678 + LinkRouteTableId: rtbassoc-12345678 + NetId: vpc-12345678 + Tags: [] + RoutePropagatingVirtualGateways: [] + RouteTableId: rtb-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/UpdateRouteResponse' description: The HTTP 200 response (OK). @@ -5388,17 +10906,91 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + VirtualGatewayId: vgw-12345678 + RouteTableId: rtb-12345678 + Enable: true schema: $ref: '#/components/schemas/UpdateRoutePropagationRequest' responses: "200": content: application/json: + examples: + ex1: + value: + RouteTable: + Routes: + - DestinationIpRange: 10.0.0.0/16 + CreationMethod: CreateRouteTable + State: active + LinkRouteTables: + - RouteTableId: rtb-12345678 + Main: true + LinkRouteTableId: rtbassoc-12345678 + NetId: vpc-12345678 + Tags: [] + RoutePropagatingVirtualGateways: + - VirtualGatewayId: vgw-12345678 + RouteTableId: rtb-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/UpdateRoutePropagationResponse' description: The HTTP 200 response (OK). tags: - VirtualGateway + /UpdateRouteTableLink: + description: |- + Replaces the route table associated with a specific Subnet in a Net with another one.
+ After the route table is replaced, the Subnet uses the routes in the new route table it is associated with. + post: + operationId: UpdateRouteTableLink + requestBody: + content: + application/json: + examples: + ex1: + value: + LinkRouteTableId: rtbassoc-12345678 + RouteTableId: rtb-12345678 + schema: + $ref: '#/components/schemas/UpdateRouteTableLinkRequest' + responses: + "200": + content: + application/json: + examples: + ex1: + value: + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + LinkRouteTableId: rtbassoc-12345678 + schema: + $ref: '#/components/schemas/UpdateRouteTableLinkResponse' + description: The HTTP 200 response (OK). + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + description: The HTTP 400 response (Bad Request). + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + description: The HTTP 401 response (Unauthorized). + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + description: The HTTP 500 response (Internal Server Error). + tags: + - RouteTable /UpdateServerCertificate: description: Modifies the name and/or the path of a specified server certificate. post: @@ -5406,12 +10998,26 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + Name: server-cert-example + NewName: new-name schema: $ref: '#/components/schemas/UpdateServerCertificateRequest' responses: "200": content: application/json: + examples: + ex1: + value: + ServerCertificate: + Path: /example/ + Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ1234 + Name: new-name + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/UpdateServerCertificateResponse' description: The HTTP 200 response (OK). @@ -5427,12 +11033,117 @@ paths: requestBody: content: application/json: + examples: + ex1: + summary: Adding permission + value: + SnapshotId: snap-12345678 + PermissionsToCreateVolume: + Additions: + AccountIds: + - "987654321098" + ex2: + summary: Removing permission + value: + SnapshotId: snap-12345678 + PermissionsToCreateVolume: + Removals: + AccountIds: + - "987654321098" + ex3: + summary: Making an image public to everyone + value: + SnapshotId: snap-12345678 + PermissionsToCreateVolume: + Additions: + GlobalPermission: true + ex4: + summary: Making an image private to everyone + value: + SnapshotId: snap-12345678 + PermissionsToCreateVolume: + Removals: + GlobalPermission: true schema: $ref: '#/components/schemas/UpdateSnapshotRequest' responses: "200": content: application/json: + examples: + ex1: + summary: Adding permission + value: + Snapshot: + VolumeSize: 10 + AccountId: "123456789012" + VolumeId: vol-12345678 + CreationDate: 2010-10-01T12:34:56.789Z + PermissionsToCreateVolume: + GlobalPermission: false + AccountIds: + - "987654321098" + Progress: 100 + SnapshotId: snap-12345678 + State: completed + Description: Snapshot created from a volume + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Removing permission + value: + Snapshot: + VolumeSize: 10 + AccountId: "123456789012" + VolumeId: vol-12345678 + CreationDate: 2010-10-01T12:34:56.789Z + PermissionsToCreateVolume: + GlobalPermission: false + AccountIds: [] + Progress: 100 + SnapshotId: snap-12345678 + State: completed + Description: Snapshot created from a volume + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex3: + summary: Making an image public to everyone + value: + Snapshot: + VolumeSize: 10 + AccountId: "123456789012" + VolumeId: vol-12345678 + CreationDate: 2010-10-01T12:34:56.789Z + PermissionsToCreateVolume: + GlobalPermission: true + AccountIds: [] + Progress: 100 + SnapshotId: snap-12345678 + State: completed + Description: Snapshot created from a volume + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex4: + summary: Making an image private to everyone + value: + Snapshot: + VolumeSize: 10 + AccountId: "123456789012" + VolumeId: vol-12345678 + CreationDate: 2010-10-01T12:34:56.789Z + PermissionsToCreateVolume: + GlobalPermission: false + AccountIds: [] + Progress: 100 + SnapshotId: snap-12345678 + State: completed + Description: Snapshot created from a volume + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/UpdateSnapshotResponse' description: The HTTP 200 response (OK). @@ -5463,12 +11174,31 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + SubnetId: subnet-12345678 + MapPublicIpOnLaunch: true schema: $ref: '#/components/schemas/UpdateSubnetRequest' responses: "200": content: application/json: + examples: + ex1: + value: + Subnet: + Tags: [] + SubregionName: eu-west-2a + SubnetId: subnet-12345678 + AvailableIpsCount: 16379 + IpRange: 10.0.0.0/18 + MapPublicIpOnLaunch: true + State: available + NetId: vpc-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/UpdateSubnetResponse' description: The HTTP 200 response (OK). @@ -5499,12 +11229,27 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + UserName: example-user + NewUserName: test-user + NewPath: /product/ schema: $ref: '#/components/schemas/UpdateUserRequest' responses: "200": content: application/json: + examples: + ex1: + value: + User: + UserName: test-user + UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345 + Path: /product/ + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/UpdateUserResponse' description: The HTTP 200 response (OK). @@ -5523,12 +11268,160 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + VmId: i-12345678 + VmType: tinav5.c2r2p2 + ex2: + value: + VmId: i-12345678 + UserData: '...' schema: $ref: '#/components/schemas/UpdateVmRequest' responses: "200": content: application/json: + examples: + ex1: + value: + Vm: + VmType: tinav5.c2r2p2 + VmInitiatedShutdownBehavior: stop + State: stopped + StateReason: "" + RootDeviceType: ebs + RootDeviceName: /dev/sda1 + IsSourceDestChecked: true + KeypairName: keypair-example + ImageId: ami-12345678 + DeletionProtection: false + Architecture: x86_64 + NestedVirtualization: false + BlockDeviceMappings: + - DeviceName: /dev/sda1 + Bsu: + VolumeId: vol-12345678 + State: attached + LinkDate: 2010-10-01T12:34:56.789Z + DeleteOnVmDeletion: true + VmId: i-12345678 + ReservationId: r-12345678 + Hypervisor: xen + Placement: + Tenancy: default + SubregionName: eu-west-2a + ProductCodes: + - "0001" + CreationDate: 2010-10-01T12:34:56.789Z + UserData: "" + SubnetId: subnet-12345678 + PrivateIp: 10.0.0.4 + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 + BsuOptimized: false + LaunchNumber: 0 + NetId: vpc-12345678 + Nics: + - SubnetId: subnet-12345678 + State: in-use + LinkNic: + State: attached + DeviceNumber: 0 + LinkNicId: eni-attach-12345678 + DeleteOnVmDeletion: true + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Description: Primary network interface + AccountId: "123456789012" + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 + MacAddress: A1:B2:C3:D4:E5:F6 + NetId: vpc-12345678 + NicId: eni-12345678 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true + Performance: high + Tags: + - Value: prod + Key: env + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + value: + Vm: + VmType: tinav5.c1r1p2 + VmInitiatedShutdownBehavior: stop + State: stopped + StateReason: "" + RootDeviceType: ebs + RootDeviceName: /dev/sda1 + IsSourceDestChecked: true + KeypairName: keypair-example + ImageId: ami-12345678 + DeletionProtection: true + Architecture: x86_64 + NestedVirtualization: false + BlockDeviceMappings: + - DeviceName: /dev/sda1 + Bsu: + VolumeId: vol-12345678 + State: attached + LinkDate: 2010-10-01T12:34:56.789Z + DeleteOnVmDeletion: true + VmId: i-12345678 + ReservationId: r-12345678 + Hypervisor: xen + Placement: + Tenancy: default + SubregionName: eu-west-2a + ProductCodes: + - "0001" + CreationDate: 2010-10-01T12:34:56.789Z + UserData: '...' + SubnetId: subnet-12345678 + PrivateIp: 10.0.0.4 + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 + BsuOptimized: false + LaunchNumber: 0 + NetId: vpc-12345678 + Nics: + - SubnetId: subnet-12345678 + State: in-use + LinkNic: + State: attached + DeviceNumber: 0 + LinkNicId: eni-attach-12345678 + DeleteOnVmDeletion: true + IsSourceDestChecked: true + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + Description: Primary network interface + AccountId: "123456789012" + SecurityGroups: + - SecurityGroupName: security-group-example + SecurityGroupId: sg-12345678 + MacAddress: A1:B2:C3:D4:E5:F6 + NetId: vpc-12345678 + NicId: eni-12345678 + PrivateIps: + - PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + PrivateIp: 10.0.0.4 + IsPrimary: true + Performance: high + Tags: + - Value: prod + Key: env + PrivateDnsName: ip-10-0-0-4.eu-west-2.compute.internal + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/UpdateVmResponse' description: The HTTP 200 response (OK). @@ -5563,12 +11456,43 @@ paths: requestBody: content: application/json: + examples: + ex1: + summary: Updating the name and description of a VM group + value: + VmGroupId: vmgroup-12345678901234567890123456789012 + VmGroupName: new-name + Description: New description of the VM group + ex2: + summary: Updating the VM template of a VM group + value: + VmGroupId: vmgroup-12345678901234567890123456789012 + VmTemplateId: vmtemplate-98765432109876543210987654321012 schema: $ref: '#/components/schemas/UpdateVmGroupRequest' responses: "200": content: application/json: + examples: + ex1: + value: + VmGroup: + VmTemplateId: vmtemplate-98765432109876543210987654321012 + SecurityGroupIds: + - sg-12345678 + VmIds: [] + CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + VmCount: 2 + VmGroupName: new-name + SubnetId: subnet-12345678 + PositioningStrategy: attract + State: available + VmGroupId: vmgroup-12345678901234567890123456789012 + Description: New description of the VM group + Tags: [] + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/UpdateVmGroupResponse' description: The HTTP 200 response (OK). @@ -5603,12 +11527,33 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + Description: The new description of the VM template + VmTemplateId: vmtemplate-98765432109876543210987654321012 + VmTemplateName: second-name schema: $ref: '#/components/schemas/UpdateVmTemplateRequest' responses: "200": content: application/json: + examples: + ex1: + value: + VmTemplateName: second-name + CpuPerformance: high + CreationDate: 2010-10-01 12:34:56.789000000 +00:00 + CpuCores: 2 + Tags: [] + Description: The new description of the VM template + ImageId: ami-12345678 + CpuGeneration: v4 + VmTemplateId: vmtemplate-98765432109876543210987654321012 + Ram: 2 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/UpdateVmTemplateResponse' description: The HTTP 200 response (OK). @@ -5626,12 +11571,55 @@ paths: requestBody: content: application/json: + examples: + ex1: + summary: Updating the size of a volume + value: + VolumeId: vol-12345678 + Size: 50 + ex2: + summary: Updating the type of a volume to io1 + value: + VolumeId: vol-12345678 + VolumeType: io1 + Iops: 200 schema: $ref: '#/components/schemas/UpdateVolumeRequest' responses: "200": content: application/json: + examples: + ex1: + summary: Updating the size of a volume + value: + Volume: + VolumeId: vol-12345678 + Tags: [] + VolumeType: gp2 + SubregionName: eu-west-2a + State: available + CreationDate: 2010-10-01T12:34:56.789Z + Iops: 100 + LinkedVolumes: [] + Size: 10 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 + ex2: + summary: Updating the type of a volume to io1 + value: + Volume: + VolumeId: vol-12345678 + Tags: [] + VolumeType: io1 + SubregionName: eu-west-2a + State: available + CreationDate: 2010-10-01T12:34:56.789Z + Iops: 200 + LinkedVolumes: [] + Size: 10 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/UpdateVolumeResponse' description: The HTTP 200 response (OK). @@ -5662,12 +11650,40 @@ paths: requestBody: content: application/json: + examples: + ex1: + value: + VpnConnectionId: vpn-12345678 + VpnOptions: + TunnelInsideIpRange: 169.254.254.22/30 schema: $ref: '#/components/schemas/UpdateVpnConnectionRequest' responses: "200": content: application/json: + examples: + ex1: + value: + VpnConnection: + VpnOptions: + TunnelInsideIpRange: 169.254.254.22/30 + Routes: [] + Tags: [] + ClientGatewayConfiguration: '...' + StaticRoutesOnly: true + VirtualGatewayId: vgw-12345678 + ConnectionType: ipsec.1 + ClientGatewayId: cgw-12345678 + State: pending + VgwTelemetries: + - StateDescription: IPSEC IS DOWN + AcceptedRouteCount: 0 + LastStateChangeDate: 2017-05-10T12:34:56.789Z + OutsideIpAddress: 192.0.2.0 + VpnConnectionId: vpn-12345678 + ResponseContext: + RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157 schema: $ref: '#/components/schemas/UpdateVpnConnectionResponse' description: The HTTP 200 response (OK). @@ -5715,6 +11731,7 @@ components: ResponseContext: RequestId: RequestId NetPeering: + ExpirationDate: 2000-01-23T04:56:07.000+00:00 SourceNet: IpRange: IpRange NetId: NetId @@ -5936,10 +11953,9 @@ components: format: int64 type: integer RequireTrustedEnv: - description: If true, a trusted session is activated, allowing you to bypass - Certificate Authorities (CAs) enforcement. For more information, see the - `ApiKeyAuth` authentication scheme in the [Authentication](#authentication) - section. + description: |- + If true, a trusted session is activated, allowing you to bypass Certificate Authorities (CAs) enforcement. For more information, see [About Your API Access Policy](https://docs.outscale.com/en/userguide/About-Your-API-Access-Policy.html).
+ If this is enabled, it is required that you and all your users log in to Cockpit v2 using the WebAuthn method for multi-factor authentication. For more information, see [About Authentication > Multi-Factor Authentication](https://docs.outscale.com/en/userguide/About-Authentication.html#_multi_factor_authentication). type: boolean type: object ApiAccessRule: @@ -6407,17 +12423,19 @@ components: description: Information about the resources consumed during the specified time period. example: - Type: Type AccountId: AccountId Category: Category - Value: 0.8008281904610115 Service: Service Title: Title - FromDate: FromDate - ToDate: ToDate Operation: Operation PayingAccountId: PayingAccountId SubregionName: SubregionName + Type: Type + UnitPrice: 6.027456183070403 + Price: 0.8008281904610115 + Value: 1.4658129805029452 + FromDate: FromDate + ToDate: ToDate properties: AccountId: description: The ID of your TINA account. @@ -6437,6 +12455,12 @@ components: 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 catalog of the Region where the API + method was used. + format: double + type: number Service: description: The service of the API call (`TinaOS-FCU`, `TinaOS-LBU`, `TinaOS-DirectLink`, `TinaOS-OOS`, or `TinaOS-OSU`). @@ -6454,6 +12478,11 @@ components: 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 + the catalog of the Region where the API method was used. + 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. @@ -6723,9 +12752,9 @@ components: BgpAsn: 0 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. - This number must be between `1` and `4294967295`. + description: |- + The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your client gateway through the Internet.
+ 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. type: integer ConnectionType: description: The communication protocol used to establish tunnel with your @@ -6765,40 +12794,90 @@ components: ResponseContext: $ref: '#/components/schemas/ResponseContext' type: object - CreateDhcpOptionsRequest: + CreateDedicatedGroupRequest: additionalProperties: false example: - LogServers: - - LogServers - - LogServers - NtpServers: - - NtpServers - - NtpServers - DomainName: DomainName + CpuGeneration: 0 DryRun: true - DomainNameServers: - - DomainNameServers - - DomainNameServers + Name: Name + SubregionName: SubregionName 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`.' - 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`.' - items: - type: string - type: array + CpuGeneration: + 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. type: boolean - LogServers: + Name: + description: A name for the dedicated group. + type: string + SubregionName: + description: The Subregion in which you want to create the dedicated group. + type: string + required: + - CpuGeneration + - Name + - SubregionName + type: object + CreateDedicatedGroupResponse: + additionalProperties: false + example: + DedicatedGroup: + AccountId: AccountId + CpuGeneration: 0 + NetIds: + - NetIds + - NetIds + DedicatedGroupId: DedicatedGroupId + Name: Name + SubregionName: SubregionName + VmIds: + - VmIds + - VmIds + ResponseContext: + RequestId: RequestId + properties: + DedicatedGroup: + $ref: '#/components/schemas/DedicatedGroup' + ResponseContext: + $ref: '#/components/schemas/ResponseContext' + type: object + CreateDhcpOptionsRequest: + additionalProperties: false + example: + LogServers: + - LogServers + - LogServers + NtpServers: + - NtpServers + - NtpServers + DomainName: DomainName + DryRun: true + DomainNameServers: + - DomainNameServers + - DomainNameServers + 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`.' + 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`.' + items: + type: string + type: array + DryRun: + 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`.' @@ -7084,11 +13163,12 @@ components: SourceImageId: SourceImageId properties: Architecture: - description: The architecture of the OMI (by default, `i386` if you specified - the `FileLocation` or `RootDeviceName` parameter). + description: '**(when registering from a snapshot, or from a bucket without + using a manifest file)** The architecture of the OMI (`i386` or `x84_64`).' type: string BlockDeviceMappings: - description: One or more block device mappings. + description: '**(when registering from a snapshot, or from a bucket without + using a manifest file)** One or more block device mappings.' items: $ref: '#/components/schemas/BlockDeviceMappingImage' type: array @@ -7100,19 +13180,18 @@ components: perform the action. type: boolean FileLocation: - description: 'The pre-signed URL of the OMI manifest file, or the full path - to the OMI stored in a bucket. If you specify this parameter, a copy of - the OMI is created in your account. You must specify only one of the following - parameters: `FileLocation`, `RootDeviceName`, `SourceImageId` or `VmId`.' + description: |- + **(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).
+ 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. type: string ImageName: description: |- A unique name for the new OMI.
- Constraints: 3-128 alphanumeric characters, underscores (_), spaces ( ), parentheses (()), slashes (/), periods (.), or dashes (-). + Constraints: 3-128 alphanumeric characters, underscores (`_`), spaces (` `), parentheses (`()`), slashes (`/`), periods (`.`), or dashes (`-`). type: string NoReboot: - description: 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. @@ -7120,23 +13199,19 @@ components: type: string type: array RootDeviceName: - description: 'The name of the root device. You must specify only one of - the following parameters: `FileLocation`, `RootDeviceName`, `SourceImageId` - or `VmId`.' + description: '**(when registering from a snapshot, or from a bucket without + using a manifest file)** The name of the root device for the new OMI.' type: string SourceImageId: - description: 'The ID of the OMI you want to copy. You must specify only - one of the following parameters: `FileLocation`, `RootDeviceName`, `SourceImageId` - or `VmId`.' + description: '**(when copying an OMI)** The ID of the OMI you want to copy.' type: string SourceRegionName: - description: The name of the source Region, which must be the same as the - Region of your account. + description: '**(when copying an OMI)** The name of the source Region (always + the same as the Region of your account).' type: string VmId: - description: 'The ID of the VM from which you want to create the OMI. You - must specify only one of the following parameters: `FileLocation`, `RootDeviceName`, - `SourceImageId` or `VmId`.' + description: '**(when creating from a VM)** The ID of the VM from which + you want to create the OMI.' type: string type: object CreateImageResponse: @@ -7242,7 +13317,8 @@ components: [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#Printable_characters). type: string PublicKey: - description: The public key. It 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 @@ -7254,6 +13330,7 @@ components: KeypairFingerprint: KeypairFingerprint PrivateKey: PrivateKey KeypairName: KeypairName + KeypairType: KeypairType ResponseContext: RequestId: RequestId properties: @@ -7892,6 +13969,7 @@ components: ResponseContext: RequestId: RequestId NetPeering: + ExpirationDate: 2000-01-23T04:56:07.000+00:00 SourceNet: IpRange: IpRange NetId: NetId @@ -7930,9 +14008,11 @@ components: description: The IP range for the Net, in CIDR notation (for example, `10.0.0.0/16`). type: string Tenancy: - description: The tenancy options for the VMs (`default` if a VM created - in a Net can be launched with any tenancy, `dedicated` if it can be launched - with dedicated tenancy VMs running on single-tenant hardware). + description: |- + The tenancy options for the VMs:
+ - `default` if a VM created in a Net can be launched with any tenancy.
+ - `dedicated` if it can be launched with dedicated tenancy VMs running on single-tenant hardware.
+ - `dedicated group ID`: if it can be launched in a dedicated group on single-tenant hardware. type: string required: - IpRange @@ -8064,6 +14144,132 @@ components: ResponseContext: $ref: '#/components/schemas/ResponseContext' type: object + CreatePolicyRequest: + additionalProperties: false + example: + Path: Path + Description: Description + PolicyName: PolicyName + DryRun: true + Document: Document + properties: + Description: + description: A description for the policy. + type: string + Document: + 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). + type: string + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + Path: + description: The path of the policy. + type: string + PolicyName: + description: The name of the policy. + type: string + required: + - Document + - PolicyName + type: object + CreatePolicyResponse: + additionalProperties: false + example: + Policy: + Path: Path + PolicyDefaultVersionId: PolicyDefaultVersionId + CreationDate: 2000-01-23T04:56:07.000+00:00 + ResourcesCount: 0 + Description: Description + IsLinkable: true + PolicyName: PolicyName + LastModificationDate: 2000-01-23T04:56:07.000+00:00 + Orn: Orn + PolicyId: PolicyId + ResponseContext: + RequestId: RequestId + properties: + Policy: + $ref: '#/components/schemas/Policy' + ResponseContext: + $ref: '#/components/schemas/ResponseContext' + type: object + CreatePolicyVersionRequest: + additionalProperties: false + example: + SetAsDefault: true + PolicyOrn: PolicyOrn + Document: Document + properties: + Document: + 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). + 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). + type: string + SetAsDefault: + description: If set to true, the new policy version is set as the default + version and becomes the operative one. + type: boolean + required: + - Document + - PolicyOrn + type: object + CreatePolicyVersionResponse: + additionalProperties: false + example: + PolicyVersion: + VersionId: VersionId + CreationDate: 2000-01-23T04:56:07.000+00:00 + DefaultVersion: true + Body: Body + ResponseContext: + RequestId: RequestId + properties: + PolicyVersion: + $ref: '#/components/schemas/PolicyVersion' + ResponseContext: + $ref: '#/components/schemas/ResponseContext' + type: object + CreateProductTypeRequest: + additionalProperties: false + example: + Description: Description + DryRun: true + Vendor: Vendor + properties: + Description: + description: The description of the product type. + type: string + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + Vendor: + description: The vendor of the product type. + type: string + required: + - Description + type: object + CreateProductTypeResponse: + additionalProperties: false + example: + ResponseContext: + RequestId: RequestId + ProductType: + Description: Description + Vendor: Vendor + ProductTypeId: ProductTypeId + properties: + ProductType: + $ref: '#/components/schemas/ProductType' + ResponseContext: + $ref: '#/components/schemas/ResponseContext' + type: object CreatePublicIpRequest: additionalProperties: false example: @@ -8151,11 +14357,13 @@ components: - VirtualGatewayId: VirtualGatewayId - VirtualGatewayId: VirtualGatewayId LinkRouteTables: - - RouteTableId: RouteTableId + - NetId: NetId + RouteTableId: RouteTableId LinkRouteTableId: LinkRouteTableId SubnetId: SubnetId Main: true - - RouteTableId: RouteTableId + - NetId: NetId + RouteTableId: RouteTableId LinkRouteTableId: LinkRouteTableId SubnetId: SubnetId Main: true @@ -8221,11 +14429,13 @@ components: - VirtualGatewayId: VirtualGatewayId - VirtualGatewayId: VirtualGatewayId LinkRouteTables: - - RouteTableId: RouteTableId + - NetId: NetId + RouteTableId: RouteTableId LinkRouteTableId: LinkRouteTableId SubnetId: SubnetId Main: true - - RouteTableId: RouteTableId + - NetId: NetId + RouteTableId: RouteTableId LinkRouteTableId: LinkRouteTableId SubnetId: SubnetId Main: true @@ -8274,8 +14484,9 @@ components: DryRun: true properties: Description: - description: A description for the security group, with a maximum length - of 255 [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#Printable_characters). + description: |- + A description for the security group.
+ 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 @@ -8287,8 +14498,8 @@ components: SecurityGroupName: description: |- The name of the security group.
- This name must not start with `sg-`.
- This name must be unique and contain between 1 and 255 ASCII characters. Accented letters are not allowed. + This name must not start with `sg-`.
+ This name must be unique and contain between 1 and 255 characters. Allowed characters are `a-z`, `A-Z`, `0-9`, spaces, and `_.-:/()#,@[]+=&;{}!$*`. type: string required: - Description @@ -8703,27 +14914,29 @@ components: perform the action. type: boolean FileLocation: - description: (When importing) 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). + description: '**(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).' type: string SnapshotSize: - description: (When importing) 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) 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) 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) 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: @@ -8772,7 +14985,7 @@ components: IpRange: description: |- The IP range in the Subnet, in CIDR notation (for example, `10.0.0.0/16`).
- The IP range of the Subnet can be either the same as the Net one if you create only a single Subnet in this Net, or a subset of the Net one. In case of several Subnets in a Net, their IP ranges must not overlap. The smallest Subnet you can create uses a /29 netmask (eight IPs). For more information, see [About VPCs](https://docs.outscale.com/en/userguide/About-VPCs.html). + The IP range of the Subnet can be either the same as the Net one if you create only a single Subnet in this Net, or a subset of the Net one. In case of several Subnets in a Net, their IP ranges must not overlap. The smallest Subnet you can create uses a /29 netmask (eight IPs). For more information, see [About Nets](https://docs.outscale.com/en/userguide/About-Nets.html). type: string NetId: description: The ID of the Net for which you want to create a Subnet. @@ -8861,9 +15074,14 @@ components: 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 (_). type: string UserName: - description: The name of the EIM user you want to create. + description: The name of the EIM user you want to create. 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 @@ -9293,7 +15511,7 @@ components: VmType: description: |- 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).
- 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 [Instance Types](https://docs.outscale.com/en/userguide/Instance-Types.html). + 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). type: string required: - ImageId @@ -9676,10 +15894,11 @@ components: perform the action. type: boolean 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: 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. @@ -9794,6 +16013,48 @@ components: ResponseContext: $ref: '#/components/schemas/ResponseContext' type: object + DedicatedGroup: + additionalProperties: false + description: Information about the dedicated group. + example: + AccountId: AccountId + CpuGeneration: 0 + NetIds: + - NetIds + - NetIds + DedicatedGroupId: DedicatedGroupId + Name: Name + SubregionName: SubregionName + VmIds: + - VmIds + - VmIds + properties: + AccountId: + description: The account ID of the owners of the dedicated group. + type: string + CpuGeneration: + description: The processor generation. + type: integer + DedicatedGroupId: + description: The ID of the dedicated group. + type: string + Name: + description: The name of the dedicated group. + type: string + NetIds: + description: The IDs of the Nets in the dedicated group. + items: + type: string + type: array + SubregionName: + description: The name of the Subregion in which the dedicated group is located. + type: string + VmIds: + description: The IDs of the VMs in the dedicated group. + items: + type: string + type: array + type: object DeleteAccessKeyRequest: additionalProperties: false example: @@ -9900,6 +16161,36 @@ components: ResponseContext: $ref: '#/components/schemas/ResponseContext' type: object + DeleteDedicatedGroupRequest: + additionalProperties: false + example: + Force: true + DedicatedGroupId: DedicatedGroupId + DryRun: true + properties: + DedicatedGroupId: + 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. + type: boolean + Force: + description: If true, forces the deletion of the dedicated group and all + its dependencies. + type: boolean + required: + - DedicatedGroupId + type: object + DeleteDedicatedGroupResponse: + additionalProperties: false + example: + ResponseContext: + RequestId: RequestId + properties: + ResponseContext: + $ref: '#/components/schemas/ResponseContext' + type: object DeleteDhcpOptionsRequest: additionalProperties: false example: @@ -10523,6 +16814,58 @@ components: ResponseContext: $ref: '#/components/schemas/ResponseContext' type: object + DeletePolicyRequest: + additionalProperties: false + example: + PolicyOrn: PolicyOrn + DryRun: true + properties: + DryRun: + 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). + type: string + required: + - PolicyOrn + type: object + DeletePolicyResponse: + additionalProperties: false + example: + ResponseContext: + RequestId: RequestId + properties: + ResponseContext: + $ref: '#/components/schemas/ResponseContext' + type: object + DeletePolicyVersionRequest: + additionalProperties: false + example: + VersionId: VersionId + PolicyOrn: PolicyOrn + 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). + type: string + VersionId: + description: The ID of the version of the policy you want to delete. + type: string + required: + - PolicyOrn + - VersionId + type: object + DeletePolicyVersionResponse: + additionalProperties: false + example: + ResponseContext: + RequestId: RequestId + properties: + ResponseContext: + $ref: '#/components/schemas/ResponseContext' + type: object DeletePublicIpRequest: additionalProperties: false example: @@ -10582,11 +16925,13 @@ components: - VirtualGatewayId: VirtualGatewayId - VirtualGatewayId: VirtualGatewayId LinkRouteTables: - - RouteTableId: RouteTableId + - NetId: NetId + RouteTableId: RouteTableId LinkRouteTableId: LinkRouteTableId SubnetId: SubnetId Main: true - - RouteTableId: RouteTableId + - NetId: NetId + RouteTableId: RouteTableId LinkRouteTableId: LinkRouteTableId SubnetId: SubnetId Main: true @@ -11356,7 +17701,8 @@ components: description: The ID of the target virtual gateway. type: string Vlan: - description: The VLAN number associated with the DirectLink interface. + description: The VLAN number associated with the DirectLink interface. This + number must be unique and be between `2` and `4094`. type: integer required: - BgpAsn @@ -11730,24 +18076,64 @@ components: type: string type: array type: object - FiltersDhcpOptions: + FiltersDedicatedGroup: additionalProperties: false description: One or more filters. example: - LogServers: - - LogServers - - LogServers - NtpServers: - - NtpServers - - NtpServers - Default: true - DomainNames: - - DomainNames - - DomainNames - DomainNameServers: - - DomainNameServers - - DomainNameServers - TagKeys: + Names: + - Names + - Names + CpuGenerations: + - 0 + - 0 + SubregionNames: + - SubregionNames + - SubregionNames + DedicatedGroupIds: + - DedicatedGroupIds + - DedicatedGroupIds + properties: + CpuGenerations: + description: The processor generation for the VMs in the dedicated group + (for example, `4`). + items: + type: integer + type: array + DedicatedGroupIds: + description: The IDs of the dedicated groups. + items: + type: string + type: array + Names: + description: The names of the dedicated groups. + items: + type: string + type: array + SubregionNames: + description: The names of the Subregions in which the dedicated groups are + located. + items: + type: string + type: array + type: object + FiltersDhcpOptions: + additionalProperties: false + description: One or more filters. + example: + LogServers: + - LogServers + - LogServers + NtpServers: + - NtpServers + - NtpServers + Default: true + DomainNames: + - DomainNames + - DomainNames + DomainNameServers: + - DomainNameServers + - DomainNameServers + TagKeys: - TagKeys - TagKeys TagValues: @@ -11961,6 +18347,9 @@ components: BlockDeviceMappingVolumeSizes: - 0 - 0 + ProductCodeNames: + - ProductCodeNames + - ProductCodeNames ImageNames: - ImageNames - ImageNames @@ -12055,8 +18444,7 @@ components: type: string type: array PermissionsToLaunchAccountIds: - description: The account IDs of the users who have launch permissions for - the OMIs. + description: The account IDs which have launch permissions for the OMIs. items: type: string type: array @@ -12064,6 +18452,11 @@ components: 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. + items: + type: string + type: array ProductCodes: description: The product codes associated with the OMI. items: @@ -12075,7 +18468,7 @@ components: type: string type: array RootDeviceTypes: - description: The types of root device used by the OMIs (always `bsu`). + description: The types of root device used by the OMIs (`bsu` or `ebs`). items: type: string type: array @@ -12142,7 +18535,7 @@ components: 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 VPC). + to a Net). items: type: string type: array @@ -12173,6 +18566,9 @@ components: KeypairFingerprints: - KeypairFingerprints - KeypairFingerprints + KeypairTypes: + - KeypairTypes + - KeypairTypes properties: KeypairFingerprints: description: The fingerprints of the keypairs. @@ -12184,6 +18580,12 @@ components: items: 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`). + items: + type: string + type: array type: object FiltersListenerRule: additionalProperties: false @@ -12324,7 +18726,7 @@ components: type: string type: array States: - description: The states of the Nets (`pending` \| `available` \| `deleted`). + description: The states of the Nets (`pending` \| `available` \| `deleting`). items: type: string type: array @@ -12428,24 +18830,27 @@ components: NetPeeringIds: - NetPeeringIds - NetPeeringIds - AccepterNetAccountIds: - - AccepterNetAccountIds - - AccepterNetAccountIds SourceNetAccountIds: - SourceNetAccountIds - SourceNetAccountIds SourceNetIpRanges: - SourceNetIpRanges - SourceNetIpRanges - StateNames: - - StateNames - - StateNames TagKeys: - TagKeys - TagKeys TagValues: - TagValues - TagValues + ExpirationDates: + - 2000-01-23T04:56:07.000+00:00 + - 2000-01-23T04:56:07.000+00:00 + AccepterNetAccountIds: + - AccepterNetAccountIds + - AccepterNetAccountIds + StateNames: + - StateNames + - StateNames Tags: - Tags - Tags @@ -12466,6 +18871,13 @@ components: items: 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`). + items: + format: date-time + type: string + type: array NetPeeringIds: description: The IDs of the Net peerings. items: @@ -13047,9 +19459,6 @@ components: InboundRuleToPortRanges: - 6 - 6 - AccountIds: - - AccountIds - - AccountIds NetIds: - NetIds - NetIds @@ -13102,11 +19511,6 @@ components: - Tags - Tags properties: - AccountIds: - description: The account IDs of the owners of the security groups. - items: - type: string - type: array Descriptions: description: The descriptions of the security groups. items: @@ -13324,8 +19728,7 @@ components: format: date-time type: string PermissionsToCreateVolumeAccountIds: - description: The account IDs of one or more users who have permissions to - create volumes. + description: The account IDs which have permissions to create volumes. items: type: string type: array @@ -13465,10 +19868,26 @@ components: additionalProperties: false description: One or more filters. example: + States: + - States + - States + RegionNames: + - RegionNames + - RegionNames SubregionNames: - SubregionNames - SubregionNames properties: + RegionNames: + description: The names of the Regions containing the Subregions. + items: + type: string + type: array + States: + description: The states of the Subregions. + items: + type: string + type: array SubregionNames: description: The names of the Subregions. items: @@ -13599,131 +20018,618 @@ components: additionalProperties: false description: One or more filters. example: - TagKeys: - - TagKeys - - TagKeys + CreationDates: + - 2000-01-23 + - 2000-01-23 + KeypairNames: + - KeypairNames + - KeypairNames + NicLinkPublicIpPublicIpIds: + - NicLinkPublicIpPublicIpIds + - NicLinkPublicIpPublicIpIds + Tenancies: + - Tenancies + - Tenancies + RootDeviceNames: + - RootDeviceNames + - RootDeviceNames + BlockDeviceMappingLinkDates: + - 2000-01-23 + - 2000-01-23 + NicLinkNicLinkNicIds: + - NicLinkNicLinkNicIds + - NicLinkNicLinkNicIds + NicPrivateIpsPrivateIps: + - NicPrivateIpsPrivateIps + - NicPrivateIpsPrivateIps + NicSubregionNames: + - NicSubregionNames + - NicSubregionNames TagValues: - TagValues - TagValues - Tags: - - Tags - - Tags + VmStateCodes: + - 5 + - 5 VmIds: - VmIds - VmIds - properties: + NicLinkPublicIpLinkPublicIpIds: + - NicLinkPublicIpLinkPublicIpIds + - NicLinkPublicIpLinkPublicIpIds + BlockDeviceMappingVolumeIds: + - BlockDeviceMappingVolumeIds + - BlockDeviceMappingVolumeIds + NicMacAddresses: + - NicMacAddresses + - NicMacAddresses + SubregionNames: + - SubregionNames + - SubregionNames + NicLinkNicStates: + - NicLinkNicStates + - NicLinkNicStates + NicSubnetIds: + - NicSubnetIds + - NicSubnetIds + Tags: + - Tags + - Tags + ProductCodes: + - ProductCodes + - ProductCodes + Platforms: + - Platforms + - Platforms + NetIds: + - NetIds + - NetIds + NicSecurityGroupIds: + - NicSecurityGroupIds + - NicSecurityGroupIds + NicLinkNicDeviceNumbers: + - 6 + - 6 + SecurityGroupIds: + - SecurityGroupIds + - SecurityGroupIds + BlockDeviceMappingDeleteOnVmDeletion: true + StateReasonMessages: + - StateReasonMessages + - StateReasonMessages + NicLinkNicLinkNicDates: + - 2000-01-23 + - 2000-01-23 + NicSecurityGroupNames: + - NicSecurityGroupNames + - NicSecurityGroupNames + PrivateIps: + - PrivateIps + - PrivateIps + ClientTokens: + - ClientTokens + - ClientTokens + VmStateNames: + - VmStateNames + - VmStateNames + NicDescriptions: + - NicDescriptions + - NicDescriptions + NicIsSourceDestChecked: true + LaunchNumbers: + - 0 + - 0 + NicLinkNicDeleteOnVmDeletion: true + NicPrivateIpsPrimaryIp: true + NicLinkNicVmAccountIds: + - NicLinkNicVmAccountIds + - NicLinkNicVmAccountIds + ReservationIds: + - ReservationIds + - ReservationIds + SubnetIds: + - SubnetIds + - SubnetIds + VmTypes: + - VmTypes + - VmTypes + PublicIps: + - PublicIps + - PublicIps + IsSourceDestChecked: true + NicNicIds: + - NicNicIds + - NicNicIds + NicLinkPublicIpAccountIds: + - NicLinkPublicIpAccountIds + - NicLinkPublicIpAccountIds + Lifecycles: + - Lifecycles + - Lifecycles + NicLinkPublicIpPublicIps: + - NicLinkPublicIpPublicIps + - NicLinkPublicIpPublicIps + ImageIds: + - ImageIds + - ImageIds + NicPrivateIpsLinkPublicIpAccountIds: + - NicPrivateIpsLinkPublicIpAccountIds + - NicPrivateIpsLinkPublicIpAccountIds + NicLinkNicVmIds: + - NicLinkNicVmIds + - NicLinkNicVmIds + StateReasonCodes: + - 1 + - 1 + SecurityGroupNames: + - SecurityGroupNames + - SecurityGroupNames TagKeys: - description: The keys of the tags associated with the VMs. + - TagKeys + - TagKeys + VmSecurityGroupNames: + - VmSecurityGroupNames + - VmSecurityGroupNames + NicPrivateIpsLinkPublicIpIds: + - NicPrivateIpsLinkPublicIpIds + - NicPrivateIpsLinkPublicIpIds + StateReasons: + - StateReasons + - StateReasons + BlockDeviceMappingStates: + - BlockDeviceMappingStates + - BlockDeviceMappingStates + VmSecurityGroupIds: + - VmSecurityGroupIds + - VmSecurityGroupIds + NicAccountIds: + - NicAccountIds + - NicAccountIds + NicStates: + - NicStates + - NicStates + RootDeviceTypes: + - RootDeviceTypes + - RootDeviceTypes + BlockDeviceMappingDeviceNames: + - BlockDeviceMappingDeviceNames + - BlockDeviceMappingDeviceNames + NicNetIds: + - NicNetIds + - NicNetIds + Architectures: + - Architectures + - Architectures + properties: + Architectures: + description: The architectures of the VMs (`i386` \| `x86_64`). items: type: string type: array - TagValues: - description: The values of the tags associated with the VMs. + BlockDeviceMappingDeleteOnVmDeletion: + 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`). items: 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"]}.' + BlockDeviceMappingLinkDates: + 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 type: array - VmIds: - description: One or more IDs of VMs. + BlockDeviceMappingStates: + description: The states for the BSU volumes (`attaching` \| `attached` \| + `detaching` \| `detached`). items: type: string type: array - type: object - FiltersVmGroup: - additionalProperties: false - description: One or more filters. - example: - Descriptions: - - Descriptions - - Descriptions - VmGroupIds: - - VmGroupIds - - VmGroupIds - VmGroupNames: - - VmGroupNames - - VmGroupNames - VmTemplateIds: - - VmTemplateIds - - VmTemplateIds - SecurityGroupIds: - - SecurityGroupIds - - SecurityGroupIds - SubnetIds: - - SubnetIds - - SubnetIds - TagKeys: - - TagKeys - - TagKeys - TagValues: - - TagValues - - TagValues - Tags: - - Tags - - Tags - VmCounts: - - 0 - - 0 - properties: - Descriptions: - description: The descriptions of the VM groups. + BlockDeviceMappingVolumeIds: + description: The volume IDs of the BSU volumes. items: type: string type: array - SecurityGroupIds: - description: The IDs of the security groups. + ClientTokens: + description: The idempotency tokens provided when launching the VMs. items: type: string type: array - SubnetIds: - description: The IDs of the Subnets. + CreationDates: + description: The dates when the VMs were launched. items: + format: date type: string type: array - TagKeys: - description: The keys of the tags associated with the VM groups. + ImageIds: + description: The IDs of the OMIs used to launch the VMs. items: type: string type: array - TagValues: - description: The values of the tags associated with the VM groups. + IsSourceDestChecked: + 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. items: 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"]}.' + LaunchNumbers: + 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 + Lifecycles: + description: Whether the VMs are Spot Instances (spot). items: type: string type: array - VmCounts: - description: The number of VMs in the VM group. + NetIds: + description: The IDs of the Nets in which the VMs are running. items: - type: integer + type: string type: array - VmGroupIds: - description: The IDs of the VM groups. + NicAccountIds: + description: The IDs of the NICs. items: type: string type: array - VmGroupNames: - description: The names of the VM groups. + NicDescriptions: + description: The descriptions of the NICs. items: type: string type: array - VmTemplateIds: - description: The IDs of the VM templates. + NicIsSourceDestChecked: + 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. + type: boolean + NicLinkNicDeviceNumbers: + description: The device numbers the NICs are attached to. items: + type: integer + type: array + NicLinkNicLinkNicDates: + description: The dates and time when the NICs were attached to the VMs. + items: + format: date type: string type: array - type: object - FiltersVmTemplate: - additionalProperties: false - description: One or more filters. + NicLinkNicLinkNicIds: + description: The IDs of the NIC attachments. + items: + type: string + type: array + NicLinkNicStates: + description: The states of the attachments. + items: + type: string + type: array + NicLinkNicVmAccountIds: + description: The account IDs of the owners of the VMs the NICs are attached + to. + items: + type: string + type: array + NicLinkNicVmIds: + description: The IDs of the VMs the NICs are attached to. + items: + type: string + type: array + NicLinkPublicIpAccountIds: + 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. + items: + type: string + type: array + NicLinkPublicIpPublicIpIds: + description: The allocation IDs returned when the public IPs were allocated + to their accounts. + items: + type: string + type: array + NicLinkPublicIpPublicIps: + description: The public IPs associated with the NICs. + items: + type: string + type: array + NicMacAddresses: + description: The Media Access Control (MAC) addresses of the NICs. + items: + type: string + type: array + NicNetIds: + description: The IDs of the Nets where the NICs are located. + items: + type: string + type: array + NicNicIds: + description: The IDs of the NICs. + items: + type: string + type: array + NicPrivateIpsLinkPublicIpAccountIds: + description: The account IDs of the owner of the public IPs associated with + the private IPs. + items: + type: string + type: array + NicPrivateIpsLinkPublicIpIds: + description: The public IPs associated with the private IPs. + items: + type: string + type: array + NicPrivateIpsPrimaryIp: + description: Whether the private IPs are the primary IPs associated with + the NICs. + type: boolean + NicPrivateIpsPrivateIps: + description: The private IPs of the NICs. + items: + type: string + type: array + NicSecurityGroupIds: + description: The IDs of the security groups associated with the NICs. + items: + type: string + type: array + NicSecurityGroupNames: + description: The names of the security groups associated with the NICs. + items: + type: string + type: array + NicStates: + description: The states of the NICs (`available` \| `in-use`). + items: + type: string + type: array + NicSubnetIds: + description: The IDs of the Subnets for the NICs. + items: + type: string + type: array + NicSubregionNames: + description: The Subregions where the NICs are located. + items: + type: string + type: array + Platforms: + description: The platforms. Use windows if you have Windows VMs. Otherwise, + leave this filter blank. + items: + type: string + type: array + PrivateIps: + description: The private IPs of the VMs. + items: + type: string + type: array + ProductCodes: + description: The product codes associated with the OMI used to create the + VMs. + items: + type: string + type: array + PublicIps: + description: The public IPs of the VMs. + items: + 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 lauch a group of VMs using the same launch request. + items: + type: string + type: array + RootDeviceNames: + description: The names of the root devices for the VMs (for example, `/dev/sda1`) + items: + type: string + type: array + RootDeviceTypes: + description: The root devices types used by the VMs (always `ebs`) + items: + type: string + type: array + SecurityGroupIds: + 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). + items: + type: string + type: array + StateReasonCodes: + description: The reason codes for the state changes. + items: + type: integer + type: array + StateReasonMessages: + description: The messages describing the state changes. + items: + type: string + type: array + StateReasons: + description: The reasons explaining the current states of the VMs. This + filter is like the `StateReasonCodes` one. + items: + type: string + type: array + SubnetIds: + description: The IDs of the Subnets for the VMs. + items: + type: string + type: array + SubregionNames: + description: The names of the Subregions of the VMs. + items: + type: string + type: array + TagKeys: + description: The keys of the tags associated with the VMs. + items: + type: string + type: array + TagValues: + description: The values of the tags associated with the VMs. + items: + 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"]}.' + items: + type: string + type: array + Tenancies: + description: The tenancies of the VMs (`dedicated` \| `default` \| `host`). + items: + type: string + type: array + VmIds: + description: One or more IDs of VMs. + items: + type: string + type: array + VmSecurityGroupIds: + description: The IDs of the security groups for the VMs. + items: + type: string + type: array + VmSecurityGroupNames: + description: The names of the security group for the VMs. + items: + 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).' + items: + type: integer + type: array + VmStateNames: + 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). + items: + type: string + type: array + type: object + FiltersVmGroup: + additionalProperties: false + description: One or more filters. + example: + Descriptions: + - Descriptions + - Descriptions + VmGroupIds: + - VmGroupIds + - VmGroupIds + VmGroupNames: + - VmGroupNames + - VmGroupNames + VmTemplateIds: + - VmTemplateIds + - VmTemplateIds + SecurityGroupIds: + - SecurityGroupIds + - SecurityGroupIds + SubnetIds: + - SubnetIds + - SubnetIds + TagKeys: + - TagKeys + - TagKeys + TagValues: + - TagValues + - TagValues + Tags: + - Tags + - Tags + VmCounts: + - 0 + - 0 + properties: + Descriptions: + description: The descriptions of the VM groups. + items: + type: string + type: array + SecurityGroupIds: + description: The IDs of the security groups. + items: + type: string + type: array + SubnetIds: + description: The IDs of the Subnets. + items: + type: string + type: array + TagKeys: + description: The keys of the tags associated with the VM groups. + items: + type: string + type: array + TagValues: + description: The values of the tags associated with the VM groups. + items: + 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"]}.' + items: + type: string + type: array + VmCounts: + description: The number of VMs in the VM group. + items: + type: integer + type: array + VmGroupIds: + description: The IDs of the VM groups. + items: + type: string + type: array + VmGroupNames: + description: The names of the VM groups. + items: + type: string + type: array + VmTemplateIds: + description: The IDs of the VM templates. + items: + type: string + type: array + type: object + FiltersVmTemplate: + additionalProperties: false + description: One or more filters. example: ImageIds: - ImageIds @@ -13809,7 +20715,7 @@ components: type: array Tags: description: 'The key/value combination of the tags associated with the - VM templates, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' + VM templates, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.' items: type: string type: array @@ -13829,17 +20735,26 @@ components: description: One or more filters. example: VolumeSizes: + - 2 + - 2 + VcoreCounts: - 5 - 5 - VcoreCounts: + Gpus: - 6 - 6 VolumeCounts: - - 1 - - 1 + - 5 + - 5 + EphemeralsTypes: + - EphemeralsTypes + - EphemeralsTypes + Eths: + - 0 + - 0 MemorySizes: - - 0.8008282 - - 0.8008282 + - 1.4658129 + - 1.4658129 BsuOptimized: true VmTypeNames: - VmTypeNames @@ -13849,6 +20764,21 @@ components: 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. + items: + type: string + type: array + Eths: + description: The number of Ethernet interfaces available. + items: + type: integer + type: array + Gpus: + description: The number of GPUs available. + items: + type: integer + type: array MemorySizes: description: The amounts of memory, in gibibytes (GiB). items: @@ -13861,8 +20791,7 @@ components: type: integer type: array VmTypeNames: - description: The names of the VM types. For more information, see [Instance - Types](https://docs.outscale.com/en/userguide/Instance-Types.html). + description: The names of the VM types. For more information, see [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html). items: type: string type: array @@ -14250,15 +21179,15 @@ components: Protocol: Protocol properties: CheckInterval: - description: The number of seconds between two pings (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 pings before considering + 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 ping path. + description: If you use the HTTP or HTTPS protocols, the request URL path. type: string Port: description: The port number (between `1` and `65535`, both included). @@ -14272,8 +21201,8 @@ components: the VM as unhealthy, in seconds (between `2` and `60` both included). type: integer UnhealthyThreshold: - description: The number of consecutive failed pings 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 @@ -14340,7 +21269,7 @@ components: description: The account ID of the owner of the OMI. type: string Architecture: - description: The architecture of the OMI (by default, `i386`). + description: The architecture of the OMI. type: string BlockDeviceMappings: description: One or more block device mappings. @@ -14356,7 +21285,7 @@ components: description: The description of the OMI. type: string FileLocation: - description: The location of the bucket where the OMI files are stored. + description: The location from which the OMI files were created. type: string ImageId: description: The ID of the OMI. @@ -14470,6 +21399,7 @@ components: example: KeypairFingerprint: KeypairFingerprint KeypairName: KeypairName + KeypairType: KeypairType properties: KeypairFingerprint: description: The MD5 public key fingerprint as specified in section 4 of @@ -14478,6 +21408,10 @@ components: KeypairName: 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`). + type: string type: object KeypairCreated: additionalProperties: false @@ -14486,17 +21420,23 @@ components: KeypairFingerprint: KeypairFingerprint PrivateKey: PrivateKey KeypairName: KeypairName + KeypairType: KeypairType properties: KeypairFingerprint: - description: The MD5 public key fingerprint as specified in section 4 of + description: The MD5 public key fingerprint, as specified in section 4 of RFC 4716. type: string KeypairName: 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`). + type: string PrivateKey: - description: The private key. When saving the private key in a .rsa file, - replace the `\n` escape sequences with 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 type: object LinkFlexibleGpuRequest: @@ -14713,6 +21653,38 @@ components: description: The ID of the NIC attachment. type: string type: object + LinkPolicyRequest: + additionalProperties: false + example: + UserName: UserName + PolicyOrn: PolicyOrn + DryRun: true + properties: + DryRun: + 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). + type: string + UserName: + description: The name of the user you want to link the policy to (between + 1 and 64 characters). + type: string + required: + - PolicyOrn + - UserName + type: object + LinkPolicyResponse: + additionalProperties: false + example: + ResponseContext: + RequestId: RequestId + properties: + ResponseContext: + $ref: '#/components/schemas/ResponseContext' + type: object LinkPrivateIpsRequest: additionalProperties: false example: @@ -14815,9 +21787,9 @@ components: 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 EIP 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.) + 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 @@ -14866,6 +21838,7 @@ components: additionalProperties: false description: One or more associations between the route table and the Subnets. example: + NetId: NetId RouteTableId: RouteTableId LinkRouteTableId: LinkRouteTableId SubnetId: SubnetId @@ -14877,6 +21850,9 @@ components: Main: description: If true, the route table is the main one. type: boolean + NetId: + description: The ID of the Net. + type: string RouteTableId: description: The ID of the route table. type: string @@ -14991,6 +21967,35 @@ components: ResponseContext: $ref: '#/components/schemas/ResponseContext' type: object + LinkedPolicy: + additionalProperties: false + description: Information about the attached policy. + example: + CreationDate: 2000-01-23T04:56:07.000+00:00 + PolicyName: PolicyName + LastModificationDate: 2000-01-23T04:56:07.000+00:00 + Orn: Orn + PolicyId: PolicyId + properties: + CreationDate: + description: The date and time of creation of the attached policy. + format: date-time + type: string + LastModificationDate: + description: The date and time at which the attached 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). + type: string + PolicyId: + description: The ID of the policy. + type: string + PolicyName: + description: The name of the policy. + type: string + type: object LinkedVolume: additionalProperties: false description: Information about volume attachment. @@ -15563,7 +22568,7 @@ components: description: The ID of the Net. type: string State: - description: The state of the Net (`pending` \| `available` \| `deleted`). + description: The state of the Net (`pending` \| `available` \| `deleting`). type: string Tags: description: One or more tags associated with the Net. @@ -15620,6 +22625,7 @@ components: additionalProperties: false description: Information about the Net peering. example: + ExpirationDate: 2000-01-23T04:56:07.000+00:00 SourceNet: IpRange: IpRange NetId: NetId @@ -15640,6 +22646,11 @@ components: properties: AccepterNet: $ref: '#/components/schemas/AccepterNet' + ExpirationDate: + description: The date and time at which the Net peerings expire. + format: date-time + nullable: true + type: string NetPeeringId: description: The ID of the Net peering. type: string @@ -16191,6 +23202,18 @@ components: any character except line breaks and double quotes ("). type: string type: object + Phase2OptionsToUpdate: + additionalProperties: false + description: 'Information about Phase 2 of the Internet Key Exchange (IKE) negotiation. ' + example: + PreSharedKey: PreSharedKey + properties: + 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 ("). + type: string + type: object Placement: additionalProperties: false description: Information about the placement of the VM. @@ -16203,7 +23226,81 @@ components: must not specify the `Nics` parameter. type: string Tenancy: - description: The tenancy of the VM (`default` \| `dedicated`). + description: The tenancy of the VM (`default`, `dedicated`, or a dedicated + group ID). + type: string + type: object + Policy: + additionalProperties: false + description: Information about the policy. + example: + Path: Path + PolicyDefaultVersionId: PolicyDefaultVersionId + CreationDate: 2000-01-23T04:56:07.000+00:00 + ResourcesCount: 0 + Description: Description + IsLinkable: true + PolicyName: PolicyName + LastModificationDate: 2000-01-23T04:56:07.000+00:00 + Orn: Orn + PolicyId: PolicyId + properties: + CreationDate: + description: The date and time of creation of the policy. + format: date-time + type: string + Description: + 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. + type: boolean + LastModificationDate: + description: The date and time 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). + type: string + Path: + description: The path to the policy. + type: string + PolicyDefaultVersionId: + description: The ID of the policy default version. + type: string + PolicyId: + description: The ID of the policy. + type: string + PolicyName: + description: The name of the policy. + type: string + ResourcesCount: + description: The number of resources attached to the policy. + type: integer + type: object + PolicyVersion: + additionalProperties: false + description: Information about the policy version. + example: + VersionId: VersionId + CreationDate: 2000-01-23T04:56:07.000+00:00 + DefaultVersion: true + Body: Body + properties: + Body: + description: The policy document as a json string. + type: string + CreationDate: + description: The date and time of creation of the version. + format: date-time + type: string + DefaultVersion: + description: If true, the version is the default one. + type: boolean + VersionId: + description: The ID of the version. type: string type: object PrivateIp: @@ -16367,8 +23464,8 @@ components: description: The description of the quota. type: string MaxValue: - description: The maximum value of the quota for the OUTSCALE user 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. @@ -16380,7 +23477,7 @@ components: description: The description of the quota. type: string UsedValue: - description: The limit value currently used by the OUTSCALE user account. + description: The limit value currently used by the account. type: integer type: object QuotaTypes: @@ -16409,7 +23506,7 @@ components: if it is not. type: string Quotas: - description: One or more quotas associated with the user. + description: One or more quotas associated with the account. items: $ref: '#/components/schemas/Quota' type: array @@ -17028,6 +24125,7 @@ components: additionalProperties: false example: Overall: false + ShowPrice: true DryRun: true FromDate: FromDate ToDate: ToDate @@ -17050,6 +24148,13 @@ components: 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: By default or if false, returns only the consumption of the + specific account that sends this request. If true, returns the unit price + of the consumed resource, and the total price of the consumed resource + during the specified time period in the currency of the catalog of the + Region where the API method was used. + 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 @@ -17066,28 +24171,32 @@ components: ResponseContext: RequestId: RequestId ConsumptionEntries: - - Type: Type - AccountId: AccountId + - AccountId: AccountId Category: Category - Value: 0.8008281904610115 Service: Service Title: Title - FromDate: FromDate - ToDate: ToDate Operation: Operation PayingAccountId: PayingAccountId SubregionName: SubregionName - - Type: Type - AccountId: AccountId + Type: Type + UnitPrice: 6.027456183070403 + Price: 0.8008281904610115 + Value: 1.4658129805029452 + FromDate: FromDate + ToDate: ToDate + - AccountId: AccountId Category: Category - Value: 0.8008281904610115 Service: Service Title: Title - FromDate: FromDate - ToDate: ToDate Operation: Operation PayingAccountId: PayingAccountId SubregionName: SubregionName + Type: Type + UnitPrice: 6.027456183070403 + Price: 0.8008281904610115 + Value: 1.4658129805029452 + FromDate: FromDate + ToDate: ToDate properties: ConsumptionEntries: description: Information about the resources consumed during the specified @@ -17098,6 +24207,68 @@ components: ResponseContext: $ref: '#/components/schemas/ResponseContext' type: object + ReadDedicatedGroupsRequest: + additionalProperties: false + example: + Filters: + Names: + - Names + - Names + CpuGenerations: + - 0 + - 0 + SubregionNames: + - SubregionNames + - SubregionNames + DedicatedGroupIds: + - DedicatedGroupIds + - DedicatedGroupIds + DryRun: true + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + Filters: + $ref: '#/components/schemas/FiltersDedicatedGroup' + type: object + ReadDedicatedGroupsResponse: + additionalProperties: false + example: + DedicatedGroups: + - AccountId: AccountId + CpuGeneration: 0 + NetIds: + - NetIds + - NetIds + DedicatedGroupId: DedicatedGroupId + Name: Name + SubregionName: SubregionName + VmIds: + - VmIds + - VmIds + - AccountId: AccountId + CpuGeneration: 0 + NetIds: + - NetIds + - NetIds + DedicatedGroupId: DedicatedGroupId + Name: Name + SubregionName: SubregionName + VmIds: + - VmIds + - VmIds + ResponseContext: + RequestId: RequestId + properties: + DedicatedGroups: + description: Information about one or more dedicated groups. + items: + $ref: '#/components/schemas/DedicatedGroup' + type: array + ResponseContext: + $ref: '#/components/schemas/ResponseContext' + type: object ReadDhcpOptionsRequest: additionalProperties: false example: @@ -17127,7 +24298,9 @@ components: DhcpOptionsSetIds: - DhcpOptionsSetIds - DhcpOptionsSetIds + NextPageToken: NextPageToken DryRun: true + ResultsPerPage: 0 properties: DryRun: description: If true, checks whether you have the required permissions to @@ -17135,6 +24308,15 @@ components: type: boolean Filters: $ref: '#/components/schemas/FiltersDhcpOptions' + NextPageToken: + 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`. + type: integer type: object ReadDhcpOptionsResponse: additionalProperties: false @@ -17174,6 +24356,7 @@ components: Key: Key - Value: Value Key: Key + NextPageToken: NextPageToken ResponseContext: RequestId: RequestId properties: @@ -17182,6 +24365,11 @@ components: items: $ref: '#/components/schemas/DhcpOptionsSet' type: array + NextPageToken: + 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' type: object @@ -17496,6 +24684,9 @@ components: BlockDeviceMappingVolumeSizes: - 0 - 0 + ProductCodeNames: + - ProductCodeNames + - ProductCodeNames ImageNames: - ImageNames - ImageNames @@ -17523,7 +24714,9 @@ components: Architectures: - Architectures - Architectures + NextPageToken: NextPageToken DryRun: true + ResultsPerPage: 6 properties: DryRun: description: If true, checks whether you have the required permissions to @@ -17531,10 +24724,20 @@ components: type: boolean Filters: $ref: '#/components/schemas/FiltersImage' + NextPageToken: + 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`. + type: integer type: object ReadImagesResponse: additionalProperties: false example: + NextPageToken: NextPageToken Images: - ProductCodes: - ProductCodes @@ -17634,6 +24837,11 @@ components: items: $ref: '#/components/schemas/Image' type: array + NextPageToken: + 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' type: object @@ -17709,6 +24917,9 @@ components: KeypairFingerprints: - KeypairFingerprints - KeypairFingerprints + KeypairTypes: + - KeypairTypes + - KeypairTypes DryRun: true properties: DryRun: @@ -17724,16 +24935,90 @@ components: Keypairs: - KeypairFingerprint: KeypairFingerprint KeypairName: KeypairName + KeypairType: KeypairType - KeypairFingerprint: KeypairFingerprint KeypairName: KeypairName - ResponseContext: - RequestId: RequestId + KeypairType: KeypairType properties: Keypairs: description: Information about one or more keypairs. items: $ref: '#/components/schemas/Keypair' type: array + type: object + ReadLinkedPoliciesFilters: + additionalProperties: false + description: One or more filters. + example: + PathPrefix: PathPrefix + properties: + PathPrefix: + description: The path prefix of the policies, set to a slash (`/`) by default. + type: string + type: object + ReadLinkedPoliciesRequest: + additionalProperties: false + example: + Filters: + PathPrefix: PathPrefix + UserName: UserName + DryRun: true + FirstItem: 0 + ResultsPerPage: 6 + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + Filters: + $ref: '#/components/schemas/ReadLinkedPoliciesFilters' + 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). + type: integer + UserName: + description: The name of the user the policies are linked to. + type: string + type: object + ReadLinkedPoliciesResponse: + additionalProperties: false + example: + MaxResultsLimit: 0 + MaxResultsTruncated: true + Policies: + - CreationDate: 2000-01-23T04:56:07.000+00:00 + PolicyName: PolicyName + LastModificationDate: 2000-01-23T04:56:07.000+00:00 + Orn: Orn + PolicyId: PolicyId + - CreationDate: 2000-01-23T04:56:07.000+00:00 + PolicyName: PolicyName + LastModificationDate: 2000-01-23T04:56:07.000+00:00 + Orn: Orn + PolicyId: PolicyId + ResponseContext: + RequestId: RequestId + HasMoreItems: true + properties: + HasMoreItems: + 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. + type: boolean + Policies: + description: One or more policies linked to the specified user. + items: + $ref: '#/components/schemas/LinkedPolicy' + type: array ResponseContext: $ref: '#/components/schemas/ResponseContext' type: object @@ -18052,7 +25337,9 @@ components: Tags: - Tags - Tags + NextPageToken: NextPageToken DryRun: true + ResultsPerPage: 0 properties: DryRun: description: If true, checks whether you have the required permissions to @@ -18060,10 +25347,20 @@ components: type: boolean Filters: $ref: '#/components/schemas/FiltersNatService' + NextPageToken: + 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`. + type: integer type: object ReadNatServicesResponse: additionalProperties: false example: + NextPageToken: NextPageToken ResponseContext: RequestId: RequestId NatServices: @@ -18101,6 +25398,11 @@ components: items: $ref: '#/components/schemas/NatService' type: array + NextPageToken: + 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' type: object @@ -18173,7 +25475,9 @@ components: Tags: - Tags - Tags + NextPageToken: NextPageToken DryRun: true + ResultsPerPage: 0 properties: DryRun: description: If true, checks whether you have the required permissions to @@ -18181,6 +25485,15 @@ components: type: boolean Filters: $ref: '#/components/schemas/FiltersNetAccessPoint' + NextPageToken: + 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`. + type: integer type: object ReadNetAccessPointsResponse: additionalProperties: false @@ -18210,6 +25523,7 @@ components: Key: Key - Value: Value Key: Key + NextPageToken: NextPageToken ResponseContext: RequestId: RequestId properties: @@ -18218,6 +25532,11 @@ components: items: $ref: '#/components/schemas/NetAccessPoint' type: array + NextPageToken: + 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' type: object @@ -18240,28 +25559,33 @@ components: NetPeeringIds: - NetPeeringIds - NetPeeringIds - AccepterNetAccountIds: - - AccepterNetAccountIds - - AccepterNetAccountIds SourceNetAccountIds: - SourceNetAccountIds - SourceNetAccountIds SourceNetIpRanges: - SourceNetIpRanges - SourceNetIpRanges - StateNames: - - StateNames - - StateNames TagKeys: - TagKeys - TagKeys TagValues: - TagValues - TagValues + ExpirationDates: + - 2000-01-23T04:56:07.000+00:00 + - 2000-01-23T04:56:07.000+00:00 + AccepterNetAccountIds: + - AccepterNetAccountIds + - AccepterNetAccountIds + StateNames: + - StateNames + - StateNames Tags: - Tags - Tags + NextPageToken: NextPageToken DryRun: true + ResultsPerPage: 0 properties: DryRun: description: If true, checks whether you have the required permissions to @@ -18269,14 +25593,25 @@ components: type: boolean Filters: $ref: '#/components/schemas/FiltersNetPeering' + NextPageToken: + 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`. + type: integer type: object ReadNetPeeringsResponse: additionalProperties: false example: + NextPageToken: NextPageToken ResponseContext: RequestId: RequestId NetPeerings: - - SourceNet: + - ExpirationDate: 2000-01-23T04:56:07.000+00:00 + SourceNet: IpRange: IpRange NetId: NetId AccountId: AccountId @@ -18293,7 +25628,8 @@ components: Key: Key - Value: Value Key: Key - - SourceNet: + - ExpirationDate: 2000-01-23T04:56:07.000+00:00 + SourceNet: IpRange: IpRange NetId: NetId AccountId: AccountId @@ -18316,6 +25652,11 @@ components: items: $ref: '#/components/schemas/NetPeering' type: array + NextPageToken: + 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' type: object @@ -18599,6 +25940,222 @@ components: ResponseContext: $ref: '#/components/schemas/ResponseContext' type: object + ReadPoliciesFilters: + additionalProperties: false + description: One or more filters. + example: + Scope: LOCAL + OnlyLinked: true + PathPrefix: PathPrefix + properties: + OnlyLinked: + 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, set to a + slash (`/`) by default. + type: string + Scope: + description: The scope to filter policies (`ALL` \| `OWS` \| `local`). + enum: + - LOCAL + - OWS + type: string + type: object + ReadPoliciesRequest: + additionalProperties: false + example: + Filters: + Scope: LOCAL + OnlyLinked: true + PathPrefix: PathPrefix + DryRun: true + FirstItem: 0 + ResultsPerPage: 6 + properties: + DryRun: + description: If true, checks whether you have the required permissions to + perform the action. + type: boolean + Filters: + $ref: '#/components/schemas/ReadPoliciesFilters' + 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). + type: integer + type: object + ReadPoliciesResponse: + additionalProperties: false + example: + MaxResultsLimit: 0 + MaxResultsTruncated: true + Policies: + - Path: Path + PolicyDefaultVersionId: PolicyDefaultVersionId + CreationDate: 2000-01-23T04:56:07.000+00:00 + ResourcesCount: 0 + Description: Description + IsLinkable: true + PolicyName: PolicyName + LastModificationDate: 2000-01-23T04:56:07.000+00:00 + Orn: Orn + PolicyId: PolicyId + - Path: Path + PolicyDefaultVersionId: PolicyDefaultVersionId + CreationDate: 2000-01-23T04:56:07.000+00:00 + ResourcesCount: 0 + Description: Description + IsLinkable: true + PolicyName: PolicyName + LastModificationDate: 2000-01-23T04:56:07.000+00:00 + Orn: Orn + PolicyId: PolicyId + ResponseContext: + RequestId: RequestId + HasMoreItems: true + properties: + HasMoreItems: + 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. + type: boolean + Policies: + description: Information about one or more policies. + items: + $ref: '#/components/schemas/Policy' + type: array + ResponseContext: + $ref: '#/components/schemas/ResponseContext' + type: object + ReadPolicyRequest: + additionalProperties: false + example: + PolicyOrn: PolicyOrn + 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). + type: string + required: + - PolicyOrn + type: object + ReadPolicyResponse: + additionalProperties: false + example: + Policy: + Path: Path + PolicyDefaultVersionId: PolicyDefaultVersionId + CreationDate: 2000-01-23T04:56:07.000+00:00 + ResourcesCount: 0 + Description: Description + IsLinkable: true + PolicyName: PolicyName + LastModificationDate: 2000-01-23T04:56:07.000+00:00 + Orn: Orn + PolicyId: PolicyId + ResponseContext: + RequestId: RequestId + properties: + Policy: + $ref: '#/components/schemas/Policy' + ResponseContext: + $ref: '#/components/schemas/ResponseContext' + type: object + ReadPolicyVersionRequest: + additionalProperties: false + example: + VersionId: VersionId + PolicyOrn: PolicyOrn + 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). + type: string + VersionId: + description: The ID of the policy version. + type: string + required: + - PolicyOrn + - VersionId + type: object + ReadPolicyVersionResponse: + additionalProperties: false + example: + PolicyVersion: + VersionId: VersionId + CreationDate: 2000-01-23T04:56:07.000+00:00 + DefaultVersion: true + Body: Body + ResponseContext: + RequestId: RequestId + properties: + PolicyVersion: + $ref: '#/components/schemas/PolicyVersion' + ResponseContext: + $ref: '#/components/schemas/ResponseContext' + type: object + ReadPolicyVersionsRequest: + additionalProperties: false + example: + PolicyOrn: PolicyOrn + FirstItem: 0 + ResultsPerPage: 6 + properties: + FirstItem: + 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). + type: string + ResultsPerPage: + description: The maximum number of items that can be returned in a single + response (by default, 100). + type: integer + required: + - PolicyOrn + type: object + ReadPolicyVersionsResponse: + additionalProperties: false + example: + MaxResultsLimit: 0 + ResponseContext: + RequestId: RequestId + PolicyVersions: + - VersionId: VersionId + CreationDate: 2000-01-23T04:56:07.000+00:00 + DefaultVersion: true + Body: Body + - VersionId: VersionId + CreationDate: 2000-01-23T04:56:07.000+00:00 + DefaultVersion: true + Body: Body + HasMoreItems: true + properties: + HasMoreItems: + 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 + PolicyVersions: + description: A list of all the versions of the policy. + items: + $ref: '#/components/schemas/PolicyVersion' + type: array + ResponseContext: + $ref: '#/components/schemas/ResponseContext' + type: object ReadProductTypesRequest: additionalProperties: false example: @@ -18740,7 +26297,9 @@ components: VmIds: - VmIds - VmIds + NextPageToken: NextPageToken DryRun: true + ResultsPerPage: 0 properties: DryRun: description: If true, checks whether you have the required permissions to @@ -18748,6 +26307,15 @@ components: type: boolean Filters: $ref: '#/components/schemas/FiltersPublicIp' + NextPageToken: + 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`. + type: integer type: object ReadPublicIpsResponse: additionalProperties: false @@ -18777,9 +26345,15 @@ components: - Value: Value Key: Key NicId: NicId + NextPageToken: NextPageToken ResponseContext: RequestId: RequestId properties: + NextPageToken: + 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: @@ -18942,7 +26516,9 @@ components: RouteCreationMethods: - RouteCreationMethods - RouteCreationMethods + NextPageToken: NextPageToken DryRun: true + ResultsPerPage: 0 properties: DryRun: description: If true, checks whether you have the required permissions to @@ -18950,10 +26526,20 @@ components: type: boolean Filters: $ref: '#/components/schemas/FiltersRouteTable' + NextPageToken: + 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`. + type: integer type: object ReadRouteTablesResponse: additionalProperties: false example: + NextPageToken: NextPageToken ResponseContext: RequestId: RequestId RouteTables: @@ -18963,11 +26549,13 @@ components: - VirtualGatewayId: VirtualGatewayId - VirtualGatewayId: VirtualGatewayId LinkRouteTables: - - RouteTableId: RouteTableId + - NetId: NetId + RouteTableId: RouteTableId LinkRouteTableId: LinkRouteTableId SubnetId: SubnetId Main: true - - RouteTableId: RouteTableId + - NetId: NetId + RouteTableId: RouteTableId LinkRouteTableId: LinkRouteTableId SubnetId: SubnetId Main: true @@ -19005,11 +26593,13 @@ components: - VirtualGatewayId: VirtualGatewayId - VirtualGatewayId: VirtualGatewayId LinkRouteTables: - - RouteTableId: RouteTableId + - NetId: NetId + RouteTableId: RouteTableId LinkRouteTableId: LinkRouteTableId SubnetId: SubnetId Main: true - - RouteTableId: RouteTableId + - NetId: NetId + RouteTableId: RouteTableId LinkRouteTableId: LinkRouteTableId SubnetId: SubnetId Main: true @@ -19042,6 +26632,11 @@ components: - Value: Value Key: Key properties: + NextPageToken: + 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' RouteTables: @@ -19100,9 +26695,6 @@ components: InboundRuleToPortRanges: - 6 - 6 - AccountIds: - - AccountIds - - AccountIds NetIds: - NetIds - NetIds @@ -19620,6 +27212,12 @@ components: additionalProperties: false example: Filters: + States: + - States + - States + RegionNames: + - RegionNames + - RegionNames SubregionNames: - SubregionNames - SubregionNames @@ -19762,7 +27360,9 @@ components: VirtualGatewayIds: - VirtualGatewayIds - VirtualGatewayIds + NextPageToken: NextPageToken DryRun: true + ResultsPerPage: 0 properties: DryRun: description: If true, checks whether you have the required permissions to @@ -19770,10 +27370,20 @@ components: type: boolean Filters: $ref: '#/components/schemas/FiltersVirtualGateway' + NextPageToken: + 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`. + type: integer type: object ReadVirtualGatewaysResponse: additionalProperties: false example: + NextPageToken: NextPageToken ResponseContext: RequestId: RequestId VirtualGateways: @@ -19804,6 +27414,11 @@ components: - Value: Value Key: Key properties: + NextPageToken: + 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' VirtualGateways: @@ -20009,17 +27624,26 @@ components: example: Filters: VolumeSizes: + - 2 + - 2 + VcoreCounts: - 5 - 5 - VcoreCounts: + Gpus: - 6 - 6 VolumeCounts: - - 1 - - 1 + - 5 + - 5 + EphemeralsTypes: + - EphemeralsTypes + - EphemeralsTypes + Eths: + - 0 + - 0 MemorySizes: - - 0.8008282 - - 0.8008282 + - 1.4658129 + - 1.4658129 BsuOptimized: true VmTypeNames: - VmTypeNames @@ -20037,20 +27661,26 @@ components: additionalProperties: false example: VmTypes: - - MemorySize: 6.0274563 - VcoreCount: 1 - MaxPrivateIps: 0 + - MemorySize: 5.962134 + VcoreCount: 5 + MaxPrivateIps: 1 + Eth: 0 VmTypeName: VmTypeName - VolumeCount: 5 - VolumeSize: 5 + VolumeCount: 2 + Gpu: 6 + VolumeSize: 7 BsuOptimized: true - - MemorySize: 6.0274563 - VcoreCount: 1 - MaxPrivateIps: 0 + EphemeralsType: EphemeralsType + - MemorySize: 5.962134 + VcoreCount: 5 + MaxPrivateIps: 1 + Eth: 0 VmTypeName: VmTypeName - VolumeCount: 5 - VolumeSize: 5 + VolumeCount: 2 + Gpu: 6 + VolumeSize: 7 BsuOptimized: true + EphemeralsType: EphemeralsType ResponseContext: RequestId: RequestId properties: @@ -20113,19 +27743,191 @@ components: additionalProperties: false example: Filters: - TagKeys: - - TagKeys - - TagKeys + CreationDates: + - 2000-01-23 + - 2000-01-23 + KeypairNames: + - KeypairNames + - KeypairNames + NicLinkPublicIpPublicIpIds: + - NicLinkPublicIpPublicIpIds + - NicLinkPublicIpPublicIpIds + Tenancies: + - Tenancies + - Tenancies + RootDeviceNames: + - RootDeviceNames + - RootDeviceNames + BlockDeviceMappingLinkDates: + - 2000-01-23 + - 2000-01-23 + NicLinkNicLinkNicIds: + - NicLinkNicLinkNicIds + - NicLinkNicLinkNicIds + NicPrivateIpsPrivateIps: + - NicPrivateIpsPrivateIps + - NicPrivateIpsPrivateIps + NicSubregionNames: + - NicSubregionNames + - NicSubregionNames TagValues: - TagValues - TagValues - Tags: - - Tags - - Tags + VmStateCodes: + - 5 + - 5 VmIds: - VmIds - VmIds + NicLinkPublicIpLinkPublicIpIds: + - NicLinkPublicIpLinkPublicIpIds + - NicLinkPublicIpLinkPublicIpIds + BlockDeviceMappingVolumeIds: + - BlockDeviceMappingVolumeIds + - BlockDeviceMappingVolumeIds + NicMacAddresses: + - NicMacAddresses + - NicMacAddresses + SubregionNames: + - SubregionNames + - SubregionNames + NicLinkNicStates: + - NicLinkNicStates + - NicLinkNicStates + NicSubnetIds: + - NicSubnetIds + - NicSubnetIds + Tags: + - Tags + - Tags + ProductCodes: + - ProductCodes + - ProductCodes + Platforms: + - Platforms + - Platforms + NetIds: + - NetIds + - NetIds + NicSecurityGroupIds: + - NicSecurityGroupIds + - NicSecurityGroupIds + NicLinkNicDeviceNumbers: + - 6 + - 6 + SecurityGroupIds: + - SecurityGroupIds + - SecurityGroupIds + BlockDeviceMappingDeleteOnVmDeletion: true + StateReasonMessages: + - StateReasonMessages + - StateReasonMessages + NicLinkNicLinkNicDates: + - 2000-01-23 + - 2000-01-23 + NicSecurityGroupNames: + - NicSecurityGroupNames + - NicSecurityGroupNames + PrivateIps: + - PrivateIps + - PrivateIps + ClientTokens: + - ClientTokens + - ClientTokens + VmStateNames: + - VmStateNames + - VmStateNames + NicDescriptions: + - NicDescriptions + - NicDescriptions + NicIsSourceDestChecked: true + LaunchNumbers: + - 0 + - 0 + NicLinkNicDeleteOnVmDeletion: true + NicPrivateIpsPrimaryIp: true + NicLinkNicVmAccountIds: + - NicLinkNicVmAccountIds + - NicLinkNicVmAccountIds + ReservationIds: + - ReservationIds + - ReservationIds + SubnetIds: + - SubnetIds + - SubnetIds + VmTypes: + - VmTypes + - VmTypes + PublicIps: + - PublicIps + - PublicIps + IsSourceDestChecked: true + NicNicIds: + - NicNicIds + - NicNicIds + NicLinkPublicIpAccountIds: + - NicLinkPublicIpAccountIds + - NicLinkPublicIpAccountIds + Lifecycles: + - Lifecycles + - Lifecycles + NicLinkPublicIpPublicIps: + - NicLinkPublicIpPublicIps + - NicLinkPublicIpPublicIps + ImageIds: + - ImageIds + - ImageIds + NicPrivateIpsLinkPublicIpAccountIds: + - NicPrivateIpsLinkPublicIpAccountIds + - NicPrivateIpsLinkPublicIpAccountIds + NicLinkNicVmIds: + - NicLinkNicVmIds + - NicLinkNicVmIds + StateReasonCodes: + - 1 + - 1 + SecurityGroupNames: + - SecurityGroupNames + - SecurityGroupNames + TagKeys: + - TagKeys + - TagKeys + VmSecurityGroupNames: + - VmSecurityGroupNames + - VmSecurityGroupNames + NicPrivateIpsLinkPublicIpIds: + - NicPrivateIpsLinkPublicIpIds + - NicPrivateIpsLinkPublicIpIds + StateReasons: + - StateReasons + - StateReasons + BlockDeviceMappingStates: + - BlockDeviceMappingStates + - BlockDeviceMappingStates + VmSecurityGroupIds: + - VmSecurityGroupIds + - VmSecurityGroupIds + NicAccountIds: + - NicAccountIds + - NicAccountIds + NicStates: + - NicStates + - NicStates + RootDeviceTypes: + - RootDeviceTypes + - RootDeviceTypes + BlockDeviceMappingDeviceNames: + - BlockDeviceMappingDeviceNames + - BlockDeviceMappingDeviceNames + NicNetIds: + - NicNetIds + - NicNetIds + Architectures: + - Architectures + - Architectures + NextPageToken: NextPageToken DryRun: true + ResultsPerPage: 5 properties: DryRun: description: If true, checks whether you have the required permissions to @@ -20133,10 +27935,20 @@ components: type: boolean Filters: $ref: '#/components/schemas/FiltersVm' + NextPageToken: + 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`. + type: integer type: object ReadVmsResponse: additionalProperties: false example: + NextPageToken: NextPageToken ResponseContext: RequestId: RequestId Vms: @@ -20409,6 +28221,11 @@ components: ClientToken: ClientToken Performance: Performance properties: + NextPageToken: + 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' Vms: @@ -20543,7 +28360,9 @@ components: Tags: - Tags - Tags + NextPageToken: NextPageToken DryRun: true + ResultsPerPage: 6 properties: DryRun: description: If true, checks whether you have the required permissions to @@ -20551,6 +28370,15 @@ components: type: boolean Filters: $ref: '#/components/schemas/FiltersVolume' + NextPageToken: + 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`. + type: integer type: object ReadVolumesResponse: additionalProperties: false @@ -20604,9 +28432,15 @@ components: - Value: Value Key: Key SubregionName: SubregionName + NextPageToken: NextPageToken ResponseContext: RequestId: RequestId properties: + NextPageToken: + 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' Volumes: @@ -20650,7 +28484,9 @@ components: VirtualGatewayIds: - VirtualGatewayIds - VirtualGatewayIds + NextPageToken: NextPageToken DryRun: true + ResultsPerPage: 6 properties: DryRun: description: If true, checks whether you have the required permissions to @@ -20658,10 +28494,20 @@ components: type: boolean Filters: $ref: '#/components/schemas/FiltersVpnConnection' + NextPageToken: + 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`. + type: integer type: object ReadVpnConnectionsResponse: additionalProperties: false example: + NextPageToken: NextPageToken ResponseContext: RequestId: RequestId VpnConnections: @@ -20790,6 +28636,11 @@ components: AcceptedRouteCount: 0 StateDescription: StateDescription properties: + NextPageToken: + 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' VpnConnections: @@ -20902,37 +28753,6 @@ components: ResponseContext: $ref: '#/components/schemas/ResponseContext' type: object - ResetAccountPasswordRequest: - additionalProperties: false - example: - DryRun: true - Token: Token - Password: Password - properties: - DryRun: - description: If true, checks whether you have the required permissions to - perform the action. - type: boolean - Password: - description: The new password for the account. - type: string - Token: - description: The token you received at the email address provided for the - account. - type: string - required: - - Password - - Token - type: object - ResetAccountPasswordResponse: - additionalProperties: false - example: - ResponseContext: - RequestId: RequestId - properties: - ResponseContext: - $ref: '#/components/schemas/ResponseContext' - type: object ResourceLoadBalancerTag: additionalProperties: false description: Information about the tag. @@ -21062,11 +28882,13 @@ components: - VirtualGatewayId: VirtualGatewayId - VirtualGatewayId: VirtualGatewayId LinkRouteTables: - - RouteTableId: RouteTableId + - NetId: NetId + RouteTableId: RouteTableId LinkRouteTableId: LinkRouteTableId SubnetId: SubnetId Main: true - - RouteTableId: RouteTableId + - NetId: NetId + RouteTableId: RouteTableId LinkRouteTableId: LinkRouteTableId SubnetId: SubnetId Main: true @@ -21268,7 +29090,7 @@ components: Key: Key properties: AccountId: - description: The account ID of a user that has been granted permission. + description: The account ID that has been granted permission. type: string Description: description: The description of the security group. @@ -21386,31 +29208,6 @@ components: group that you want to link to the security group of the rule. type: string type: object - SendResetPasswordEmailRequest: - additionalProperties: false - example: - Email: Email - DryRun: true - properties: - DryRun: - description: If true, checks whether you have the required permissions to - perform the action. - type: boolean - Email: - description: The email address provided for the account. - type: string - required: - - Email - type: object - SendResetPasswordEmailResponse: - additionalProperties: false - example: - ResponseContext: - RequestId: RequestId - properties: - ResponseContext: - $ref: '#/components/schemas/ResponseContext' - type: object ServerCertificate: additionalProperties: false description: Information about the server certificate. @@ -21467,6 +29264,32 @@ components: description: The name of the service. type: string type: object + SetDefaultPolicyVersionRequest: + additionalProperties: false + example: + VersionId: VersionId + PolicyOrn: PolicyOrn + 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). + type: string + VersionId: + description: The ID of the version. + type: string + required: + - PolicyOrn + - VersionId + type: object + SetDefaultPolicyVersionResponse: + additionalProperties: false + example: + ResponseContext: + RequestId: RequestId + properties: + ResponseContext: + $ref: '#/components/schemas/ResponseContext' + type: object Snapshot: additionalProperties: false description: Information about the snapshot. @@ -21768,8 +29591,7 @@ components: description: The name of the Region containing the Subregion. type: string State: - description: The state of the Subregion (`available` \| `information` \| - `impaired` \| `unavailable`). + description: The state of the Subregion. type: string SubregionName: description: The name of the Subregion. @@ -21919,6 +29741,37 @@ components: ResponseContext: $ref: '#/components/schemas/ResponseContext' type: object + UnlinkPolicyRequest: + additionalProperties: false + example: + UserName: UserName + PolicyOrn: PolicyOrn + DryRun: true + properties: + DryRun: + 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). + type: string + UserName: + description: The name of the user you want to detach the policy from. + type: string + required: + - PolicyOrn + - UserName + type: object + UnlinkPolicyResponse: + additionalProperties: false + example: + ResponseContext: + RequestId: RequestId + properties: + ResponseContext: + $ref: '#/components/schemas/ResponseContext' + type: object UnlinkPrivateIpsRequest: additionalProperties: false example: @@ -22098,9 +29951,10 @@ components: requests. When set to `INACTIVE`, the access key is disabled. type: string UserName: - description: The name of the EIM 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 @@ -22244,9 +30098,9 @@ components: format: int64 type: integer RequireTrustedEnv: - description: If true, a trusted session is activated, provided that you - specify the `MaxAccessKeyExpirationSeconds` parameter with a value greater - than `0`. + description: |- + If true, a trusted session is activated, provided that you specify the `MaxAccessKeyExpirationSeconds` parameter with a value greater than `0`.
+ Enabling this will require you and all your users to log in to Cockpit v2 using the WebAuthn method for multi-factor authentication. For more information, see [About Authentication > Multi-Factor Authentication](https://docs.outscale.com/en/userguide/About-Authentication.html#_multi_factor_authentication). type: boolean required: - MaxAccessKeyExpirationSeconds @@ -22368,6 +30222,50 @@ components: ResponseContext: $ref: '#/components/schemas/ResponseContext' type: object + UpdateDedicatedGroupRequest: + additionalProperties: false + example: + DedicatedGroupId: DedicatedGroupId + DryRun: true + Name: Name + properties: + DedicatedGroupId: + 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. + type: boolean + Name: + description: The new name of the dedicated group. + type: string + required: + - DedicatedGroupId + - Name + type: object + UpdateDedicatedGroupResponse: + additionalProperties: false + example: + DedicatedGroup: + AccountId: AccountId + CpuGeneration: 0 + NetIds: + - NetIds + - NetIds + DedicatedGroupId: DedicatedGroupId + Name: Name + SubregionName: SubregionName + VmIds: + - VmIds + - VmIds + ResponseContext: + RequestId: RequestId + properties: + DedicatedGroup: + $ref: '#/components/schemas/DedicatedGroup' + ResponseContext: + $ref: '#/components/schemas/ResponseContext' + type: object UpdateDirectLinkInterfaceRequest: additionalProperties: false example: @@ -22994,11 +30892,13 @@ components: - VirtualGatewayId: VirtualGatewayId - VirtualGatewayId: VirtualGatewayId LinkRouteTables: - - RouteTableId: RouteTableId + - NetId: NetId + RouteTableId: RouteTableId LinkRouteTableId: LinkRouteTableId SubnetId: SubnetId Main: true - - RouteTableId: RouteTableId + - NetId: NetId + RouteTableId: RouteTableId LinkRouteTableId: LinkRouteTableId SubnetId: SubnetId Main: true @@ -23091,11 +30991,13 @@ components: - VirtualGatewayId: VirtualGatewayId - VirtualGatewayId: VirtualGatewayId LinkRouteTables: - - RouteTableId: RouteTableId + - NetId: NetId + RouteTableId: RouteTableId LinkRouteTableId: LinkRouteTableId SubnetId: SubnetId Main: true - - RouteTableId: RouteTableId + - NetId: NetId + RouteTableId: RouteTableId LinkRouteTableId: LinkRouteTableId SubnetId: SubnetId Main: true @@ -23135,6 +31037,40 @@ components: RouteTable: $ref: '#/components/schemas/RouteTable' type: object + UpdateRouteTableLinkRequest: + additionalProperties: false + example: + RouteTableId: RouteTableId + DryRun: true + LinkRouteTableId: LinkRouteTableId + properties: + DryRun: + 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. + type: string + RouteTableId: + description: The ID of the new route table to associate with the Subnet. + type: string + required: + - LinkRouteTableId + - RouteTableId + type: object + UpdateRouteTableLinkResponse: + additionalProperties: false + example: + ResponseContext: + RequestId: RequestId + LinkRouteTableId: LinkRouteTableId + properties: + LinkRouteTableId: + description: The ID of the association between the route table and the Subnet. + type: string + ResponseContext: + $ref: '#/components/schemas/ResponseContext' + type: object UpdateServerCertificateRequest: additionalProperties: false example: @@ -23449,7 +31385,7 @@ components: KeypairName: description: |- The name of a keypair you want to associate with the VM.
- 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 an Instance](https://docs.outscale.com/en/userguide/Modifying-the-Keypair-of-an-Instance.html). + 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 @@ -23480,7 +31416,7 @@ components: If set to `terminate`, the VM stops and is terminated. type: string VmType: - description: The type of VM. For more information, see [Instance Types](https://docs.outscale.com/en/userguide/Instance-Types.html). + description: The type of VM. For more information, see [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html). type: string required: - VmId @@ -23706,24 +31642,23 @@ components: 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. The maximum number - of IOPS allowed for `io1` volumes is `13000` with a maximum performance - ratio of 300 IOPS per gibibyte. This modification is instantaneous on - a cold volume, not on a hot one. + description: |- + **Cold volume**: 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`. This modification is instantaneous.
+ **Hot volume**: the new number of I/O operations per second (IOPS). This parameter can be specified only if you update an `io1` volume. This modification is not instantaneous.

+ 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: (cold volume only) 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: |- + **Cold volume**: 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.
+ **Hot volume**: you cannot change the size of a hot volume. type: integer VolumeId: description: The ID of the volume you want to update. type: string VolumeType: - description: (cold volume only) The new type of the volume (`standard` \| - `io1` \| `gp2`). This modification is instantaneous. If you update to - an `io1` volume, you must also specify the `Iops` parameter. + description: |- + **Cold volume**: the new type of the volume (`standard` \| `io1` \| `gp2`). This modification is instantaneous. If you update to an `io1` volume, you must also specify the `Iops` parameter.
+ **Hot volume**: you cannot change the type of a hot volume. type: string required: - VolumeId @@ -23769,36 +31704,8 @@ components: example: ClientGatewayId: ClientGatewayId VpnOptions: - Phase1Options: - DpdTimeoutSeconds: 6 - StartupAction: StartupAction - Phase1IntegrityAlgorithms: - - Phase1IntegrityAlgorithms - - Phase1IntegrityAlgorithms - Phase1LifetimeSeconds: 5 - Phase1EncryptionAlgorithms: - - Phase1EncryptionAlgorithms - - Phase1EncryptionAlgorithms - DpdTimeoutAction: DpdTimeoutAction - ReplayWindowSize: 5 - IkeVersions: - - IkeVersions - - IkeVersions - Phase1DhGroupNumbers: - - 1 - - 1 TunnelInsideIpRange: TunnelInsideIpRange Phase2Options: - Phase2EncryptionAlgorithms: - - Phase2EncryptionAlgorithms - - Phase2EncryptionAlgorithms - Phase2DhGroupNumbers: - - 2 - - 2 - Phase2LifetimeSeconds: 7 - Phase2IntegrityAlgorithms: - - Phase2IntegrityAlgorithms - - Phase2IntegrityAlgorithms PreSharedKey: PreSharedKey DryRun: true VpnConnectionId: VpnConnectionId @@ -23818,7 +31725,7 @@ components: description: The ID of the VPN connection you want to modify. type: string VpnOptions: - $ref: '#/components/schemas/VpnOptions' + $ref: '#/components/schemas/VpnOptionsToUpdate' required: - VpnConnectionId type: object @@ -24205,7 +32112,7 @@ components: description: The reservation ID of the VM. type: string RootDeviceName: - description: The name of the root device for the VM (for example, `/dev/vda1`). + description: The name of the root device for the VM (for example, `/dev/sda1`). type: string RootDeviceType: description: The type of root device used by the VM (always `bsu`). @@ -24242,7 +32149,7 @@ components: If set to `terminate`, the VM stops and is deleted. type: string VmType: - description: The type of VM. For more information, see [Instance Types](https://docs.outscale.com/en/userguide/Instance-Types.html). + description: The type of VM. For more information, see [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html). type: string type: object VmGroup: @@ -24455,18 +32362,30 @@ components: additionalProperties: false description: Information about the VM type. example: - MemorySize: 6.0274563 - VcoreCount: 1 - MaxPrivateIps: 0 + MemorySize: 5.962134 + VcoreCount: 5 + MaxPrivateIps: 1 + Eth: 0 VmTypeName: VmTypeName - VolumeCount: 5 - VolumeSize: 5 + VolumeCount: 2 + Gpu: 6 + VolumeSize: 7 BsuOptimized: true + EphemeralsType: EphemeralsType properties: BsuOptimized: 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. + type: string + Eth: + description: The number of Ethernet interface available. + type: integer + Gpu: + description: The number of GPU available. + type: integer MaxPrivateIps: description: The maximum number of private IPs per network interface card (NIC). @@ -24716,6 +32635,21 @@ components: CIDR block from the 169.254.254.0/24 range. type: string type: object + VpnOptionsToUpdate: + additionalProperties: false + description: Information about the VPN options. + example: + TunnelInsideIpRange: TunnelInsideIpRange + Phase2Options: + PreSharedKey: PreSharedKey + properties: + Phase2Options: + $ref: '#/components/schemas/Phase2OptionsToUpdate' + 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. + type: string + type: object With: additionalProperties: false description: The information to display in each returned log. diff --git a/v2/api_access_key.go b/v2/api_access_key.go index 9b735fec8..82f18f746 100644 --- a/v2/api_access_key.go +++ b/v2/api_access_key.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_account.go b/v2/api_account.go index 335ffe088..29626397d 100644 --- a/v2/api_account.go +++ b/v2/api_account.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -515,222 +515,6 @@ func (a *AccountApiService) ReadConsumptionAccountExecute(r ApiReadConsumptionAc return localVarReturnValue, localVarHTTPResponse, nil } -type ApiResetAccountPasswordRequest struct { - ctx _context.Context - ApiService *AccountApiService - resetAccountPasswordRequest *ResetAccountPasswordRequest -} - -func (r ApiResetAccountPasswordRequest) ResetAccountPasswordRequest(resetAccountPasswordRequest ResetAccountPasswordRequest) ApiResetAccountPasswordRequest { - r.resetAccountPasswordRequest = &resetAccountPasswordRequest - return r -} - -func (r ApiResetAccountPasswordRequest) Execute() (ResetAccountPasswordResponse, *_nethttp.Response, error) { - return r.ApiService.ResetAccountPasswordExecute(r) -} - -/* - * ResetAccountPassword Method for ResetAccountPassword - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @return ApiResetAccountPasswordRequest - */ -func (a *AccountApiService) ResetAccountPassword(ctx _context.Context) ApiResetAccountPasswordRequest { - return ApiResetAccountPasswordRequest{ - ApiService: a, - ctx: ctx, - } -} - -/* - * Execute executes the request - * @return ResetAccountPasswordResponse - */ -func (a *AccountApiService) ResetAccountPasswordExecute(r ApiResetAccountPasswordRequest) (ResetAccountPasswordResponse, *_nethttp.Response, error) { - var ( - localVarHTTPMethod = _nethttp.MethodPost - localVarPostBody interface{} - localVarFormFileName string - localVarFileName string - localVarFileBytes []byte - localVarReturnValue ResetAccountPasswordResponse - ) - - localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "AccountApiService.ResetAccountPassword") - if err != nil { - return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} - } - - localVarPath := localBasePath + "/ResetAccountPassword" - - localVarHeaderParams := make(map[string]string) - localVarQueryParams := _neturl.Values{} - localVarFormParams := _neturl.Values{} - - // to determine the Content-Type header - localVarHTTPContentTypes := []string{"application/json"} - - // set Content-Type header - localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) - if localVarHTTPContentType != "" { - localVarHeaderParams["Content-Type"] = localVarHTTPContentType - } - - // to determine the Accept header - localVarHTTPHeaderAccepts := []string{"application/json"} - - // set Accept header - localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) - if localVarHTTPHeaderAccept != "" { - localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept - } - // body params - localVarPostBody = r.resetAccountPasswordRequest - req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) - if err != nil { - return localVarReturnValue, nil, err - } - - localVarHTTPResponse, err := a.client.callAPI(req) - if err != nil || localVarHTTPResponse == nil { - return localVarReturnValue, localVarHTTPResponse, err - } - - localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) - localVarHTTPResponse.Body.Close() - localVarHTTPResponse.Body = _ioutil.NopCloser(bytes.NewBuffer(localVarBody)) - if err != nil { - return localVarReturnValue, localVarHTTPResponse, err - } - - if localVarHTTPResponse.StatusCode >= 300 { - newErr := GenericOpenAPIError{ - body: localVarBody, - error: localVarHTTPResponse.Status, - } - return localVarReturnValue, localVarHTTPResponse, newErr - } - - err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr := GenericOpenAPIError{ - body: localVarBody, - error: err.Error(), - } - return localVarReturnValue, localVarHTTPResponse, newErr - } - - return localVarReturnValue, localVarHTTPResponse, nil -} - -type ApiSendResetPasswordEmailRequest struct { - ctx _context.Context - ApiService *AccountApiService - sendResetPasswordEmailRequest *SendResetPasswordEmailRequest -} - -func (r ApiSendResetPasswordEmailRequest) SendResetPasswordEmailRequest(sendResetPasswordEmailRequest SendResetPasswordEmailRequest) ApiSendResetPasswordEmailRequest { - r.sendResetPasswordEmailRequest = &sendResetPasswordEmailRequest - return r -} - -func (r ApiSendResetPasswordEmailRequest) Execute() (SendResetPasswordEmailResponse, *_nethttp.Response, error) { - return r.ApiService.SendResetPasswordEmailExecute(r) -} - -/* - * SendResetPasswordEmail Method for SendResetPasswordEmail - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @return ApiSendResetPasswordEmailRequest - */ -func (a *AccountApiService) SendResetPasswordEmail(ctx _context.Context) ApiSendResetPasswordEmailRequest { - return ApiSendResetPasswordEmailRequest{ - ApiService: a, - ctx: ctx, - } -} - -/* - * Execute executes the request - * @return SendResetPasswordEmailResponse - */ -func (a *AccountApiService) SendResetPasswordEmailExecute(r ApiSendResetPasswordEmailRequest) (SendResetPasswordEmailResponse, *_nethttp.Response, error) { - var ( - localVarHTTPMethod = _nethttp.MethodPost - localVarPostBody interface{} - localVarFormFileName string - localVarFileName string - localVarFileBytes []byte - localVarReturnValue SendResetPasswordEmailResponse - ) - - localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "AccountApiService.SendResetPasswordEmail") - if err != nil { - return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} - } - - localVarPath := localBasePath + "/SendResetPasswordEmail" - - localVarHeaderParams := make(map[string]string) - localVarQueryParams := _neturl.Values{} - localVarFormParams := _neturl.Values{} - - // to determine the Content-Type header - localVarHTTPContentTypes := []string{"application/json"} - - // set Content-Type header - localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) - if localVarHTTPContentType != "" { - localVarHeaderParams["Content-Type"] = localVarHTTPContentType - } - - // to determine the Accept header - localVarHTTPHeaderAccepts := []string{"application/json"} - - // set Accept header - localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) - if localVarHTTPHeaderAccept != "" { - localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept - } - // body params - localVarPostBody = r.sendResetPasswordEmailRequest - req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) - if err != nil { - return localVarReturnValue, nil, err - } - - localVarHTTPResponse, err := a.client.callAPI(req) - if err != nil || localVarHTTPResponse == nil { - return localVarReturnValue, localVarHTTPResponse, err - } - - localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) - localVarHTTPResponse.Body.Close() - localVarHTTPResponse.Body = _ioutil.NopCloser(bytes.NewBuffer(localVarBody)) - if err != nil { - return localVarReturnValue, localVarHTTPResponse, err - } - - if localVarHTTPResponse.StatusCode >= 300 { - newErr := GenericOpenAPIError{ - body: localVarBody, - error: localVarHTTPResponse.Status, - } - return localVarReturnValue, localVarHTTPResponse, newErr - } - - err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr := GenericOpenAPIError{ - body: localVarBody, - error: err.Error(), - } - return localVarReturnValue, localVarHTTPResponse, newErr - } - - return localVarReturnValue, localVarHTTPResponse, nil -} - type ApiUpdateAccountRequest struct { ctx _context.Context ApiService *AccountApiService diff --git a/v2/api_api_access_policy.go b/v2/api_api_access_policy.go index d9e5b8840..a4633784a 100644 --- a/v2/api_api_access_policy.go +++ b/v2/api_api_access_policy.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_api_access_rule.go b/v2/api_api_access_rule.go index 170d4f406..95ff75995 100644 --- a/v2/api_api_access_rule.go +++ b/v2/api_api_access_rule.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_api_log.go b/v2/api_api_log.go index 03d7e39d0..f0790ba02 100644 --- a/v2/api_api_log.go +++ b/v2/api_api_log.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_ca.go b/v2/api_ca.go index 7db7830b9..d6f55f841 100644 --- a/v2/api_ca.go +++ b/v2/api_ca.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_catalog.go b/v2/api_catalog.go index b1896594c..8218d7337 100644 --- a/v2/api_catalog.go +++ b/v2/api_catalog.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_client_gateway.go b/v2/api_client_gateway.go index 7744558ab..ea66e6042 100644 --- a/v2/api_client_gateway.go +++ b/v2/api_client_gateway.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_dedicated_group.go b/v2/api_dedicated_group.go new file mode 100644 index 000000000..2738f7c5e --- /dev/null +++ b/v2/api_dedicated_group.go @@ -0,0 +1,632 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "bytes" + _context "context" + _ioutil "io/ioutil" + _nethttp "net/http" + _neturl "net/url" +) + +// Linger please +var ( + _ _context.Context +) + +// DedicatedGroupApiService DedicatedGroupApi service +type DedicatedGroupApiService service + +type ApiCreateDedicatedGroupRequest struct { + ctx _context.Context + ApiService *DedicatedGroupApiService + createDedicatedGroupRequest *CreateDedicatedGroupRequest +} + +func (r ApiCreateDedicatedGroupRequest) CreateDedicatedGroupRequest(createDedicatedGroupRequest CreateDedicatedGroupRequest) ApiCreateDedicatedGroupRequest { + r.createDedicatedGroupRequest = &createDedicatedGroupRequest + return r +} + +func (r ApiCreateDedicatedGroupRequest) Execute() (CreateDedicatedGroupResponse, *_nethttp.Response, error) { + return r.ApiService.CreateDedicatedGroupExecute(r) +} + +/* + * CreateDedicatedGroup Method for CreateDedicatedGroup + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @return ApiCreateDedicatedGroupRequest + */ +func (a *DedicatedGroupApiService) CreateDedicatedGroup(ctx _context.Context) ApiCreateDedicatedGroupRequest { + return ApiCreateDedicatedGroupRequest{ + ApiService: a, + ctx: ctx, + } +} + +/* + * Execute executes the request + * @return CreateDedicatedGroupResponse + */ +func (a *DedicatedGroupApiService) CreateDedicatedGroupExecute(r ApiCreateDedicatedGroupRequest) (CreateDedicatedGroupResponse, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue CreateDedicatedGroupResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "DedicatedGroupApiService.CreateDedicatedGroup") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/CreateDedicatedGroup" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.createDedicatedGroupRequest + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["ApiKeyAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = _ioutil.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiDeleteDedicatedGroupRequest struct { + ctx _context.Context + ApiService *DedicatedGroupApiService + deleteDedicatedGroupRequest *DeleteDedicatedGroupRequest +} + +func (r ApiDeleteDedicatedGroupRequest) DeleteDedicatedGroupRequest(deleteDedicatedGroupRequest DeleteDedicatedGroupRequest) ApiDeleteDedicatedGroupRequest { + r.deleteDedicatedGroupRequest = &deleteDedicatedGroupRequest + return r +} + +func (r ApiDeleteDedicatedGroupRequest) Execute() (DeleteDedicatedGroupResponse, *_nethttp.Response, error) { + return r.ApiService.DeleteDedicatedGroupExecute(r) +} + +/* + * DeleteDedicatedGroup Method for DeleteDedicatedGroup + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @return ApiDeleteDedicatedGroupRequest + */ +func (a *DedicatedGroupApiService) DeleteDedicatedGroup(ctx _context.Context) ApiDeleteDedicatedGroupRequest { + return ApiDeleteDedicatedGroupRequest{ + ApiService: a, + ctx: ctx, + } +} + +/* + * Execute executes the request + * @return DeleteDedicatedGroupResponse + */ +func (a *DedicatedGroupApiService) DeleteDedicatedGroupExecute(r ApiDeleteDedicatedGroupRequest) (DeleteDedicatedGroupResponse, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue DeleteDedicatedGroupResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "DedicatedGroupApiService.DeleteDedicatedGroup") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/DeleteDedicatedGroup" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.deleteDedicatedGroupRequest + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["ApiKeyAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = _ioutil.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiReadDedicatedGroupsRequest struct { + ctx _context.Context + ApiService *DedicatedGroupApiService + readDedicatedGroupsRequest *ReadDedicatedGroupsRequest +} + +func (r ApiReadDedicatedGroupsRequest) ReadDedicatedGroupsRequest(readDedicatedGroupsRequest ReadDedicatedGroupsRequest) ApiReadDedicatedGroupsRequest { + r.readDedicatedGroupsRequest = &readDedicatedGroupsRequest + return r +} + +func (r ApiReadDedicatedGroupsRequest) Execute() (ReadDedicatedGroupsResponse, *_nethttp.Response, error) { + return r.ApiService.ReadDedicatedGroupsExecute(r) +} + +/* + * ReadDedicatedGroups Method for ReadDedicatedGroups + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @return ApiReadDedicatedGroupsRequest + */ +func (a *DedicatedGroupApiService) ReadDedicatedGroups(ctx _context.Context) ApiReadDedicatedGroupsRequest { + return ApiReadDedicatedGroupsRequest{ + ApiService: a, + ctx: ctx, + } +} + +/* + * Execute executes the request + * @return ReadDedicatedGroupsResponse + */ +func (a *DedicatedGroupApiService) ReadDedicatedGroupsExecute(r ApiReadDedicatedGroupsRequest) (ReadDedicatedGroupsResponse, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue ReadDedicatedGroupsResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "DedicatedGroupApiService.ReadDedicatedGroups") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/ReadDedicatedGroups" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.readDedicatedGroupsRequest + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["ApiKeyAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = _ioutil.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiUpdateDedicatedGroupRequest struct { + ctx _context.Context + ApiService *DedicatedGroupApiService + updateDedicatedGroupRequest *UpdateDedicatedGroupRequest +} + +func (r ApiUpdateDedicatedGroupRequest) UpdateDedicatedGroupRequest(updateDedicatedGroupRequest UpdateDedicatedGroupRequest) ApiUpdateDedicatedGroupRequest { + r.updateDedicatedGroupRequest = &updateDedicatedGroupRequest + return r +} + +func (r ApiUpdateDedicatedGroupRequest) Execute() (UpdateDedicatedGroupResponse, *_nethttp.Response, error) { + return r.ApiService.UpdateDedicatedGroupExecute(r) +} + +/* + * UpdateDedicatedGroup Method for UpdateDedicatedGroup + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @return ApiUpdateDedicatedGroupRequest + */ +func (a *DedicatedGroupApiService) UpdateDedicatedGroup(ctx _context.Context) ApiUpdateDedicatedGroupRequest { + return ApiUpdateDedicatedGroupRequest{ + ApiService: a, + ctx: ctx, + } +} + +/* + * Execute executes the request + * @return UpdateDedicatedGroupResponse + */ +func (a *DedicatedGroupApiService) UpdateDedicatedGroupExecute(r ApiUpdateDedicatedGroupRequest) (UpdateDedicatedGroupResponse, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue UpdateDedicatedGroupResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "DedicatedGroupApiService.UpdateDedicatedGroup") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/UpdateDedicatedGroup" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.updateDedicatedGroupRequest + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["ApiKeyAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = _ioutil.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} diff --git a/v2/api_dhcp_option.go b/v2/api_dhcp_option.go index d77700e54..691943f64 100644 --- a/v2/api_dhcp_option.go +++ b/v2/api_dhcp_option.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_direct_link.go b/v2/api_direct_link.go index a615c4f30..b26d4a45b 100644 --- a/v2/api_direct_link.go +++ b/v2/api_direct_link.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_direct_link_interface.go b/v2/api_direct_link_interface.go index 34b96e05a..7c694ced6 100644 --- a/v2/api_direct_link_interface.go +++ b/v2/api_direct_link_interface.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_flexible_gpu.go b/v2/api_flexible_gpu.go index 9d01e634a..14eb711e5 100644 --- a/v2/api_flexible_gpu.go +++ b/v2/api_flexible_gpu.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_image.go b/v2/api_image.go index 6ae8ce7ba..2b4410223 100644 --- a/v2/api_image.go +++ b/v2/api_image.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_internet_service.go b/v2/api_internet_service.go index 5d432fd9b..d13ace79c 100644 --- a/v2/api_internet_service.go +++ b/v2/api_internet_service.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_keypair.go b/v2/api_keypair.go index d4f1b451c..5a5643c86 100644 --- a/v2/api_keypair.go +++ b/v2/api_keypair.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_listener.go b/v2/api_listener.go index e077658bf..e8a8ad1cd 100644 --- a/v2/api_listener.go +++ b/v2/api_listener.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_load_balancer.go b/v2/api_load_balancer.go index 0ad4c7550..9741b8420 100644 --- a/v2/api_load_balancer.go +++ b/v2/api_load_balancer.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_load_balancer_policy.go b/v2/api_load_balancer_policy.go index 5e6adc484..a2a61dac2 100644 --- a/v2/api_load_balancer_policy.go +++ b/v2/api_load_balancer_policy.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_location.go b/v2/api_location.go index 4e51c9ce1..719df3eab 100644 --- a/v2/api_location.go +++ b/v2/api_location.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_nat_service.go b/v2/api_nat_service.go index 7d5a36d27..265fc46ba 100644 --- a/v2/api_nat_service.go +++ b/v2/api_nat_service.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_net.go b/v2/api_net.go index 2b687e2a3..eb4a00606 100644 --- a/v2/api_net.go +++ b/v2/api_net.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_net_access_point.go b/v2/api_net_access_point.go index fa49e49be..6d8cecc15 100644 --- a/v2/api_net_access_point.go +++ b/v2/api_net_access_point.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_net_peering.go b/v2/api_net_peering.go index 4a078dc13..fb2942d8e 100644 --- a/v2/api_net_peering.go +++ b/v2/api_net_peering.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_nic.go b/v2/api_nic.go index 5fb204309..88a3fbac1 100644 --- a/v2/api_nic.go +++ b/v2/api_nic.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_policy.go b/v2/api_policy.go new file mode 100644 index 000000000..2769133f2 --- /dev/null +++ b/v2/api_policy.go @@ -0,0 +1,1492 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "bytes" + _context "context" + _ioutil "io/ioutil" + _nethttp "net/http" + _neturl "net/url" +) + +// Linger please +var ( + _ _context.Context +) + +// PolicyApiService PolicyApi service +type PolicyApiService service + +type ApiCreatePolicyRequest struct { + ctx _context.Context + ApiService *PolicyApiService + createPolicyRequest *CreatePolicyRequest +} + +func (r ApiCreatePolicyRequest) CreatePolicyRequest(createPolicyRequest CreatePolicyRequest) ApiCreatePolicyRequest { + r.createPolicyRequest = &createPolicyRequest + return r +} + +func (r ApiCreatePolicyRequest) Execute() (CreatePolicyResponse, *_nethttp.Response, error) { + return r.ApiService.CreatePolicyExecute(r) +} + +/* + * CreatePolicy Method for CreatePolicy + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @return ApiCreatePolicyRequest + */ +func (a *PolicyApiService) CreatePolicy(ctx _context.Context) ApiCreatePolicyRequest { + return ApiCreatePolicyRequest{ + ApiService: a, + ctx: ctx, + } +} + +/* + * Execute executes the request + * @return CreatePolicyResponse + */ +func (a *PolicyApiService) CreatePolicyExecute(r ApiCreatePolicyRequest) (CreatePolicyResponse, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue CreatePolicyResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "PolicyApiService.CreatePolicy") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/CreatePolicy" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.createPolicyRequest + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["ApiKeyAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = _ioutil.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiCreatePolicyVersionRequest struct { + ctx _context.Context + ApiService *PolicyApiService + createPolicyVersionRequest *CreatePolicyVersionRequest +} + +func (r ApiCreatePolicyVersionRequest) CreatePolicyVersionRequest(createPolicyVersionRequest CreatePolicyVersionRequest) ApiCreatePolicyVersionRequest { + r.createPolicyVersionRequest = &createPolicyVersionRequest + return r +} + +func (r ApiCreatePolicyVersionRequest) Execute() (CreatePolicyVersionResponse, *_nethttp.Response, error) { + return r.ApiService.CreatePolicyVersionExecute(r) +} + +/* + * CreatePolicyVersion Method for CreatePolicyVersion + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @return ApiCreatePolicyVersionRequest + */ +func (a *PolicyApiService) CreatePolicyVersion(ctx _context.Context) ApiCreatePolicyVersionRequest { + return ApiCreatePolicyVersionRequest{ + ApiService: a, + ctx: ctx, + } +} + +/* + * Execute executes the request + * @return CreatePolicyVersionResponse + */ +func (a *PolicyApiService) CreatePolicyVersionExecute(r ApiCreatePolicyVersionRequest) (CreatePolicyVersionResponse, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue CreatePolicyVersionResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "PolicyApiService.CreatePolicyVersion") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/CreatePolicyVersion" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.createPolicyVersionRequest + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["ApiKeyAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = _ioutil.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiDeletePolicyRequest struct { + ctx _context.Context + ApiService *PolicyApiService + deletePolicyRequest *DeletePolicyRequest +} + +func (r ApiDeletePolicyRequest) DeletePolicyRequest(deletePolicyRequest DeletePolicyRequest) ApiDeletePolicyRequest { + r.deletePolicyRequest = &deletePolicyRequest + return r +} + +func (r ApiDeletePolicyRequest) Execute() (DeletePolicyResponse, *_nethttp.Response, error) { + return r.ApiService.DeletePolicyExecute(r) +} + +/* + * DeletePolicy Method for DeletePolicy + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @return ApiDeletePolicyRequest + */ +func (a *PolicyApiService) DeletePolicy(ctx _context.Context) ApiDeletePolicyRequest { + return ApiDeletePolicyRequest{ + ApiService: a, + ctx: ctx, + } +} + +/* + * Execute executes the request + * @return DeletePolicyResponse + */ +func (a *PolicyApiService) DeletePolicyExecute(r ApiDeletePolicyRequest) (DeletePolicyResponse, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue DeletePolicyResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "PolicyApiService.DeletePolicy") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/DeletePolicy" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.deletePolicyRequest + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["ApiKeyAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = _ioutil.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiDeletePolicyVersionRequest struct { + ctx _context.Context + ApiService *PolicyApiService + deletePolicyVersionRequest *DeletePolicyVersionRequest +} + +func (r ApiDeletePolicyVersionRequest) DeletePolicyVersionRequest(deletePolicyVersionRequest DeletePolicyVersionRequest) ApiDeletePolicyVersionRequest { + r.deletePolicyVersionRequest = &deletePolicyVersionRequest + return r +} + +func (r ApiDeletePolicyVersionRequest) Execute() (DeletePolicyVersionResponse, *_nethttp.Response, error) { + return r.ApiService.DeletePolicyVersionExecute(r) +} + +/* + * DeletePolicyVersion Method for DeletePolicyVersion + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @return ApiDeletePolicyVersionRequest + */ +func (a *PolicyApiService) DeletePolicyVersion(ctx _context.Context) ApiDeletePolicyVersionRequest { + return ApiDeletePolicyVersionRequest{ + ApiService: a, + ctx: ctx, + } +} + +/* + * Execute executes the request + * @return DeletePolicyVersionResponse + */ +func (a *PolicyApiService) DeletePolicyVersionExecute(r ApiDeletePolicyVersionRequest) (DeletePolicyVersionResponse, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue DeletePolicyVersionResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "PolicyApiService.DeletePolicyVersion") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/DeletePolicyVersion" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.deletePolicyVersionRequest + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["ApiKeyAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = _ioutil.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiLinkPolicyRequest struct { + ctx _context.Context + ApiService *PolicyApiService + linkPolicyRequest *LinkPolicyRequest +} + +func (r ApiLinkPolicyRequest) LinkPolicyRequest(linkPolicyRequest LinkPolicyRequest) ApiLinkPolicyRequest { + r.linkPolicyRequest = &linkPolicyRequest + return r +} + +func (r ApiLinkPolicyRequest) Execute() (LinkPolicyResponse, *_nethttp.Response, error) { + return r.ApiService.LinkPolicyExecute(r) +} + +/* + * LinkPolicy Method for LinkPolicy + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @return ApiLinkPolicyRequest + */ +func (a *PolicyApiService) LinkPolicy(ctx _context.Context) ApiLinkPolicyRequest { + return ApiLinkPolicyRequest{ + ApiService: a, + ctx: ctx, + } +} + +/* + * Execute executes the request + * @return LinkPolicyResponse + */ +func (a *PolicyApiService) LinkPolicyExecute(r ApiLinkPolicyRequest) (LinkPolicyResponse, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue LinkPolicyResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "PolicyApiService.LinkPolicy") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/LinkPolicy" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.linkPolicyRequest + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["ApiKeyAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = _ioutil.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiReadLinkedPoliciesRequest struct { + ctx _context.Context + ApiService *PolicyApiService + readLinkedPoliciesRequest *ReadLinkedPoliciesRequest +} + +func (r ApiReadLinkedPoliciesRequest) ReadLinkedPoliciesRequest(readLinkedPoliciesRequest ReadLinkedPoliciesRequest) ApiReadLinkedPoliciesRequest { + r.readLinkedPoliciesRequest = &readLinkedPoliciesRequest + return r +} + +func (r ApiReadLinkedPoliciesRequest) Execute() (ReadLinkedPoliciesResponse, *_nethttp.Response, error) { + return r.ApiService.ReadLinkedPoliciesExecute(r) +} + +/* + * ReadLinkedPolicies Method for ReadLinkedPolicies + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @return ApiReadLinkedPoliciesRequest + */ +func (a *PolicyApiService) ReadLinkedPolicies(ctx _context.Context) ApiReadLinkedPoliciesRequest { + return ApiReadLinkedPoliciesRequest{ + ApiService: a, + ctx: ctx, + } +} + +/* + * Execute executes the request + * @return ReadLinkedPoliciesResponse + */ +func (a *PolicyApiService) ReadLinkedPoliciesExecute(r ApiReadLinkedPoliciesRequest) (ReadLinkedPoliciesResponse, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue ReadLinkedPoliciesResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "PolicyApiService.ReadLinkedPolicies") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/ReadLinkedPolicies" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.readLinkedPoliciesRequest + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["ApiKeyAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = _ioutil.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiReadPoliciesRequest struct { + ctx _context.Context + ApiService *PolicyApiService + readPoliciesRequest *ReadPoliciesRequest +} + +func (r ApiReadPoliciesRequest) ReadPoliciesRequest(readPoliciesRequest ReadPoliciesRequest) ApiReadPoliciesRequest { + r.readPoliciesRequest = &readPoliciesRequest + return r +} + +func (r ApiReadPoliciesRequest) Execute() (ReadPoliciesResponse, *_nethttp.Response, error) { + return r.ApiService.ReadPoliciesExecute(r) +} + +/* + * ReadPolicies Method for ReadPolicies + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @return ApiReadPoliciesRequest + */ +func (a *PolicyApiService) ReadPolicies(ctx _context.Context) ApiReadPoliciesRequest { + return ApiReadPoliciesRequest{ + ApiService: a, + ctx: ctx, + } +} + +/* + * Execute executes the request + * @return ReadPoliciesResponse + */ +func (a *PolicyApiService) ReadPoliciesExecute(r ApiReadPoliciesRequest) (ReadPoliciesResponse, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue ReadPoliciesResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "PolicyApiService.ReadPolicies") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/ReadPolicies" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.readPoliciesRequest + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["ApiKeyAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = _ioutil.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiReadPolicyRequest struct { + ctx _context.Context + ApiService *PolicyApiService + readPolicyRequest *ReadPolicyRequest +} + +func (r ApiReadPolicyRequest) ReadPolicyRequest(readPolicyRequest ReadPolicyRequest) ApiReadPolicyRequest { + r.readPolicyRequest = &readPolicyRequest + return r +} + +func (r ApiReadPolicyRequest) Execute() (ReadPolicyResponse, *_nethttp.Response, error) { + return r.ApiService.ReadPolicyExecute(r) +} + +/* + * ReadPolicy Method for ReadPolicy + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @return ApiReadPolicyRequest + */ +func (a *PolicyApiService) ReadPolicy(ctx _context.Context) ApiReadPolicyRequest { + return ApiReadPolicyRequest{ + ApiService: a, + ctx: ctx, + } +} + +/* + * Execute executes the request + * @return ReadPolicyResponse + */ +func (a *PolicyApiService) ReadPolicyExecute(r ApiReadPolicyRequest) (ReadPolicyResponse, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue ReadPolicyResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "PolicyApiService.ReadPolicy") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/ReadPolicy" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.readPolicyRequest + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["ApiKeyAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = _ioutil.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiReadPolicyVersionRequest struct { + ctx _context.Context + ApiService *PolicyApiService + readPolicyVersionRequest *ReadPolicyVersionRequest +} + +func (r ApiReadPolicyVersionRequest) ReadPolicyVersionRequest(readPolicyVersionRequest ReadPolicyVersionRequest) ApiReadPolicyVersionRequest { + r.readPolicyVersionRequest = &readPolicyVersionRequest + return r +} + +func (r ApiReadPolicyVersionRequest) Execute() (ReadPolicyVersionResponse, *_nethttp.Response, error) { + return r.ApiService.ReadPolicyVersionExecute(r) +} + +/* + * ReadPolicyVersion Method for ReadPolicyVersion + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @return ApiReadPolicyVersionRequest + */ +func (a *PolicyApiService) ReadPolicyVersion(ctx _context.Context) ApiReadPolicyVersionRequest { + return ApiReadPolicyVersionRequest{ + ApiService: a, + ctx: ctx, + } +} + +/* + * Execute executes the request + * @return ReadPolicyVersionResponse + */ +func (a *PolicyApiService) ReadPolicyVersionExecute(r ApiReadPolicyVersionRequest) (ReadPolicyVersionResponse, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue ReadPolicyVersionResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "PolicyApiService.ReadPolicyVersion") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/ReadPolicyVersion" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.readPolicyVersionRequest + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["ApiKeyAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = _ioutil.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiReadPolicyVersionsRequest struct { + ctx _context.Context + ApiService *PolicyApiService + readPolicyVersionsRequest *ReadPolicyVersionsRequest +} + +func (r ApiReadPolicyVersionsRequest) ReadPolicyVersionsRequest(readPolicyVersionsRequest ReadPolicyVersionsRequest) ApiReadPolicyVersionsRequest { + r.readPolicyVersionsRequest = &readPolicyVersionsRequest + return r +} + +func (r ApiReadPolicyVersionsRequest) Execute() (ReadPolicyVersionsResponse, *_nethttp.Response, error) { + return r.ApiService.ReadPolicyVersionsExecute(r) +} + +/* + * ReadPolicyVersions Method for ReadPolicyVersions + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @return ApiReadPolicyVersionsRequest + */ +func (a *PolicyApiService) ReadPolicyVersions(ctx _context.Context) ApiReadPolicyVersionsRequest { + return ApiReadPolicyVersionsRequest{ + ApiService: a, + ctx: ctx, + } +} + +/* + * Execute executes the request + * @return ReadPolicyVersionsResponse + */ +func (a *PolicyApiService) ReadPolicyVersionsExecute(r ApiReadPolicyVersionsRequest) (ReadPolicyVersionsResponse, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue ReadPolicyVersionsResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "PolicyApiService.ReadPolicyVersions") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/ReadPolicyVersions" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.readPolicyVersionsRequest + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["ApiKeyAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = _ioutil.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiSetDefaultPolicyVersionRequest struct { + ctx _context.Context + ApiService *PolicyApiService + setDefaultPolicyVersionRequest *SetDefaultPolicyVersionRequest +} + +func (r ApiSetDefaultPolicyVersionRequest) SetDefaultPolicyVersionRequest(setDefaultPolicyVersionRequest SetDefaultPolicyVersionRequest) ApiSetDefaultPolicyVersionRequest { + r.setDefaultPolicyVersionRequest = &setDefaultPolicyVersionRequest + return r +} + +func (r ApiSetDefaultPolicyVersionRequest) Execute() (SetDefaultPolicyVersionResponse, *_nethttp.Response, error) { + return r.ApiService.SetDefaultPolicyVersionExecute(r) +} + +/* + * SetDefaultPolicyVersion Method for SetDefaultPolicyVersion + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @return ApiSetDefaultPolicyVersionRequest + */ +func (a *PolicyApiService) SetDefaultPolicyVersion(ctx _context.Context) ApiSetDefaultPolicyVersionRequest { + return ApiSetDefaultPolicyVersionRequest{ + ApiService: a, + ctx: ctx, + } +} + +/* + * Execute executes the request + * @return SetDefaultPolicyVersionResponse + */ +func (a *PolicyApiService) SetDefaultPolicyVersionExecute(r ApiSetDefaultPolicyVersionRequest) (SetDefaultPolicyVersionResponse, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue SetDefaultPolicyVersionResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "PolicyApiService.SetDefaultPolicyVersion") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/SetDefaultPolicyVersion" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.setDefaultPolicyVersionRequest + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["ApiKeyAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = _ioutil.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiUnlinkPolicyRequest struct { + ctx _context.Context + ApiService *PolicyApiService + unlinkPolicyRequest *UnlinkPolicyRequest +} + +func (r ApiUnlinkPolicyRequest) UnlinkPolicyRequest(unlinkPolicyRequest UnlinkPolicyRequest) ApiUnlinkPolicyRequest { + r.unlinkPolicyRequest = &unlinkPolicyRequest + return r +} + +func (r ApiUnlinkPolicyRequest) Execute() (UnlinkPolicyResponse, *_nethttp.Response, error) { + return r.ApiService.UnlinkPolicyExecute(r) +} + +/* + * UnlinkPolicy Method for UnlinkPolicy + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @return ApiUnlinkPolicyRequest + */ +func (a *PolicyApiService) UnlinkPolicy(ctx _context.Context) ApiUnlinkPolicyRequest { + return ApiUnlinkPolicyRequest{ + ApiService: a, + ctx: ctx, + } +} + +/* + * Execute executes the request + * @return UnlinkPolicyResponse + */ +func (a *PolicyApiService) UnlinkPolicyExecute(r ApiUnlinkPolicyRequest) (UnlinkPolicyResponse, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue UnlinkPolicyResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "PolicyApiService.UnlinkPolicy") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/UnlinkPolicy" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.unlinkPolicyRequest + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["ApiKeyAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = _ioutil.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} diff --git a/v2/api_product_type.go b/v2/api_product_type.go index 0128f03b9..95636b2e5 100644 --- a/v2/api_product_type.go +++ b/v2/api_product_type.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -27,6 +27,128 @@ var ( // ProductTypeApiService ProductTypeApi service type ProductTypeApiService service +type ApiCreateProductTypeRequest struct { + ctx _context.Context + ApiService *ProductTypeApiService + createProductTypeRequest *CreateProductTypeRequest +} + +func (r ApiCreateProductTypeRequest) CreateProductTypeRequest(createProductTypeRequest CreateProductTypeRequest) ApiCreateProductTypeRequest { + r.createProductTypeRequest = &createProductTypeRequest + return r +} + +func (r ApiCreateProductTypeRequest) Execute() (CreateProductTypeResponse, *_nethttp.Response, error) { + return r.ApiService.CreateProductTypeExecute(r) +} + +/* + * CreateProductType Method for CreateProductType + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @return ApiCreateProductTypeRequest + */ +func (a *ProductTypeApiService) CreateProductType(ctx _context.Context) ApiCreateProductTypeRequest { + return ApiCreateProductTypeRequest{ + ApiService: a, + ctx: ctx, + } +} + +/* + * Execute executes the request + * @return CreateProductTypeResponse + */ +func (a *ProductTypeApiService) CreateProductTypeExecute(r ApiCreateProductTypeRequest) (CreateProductTypeResponse, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue CreateProductTypeResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "ProductTypeApiService.CreateProductType") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/CreateProductType" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.createProductTypeRequest + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["ApiKeyAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = _ioutil.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + type ApiReadProductTypesRequest struct { ctx _context.Context ApiService *ProductTypeApiService diff --git a/v2/api_public_catalog.go b/v2/api_public_catalog.go index ce30c64b0..45c23ab39 100644 --- a/v2/api_public_catalog.go +++ b/v2/api_public_catalog.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_public_ip.go b/v2/api_public_ip.go index fdeb631d6..630612b99 100644 --- a/v2/api_public_ip.go +++ b/v2/api_public_ip.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_quota.go b/v2/api_quota.go index 6d0364f99..b313aa881 100644 --- a/v2/api_quota.go +++ b/v2/api_quota.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_region.go b/v2/api_region.go index a51909545..505643b0e 100644 --- a/v2/api_region.go +++ b/v2/api_region.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_route.go b/v2/api_route.go index 86db5df3a..5af7a4af9 100644 --- a/v2/api_route.go +++ b/v2/api_route.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_route_table.go b/v2/api_route_table.go index 1808c21a8..d308c0385 100644 --- a/v2/api_route_table.go +++ b/v2/api_route_table.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -781,3 +781,154 @@ func (a *RouteTableApiService) UnlinkRouteTableExecute(r ApiUnlinkRouteTableRequ return localVarReturnValue, localVarHTTPResponse, nil } + +type ApiUpdateRouteTableLinkRequest struct { + ctx _context.Context + ApiService *RouteTableApiService + updateRouteTableLinkRequest *UpdateRouteTableLinkRequest +} + +func (r ApiUpdateRouteTableLinkRequest) UpdateRouteTableLinkRequest(updateRouteTableLinkRequest UpdateRouteTableLinkRequest) ApiUpdateRouteTableLinkRequest { + r.updateRouteTableLinkRequest = &updateRouteTableLinkRequest + return r +} + +func (r ApiUpdateRouteTableLinkRequest) Execute() (UpdateRouteTableLinkResponse, *_nethttp.Response, error) { + return r.ApiService.UpdateRouteTableLinkExecute(r) +} + +/* + * UpdateRouteTableLink Method for UpdateRouteTableLink + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @return ApiUpdateRouteTableLinkRequest + */ +func (a *RouteTableApiService) UpdateRouteTableLink(ctx _context.Context) ApiUpdateRouteTableLinkRequest { + return ApiUpdateRouteTableLinkRequest{ + ApiService: a, + ctx: ctx, + } +} + +/* + * Execute executes the request + * @return UpdateRouteTableLinkResponse + */ +func (a *RouteTableApiService) UpdateRouteTableLinkExecute(r ApiUpdateRouteTableLinkRequest) (UpdateRouteTableLinkResponse, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue UpdateRouteTableLinkResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "RouteTableApiService.UpdateRouteTableLink") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/UpdateRouteTableLink" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.updateRouteTableLinkRequest + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["ApiKeyAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = _ioutil.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} diff --git a/v2/api_security_group.go b/v2/api_security_group.go index d3759b347..a310ac12e 100644 --- a/v2/api_security_group.go +++ b/v2/api_security_group.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_security_group_rule.go b/v2/api_security_group_rule.go index 2f4accaf9..8491593d7 100644 --- a/v2/api_security_group_rule.go +++ b/v2/api_security_group_rule.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_server_certificate.go b/v2/api_server_certificate.go index 085b42005..122a8b18b 100644 --- a/v2/api_server_certificate.go +++ b/v2/api_server_certificate.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_snapshot.go b/v2/api_snapshot.go index e2d169d87..0b80dc9b4 100644 --- a/v2/api_snapshot.go +++ b/v2/api_snapshot.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_subnet.go b/v2/api_subnet.go index bcb4f0ab0..8827d5d96 100644 --- a/v2/api_subnet.go +++ b/v2/api_subnet.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_subregion.go b/v2/api_subregion.go index 54f9cba48..dec9bbeff 100644 --- a/v2/api_subregion.go +++ b/v2/api_subregion.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_tag.go b/v2/api_tag.go index fda09d124..4423c97ee 100644 --- a/v2/api_tag.go +++ b/v2/api_tag.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_task.go b/v2/api_task.go index f5128cbe0..3d8557fe1 100644 --- a/v2/api_task.go +++ b/v2/api_task.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_user.go b/v2/api_user.go index 2ba047847..aa6491727 100644 --- a/v2/api_user.go +++ b/v2/api_user.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_virtual_gateway.go b/v2/api_virtual_gateway.go index 5c292a860..e54700a41 100644 --- a/v2/api_virtual_gateway.go +++ b/v2/api_virtual_gateway.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_vm.go b/v2/api_vm.go index 925a19f9c..7c0f4c726 100644 --- a/v2/api_vm.go +++ b/v2/api_vm.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_vm_group.go b/v2/api_vm_group.go index ea023c918..ec0dcd62b 100644 --- a/v2/api_vm_group.go +++ b/v2/api_vm_group.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_vm_template.go b/v2/api_vm_template.go index 7e5943c18..ead67308b 100644 --- a/v2/api_vm_template.go +++ b/v2/api_vm_template.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_volume.go b/v2/api_volume.go index 1e4b5fdc1..541e1a8c2 100644 --- a/v2/api_volume.go +++ b/v2/api_volume.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/api_vpn_connection.go b/v2/api_vpn_connection.go index 205c63d8f..4d4112c28 100644 --- a/v2/api_vpn_connection.go +++ b/v2/api_vpn_connection.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/client.go b/v2/client.go index 0935d39ec..a1ea39006 100644 --- a/v2/client.go +++ b/v2/client.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -43,7 +43,7 @@ var ( xmlCheck = regexp.MustCompile(`(?i:(?:application|text)/xml)`) ) -// APIClient manages communication with the 3DS OUTSCALE API API v1.27 +// APIClient manages communication with the 3DS OUTSCALE API API v1.28.5 // In most cases there should be only one, shared, APIClient. type APIClient struct { cfg *Configuration @@ -67,6 +67,8 @@ type APIClient struct { ClientGatewayApi *ClientGatewayApiService + DedicatedGroupApi *DedicatedGroupApiService + DhcpOptionApi *DhcpOptionApiService DirectLinkApi *DirectLinkApiService @@ -99,6 +101,8 @@ type APIClient struct { NicApi *NicApiService + PolicyApi *PolicyApiService + ProductTypeApi *ProductTypeApiService PublicCatalogApi *PublicCatalogApiService @@ -168,6 +172,7 @@ func NewAPIClient(cfg *Configuration) *APIClient { c.CaApi = (*CaApiService)(&c.common) c.CatalogApi = (*CatalogApiService)(&c.common) c.ClientGatewayApi = (*ClientGatewayApiService)(&c.common) + c.DedicatedGroupApi = (*DedicatedGroupApiService)(&c.common) c.DhcpOptionApi = (*DhcpOptionApiService)(&c.common) c.DirectLinkApi = (*DirectLinkApiService)(&c.common) c.DirectLinkInterfaceApi = (*DirectLinkInterfaceApiService)(&c.common) @@ -184,6 +189,7 @@ func NewAPIClient(cfg *Configuration) *APIClient { c.NetAccessPointApi = (*NetAccessPointApiService)(&c.common) c.NetPeeringApi = (*NetPeeringApiService)(&c.common) c.NicApi = (*NicApiService)(&c.common) + c.PolicyApi = (*PolicyApiService)(&c.common) c.ProductTypeApi = (*ProductTypeApiService)(&c.common) c.PublicCatalogApi = (*PublicCatalogApiService)(&c.common) c.PublicIpApi = (*PublicIpApiService)(&c.common) diff --git a/v2/configuration.go b/v2/configuration.go index d06e655ef..e58df720f 100644 --- a/v2/configuration.go +++ b/v2/configuration.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -112,7 +112,7 @@ type Configuration struct { func NewConfiguration() *Configuration { cfg := &Configuration{ DefaultHeader: make(map[string]string), - UserAgent: "osc-sdk-go/2.18.2", + UserAgent: "osc-sdk-go/2.19.0", Debug: false, Servers: ServerConfigurations{ { @@ -132,19 +132,6 @@ func NewConfiguration() *Configuration { }, }, }, - { - URL: "https://api.{region}.outscale.jp/api/v1", - Description: "No description provided", - Variables: map[string]ServerVariable{ - "region": ServerVariable{ - Description: "No description provided", - DefaultValue: "ap-northeast-1", - EnumValues: []string{ - "ap-northeast-1", - }, - }, - }, - }, }, OperationServers: map[string]ServerConfigurations{}, } diff --git a/v2/docs/AccountApi.md b/v2/docs/AccountApi.md index 8c6dde3f0..a5460f794 100644 --- a/v2/docs/AccountApi.md +++ b/v2/docs/AccountApi.md @@ -8,8 +8,6 @@ Method | HTTP request | Description [**CreateAccount**](AccountApi.md#CreateAccount) | **Post** /CreateAccount | [**ReadAccounts**](AccountApi.md#ReadAccounts) | **Post** /ReadAccounts | [**ReadConsumptionAccount**](AccountApi.md#ReadConsumptionAccount) | **Post** /ReadConsumptionAccount | -[**ResetAccountPassword**](AccountApi.md#ResetAccountPassword) | **Post** /ResetAccountPassword | -[**SendResetPasswordEmail**](AccountApi.md#SendResetPasswordEmail) | **Post** /SendResetPasswordEmail | [**UpdateAccount**](AccountApi.md#UpdateAccount) | **Post** /UpdateAccount | @@ -270,134 +268,6 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## ResetAccountPassword - -> ResetAccountPasswordResponse ResetAccountPassword(ctx).ResetAccountPasswordRequest(resetAccountPasswordRequest).Execute() - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "./openapi" -) - -func main() { - resetAccountPasswordRequest := *openapiclient.NewResetAccountPasswordRequest("Password_example", "Token_example") // ResetAccountPasswordRequest | (optional) - - configuration := openapiclient.NewConfiguration() - api_client := openapiclient.NewAPIClient(configuration) - resp, r, err := api_client.AccountApi.ResetAccountPassword(context.Background()).ResetAccountPasswordRequest(resetAccountPasswordRequest).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `AccountApi.ResetAccountPassword``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `ResetAccountPassword`: ResetAccountPasswordResponse - fmt.Fprintf(os.Stdout, "Response from `AccountApi.ResetAccountPassword`: %v\n", resp) -} -``` - -### Path Parameters - - - -### Other Parameters - -Other parameters are passed through a pointer to a apiResetAccountPasswordRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **resetAccountPasswordRequest** | [**ResetAccountPasswordRequest**](ResetAccountPasswordRequest.md) | | - -### Return type - -[**ResetAccountPasswordResponse**](ResetAccountPasswordResponse.md) - -### Authorization - -No authorization required - -### 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) - - -## SendResetPasswordEmail - -> SendResetPasswordEmailResponse SendResetPasswordEmail(ctx).SendResetPasswordEmailRequest(sendResetPasswordEmailRequest).Execute() - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "./openapi" -) - -func main() { - sendResetPasswordEmailRequest := *openapiclient.NewSendResetPasswordEmailRequest("Email_example") // SendResetPasswordEmailRequest | (optional) - - configuration := openapiclient.NewConfiguration() - api_client := openapiclient.NewAPIClient(configuration) - resp, r, err := api_client.AccountApi.SendResetPasswordEmail(context.Background()).SendResetPasswordEmailRequest(sendResetPasswordEmailRequest).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `AccountApi.SendResetPasswordEmail``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `SendResetPasswordEmail`: SendResetPasswordEmailResponse - fmt.Fprintf(os.Stdout, "Response from `AccountApi.SendResetPasswordEmail`: %v\n", resp) -} -``` - -### Path Parameters - - - -### Other Parameters - -Other parameters are passed through a pointer to a apiSendResetPasswordEmailRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **sendResetPasswordEmailRequest** | [**SendResetPasswordEmailRequest**](SendResetPasswordEmailRequest.md) | | - -### Return type - -[**SendResetPasswordEmailResponse**](SendResetPasswordEmailResponse.md) - -### Authorization - -No authorization required - -### 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) - - ## UpdateAccount > UpdateAccountResponse UpdateAccount(ctx).UpdateAccountRequest(updateAccountRequest).Execute() diff --git a/v2/docs/ApiAccessPolicy.md b/v2/docs/ApiAccessPolicy.md index fb11208ce..3911339cc 100644 --- a/v2/docs/ApiAccessPolicy.md +++ b/v2/docs/ApiAccessPolicy.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **MaxAccessKeyExpirationSeconds** | Pointer to **int64** | The maximum possible lifetime for your access keys, in seconds. If `0`, your access keys can have unlimited lifetimes. | [optional] -**RequireTrustedEnv** | Pointer to **bool** | If true, a trusted session is activated, allowing you to bypass Certificate Authorities (CAs) enforcement. For more information, see the `ApiKeyAuth` authentication scheme in the [Authentication](#authentication) section. | [optional] +**RequireTrustedEnv** | Pointer to **bool** | If true, a trusted session is activated, allowing you to bypass Certificate Authorities (CAs) enforcement. For more information, see [About Your API Access Policy](https://docs.outscale.com/en/userguide/About-Your-API-Access-Policy.html).<br /> If this is enabled, it is required that you and all your users log in to Cockpit v2 using the WebAuthn method for multi-factor authentication. For more information, see [About Authentication > Multi-Factor Authentication](https://docs.outscale.com/en/userguide/About-Authentication.html#_multi_factor_authentication). | [optional] ## Methods diff --git a/v2/docs/ConsumptionEntry.md b/v2/docs/ConsumptionEntry.md index 438d2625d..f36ae34d2 100644 --- a/v2/docs/ConsumptionEntry.md +++ b/v2/docs/ConsumptionEntry.md @@ -9,11 +9,13 @@ Name | Type | Description | Notes **FromDate** | Pointer to **string** | The beginning of the time period, in ISO 8601 date-time format. | [optional] **Operation** | Pointer to **string** | The API call that triggered the resource consumption (for example, `RunInstances` or `CreateVolume`). | [optional] **PayingAccountId** | Pointer to **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** | Pointer to **float64** | The total price of the consumed resource during the specified time period, in the currency of the catalog of the Region where the API method was used. | [optional] **Service** | Pointer to **string** | The service of the API call (`TinaOS-FCU`, `TinaOS-LBU`, `TinaOS-DirectLink`, `TinaOS-OOS`, or `TinaOS-OSU`). | [optional] **SubregionName** | Pointer to **string** | The name of the Subregion. | [optional] **Title** | Pointer to **string** | A description of the consumed resource. | [optional] **ToDate** | Pointer to **string** | The end of the time period, in ISO 8601 date-time format. | [optional] **Type** | Pointer to **string** | The type of resource, depending on the API call. | [optional] +**UnitPrice** | Pointer to **float64** | The unit price of the consumed resource, in the currency of the catalog of the Region where the API method was used. | [optional] **Value** | Pointer to **float64** | The consumed amount for the resource. The unit depends on the resource type. For more information, see the `Title` element. | [optional] ## Methods @@ -160,6 +162,31 @@ SetPayingAccountId sets PayingAccountId field to given value. HasPayingAccountId returns a boolean if a field has been set. +### GetPrice + +`func (o *ConsumptionEntry) GetPrice() float64` + +GetPrice returns the Price field if non-nil, zero value otherwise. + +### GetPriceOk + +`func (o *ConsumptionEntry) GetPriceOk() (*float64, bool)` + +GetPriceOk returns a tuple with the Price field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrice + +`func (o *ConsumptionEntry) SetPrice(v float64)` + +SetPrice sets Price field to given value. + +### HasPrice + +`func (o *ConsumptionEntry) HasPrice() bool` + +HasPrice returns a boolean if a field has been set. + ### GetService `func (o *ConsumptionEntry) GetService() string` @@ -285,6 +312,31 @@ SetType sets Type field to given value. HasType returns a boolean if a field has been set. +### GetUnitPrice + +`func (o *ConsumptionEntry) GetUnitPrice() float64` + +GetUnitPrice returns the UnitPrice field if non-nil, zero value otherwise. + +### GetUnitPriceOk + +`func (o *ConsumptionEntry) GetUnitPriceOk() (*float64, bool)` + +GetUnitPriceOk returns a tuple with the UnitPrice field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnitPrice + +`func (o *ConsumptionEntry) SetUnitPrice(v float64)` + +SetUnitPrice sets UnitPrice field to given value. + +### HasUnitPrice + +`func (o *ConsumptionEntry) HasUnitPrice() bool` + +HasUnitPrice returns a boolean if a field has been set. + ### GetValue `func (o *ConsumptionEntry) GetValue() float64` diff --git a/v2/docs/CreateClientGatewayRequest.md b/v2/docs/CreateClientGatewayRequest.md index 6d1579a1a..ba766821d 100644 --- a/v2/docs/CreateClientGatewayRequest.md +++ b/v2/docs/CreateClientGatewayRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**BgpAsn** | **int32** | The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your client gateway through the Internet. This number must be between `1` and `4294967295`. | +**BgpAsn** | **int32** | 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. | **ConnectionType** | **string** | The communication protocol used to establish tunnel with your client gateway (only `ipsec.1` is supported). | **DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] **PublicIp** | **string** | The public fixed IPv4 address of your client gateway. | diff --git a/v2/docs/CreateDedicatedGroupRequest.md b/v2/docs/CreateDedicatedGroupRequest.md new file mode 100644 index 000000000..7f0e69241 --- /dev/null +++ b/v2/docs/CreateDedicatedGroupRequest.md @@ -0,0 +1,119 @@ +# CreateDedicatedGroupRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CpuGeneration** | **int32** | The processor generation for the VMs in the dedicated group (for example, `4`). | +**DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] +**Name** | **string** | A name for the dedicated group. | +**SubregionName** | **string** | The Subregion in which you want to create the dedicated group. | + +## Methods + +### NewCreateDedicatedGroupRequest + +`func NewCreateDedicatedGroupRequest(cpuGeneration int32, name string, subregionName string, ) *CreateDedicatedGroupRequest` + +NewCreateDedicatedGroupRequest instantiates a new CreateDedicatedGroupRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCreateDedicatedGroupRequestWithDefaults + +`func NewCreateDedicatedGroupRequestWithDefaults() *CreateDedicatedGroupRequest` + +NewCreateDedicatedGroupRequestWithDefaults instantiates a new CreateDedicatedGroupRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCpuGeneration + +`func (o *CreateDedicatedGroupRequest) GetCpuGeneration() int32` + +GetCpuGeneration returns the CpuGeneration field if non-nil, zero value otherwise. + +### GetCpuGenerationOk + +`func (o *CreateDedicatedGroupRequest) GetCpuGenerationOk() (*int32, bool)` + +GetCpuGenerationOk returns a tuple with the CpuGeneration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCpuGeneration + +`func (o *CreateDedicatedGroupRequest) SetCpuGeneration(v int32)` + +SetCpuGeneration sets CpuGeneration field to given value. + + +### GetDryRun + +`func (o *CreateDedicatedGroupRequest) GetDryRun() bool` + +GetDryRun returns the DryRun field if non-nil, zero value otherwise. + +### GetDryRunOk + +`func (o *CreateDedicatedGroupRequest) GetDryRunOk() (*bool, bool)` + +GetDryRunOk returns a tuple with the DryRun field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDryRun + +`func (o *CreateDedicatedGroupRequest) SetDryRun(v bool)` + +SetDryRun sets DryRun field to given value. + +### HasDryRun + +`func (o *CreateDedicatedGroupRequest) HasDryRun() bool` + +HasDryRun returns a boolean if a field has been set. + +### GetName + +`func (o *CreateDedicatedGroupRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreateDedicatedGroupRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CreateDedicatedGroupRequest) SetName(v string)` + +SetName sets Name field to given value. + + +### GetSubregionName + +`func (o *CreateDedicatedGroupRequest) GetSubregionName() string` + +GetSubregionName returns the SubregionName field if non-nil, zero value otherwise. + +### GetSubregionNameOk + +`func (o *CreateDedicatedGroupRequest) GetSubregionNameOk() (*string, bool)` + +GetSubregionNameOk returns a tuple with the SubregionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubregionName + +`func (o *CreateDedicatedGroupRequest) SetSubregionName(v string)` + +SetSubregionName sets SubregionName field to given value. + + + +[[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/v2/docs/CreateDedicatedGroupResponse.md b/v2/docs/CreateDedicatedGroupResponse.md new file mode 100644 index 000000000..1fe7d9ae3 --- /dev/null +++ b/v2/docs/CreateDedicatedGroupResponse.md @@ -0,0 +1,82 @@ +# CreateDedicatedGroupResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DedicatedGroup** | Pointer to [**DedicatedGroup**](DedicatedGroup.md) | | [optional] +**ResponseContext** | Pointer to [**ResponseContext**](ResponseContext.md) | | [optional] + +## Methods + +### NewCreateDedicatedGroupResponse + +`func NewCreateDedicatedGroupResponse() *CreateDedicatedGroupResponse` + +NewCreateDedicatedGroupResponse instantiates a new CreateDedicatedGroupResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCreateDedicatedGroupResponseWithDefaults + +`func NewCreateDedicatedGroupResponseWithDefaults() *CreateDedicatedGroupResponse` + +NewCreateDedicatedGroupResponseWithDefaults instantiates a new CreateDedicatedGroupResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDedicatedGroup + +`func (o *CreateDedicatedGroupResponse) GetDedicatedGroup() DedicatedGroup` + +GetDedicatedGroup returns the DedicatedGroup field if non-nil, zero value otherwise. + +### GetDedicatedGroupOk + +`func (o *CreateDedicatedGroupResponse) GetDedicatedGroupOk() (*DedicatedGroup, bool)` + +GetDedicatedGroupOk returns a tuple with the DedicatedGroup field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDedicatedGroup + +`func (o *CreateDedicatedGroupResponse) SetDedicatedGroup(v DedicatedGroup)` + +SetDedicatedGroup sets DedicatedGroup field to given value. + +### HasDedicatedGroup + +`func (o *CreateDedicatedGroupResponse) HasDedicatedGroup() bool` + +HasDedicatedGroup returns a boolean if a field has been set. + +### GetResponseContext + +`func (o *CreateDedicatedGroupResponse) GetResponseContext() ResponseContext` + +GetResponseContext returns the ResponseContext field if non-nil, zero value otherwise. + +### GetResponseContextOk + +`func (o *CreateDedicatedGroupResponse) GetResponseContextOk() (*ResponseContext, bool)` + +GetResponseContextOk returns a tuple with the ResponseContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseContext + +`func (o *CreateDedicatedGroupResponse) SetResponseContext(v ResponseContext)` + +SetResponseContext sets ResponseContext field to given value. + +### HasResponseContext + +`func (o *CreateDedicatedGroupResponse) HasResponseContext() bool` + +HasResponseContext returns a boolean if a field has been set. + + +[[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/v2/docs/CreateImageRequest.md b/v2/docs/CreateImageRequest.md index 0ddd12e47..40ccf9611 100644 --- a/v2/docs/CreateImageRequest.md +++ b/v2/docs/CreateImageRequest.md @@ -4,18 +4,18 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Architecture** | Pointer to **string** | The architecture of the OMI (by default, `i386` if you specified the `FileLocation` or `RootDeviceName` parameter). | [optional] -**BlockDeviceMappings** | Pointer to [**[]BlockDeviceMappingImage**](BlockDeviceMappingImage.md) | One or more block device mappings. | [optional] +**Architecture** | Pointer to **string** | **(when registering from a snapshot, or from a bucket without using a manifest file)** The architecture of the OMI (`i386` or `x84_64`). | [optional] +**BlockDeviceMappings** | Pointer to [**[]BlockDeviceMappingImage**](BlockDeviceMappingImage.md) | **(when registering from a snapshot, or from a bucket without using a manifest file)** One or more block device mappings. | [optional] **Description** | Pointer to **string** | A description for the new OMI. | [optional] **DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] -**FileLocation** | Pointer to **string** | The pre-signed URL of the OMI manifest file, or the full path to the OMI stored in a bucket. If you specify this parameter, a copy of the OMI is created in your account. You must specify only one of the following parameters: `FileLocation`, `RootDeviceName`, `SourceImageId` or `VmId`. | [optional] -**ImageName** | Pointer to **string** | A unique name for the new OMI.<br /> Constraints: 3-128 alphanumeric characters, underscores (_), spaces ( ), parentheses (()), slashes (/), periods (.), or dashes (-). | [optional] -**NoReboot** | Pointer to **bool** | If false, the VM shuts down before creating the OMI and then reboots. If true, the VM does not. | [optional] +**FileLocation** | Pointer to **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] +**ImageName** | Pointer to **string** | A unique name for the new OMI.<br /> Constraints: 3-128 alphanumeric characters, underscores (`_`), spaces (` `), parentheses (`()`), slashes (`/`), periods (`.`), or dashes (`-`). | [optional] +**NoReboot** | Pointer to **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] **ProductCodes** | Pointer to **[]string** | The product codes associated with the OMI. | [optional] -**RootDeviceName** | Pointer to **string** | The name of the root device. You must specify only one of the following parameters: `FileLocation`, `RootDeviceName`, `SourceImageId` or `VmId`. | [optional] -**SourceImageId** | Pointer to **string** | The ID of the OMI you want to copy. You must specify only one of the following parameters: `FileLocation`, `RootDeviceName`, `SourceImageId` or `VmId`. | [optional] -**SourceRegionName** | Pointer to **string** | The name of the source Region, which must be the same as the Region of your account. | [optional] -**VmId** | Pointer to **string** | The ID of the VM from which you want to create the OMI. You must specify only one of the following parameters: `FileLocation`, `RootDeviceName`, `SourceImageId` or `VmId`. | [optional] +**RootDeviceName** | Pointer to **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] +**SourceImageId** | Pointer to **string** | **(when copying an OMI)** The ID of the OMI you want to copy. | [optional] +**SourceRegionName** | Pointer to **string** | **(when copying an OMI)** The name of the source Region (always the same as the Region of your account). | [optional] +**VmId** | Pointer to **string** | **(when creating from a VM)** The ID of the VM from which you want to create the OMI. | [optional] ## Methods diff --git a/v2/docs/CreateKeypairRequest.md b/v2/docs/CreateKeypairRequest.md index 6434a6346..0b17439f5 100644 --- a/v2/docs/CreateKeypairRequest.md +++ b/v2/docs/CreateKeypairRequest.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] **KeypairName** | **string** | A unique name for the keypair, with a maximum length of 255 [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#Printable_characters). | -**PublicKey** | Pointer to **string** | The public key. It must be Base64-encoded. | [optional] +**PublicKey** | Pointer to **string** | The public key to import in your account, if you are importing an existing keypair. This value must be Base64-encoded. | [optional] ## Methods diff --git a/v2/docs/CreateNetRequest.md b/v2/docs/CreateNetRequest.md index 77e9c92a2..9a194ad6d 100644 --- a/v2/docs/CreateNetRequest.md +++ b/v2/docs/CreateNetRequest.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] **IpRange** | **string** | The IP range for the Net, in CIDR notation (for example, `10.0.0.0/16`). | -**Tenancy** | Pointer to **string** | The tenancy options for the VMs (`default` if a VM created in a Net can be launched with any tenancy, `dedicated` if it can be launched with dedicated tenancy VMs running on single-tenant hardware). | [optional] +**Tenancy** | Pointer to **string** | The tenancy options for the VMs:<br /> - `default` if a VM created in a Net can be launched with any tenancy.<br /> - `dedicated` if it can be launched with dedicated tenancy VMs running on single-tenant hardware.<br /> - `dedicated group ID`: if it can be launched in a dedicated group on single-tenant hardware. | [optional] ## Methods diff --git a/v2/docs/CreatePolicyRequest.md b/v2/docs/CreatePolicyRequest.md new file mode 100644 index 000000000..579efb3eb --- /dev/null +++ b/v2/docs/CreatePolicyRequest.md @@ -0,0 +1,150 @@ +# CreatePolicyRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **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). | +**DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] +**Path** | Pointer to **string** | The path of the policy. | [optional] +**PolicyName** | **string** | The name of the policy. | + +## Methods + +### NewCreatePolicyRequest + +`func NewCreatePolicyRequest(document string, policyName string, ) *CreatePolicyRequest` + +NewCreatePolicyRequest instantiates a new CreatePolicyRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCreatePolicyRequestWithDefaults + +`func NewCreatePolicyRequestWithDefaults() *CreatePolicyRequest` + +NewCreatePolicyRequestWithDefaults instantiates a new CreatePolicyRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDescription + +`func (o *CreatePolicyRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CreatePolicyRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CreatePolicyRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *CreatePolicyRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetDocument + +`func (o *CreatePolicyRequest) GetDocument() string` + +GetDocument returns the Document field if non-nil, zero value otherwise. + +### GetDocumentOk + +`func (o *CreatePolicyRequest) GetDocumentOk() (*string, bool)` + +GetDocumentOk returns a tuple with the Document field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDocument + +`func (o *CreatePolicyRequest) SetDocument(v string)` + +SetDocument sets Document field to given value. + + +### GetDryRun + +`func (o *CreatePolicyRequest) GetDryRun() bool` + +GetDryRun returns the DryRun field if non-nil, zero value otherwise. + +### GetDryRunOk + +`func (o *CreatePolicyRequest) GetDryRunOk() (*bool, bool)` + +GetDryRunOk returns a tuple with the DryRun field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDryRun + +`func (o *CreatePolicyRequest) SetDryRun(v bool)` + +SetDryRun sets DryRun field to given value. + +### HasDryRun + +`func (o *CreatePolicyRequest) HasDryRun() bool` + +HasDryRun returns a boolean if a field has been set. + +### GetPath + +`func (o *CreatePolicyRequest) GetPath() string` + +GetPath returns the Path field if non-nil, zero value otherwise. + +### GetPathOk + +`func (o *CreatePolicyRequest) GetPathOk() (*string, bool)` + +GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPath + +`func (o *CreatePolicyRequest) SetPath(v string)` + +SetPath sets Path field to given value. + +### HasPath + +`func (o *CreatePolicyRequest) HasPath() bool` + +HasPath returns a boolean if a field has been set. + +### GetPolicyName + +`func (o *CreatePolicyRequest) GetPolicyName() string` + +GetPolicyName returns the PolicyName field if non-nil, zero value otherwise. + +### GetPolicyNameOk + +`func (o *CreatePolicyRequest) GetPolicyNameOk() (*string, bool)` + +GetPolicyNameOk returns a tuple with the PolicyName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicyName + +`func (o *CreatePolicyRequest) SetPolicyName(v string)` + +SetPolicyName sets PolicyName field to given value. + + + +[[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/v2/docs/CreatePolicyResponse.md b/v2/docs/CreatePolicyResponse.md new file mode 100644 index 000000000..070383abd --- /dev/null +++ b/v2/docs/CreatePolicyResponse.md @@ -0,0 +1,82 @@ +# CreatePolicyResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Policy** | Pointer to [**Policy**](Policy.md) | | [optional] +**ResponseContext** | Pointer to [**ResponseContext**](ResponseContext.md) | | [optional] + +## Methods + +### NewCreatePolicyResponse + +`func NewCreatePolicyResponse() *CreatePolicyResponse` + +NewCreatePolicyResponse instantiates a new CreatePolicyResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCreatePolicyResponseWithDefaults + +`func NewCreatePolicyResponseWithDefaults() *CreatePolicyResponse` + +NewCreatePolicyResponseWithDefaults instantiates a new CreatePolicyResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetPolicy + +`func (o *CreatePolicyResponse) GetPolicy() Policy` + +GetPolicy returns the Policy field if non-nil, zero value otherwise. + +### GetPolicyOk + +`func (o *CreatePolicyResponse) GetPolicyOk() (*Policy, bool)` + +GetPolicyOk returns a tuple with the Policy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicy + +`func (o *CreatePolicyResponse) SetPolicy(v Policy)` + +SetPolicy sets Policy field to given value. + +### HasPolicy + +`func (o *CreatePolicyResponse) HasPolicy() bool` + +HasPolicy returns a boolean if a field has been set. + +### GetResponseContext + +`func (o *CreatePolicyResponse) GetResponseContext() ResponseContext` + +GetResponseContext returns the ResponseContext field if non-nil, zero value otherwise. + +### GetResponseContextOk + +`func (o *CreatePolicyResponse) GetResponseContextOk() (*ResponseContext, bool)` + +GetResponseContextOk returns a tuple with the ResponseContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseContext + +`func (o *CreatePolicyResponse) SetResponseContext(v ResponseContext)` + +SetResponseContext sets ResponseContext field to given value. + +### HasResponseContext + +`func (o *CreatePolicyResponse) HasResponseContext() bool` + +HasResponseContext returns a boolean if a field has been set. + + +[[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/v2/docs/CreatePolicyVersionRequest.md b/v2/docs/CreatePolicyVersionRequest.md new file mode 100644 index 000000000..14c14b330 --- /dev/null +++ b/v2/docs/CreatePolicyVersionRequest.md @@ -0,0 +1,98 @@ +# CreatePolicyVersionRequest + +## Properties + +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). | +**PolicyOrn** | **string** | The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). | +**SetAsDefault** | Pointer to **bool** | If set to true, the new policy version is set as the default version and becomes the operative one. | [optional] + +## Methods + +### NewCreatePolicyVersionRequest + +`func NewCreatePolicyVersionRequest(document string, policyOrn string, ) *CreatePolicyVersionRequest` + +NewCreatePolicyVersionRequest instantiates a new CreatePolicyVersionRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCreatePolicyVersionRequestWithDefaults + +`func NewCreatePolicyVersionRequestWithDefaults() *CreatePolicyVersionRequest` + +NewCreatePolicyVersionRequestWithDefaults instantiates a new CreatePolicyVersionRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDocument + +`func (o *CreatePolicyVersionRequest) GetDocument() string` + +GetDocument returns the Document field if non-nil, zero value otherwise. + +### GetDocumentOk + +`func (o *CreatePolicyVersionRequest) GetDocumentOk() (*string, bool)` + +GetDocumentOk returns a tuple with the Document field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDocument + +`func (o *CreatePolicyVersionRequest) SetDocument(v string)` + +SetDocument sets Document field to given value. + + +### GetPolicyOrn + +`func (o *CreatePolicyVersionRequest) GetPolicyOrn() string` + +GetPolicyOrn returns the PolicyOrn field if non-nil, zero value otherwise. + +### GetPolicyOrnOk + +`func (o *CreatePolicyVersionRequest) GetPolicyOrnOk() (*string, bool)` + +GetPolicyOrnOk returns a tuple with the PolicyOrn field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicyOrn + +`func (o *CreatePolicyVersionRequest) SetPolicyOrn(v string)` + +SetPolicyOrn sets PolicyOrn field to given value. + + +### GetSetAsDefault + +`func (o *CreatePolicyVersionRequest) GetSetAsDefault() bool` + +GetSetAsDefault returns the SetAsDefault field if non-nil, zero value otherwise. + +### GetSetAsDefaultOk + +`func (o *CreatePolicyVersionRequest) GetSetAsDefaultOk() (*bool, bool)` + +GetSetAsDefaultOk returns a tuple with the SetAsDefault field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSetAsDefault + +`func (o *CreatePolicyVersionRequest) SetSetAsDefault(v bool)` + +SetSetAsDefault sets SetAsDefault field to given value. + +### HasSetAsDefault + +`func (o *CreatePolicyVersionRequest) HasSetAsDefault() bool` + +HasSetAsDefault returns a boolean if a field has been set. + + +[[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/v2/docs/CreatePolicyVersionResponse.md b/v2/docs/CreatePolicyVersionResponse.md new file mode 100644 index 000000000..9f326a755 --- /dev/null +++ b/v2/docs/CreatePolicyVersionResponse.md @@ -0,0 +1,82 @@ +# CreatePolicyVersionResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PolicyVersion** | Pointer to [**PolicyVersion**](PolicyVersion.md) | | [optional] +**ResponseContext** | Pointer to [**ResponseContext**](ResponseContext.md) | | [optional] + +## Methods + +### NewCreatePolicyVersionResponse + +`func NewCreatePolicyVersionResponse() *CreatePolicyVersionResponse` + +NewCreatePolicyVersionResponse instantiates a new CreatePolicyVersionResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCreatePolicyVersionResponseWithDefaults + +`func NewCreatePolicyVersionResponseWithDefaults() *CreatePolicyVersionResponse` + +NewCreatePolicyVersionResponseWithDefaults instantiates a new CreatePolicyVersionResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetPolicyVersion + +`func (o *CreatePolicyVersionResponse) GetPolicyVersion() PolicyVersion` + +GetPolicyVersion returns the PolicyVersion field if non-nil, zero value otherwise. + +### GetPolicyVersionOk + +`func (o *CreatePolicyVersionResponse) GetPolicyVersionOk() (*PolicyVersion, bool)` + +GetPolicyVersionOk returns a tuple with the PolicyVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicyVersion + +`func (o *CreatePolicyVersionResponse) SetPolicyVersion(v PolicyVersion)` + +SetPolicyVersion sets PolicyVersion field to given value. + +### HasPolicyVersion + +`func (o *CreatePolicyVersionResponse) HasPolicyVersion() bool` + +HasPolicyVersion returns a boolean if a field has been set. + +### GetResponseContext + +`func (o *CreatePolicyVersionResponse) GetResponseContext() ResponseContext` + +GetResponseContext returns the ResponseContext field if non-nil, zero value otherwise. + +### GetResponseContextOk + +`func (o *CreatePolicyVersionResponse) GetResponseContextOk() (*ResponseContext, bool)` + +GetResponseContextOk returns a tuple with the ResponseContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseContext + +`func (o *CreatePolicyVersionResponse) SetResponseContext(v ResponseContext)` + +SetResponseContext sets ResponseContext field to given value. + +### HasResponseContext + +`func (o *CreatePolicyVersionResponse) HasResponseContext() bool` + +HasResponseContext returns a boolean if a field has been set. + + +[[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/v2/docs/CreateProductTypeRequest.md b/v2/docs/CreateProductTypeRequest.md new file mode 100644 index 000000000..69a9c8d03 --- /dev/null +++ b/v2/docs/CreateProductTypeRequest.md @@ -0,0 +1,103 @@ +# CreateProductTypeRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | **string** | The description of the product type. | +**DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] +**Vendor** | Pointer to **string** | The vendor of the product type. | [optional] + +## Methods + +### NewCreateProductTypeRequest + +`func NewCreateProductTypeRequest(description string, ) *CreateProductTypeRequest` + +NewCreateProductTypeRequest instantiates a new CreateProductTypeRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCreateProductTypeRequestWithDefaults + +`func NewCreateProductTypeRequestWithDefaults() *CreateProductTypeRequest` + +NewCreateProductTypeRequestWithDefaults instantiates a new CreateProductTypeRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDescription + +`func (o *CreateProductTypeRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CreateProductTypeRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CreateProductTypeRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetDryRun + +`func (o *CreateProductTypeRequest) GetDryRun() bool` + +GetDryRun returns the DryRun field if non-nil, zero value otherwise. + +### GetDryRunOk + +`func (o *CreateProductTypeRequest) GetDryRunOk() (*bool, bool)` + +GetDryRunOk returns a tuple with the DryRun field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDryRun + +`func (o *CreateProductTypeRequest) SetDryRun(v bool)` + +SetDryRun sets DryRun field to given value. + +### HasDryRun + +`func (o *CreateProductTypeRequest) HasDryRun() bool` + +HasDryRun returns a boolean if a field has been set. + +### GetVendor + +`func (o *CreateProductTypeRequest) GetVendor() string` + +GetVendor returns the Vendor field if non-nil, zero value otherwise. + +### GetVendorOk + +`func (o *CreateProductTypeRequest) GetVendorOk() (*string, bool)` + +GetVendorOk returns a tuple with the Vendor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVendor + +`func (o *CreateProductTypeRequest) SetVendor(v string)` + +SetVendor sets Vendor field to given value. + +### HasVendor + +`func (o *CreateProductTypeRequest) HasVendor() bool` + +HasVendor returns a boolean if a field has been set. + + +[[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/v2/docs/CreateProductTypeResponse.md b/v2/docs/CreateProductTypeResponse.md new file mode 100644 index 000000000..a222aa34d --- /dev/null +++ b/v2/docs/CreateProductTypeResponse.md @@ -0,0 +1,82 @@ +# CreateProductTypeResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ProductType** | Pointer to [**ProductType**](ProductType.md) | | [optional] +**ResponseContext** | Pointer to [**ResponseContext**](ResponseContext.md) | | [optional] + +## Methods + +### NewCreateProductTypeResponse + +`func NewCreateProductTypeResponse() *CreateProductTypeResponse` + +NewCreateProductTypeResponse instantiates a new CreateProductTypeResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCreateProductTypeResponseWithDefaults + +`func NewCreateProductTypeResponseWithDefaults() *CreateProductTypeResponse` + +NewCreateProductTypeResponseWithDefaults instantiates a new CreateProductTypeResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetProductType + +`func (o *CreateProductTypeResponse) GetProductType() ProductType` + +GetProductType returns the ProductType field if non-nil, zero value otherwise. + +### GetProductTypeOk + +`func (o *CreateProductTypeResponse) GetProductTypeOk() (*ProductType, bool)` + +GetProductTypeOk returns a tuple with the ProductType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProductType + +`func (o *CreateProductTypeResponse) SetProductType(v ProductType)` + +SetProductType sets ProductType field to given value. + +### HasProductType + +`func (o *CreateProductTypeResponse) HasProductType() bool` + +HasProductType returns a boolean if a field has been set. + +### GetResponseContext + +`func (o *CreateProductTypeResponse) GetResponseContext() ResponseContext` + +GetResponseContext returns the ResponseContext field if non-nil, zero value otherwise. + +### GetResponseContextOk + +`func (o *CreateProductTypeResponse) GetResponseContextOk() (*ResponseContext, bool)` + +GetResponseContextOk returns a tuple with the ResponseContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseContext + +`func (o *CreateProductTypeResponse) SetResponseContext(v ResponseContext)` + +SetResponseContext sets ResponseContext field to given value. + +### HasResponseContext + +`func (o *CreateProductTypeResponse) HasResponseContext() bool` + +HasResponseContext returns a boolean if a field has been set. + + +[[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/v2/docs/CreateSecurityGroupRequest.md b/v2/docs/CreateSecurityGroupRequest.md index 726ef82bc..9bde30aca 100644 --- a/v2/docs/CreateSecurityGroupRequest.md +++ b/v2/docs/CreateSecurityGroupRequest.md @@ -4,10 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Description** | **string** | A description for the security group, with a maximum length of 255 [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#Printable_characters). | +**Description** | **string** | A description for the security group.<br /> This description can contain between 1 and 255 characters. Allowed characters are `a-z`, `A-Z`, `0-9`, accented letters, spaces, and `_.-:/()#,@[]+=&;{}!$*`. | **DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] **NetId** | Pointer to **string** | The ID of the Net for the security group. | [optional] -**SecurityGroupName** | **string** | The name of the security group.<br /> This name must not start with `sg-`.</br> This name must be unique and contain between 1 and 255 ASCII characters. Accented letters are not allowed. | +**SecurityGroupName** | **string** | The name of the security group.<br /> This name must not start with `sg-`.<br /> This name must be unique and contain between 1 and 255 characters. Allowed characters are `a-z`, `A-Z`, `0-9`, spaces, and `_.-:/()#,@[]+=&;{}!$*`. | ## Methods diff --git a/v2/docs/CreateSnapshotRequest.md b/v2/docs/CreateSnapshotRequest.md index a6a179315..3740b81e3 100644 --- a/v2/docs/CreateSnapshotRequest.md +++ b/v2/docs/CreateSnapshotRequest.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Description** | Pointer to **string** | A description for the snapshot. | [optional] **DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] -**FileLocation** | Pointer to **string** | (When importing) 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] -**SnapshotSize** | Pointer to **int64** | (When importing) 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] -**SourceRegionName** | Pointer to **string** | (When copying) The name of the source Region, which must be the same as the Region of your account. | [optional] -**SourceSnapshotId** | Pointer to **string** | (When copying) The ID of the snapshot you want to copy. | [optional] -**VolumeId** | Pointer to **string** | (When creating) The ID of the volume you want to create a snapshot of. | [optional] +**FileLocation** | Pointer to **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] +**SnapshotSize** | Pointer to **int64** | **(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] +**SourceRegionName** | Pointer to **string** | **(when copying a snapshot)** The name of the source Region, which must be the same as the Region of your account. | [optional] +**SourceSnapshotId** | Pointer to **string** | **(when copying a snapshot)** The ID of the snapshot you want to copy. | [optional] +**VolumeId** | Pointer to **string** | **(when creating from a volume)** The ID of the volume you want to create a snapshot of. | [optional] ## Methods diff --git a/v2/docs/CreateSubnetRequest.md b/v2/docs/CreateSubnetRequest.md index 25faeb965..75cf6d72a 100644 --- a/v2/docs/CreateSubnetRequest.md +++ b/v2/docs/CreateSubnetRequest.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] -**IpRange** | **string** | The IP range in the Subnet, in CIDR notation (for example, `10.0.0.0/16`).<br /> The IP range of the Subnet can be either the same as the Net one if you create only a single Subnet in this Net, or a subset of the Net one. In case of several Subnets in a Net, their IP ranges must not overlap. The smallest Subnet you can create uses a /29 netmask (eight IPs). For more information, see [About VPCs](https://docs.outscale.com/en/userguide/About-VPCs.html). | +**IpRange** | **string** | The IP range in the Subnet, in CIDR notation (for example, `10.0.0.0/16`).<br /> The IP range of the Subnet can be either the same as the Net one if you create only a single Subnet in this Net, or a subset of the Net one. In case of several Subnets in a Net, their IP ranges must not overlap. The smallest Subnet you can create uses a /29 netmask (eight IPs). For more information, see [About Nets](https://docs.outscale.com/en/userguide/About-Nets.html). | **NetId** | **string** | The ID of the Net for which you want to create a Subnet. | **SubregionName** | Pointer to **string** | The name of the Subregion in which you want to create the Subnet. | [optional] diff --git a/v2/docs/CreateUserRequest.md b/v2/docs/CreateUserRequest.md index c0d1727b9..43a9e6615 100644 --- a/v2/docs/CreateUserRequest.md +++ b/v2/docs/CreateUserRequest.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] -**Path** | Pointer to **string** | The path to the EIM user you want to create (by default, `/`). | [optional] -**UserName** | **string** | The name of the EIM user you want to create. | +**Path** | Pointer to **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] +**UserName** | **string** | The name of the EIM user you want to create. This user name must contain between 1 and 64 alphanumeric characters and/or pluses (+), equals (=), commas (,), periods (.), at signs (@), dashes (-), or underscores (_). | ## Methods diff --git a/v2/docs/CreateVmsRequest.md b/v2/docs/CreateVmsRequest.md index a780e7a7b..b1d08cfa1 100644 --- a/v2/docs/CreateVmsRequest.md +++ b/v2/docs/CreateVmsRequest.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes **SubnetId** | Pointer to **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] **UserData** | Pointer to **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] **VmInitiatedShutdownBehavior** | Pointer to **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"] -**VmType** | Pointer to **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 [Instance Types](https://docs.outscale.com/en/userguide/Instance-Types.html). | [optional] +**VmType** | Pointer to **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] ## Methods diff --git a/v2/docs/CreateVpnConnectionRequest.md b/v2/docs/CreateVpnConnectionRequest.md index 86e2ab273..8dd246ef7 100644 --- a/v2/docs/CreateVpnConnectionRequest.md +++ b/v2/docs/CreateVpnConnectionRequest.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **ClientGatewayId** | **string** | The ID of the client gateway. | **ConnectionType** | **string** | The type of VPN connection (only `ipsec.1` is supported). | **DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] -**StaticRoutesOnly** | Pointer to **bool** | 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). | [optional] +**StaticRoutesOnly** | Pointer to **bool** | 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). | [optional] **VirtualGatewayId** | **string** | The ID of the virtual gateway. | ## Methods diff --git a/v2/docs/DedicatedGroup.md b/v2/docs/DedicatedGroup.md new file mode 100644 index 000000000..0809adbbe --- /dev/null +++ b/v2/docs/DedicatedGroup.md @@ -0,0 +1,212 @@ +# DedicatedGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountId** | Pointer to **string** | The account ID of the owners of the dedicated group. | [optional] +**CpuGeneration** | Pointer to **int32** | The processor generation. | [optional] +**DedicatedGroupId** | Pointer to **string** | The ID of the dedicated group. | [optional] +**Name** | Pointer to **string** | The name of the dedicated group. | [optional] +**NetIds** | Pointer to **[]string** | The IDs of the Nets in the dedicated group. | [optional] +**SubregionName** | Pointer to **string** | The name of the Subregion in which the dedicated group is located. | [optional] +**VmIds** | Pointer to **[]string** | The IDs of the VMs in the dedicated group. | [optional] + +## Methods + +### NewDedicatedGroup + +`func NewDedicatedGroup() *DedicatedGroup` + +NewDedicatedGroup instantiates a new DedicatedGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDedicatedGroupWithDefaults + +`func NewDedicatedGroupWithDefaults() *DedicatedGroup` + +NewDedicatedGroupWithDefaults instantiates a new DedicatedGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAccountId + +`func (o *DedicatedGroup) GetAccountId() string` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *DedicatedGroup) GetAccountIdOk() (*string, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountId + +`func (o *DedicatedGroup) SetAccountId(v string)` + +SetAccountId sets AccountId field to given value. + +### HasAccountId + +`func (o *DedicatedGroup) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### GetCpuGeneration + +`func (o *DedicatedGroup) GetCpuGeneration() int32` + +GetCpuGeneration returns the CpuGeneration field if non-nil, zero value otherwise. + +### GetCpuGenerationOk + +`func (o *DedicatedGroup) GetCpuGenerationOk() (*int32, bool)` + +GetCpuGenerationOk returns a tuple with the CpuGeneration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCpuGeneration + +`func (o *DedicatedGroup) SetCpuGeneration(v int32)` + +SetCpuGeneration sets CpuGeneration field to given value. + +### HasCpuGeneration + +`func (o *DedicatedGroup) HasCpuGeneration() bool` + +HasCpuGeneration returns a boolean if a field has been set. + +### GetDedicatedGroupId + +`func (o *DedicatedGroup) GetDedicatedGroupId() string` + +GetDedicatedGroupId returns the DedicatedGroupId field if non-nil, zero value otherwise. + +### GetDedicatedGroupIdOk + +`func (o *DedicatedGroup) GetDedicatedGroupIdOk() (*string, bool)` + +GetDedicatedGroupIdOk returns a tuple with the DedicatedGroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDedicatedGroupId + +`func (o *DedicatedGroup) SetDedicatedGroupId(v string)` + +SetDedicatedGroupId sets DedicatedGroupId field to given value. + +### HasDedicatedGroupId + +`func (o *DedicatedGroup) HasDedicatedGroupId() bool` + +HasDedicatedGroupId returns a boolean if a field has been set. + +### GetName + +`func (o *DedicatedGroup) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *DedicatedGroup) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *DedicatedGroup) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *DedicatedGroup) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetNetIds + +`func (o *DedicatedGroup) GetNetIds() []string` + +GetNetIds returns the NetIds field if non-nil, zero value otherwise. + +### GetNetIdsOk + +`func (o *DedicatedGroup) GetNetIdsOk() (*[]string, bool)` + +GetNetIdsOk returns a tuple with the NetIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNetIds + +`func (o *DedicatedGroup) SetNetIds(v []string)` + +SetNetIds sets NetIds field to given value. + +### HasNetIds + +`func (o *DedicatedGroup) HasNetIds() bool` + +HasNetIds returns a boolean if a field has been set. + +### GetSubregionName + +`func (o *DedicatedGroup) GetSubregionName() string` + +GetSubregionName returns the SubregionName field if non-nil, zero value otherwise. + +### GetSubregionNameOk + +`func (o *DedicatedGroup) GetSubregionNameOk() (*string, bool)` + +GetSubregionNameOk returns a tuple with the SubregionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubregionName + +`func (o *DedicatedGroup) SetSubregionName(v string)` + +SetSubregionName sets SubregionName field to given value. + +### HasSubregionName + +`func (o *DedicatedGroup) HasSubregionName() bool` + +HasSubregionName returns a boolean if a field has been set. + +### GetVmIds + +`func (o *DedicatedGroup) GetVmIds() []string` + +GetVmIds returns the VmIds field if non-nil, zero value otherwise. + +### GetVmIdsOk + +`func (o *DedicatedGroup) GetVmIdsOk() (*[]string, bool)` + +GetVmIdsOk returns a tuple with the VmIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVmIds + +`func (o *DedicatedGroup) SetVmIds(v []string)` + +SetVmIds sets VmIds field to given value. + +### HasVmIds + +`func (o *DedicatedGroup) HasVmIds() bool` + +HasVmIds returns a boolean if a field has been set. + + +[[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/v2/docs/DedicatedGroupApi.md b/v2/docs/DedicatedGroupApi.md new file mode 100644 index 000000000..f9fd475aa --- /dev/null +++ b/v2/docs/DedicatedGroupApi.md @@ -0,0 +1,268 @@ +# \DedicatedGroupApi + +All URIs are relative to *https://api.eu-west-2.outscale.com/api/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CreateDedicatedGroup**](DedicatedGroupApi.md#CreateDedicatedGroup) | **Post** /CreateDedicatedGroup | +[**DeleteDedicatedGroup**](DedicatedGroupApi.md#DeleteDedicatedGroup) | **Post** /DeleteDedicatedGroup | +[**ReadDedicatedGroups**](DedicatedGroupApi.md#ReadDedicatedGroups) | **Post** /ReadDedicatedGroups | +[**UpdateDedicatedGroup**](DedicatedGroupApi.md#UpdateDedicatedGroup) | **Post** /UpdateDedicatedGroup | + + + +## CreateDedicatedGroup + +> CreateDedicatedGroupResponse CreateDedicatedGroup(ctx).CreateDedicatedGroupRequest(createDedicatedGroupRequest).Execute() + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "./openapi" +) + +func main() { + createDedicatedGroupRequest := *openapiclient.NewCreateDedicatedGroupRequest(int32(123), "Name_example", "SubregionName_example") // CreateDedicatedGroupRequest | (optional) + + configuration := openapiclient.NewConfiguration() + api_client := openapiclient.NewAPIClient(configuration) + resp, r, err := api_client.DedicatedGroupApi.CreateDedicatedGroup(context.Background()).CreateDedicatedGroupRequest(createDedicatedGroupRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DedicatedGroupApi.CreateDedicatedGroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateDedicatedGroup`: CreateDedicatedGroupResponse + fmt.Fprintf(os.Stdout, "Response from `DedicatedGroupApi.CreateDedicatedGroup`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateDedicatedGroupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **createDedicatedGroupRequest** | [**CreateDedicatedGroupRequest**](CreateDedicatedGroupRequest.md) | | + +### Return type + +[**CreateDedicatedGroupResponse**](CreateDedicatedGroupResponse.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) + + +## DeleteDedicatedGroup + +> DeleteDedicatedGroupResponse DeleteDedicatedGroup(ctx).DeleteDedicatedGroupRequest(deleteDedicatedGroupRequest).Execute() + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "./openapi" +) + +func main() { + deleteDedicatedGroupRequest := *openapiclient.NewDeleteDedicatedGroupRequest("DedicatedGroupId_example") // DeleteDedicatedGroupRequest | (optional) + + configuration := openapiclient.NewConfiguration() + api_client := openapiclient.NewAPIClient(configuration) + resp, r, err := api_client.DedicatedGroupApi.DeleteDedicatedGroup(context.Background()).DeleteDedicatedGroupRequest(deleteDedicatedGroupRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DedicatedGroupApi.DeleteDedicatedGroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteDedicatedGroup`: DeleteDedicatedGroupResponse + fmt.Fprintf(os.Stdout, "Response from `DedicatedGroupApi.DeleteDedicatedGroup`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteDedicatedGroupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **deleteDedicatedGroupRequest** | [**DeleteDedicatedGroupRequest**](DeleteDedicatedGroupRequest.md) | | + +### Return type + +[**DeleteDedicatedGroupResponse**](DeleteDedicatedGroupResponse.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) + + +## ReadDedicatedGroups + +> ReadDedicatedGroupsResponse ReadDedicatedGroups(ctx).ReadDedicatedGroupsRequest(readDedicatedGroupsRequest).Execute() + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "./openapi" +) + +func main() { + readDedicatedGroupsRequest := *openapiclient.NewReadDedicatedGroupsRequest() // ReadDedicatedGroupsRequest | (optional) + + configuration := openapiclient.NewConfiguration() + api_client := openapiclient.NewAPIClient(configuration) + resp, r, err := api_client.DedicatedGroupApi.ReadDedicatedGroups(context.Background()).ReadDedicatedGroupsRequest(readDedicatedGroupsRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DedicatedGroupApi.ReadDedicatedGroups``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ReadDedicatedGroups`: ReadDedicatedGroupsResponse + fmt.Fprintf(os.Stdout, "Response from `DedicatedGroupApi.ReadDedicatedGroups`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiReadDedicatedGroupsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **readDedicatedGroupsRequest** | [**ReadDedicatedGroupsRequest**](ReadDedicatedGroupsRequest.md) | | + +### Return type + +[**ReadDedicatedGroupsResponse**](ReadDedicatedGroupsResponse.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) + + +## UpdateDedicatedGroup + +> UpdateDedicatedGroupResponse UpdateDedicatedGroup(ctx).UpdateDedicatedGroupRequest(updateDedicatedGroupRequest).Execute() + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "./openapi" +) + +func main() { + updateDedicatedGroupRequest := *openapiclient.NewUpdateDedicatedGroupRequest("DedicatedGroupId_example", "Name_example") // UpdateDedicatedGroupRequest | (optional) + + configuration := openapiclient.NewConfiguration() + api_client := openapiclient.NewAPIClient(configuration) + resp, r, err := api_client.DedicatedGroupApi.UpdateDedicatedGroup(context.Background()).UpdateDedicatedGroupRequest(updateDedicatedGroupRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DedicatedGroupApi.UpdateDedicatedGroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateDedicatedGroup`: UpdateDedicatedGroupResponse + fmt.Fprintf(os.Stdout, "Response from `DedicatedGroupApi.UpdateDedicatedGroup`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateDedicatedGroupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **updateDedicatedGroupRequest** | [**UpdateDedicatedGroupRequest**](UpdateDedicatedGroupRequest.md) | | + +### Return type + +[**UpdateDedicatedGroupResponse**](UpdateDedicatedGroupResponse.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/v2/docs/DeleteDedicatedGroupRequest.md b/v2/docs/DeleteDedicatedGroupRequest.md new file mode 100644 index 000000000..42440fccc --- /dev/null +++ b/v2/docs/DeleteDedicatedGroupRequest.md @@ -0,0 +1,103 @@ +# DeleteDedicatedGroupRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DedicatedGroupId** | **string** | The ID of the dedicated group you want to delete. | +**DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] +**Force** | Pointer to **bool** | If true, forces the deletion of the dedicated group and all its dependencies. | [optional] + +## Methods + +### NewDeleteDedicatedGroupRequest + +`func NewDeleteDedicatedGroupRequest(dedicatedGroupId string, ) *DeleteDedicatedGroupRequest` + +NewDeleteDedicatedGroupRequest instantiates a new DeleteDedicatedGroupRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDeleteDedicatedGroupRequestWithDefaults + +`func NewDeleteDedicatedGroupRequestWithDefaults() *DeleteDedicatedGroupRequest` + +NewDeleteDedicatedGroupRequestWithDefaults instantiates a new DeleteDedicatedGroupRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDedicatedGroupId + +`func (o *DeleteDedicatedGroupRequest) GetDedicatedGroupId() string` + +GetDedicatedGroupId returns the DedicatedGroupId field if non-nil, zero value otherwise. + +### GetDedicatedGroupIdOk + +`func (o *DeleteDedicatedGroupRequest) GetDedicatedGroupIdOk() (*string, bool)` + +GetDedicatedGroupIdOk returns a tuple with the DedicatedGroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDedicatedGroupId + +`func (o *DeleteDedicatedGroupRequest) SetDedicatedGroupId(v string)` + +SetDedicatedGroupId sets DedicatedGroupId field to given value. + + +### GetDryRun + +`func (o *DeleteDedicatedGroupRequest) GetDryRun() bool` + +GetDryRun returns the DryRun field if non-nil, zero value otherwise. + +### GetDryRunOk + +`func (o *DeleteDedicatedGroupRequest) GetDryRunOk() (*bool, bool)` + +GetDryRunOk returns a tuple with the DryRun field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDryRun + +`func (o *DeleteDedicatedGroupRequest) SetDryRun(v bool)` + +SetDryRun sets DryRun field to given value. + +### HasDryRun + +`func (o *DeleteDedicatedGroupRequest) HasDryRun() bool` + +HasDryRun returns a boolean if a field has been set. + +### GetForce + +`func (o *DeleteDedicatedGroupRequest) GetForce() bool` + +GetForce returns the Force field if non-nil, zero value otherwise. + +### GetForceOk + +`func (o *DeleteDedicatedGroupRequest) GetForceOk() (*bool, bool)` + +GetForceOk returns a tuple with the Force field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForce + +`func (o *DeleteDedicatedGroupRequest) SetForce(v bool)` + +SetForce sets Force field to given value. + +### HasForce + +`func (o *DeleteDedicatedGroupRequest) HasForce() bool` + +HasForce returns a boolean if a field has been set. + + +[[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/v2/docs/ResetAccountPasswordResponse.md b/v2/docs/DeleteDedicatedGroupResponse.md similarity index 64% rename from v2/docs/ResetAccountPasswordResponse.md rename to v2/docs/DeleteDedicatedGroupResponse.md index 60bfd1125..c8c88cdb4 100644 --- a/v2/docs/ResetAccountPasswordResponse.md +++ b/v2/docs/DeleteDedicatedGroupResponse.md @@ -1,4 +1,4 @@ -# ResetAccountPasswordResponse +# DeleteDedicatedGroupResponse ## Properties @@ -8,45 +8,45 @@ Name | Type | Description | Notes ## Methods -### NewResetAccountPasswordResponse +### NewDeleteDedicatedGroupResponse -`func NewResetAccountPasswordResponse() *ResetAccountPasswordResponse` +`func NewDeleteDedicatedGroupResponse() *DeleteDedicatedGroupResponse` -NewResetAccountPasswordResponse instantiates a new ResetAccountPasswordResponse object +NewDeleteDedicatedGroupResponse instantiates a new DeleteDedicatedGroupResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed -### NewResetAccountPasswordResponseWithDefaults +### NewDeleteDedicatedGroupResponseWithDefaults -`func NewResetAccountPasswordResponseWithDefaults() *ResetAccountPasswordResponse` +`func NewDeleteDedicatedGroupResponseWithDefaults() *DeleteDedicatedGroupResponse` -NewResetAccountPasswordResponseWithDefaults instantiates a new ResetAccountPasswordResponse object +NewDeleteDedicatedGroupResponseWithDefaults instantiates a new DeleteDedicatedGroupResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set ### GetResponseContext -`func (o *ResetAccountPasswordResponse) GetResponseContext() ResponseContext` +`func (o *DeleteDedicatedGroupResponse) GetResponseContext() ResponseContext` GetResponseContext returns the ResponseContext field if non-nil, zero value otherwise. ### GetResponseContextOk -`func (o *ResetAccountPasswordResponse) GetResponseContextOk() (*ResponseContext, bool)` +`func (o *DeleteDedicatedGroupResponse) GetResponseContextOk() (*ResponseContext, bool)` GetResponseContextOk returns a tuple with the ResponseContext field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetResponseContext -`func (o *ResetAccountPasswordResponse) SetResponseContext(v ResponseContext)` +`func (o *DeleteDedicatedGroupResponse) SetResponseContext(v ResponseContext)` SetResponseContext sets ResponseContext field to given value. ### HasResponseContext -`func (o *ResetAccountPasswordResponse) HasResponseContext() bool` +`func (o *DeleteDedicatedGroupResponse) HasResponseContext() bool` HasResponseContext returns a boolean if a field has been set. diff --git a/v2/docs/DeletePolicyRequest.md b/v2/docs/DeletePolicyRequest.md new file mode 100644 index 000000000..af325ff7e --- /dev/null +++ b/v2/docs/DeletePolicyRequest.md @@ -0,0 +1,77 @@ +# DeletePolicyRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] +**PolicyOrn** | **string** | 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). | + +## Methods + +### NewDeletePolicyRequest + +`func NewDeletePolicyRequest(policyOrn string, ) *DeletePolicyRequest` + +NewDeletePolicyRequest instantiates a new DeletePolicyRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDeletePolicyRequestWithDefaults + +`func NewDeletePolicyRequestWithDefaults() *DeletePolicyRequest` + +NewDeletePolicyRequestWithDefaults instantiates a new DeletePolicyRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDryRun + +`func (o *DeletePolicyRequest) GetDryRun() bool` + +GetDryRun returns the DryRun field if non-nil, zero value otherwise. + +### GetDryRunOk + +`func (o *DeletePolicyRequest) GetDryRunOk() (*bool, bool)` + +GetDryRunOk returns a tuple with the DryRun field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDryRun + +`func (o *DeletePolicyRequest) SetDryRun(v bool)` + +SetDryRun sets DryRun field to given value. + +### HasDryRun + +`func (o *DeletePolicyRequest) HasDryRun() bool` + +HasDryRun returns a boolean if a field has been set. + +### GetPolicyOrn + +`func (o *DeletePolicyRequest) GetPolicyOrn() string` + +GetPolicyOrn returns the PolicyOrn field if non-nil, zero value otherwise. + +### GetPolicyOrnOk + +`func (o *DeletePolicyRequest) GetPolicyOrnOk() (*string, bool)` + +GetPolicyOrnOk returns a tuple with the PolicyOrn field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicyOrn + +`func (o *DeletePolicyRequest) SetPolicyOrn(v string)` + +SetPolicyOrn sets PolicyOrn field to given value. + + + +[[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/v2/docs/SendResetPasswordEmailResponse.md b/v2/docs/DeletePolicyResponse.md similarity index 60% rename from v2/docs/SendResetPasswordEmailResponse.md rename to v2/docs/DeletePolicyResponse.md index 0808a1c68..0654b120d 100644 --- a/v2/docs/SendResetPasswordEmailResponse.md +++ b/v2/docs/DeletePolicyResponse.md @@ -1,4 +1,4 @@ -# SendResetPasswordEmailResponse +# DeletePolicyResponse ## Properties @@ -8,45 +8,45 @@ Name | Type | Description | Notes ## Methods -### NewSendResetPasswordEmailResponse +### NewDeletePolicyResponse -`func NewSendResetPasswordEmailResponse() *SendResetPasswordEmailResponse` +`func NewDeletePolicyResponse() *DeletePolicyResponse` -NewSendResetPasswordEmailResponse instantiates a new SendResetPasswordEmailResponse object +NewDeletePolicyResponse instantiates a new DeletePolicyResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed -### NewSendResetPasswordEmailResponseWithDefaults +### NewDeletePolicyResponseWithDefaults -`func NewSendResetPasswordEmailResponseWithDefaults() *SendResetPasswordEmailResponse` +`func NewDeletePolicyResponseWithDefaults() *DeletePolicyResponse` -NewSendResetPasswordEmailResponseWithDefaults instantiates a new SendResetPasswordEmailResponse object +NewDeletePolicyResponseWithDefaults instantiates a new DeletePolicyResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set ### GetResponseContext -`func (o *SendResetPasswordEmailResponse) GetResponseContext() ResponseContext` +`func (o *DeletePolicyResponse) GetResponseContext() ResponseContext` GetResponseContext returns the ResponseContext field if non-nil, zero value otherwise. ### GetResponseContextOk -`func (o *SendResetPasswordEmailResponse) GetResponseContextOk() (*ResponseContext, bool)` +`func (o *DeletePolicyResponse) GetResponseContextOk() (*ResponseContext, bool)` GetResponseContextOk returns a tuple with the ResponseContext field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetResponseContext -`func (o *SendResetPasswordEmailResponse) SetResponseContext(v ResponseContext)` +`func (o *DeletePolicyResponse) SetResponseContext(v ResponseContext)` SetResponseContext sets ResponseContext field to given value. ### HasResponseContext -`func (o *SendResetPasswordEmailResponse) HasResponseContext() bool` +`func (o *DeletePolicyResponse) HasResponseContext() bool` HasResponseContext returns a boolean if a field has been set. diff --git a/v2/docs/DeletePolicyVersionRequest.md b/v2/docs/DeletePolicyVersionRequest.md new file mode 100644 index 000000000..a93dc9288 --- /dev/null +++ b/v2/docs/DeletePolicyVersionRequest.md @@ -0,0 +1,72 @@ +# DeletePolicyVersionRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PolicyOrn** | **string** | The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). | +**VersionId** | **string** | The ID of the version of the policy you want to delete. | + +## Methods + +### NewDeletePolicyVersionRequest + +`func NewDeletePolicyVersionRequest(policyOrn string, versionId string, ) *DeletePolicyVersionRequest` + +NewDeletePolicyVersionRequest instantiates a new DeletePolicyVersionRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDeletePolicyVersionRequestWithDefaults + +`func NewDeletePolicyVersionRequestWithDefaults() *DeletePolicyVersionRequest` + +NewDeletePolicyVersionRequestWithDefaults instantiates a new DeletePolicyVersionRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetPolicyOrn + +`func (o *DeletePolicyVersionRequest) GetPolicyOrn() string` + +GetPolicyOrn returns the PolicyOrn field if non-nil, zero value otherwise. + +### GetPolicyOrnOk + +`func (o *DeletePolicyVersionRequest) GetPolicyOrnOk() (*string, bool)` + +GetPolicyOrnOk returns a tuple with the PolicyOrn field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicyOrn + +`func (o *DeletePolicyVersionRequest) SetPolicyOrn(v string)` + +SetPolicyOrn sets PolicyOrn field to given value. + + +### GetVersionId + +`func (o *DeletePolicyVersionRequest) GetVersionId() string` + +GetVersionId returns the VersionId field if non-nil, zero value otherwise. + +### GetVersionIdOk + +`func (o *DeletePolicyVersionRequest) GetVersionIdOk() (*string, bool)` + +GetVersionIdOk returns a tuple with the VersionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersionId + +`func (o *DeletePolicyVersionRequest) SetVersionId(v string)` + +SetVersionId sets VersionId field to given value. + + + +[[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/v2/docs/DeletePolicyVersionResponse.md b/v2/docs/DeletePolicyVersionResponse.md new file mode 100644 index 000000000..d4b00b87c --- /dev/null +++ b/v2/docs/DeletePolicyVersionResponse.md @@ -0,0 +1,56 @@ +# DeletePolicyVersionResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ResponseContext** | Pointer to [**ResponseContext**](ResponseContext.md) | | [optional] + +## Methods + +### NewDeletePolicyVersionResponse + +`func NewDeletePolicyVersionResponse() *DeletePolicyVersionResponse` + +NewDeletePolicyVersionResponse instantiates a new DeletePolicyVersionResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDeletePolicyVersionResponseWithDefaults + +`func NewDeletePolicyVersionResponseWithDefaults() *DeletePolicyVersionResponse` + +NewDeletePolicyVersionResponseWithDefaults instantiates a new DeletePolicyVersionResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetResponseContext + +`func (o *DeletePolicyVersionResponse) GetResponseContext() ResponseContext` + +GetResponseContext returns the ResponseContext field if non-nil, zero value otherwise. + +### GetResponseContextOk + +`func (o *DeletePolicyVersionResponse) GetResponseContextOk() (*ResponseContext, bool)` + +GetResponseContextOk returns a tuple with the ResponseContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseContext + +`func (o *DeletePolicyVersionResponse) SetResponseContext(v ResponseContext)` + +SetResponseContext sets ResponseContext field to given value. + +### HasResponseContext + +`func (o *DeletePolicyVersionResponse) HasResponseContext() bool` + +HasResponseContext returns a boolean if a field has been set. + + +[[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/v2/docs/DirectLinkInterface.md b/v2/docs/DirectLinkInterface.md index b7c639df5..7037f02b1 100644 --- a/v2/docs/DirectLinkInterface.md +++ b/v2/docs/DirectLinkInterface.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **DirectLinkInterfaceName** | **string** | The name of the DirectLink interface. | **OutscalePrivateIp** | Pointer to **string** | The IP on the OUTSCALE side of the DirectLink interface. | [optional] **VirtualGatewayId** | **string** | The ID of the target virtual gateway. | -**Vlan** | **int32** | The VLAN number associated with the DirectLink interface. | +**Vlan** | **int32** | The VLAN number associated with the DirectLink interface. This number must be unique and be between `2` and `4094`. | ## Methods diff --git a/v2/docs/FiltersDedicatedGroup.md b/v2/docs/FiltersDedicatedGroup.md new file mode 100644 index 000000000..5ba9ba01a --- /dev/null +++ b/v2/docs/FiltersDedicatedGroup.md @@ -0,0 +1,134 @@ +# FiltersDedicatedGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CpuGenerations** | Pointer to **[]int32** | The processor generation for the VMs in the dedicated group (for example, `4`). | [optional] +**DedicatedGroupIds** | Pointer to **[]string** | The IDs of the dedicated groups. | [optional] +**Names** | Pointer to **[]string** | The names of the dedicated groups. | [optional] +**SubregionNames** | Pointer to **[]string** | The names of the Subregions in which the dedicated groups are located. | [optional] + +## Methods + +### NewFiltersDedicatedGroup + +`func NewFiltersDedicatedGroup() *FiltersDedicatedGroup` + +NewFiltersDedicatedGroup instantiates a new FiltersDedicatedGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewFiltersDedicatedGroupWithDefaults + +`func NewFiltersDedicatedGroupWithDefaults() *FiltersDedicatedGroup` + +NewFiltersDedicatedGroupWithDefaults instantiates a new FiltersDedicatedGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCpuGenerations + +`func (o *FiltersDedicatedGroup) GetCpuGenerations() []int32` + +GetCpuGenerations returns the CpuGenerations field if non-nil, zero value otherwise. + +### GetCpuGenerationsOk + +`func (o *FiltersDedicatedGroup) GetCpuGenerationsOk() (*[]int32, bool)` + +GetCpuGenerationsOk returns a tuple with the CpuGenerations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCpuGenerations + +`func (o *FiltersDedicatedGroup) SetCpuGenerations(v []int32)` + +SetCpuGenerations sets CpuGenerations field to given value. + +### HasCpuGenerations + +`func (o *FiltersDedicatedGroup) HasCpuGenerations() bool` + +HasCpuGenerations returns a boolean if a field has been set. + +### GetDedicatedGroupIds + +`func (o *FiltersDedicatedGroup) GetDedicatedGroupIds() []string` + +GetDedicatedGroupIds returns the DedicatedGroupIds field if non-nil, zero value otherwise. + +### GetDedicatedGroupIdsOk + +`func (o *FiltersDedicatedGroup) GetDedicatedGroupIdsOk() (*[]string, bool)` + +GetDedicatedGroupIdsOk returns a tuple with the DedicatedGroupIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDedicatedGroupIds + +`func (o *FiltersDedicatedGroup) SetDedicatedGroupIds(v []string)` + +SetDedicatedGroupIds sets DedicatedGroupIds field to given value. + +### HasDedicatedGroupIds + +`func (o *FiltersDedicatedGroup) HasDedicatedGroupIds() bool` + +HasDedicatedGroupIds returns a boolean if a field has been set. + +### GetNames + +`func (o *FiltersDedicatedGroup) GetNames() []string` + +GetNames returns the Names field if non-nil, zero value otherwise. + +### GetNamesOk + +`func (o *FiltersDedicatedGroup) GetNamesOk() (*[]string, bool)` + +GetNamesOk returns a tuple with the Names field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNames + +`func (o *FiltersDedicatedGroup) SetNames(v []string)` + +SetNames sets Names field to given value. + +### HasNames + +`func (o *FiltersDedicatedGroup) HasNames() bool` + +HasNames returns a boolean if a field has been set. + +### GetSubregionNames + +`func (o *FiltersDedicatedGroup) GetSubregionNames() []string` + +GetSubregionNames returns the SubregionNames field if non-nil, zero value otherwise. + +### GetSubregionNamesOk + +`func (o *FiltersDedicatedGroup) GetSubregionNamesOk() (*[]string, bool)` + +GetSubregionNamesOk returns a tuple with the SubregionNames field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubregionNames + +`func (o *FiltersDedicatedGroup) SetSubregionNames(v []string)` + +SetSubregionNames sets SubregionNames field to given value. + +### HasSubregionNames + +`func (o *FiltersDedicatedGroup) HasSubregionNames() bool` + +HasSubregionNames returns a boolean if a field has been set. + + +[[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/v2/docs/FiltersImage.md b/v2/docs/FiltersImage.md index f4a7584d5..b5d9d6ea0 100644 --- a/v2/docs/FiltersImage.md +++ b/v2/docs/FiltersImage.md @@ -17,11 +17,12 @@ Name | Type | Description | Notes **Hypervisors** | Pointer to **[]string** | The hypervisor type of the OMI (always `xen`). | [optional] **ImageIds** | Pointer to **[]string** | The IDs of the OMIs. | [optional] **ImageNames** | Pointer to **[]string** | The names of the OMIs, provided when they were created. | [optional] -**PermissionsToLaunchAccountIds** | Pointer to **[]string** | The account IDs of the users who have launch permissions for the OMIs. | [optional] +**PermissionsToLaunchAccountIds** | Pointer to **[]string** | The account IDs which have launch permissions for the OMIs. | [optional] **PermissionsToLaunchGlobalPermission** | Pointer to **bool** | If true, lists all public OMIs. If false, lists all private OMIs. | [optional] +**ProductCodeNames** | Pointer to **[]string** | The names of the product codes associated with the OMI. | [optional] **ProductCodes** | Pointer to **[]string** | The product codes associated with the OMI. | [optional] **RootDeviceNames** | Pointer to **[]string** | The name of the root device. This value must be /dev/sda1. | [optional] -**RootDeviceTypes** | Pointer to **[]string** | The types of root device used by the OMIs (always `bsu`). | [optional] +**RootDeviceTypes** | Pointer to **[]string** | The types of root device used by the OMIs (`bsu` or `ebs`). | [optional] **States** | Pointer to **[]string** | The states of the OMIs (`pending` \\| `available` \\| `failed`). | [optional] **TagKeys** | Pointer to **[]string** | The keys of the tags associated with the OMIs. | [optional] **TagValues** | Pointer to **[]string** | The values of the tags associated with the OMIs. | [optional] @@ -422,6 +423,31 @@ SetPermissionsToLaunchGlobalPermission sets PermissionsToLaunchGlobalPermission HasPermissionsToLaunchGlobalPermission returns a boolean if a field has been set. +### GetProductCodeNames + +`func (o *FiltersImage) GetProductCodeNames() []string` + +GetProductCodeNames returns the ProductCodeNames field if non-nil, zero value otherwise. + +### GetProductCodeNamesOk + +`func (o *FiltersImage) GetProductCodeNamesOk() (*[]string, bool)` + +GetProductCodeNamesOk returns a tuple with the ProductCodeNames field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProductCodeNames + +`func (o *FiltersImage) SetProductCodeNames(v []string)` + +SetProductCodeNames sets ProductCodeNames field to given value. + +### HasProductCodeNames + +`func (o *FiltersImage) HasProductCodeNames() bool` + +HasProductCodeNames returns a boolean if a field has been set. + ### GetProductCodes `func (o *FiltersImage) GetProductCodes() []string` diff --git a/v2/docs/FiltersInternetService.md b/v2/docs/FiltersInternetService.md index eb2332126..c097afe4d 100644 --- a/v2/docs/FiltersInternetService.md +++ b/v2/docs/FiltersInternetService.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **InternetServiceIds** | Pointer to **[]string** | The IDs of the Internet services. | [optional] **LinkNetIds** | Pointer to **[]string** | The IDs of the Nets the Internet services are attached to. | [optional] -**LinkStates** | Pointer to **[]string** | The current states of the attachments between the Internet services and the Nets (only `available`, if the Internet gateway is attached to a VPC). | [optional] +**LinkStates** | Pointer to **[]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] **TagKeys** | Pointer to **[]string** | The keys of the tags associated with the Internet services. | [optional] **TagValues** | Pointer to **[]string** | The values of the tags associated with the Internet services. | [optional] **Tags** | Pointer to **[]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] diff --git a/v2/docs/FiltersKeypair.md b/v2/docs/FiltersKeypair.md index e23c49488..2554ba7a1 100644 --- a/v2/docs/FiltersKeypair.md +++ b/v2/docs/FiltersKeypair.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **KeypairFingerprints** | Pointer to **[]string** | The fingerprints of the keypairs. | [optional] **KeypairNames** | Pointer to **[]string** | The names of the keypairs. | [optional] +**KeypairTypes** | Pointer to **[]string** | The types of the keypairs (`ssh-rsa`, `ssh-ed25519`, `ecdsa-sha2-nistp256`, `ecdsa-sha2-nistp384`, or `ecdsa-sha2-nistp521`). | [optional] ## Methods @@ -76,6 +77,31 @@ SetKeypairNames sets KeypairNames field to given value. HasKeypairNames returns a boolean if a field has been set. +### GetKeypairTypes + +`func (o *FiltersKeypair) GetKeypairTypes() []string` + +GetKeypairTypes returns the KeypairTypes field if non-nil, zero value otherwise. + +### GetKeypairTypesOk + +`func (o *FiltersKeypair) GetKeypairTypesOk() (*[]string, bool)` + +GetKeypairTypesOk returns a tuple with the KeypairTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKeypairTypes + +`func (o *FiltersKeypair) SetKeypairTypes(v []string)` + +SetKeypairTypes sets KeypairTypes field to given value. + +### HasKeypairTypes + +`func (o *FiltersKeypair) HasKeypairTypes() bool` + +HasKeypairTypes returns a boolean if a field has been set. + [[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/v2/docs/FiltersNet.md b/v2/docs/FiltersNet.md index 94b52531b..e2272deb6 100644 --- a/v2/docs/FiltersNet.md +++ b/v2/docs/FiltersNet.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **IpRanges** | Pointer to **[]string** | The IP ranges for the Nets, in CIDR notation (for example, `10.0.0.0/16`). | [optional] **IsDefault** | Pointer to **bool** | If true, the Net used is the default one. | [optional] **NetIds** | Pointer to **[]string** | The IDs of the Nets. | [optional] -**States** | Pointer to **[]string** | The states of the Nets (`pending` \\| `available` \\| `deleted`). | [optional] +**States** | Pointer to **[]string** | The states of the Nets (`pending` \\| `available` \\| `deleting`). | [optional] **TagKeys** | Pointer to **[]string** | The keys of the tags associated with the Nets. | [optional] **TagValues** | Pointer to **[]string** | The values of the tags associated with the Nets. | [optional] **Tags** | Pointer to **[]string** | The key/value combination of the tags associated with the Nets, in the following format: &quot;Filters&quot;:{&quot;Tags&quot;:[&quot;TAGKEY=TAGVALUE&quot;]}. | [optional] diff --git a/v2/docs/FiltersNetPeering.md b/v2/docs/FiltersNetPeering.md index 6ac71c290..f1dccf058 100644 --- a/v2/docs/FiltersNetPeering.md +++ b/v2/docs/FiltersNetPeering.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **AccepterNetAccountIds** | Pointer to **[]string** | The account IDs of the owners of the peer Nets. | [optional] **AccepterNetIpRanges** | Pointer to **[]string** | The IP ranges of the peer Nets, in CIDR notation (for example, `10.0.0.0/24`). | [optional] **AccepterNetNetIds** | Pointer to **[]string** | The IDs of the peer Nets. | [optional] +**ExpirationDates** | Pointer to [**[]time.Time**](time.Time.md) | The dates and times at which the Net peerings expire, in ISO 8601 date-time format (for example, `2020-06-14T00:00:00.000Z`). | [optional] **NetPeeringIds** | Pointer to **[]string** | The IDs of the Net peerings. | [optional] **SourceNetAccountIds** | Pointer to **[]string** | The account IDs of the owners of the peer Nets. | [optional] **SourceNetIpRanges** | Pointer to **[]string** | The IP ranges of the peer Nets. | [optional] @@ -111,6 +112,31 @@ SetAccepterNetNetIds sets AccepterNetNetIds field to given value. HasAccepterNetNetIds returns a boolean if a field has been set. +### GetExpirationDates + +`func (o *FiltersNetPeering) GetExpirationDates() []time.Time` + +GetExpirationDates returns the ExpirationDates field if non-nil, zero value otherwise. + +### GetExpirationDatesOk + +`func (o *FiltersNetPeering) GetExpirationDatesOk() (*[]time.Time, bool)` + +GetExpirationDatesOk returns a tuple with the ExpirationDates field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpirationDates + +`func (o *FiltersNetPeering) SetExpirationDates(v []time.Time)` + +SetExpirationDates sets ExpirationDates field to given value. + +### HasExpirationDates + +`func (o *FiltersNetPeering) HasExpirationDates() bool` + +HasExpirationDates returns a boolean if a field has been set. + ### GetNetPeeringIds `func (o *FiltersNetPeering) GetNetPeeringIds() []string` diff --git a/v2/docs/FiltersSecurityGroup.md b/v2/docs/FiltersSecurityGroup.md index b9b8c1d66..0d5588530 100644 --- a/v2/docs/FiltersSecurityGroup.md +++ b/v2/docs/FiltersSecurityGroup.md @@ -4,7 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**AccountIds** | Pointer to **[]string** | The account IDs of the owners of the security groups. | [optional] **Descriptions** | Pointer to **[]string** | The descriptions of the security groups. | [optional] **InboundRuleAccountIds** | Pointer to **[]string** | The account IDs that have been granted permissions. | [optional] **InboundRuleFromPortRanges** | Pointer to **[]int32** | The beginnings of the port ranges for the TCP and UDP protocols, or the ICMP type numbers. | [optional] @@ -46,31 +45,6 @@ NewFiltersSecurityGroupWithDefaults instantiates a new FiltersSecurityGroup obje This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set -### GetAccountIds - -`func (o *FiltersSecurityGroup) GetAccountIds() []string` - -GetAccountIds returns the AccountIds field if non-nil, zero value otherwise. - -### GetAccountIdsOk - -`func (o *FiltersSecurityGroup) GetAccountIdsOk() (*[]string, bool)` - -GetAccountIdsOk returns a tuple with the AccountIds field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### SetAccountIds - -`func (o *FiltersSecurityGroup) SetAccountIds(v []string)` - -SetAccountIds sets AccountIds field to given value. - -### HasAccountIds - -`func (o *FiltersSecurityGroup) HasAccountIds() bool` - -HasAccountIds returns a boolean if a field has been set. - ### GetDescriptions `func (o *FiltersSecurityGroup) GetDescriptions() []string` diff --git a/v2/docs/FiltersSnapshot.md b/v2/docs/FiltersSnapshot.md index 58377584f..bec4239e4 100644 --- a/v2/docs/FiltersSnapshot.md +++ b/v2/docs/FiltersSnapshot.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **AccountIds** | Pointer to **[]string** | The account IDs of the owners of the snapshots. | [optional] **Descriptions** | Pointer to **[]string** | The descriptions of the snapshots. | [optional] **FromCreationDate** | Pointer to **time.Time** | The beginning of the time period, in ISO 8601 date-time format (for example, `2020-06-14T00:00:00.000Z`). | [optional] -**PermissionsToCreateVolumeAccountIds** | Pointer to **[]string** | The account IDs of one or more users who have permissions to create volumes. | [optional] +**PermissionsToCreateVolumeAccountIds** | Pointer to **[]string** | The account IDs which have permissions to create volumes. | [optional] **PermissionsToCreateVolumeGlobalPermission** | Pointer to **bool** | If true, lists all public volumes. If false, lists all private volumes. | [optional] **Progresses** | Pointer to **[]int32** | The progresses of the snapshots, as a percentage. | [optional] **SnapshotIds** | Pointer to **[]string** | The IDs of the snapshots. | [optional] diff --git a/v2/docs/FiltersSubregion.md b/v2/docs/FiltersSubregion.md index 6b48e19e7..9c289de5a 100644 --- a/v2/docs/FiltersSubregion.md +++ b/v2/docs/FiltersSubregion.md @@ -4,6 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**RegionNames** | Pointer to **[]string** | The names of the Regions containing the Subregions. | [optional] +**States** | Pointer to **[]string** | The states of the Subregions. | [optional] **SubregionNames** | Pointer to **[]string** | The names of the Subregions. | [optional] ## Methods @@ -25,6 +27,56 @@ NewFiltersSubregionWithDefaults instantiates a new FiltersSubregion object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set +### GetRegionNames + +`func (o *FiltersSubregion) GetRegionNames() []string` + +GetRegionNames returns the RegionNames field if non-nil, zero value otherwise. + +### GetRegionNamesOk + +`func (o *FiltersSubregion) GetRegionNamesOk() (*[]string, bool)` + +GetRegionNamesOk returns a tuple with the RegionNames field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegionNames + +`func (o *FiltersSubregion) SetRegionNames(v []string)` + +SetRegionNames sets RegionNames field to given value. + +### HasRegionNames + +`func (o *FiltersSubregion) HasRegionNames() bool` + +HasRegionNames returns a boolean if a field has been set. + +### GetStates + +`func (o *FiltersSubregion) GetStates() []string` + +GetStates returns the States field if non-nil, zero value otherwise. + +### GetStatesOk + +`func (o *FiltersSubregion) GetStatesOk() (*[]string, bool)` + +GetStatesOk returns a tuple with the States field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStates + +`func (o *FiltersSubregion) SetStates(v []string)` + +SetStates sets States field to given value. + +### HasStates + +`func (o *FiltersSubregion) HasStates() bool` + +HasStates returns a boolean if a field has been set. + ### GetSubregionNames `func (o *FiltersSubregion) GetSubregionNames() []string` diff --git a/v2/docs/FiltersVm.md b/v2/docs/FiltersVm.md index 7025fbdc0..8ba907963 100644 --- a/v2/docs/FiltersVm.md +++ b/v2/docs/FiltersVm.md @@ -4,10 +4,70 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**Architectures** | Pointer to **[]string** | The architectures of the VMs (`i386` \\| `x86_64`). | [optional] +**BlockDeviceMappingDeleteOnVmDeletion** | Pointer to **bool** | Whether the BSU volumes are deleted when terminating the VMs. | [optional] +**BlockDeviceMappingDeviceNames** | Pointer to **[]string** | The device names for the BSU volumes (in the format `/dev/sdX`, `/dev/sdXX`, `/dev/xvdX`, or `/dev/xvdXX`). | [optional] +**BlockDeviceMappingLinkDates** | Pointer to **[]string** | The link dates for the BSU volumes mapped to the VMs (for example, `2016-01-23T18:45:30.000Z`). | [optional] +**BlockDeviceMappingStates** | Pointer to **[]string** | The states for the BSU volumes (`attaching` \\| `attached` \\| `detaching` \\| `detached`). | [optional] +**BlockDeviceMappingVolumeIds** | Pointer to **[]string** | The volume IDs of the BSU volumes. | [optional] +**ClientTokens** | Pointer to **[]string** | The idempotency tokens provided when launching the VMs. | [optional] +**CreationDates** | Pointer to **[]string** | The dates when the VMs were launched. | [optional] +**ImageIds** | Pointer to **[]string** | The IDs of the OMIs used to launch the VMs. | [optional] +**IsSourceDestChecked** | Pointer to **bool** | Whether the source/destination checking is enabled (true) or disabled (false). | [optional] +**KeypairNames** | Pointer to **[]string** | The names of the keypairs used when launching the VMs. | [optional] +**LaunchNumbers** | Pointer to **[]int32** | The numbers for the VMs when launching a group of several VMs (for example, `0`, `1`, `2`, and so on). | [optional] +**Lifecycles** | Pointer to **[]string** | Whether the VMs are Spot Instances (spot). | [optional] +**NetIds** | Pointer to **[]string** | The IDs of the Nets in which the VMs are running. | [optional] +**NicAccountIds** | Pointer to **[]string** | The IDs of the NICs. | [optional] +**NicDescriptions** | Pointer to **[]string** | The descriptions of the NICs. | [optional] +**NicIsSourceDestChecked** | Pointer to **bool** | Whether the source/destination checking is enabled (true) or disabled (false). | [optional] +**NicLinkNicDeleteOnVmDeletion** | Pointer to **bool** | Whether the NICs are deleted when the VMs they are attached to are deleted. | [optional] +**NicLinkNicDeviceNumbers** | Pointer to **[]int32** | The device numbers the NICs are attached to. | [optional] +**NicLinkNicLinkNicDates** | Pointer to **[]string** | The dates and time when the NICs were attached to the VMs. | [optional] +**NicLinkNicLinkNicIds** | Pointer to **[]string** | The IDs of the NIC attachments. | [optional] +**NicLinkNicStates** | Pointer to **[]string** | The states of the attachments. | [optional] +**NicLinkNicVmAccountIds** | Pointer to **[]string** | The account IDs of the owners of the VMs the NICs are attached to. | [optional] +**NicLinkNicVmIds** | Pointer to **[]string** | The IDs of the VMs the NICs are attached to. | [optional] +**NicLinkPublicIpAccountIds** | Pointer to **[]string** | The account IDs of the owners of the public IPs associated with the NICs. | [optional] +**NicLinkPublicIpLinkPublicIpIds** | Pointer to **[]string** | The association IDs returned when the public IPs were associated with the NICs. | [optional] +**NicLinkPublicIpPublicIpIds** | Pointer to **[]string** | The allocation IDs returned when the public IPs were allocated to their accounts. | [optional] +**NicLinkPublicIpPublicIps** | Pointer to **[]string** | The public IPs associated with the NICs. | [optional] +**NicMacAddresses** | Pointer to **[]string** | The Media Access Control (MAC) addresses of the NICs. | [optional] +**NicNetIds** | Pointer to **[]string** | The IDs of the Nets where the NICs are located. | [optional] +**NicNicIds** | Pointer to **[]string** | The IDs of the NICs. | [optional] +**NicPrivateIpsLinkPublicIpAccountIds** | Pointer to **[]string** | The account IDs of the owner of the public IPs associated with the private IPs. | [optional] +**NicPrivateIpsLinkPublicIpIds** | Pointer to **[]string** | The public IPs associated with the private IPs. | [optional] +**NicPrivateIpsPrimaryIp** | Pointer to **bool** | Whether the private IPs are the primary IPs associated with the NICs. | [optional] +**NicPrivateIpsPrivateIps** | Pointer to **[]string** | The private IPs of the NICs. | [optional] +**NicSecurityGroupIds** | Pointer to **[]string** | The IDs of the security groups associated with the NICs. | [optional] +**NicSecurityGroupNames** | Pointer to **[]string** | The names of the security groups associated with the NICs. | [optional] +**NicStates** | Pointer to **[]string** | The states of the NICs (`available` \\| `in-use`). | [optional] +**NicSubnetIds** | Pointer to **[]string** | The IDs of the Subnets for the NICs. | [optional] +**NicSubregionNames** | Pointer to **[]string** | The Subregions where the NICs are located. | [optional] +**Platforms** | Pointer to **[]string** | The platforms. Use windows if you have Windows VMs. Otherwise, leave this filter blank. | [optional] +**PrivateIps** | Pointer to **[]string** | The private IPs of the VMs. | [optional] +**ProductCodes** | Pointer to **[]string** | The product codes associated with the OMI used to create the VMs. | [optional] +**PublicIps** | Pointer to **[]string** | The public IPs of the VMs. | [optional] +**ReservationIds** | Pointer to **[]string** | 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 lauch a group of VMs using the same launch request. | [optional] +**RootDeviceNames** | Pointer to **[]string** | The names of the root devices for the VMs (for example, `/dev/sda1`) | [optional] +**RootDeviceTypes** | Pointer to **[]string** | The root devices types used by the VMs (always `ebs`) | [optional] +**SecurityGroupIds** | Pointer to **[]string** | The IDs of the security groups for the VMs (only in the public Cloud). | [optional] +**SecurityGroupNames** | Pointer to **[]string** | The names of the security groups for the VMs (only in the public Cloud). | [optional] +**StateReasonCodes** | Pointer to **[]int32** | The reason codes for the state changes. | [optional] +**StateReasonMessages** | Pointer to **[]string** | The messages describing the state changes. | [optional] +**StateReasons** | Pointer to **[]string** | The reasons explaining the current states of the VMs. This filter is like the `StateReasonCodes` one. | [optional] +**SubnetIds** | Pointer to **[]string** | The IDs of the Subnets for the VMs. | [optional] +**SubregionNames** | Pointer to **[]string** | The names of the Subregions of the VMs. | [optional] **TagKeys** | Pointer to **[]string** | The keys of the tags associated with the VMs. | [optional] **TagValues** | Pointer to **[]string** | The values of the tags associated with the VMs. | [optional] **Tags** | Pointer to **[]string** | The key/value combination of the tags associated with the VMs, in the following format: &quot;Filters&quot;:{&quot;Tags&quot;:[&quot;TAGKEY=TAGVALUE&quot;]}. | [optional] +**Tenancies** | Pointer to **[]string** | The tenancies of the VMs (`dedicated` \\| `default` \\| `host`). | [optional] **VmIds** | Pointer to **[]string** | One or more IDs of VMs. | [optional] +**VmSecurityGroupIds** | Pointer to **[]string** | The IDs of the security groups for the VMs. | [optional] +**VmSecurityGroupNames** | Pointer to **[]string** | The names of the security group for the VMs. | [optional] +**VmStateCodes** | Pointer to **[]int32** | The state codes of the VMs: `-1` (quarantine), `0` (pending), `16` (running), `32` (shutting-down), `48` (terminated), `64` (stopping), and `80` (stopped). | [optional] +**VmStateNames** | Pointer to **[]string** | The state names of the VMs (`pending` \\| `running` \\| `stopping` \\| `stopped` \\| `shutting-down` \\| `terminated` \\| `quarantine`). | [optional] +**VmTypes** | Pointer to **[]string** | The VM types (for example, t2.micro). For more information, see [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html). | [optional] ## Methods @@ -28,6 +88,1356 @@ NewFiltersVmWithDefaults instantiates a new FiltersVm object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set +### GetArchitectures + +`func (o *FiltersVm) GetArchitectures() []string` + +GetArchitectures returns the Architectures field if non-nil, zero value otherwise. + +### GetArchitecturesOk + +`func (o *FiltersVm) GetArchitecturesOk() (*[]string, bool)` + +GetArchitecturesOk returns a tuple with the Architectures field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetArchitectures + +`func (o *FiltersVm) SetArchitectures(v []string)` + +SetArchitectures sets Architectures field to given value. + +### HasArchitectures + +`func (o *FiltersVm) HasArchitectures() bool` + +HasArchitectures returns a boolean if a field has been set. + +### GetBlockDeviceMappingDeleteOnVmDeletion + +`func (o *FiltersVm) GetBlockDeviceMappingDeleteOnVmDeletion() bool` + +GetBlockDeviceMappingDeleteOnVmDeletion returns the BlockDeviceMappingDeleteOnVmDeletion field if non-nil, zero value otherwise. + +### GetBlockDeviceMappingDeleteOnVmDeletionOk + +`func (o *FiltersVm) GetBlockDeviceMappingDeleteOnVmDeletionOk() (*bool, bool)` + +GetBlockDeviceMappingDeleteOnVmDeletionOk returns a tuple with the BlockDeviceMappingDeleteOnVmDeletion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBlockDeviceMappingDeleteOnVmDeletion + +`func (o *FiltersVm) SetBlockDeviceMappingDeleteOnVmDeletion(v bool)` + +SetBlockDeviceMappingDeleteOnVmDeletion sets BlockDeviceMappingDeleteOnVmDeletion field to given value. + +### HasBlockDeviceMappingDeleteOnVmDeletion + +`func (o *FiltersVm) HasBlockDeviceMappingDeleteOnVmDeletion() bool` + +HasBlockDeviceMappingDeleteOnVmDeletion returns a boolean if a field has been set. + +### GetBlockDeviceMappingDeviceNames + +`func (o *FiltersVm) GetBlockDeviceMappingDeviceNames() []string` + +GetBlockDeviceMappingDeviceNames returns the BlockDeviceMappingDeviceNames field if non-nil, zero value otherwise. + +### GetBlockDeviceMappingDeviceNamesOk + +`func (o *FiltersVm) GetBlockDeviceMappingDeviceNamesOk() (*[]string, bool)` + +GetBlockDeviceMappingDeviceNamesOk returns a tuple with the BlockDeviceMappingDeviceNames field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBlockDeviceMappingDeviceNames + +`func (o *FiltersVm) SetBlockDeviceMappingDeviceNames(v []string)` + +SetBlockDeviceMappingDeviceNames sets BlockDeviceMappingDeviceNames field to given value. + +### HasBlockDeviceMappingDeviceNames + +`func (o *FiltersVm) HasBlockDeviceMappingDeviceNames() bool` + +HasBlockDeviceMappingDeviceNames returns a boolean if a field has been set. + +### GetBlockDeviceMappingLinkDates + +`func (o *FiltersVm) GetBlockDeviceMappingLinkDates() []string` + +GetBlockDeviceMappingLinkDates returns the BlockDeviceMappingLinkDates field if non-nil, zero value otherwise. + +### GetBlockDeviceMappingLinkDatesOk + +`func (o *FiltersVm) GetBlockDeviceMappingLinkDatesOk() (*[]string, bool)` + +GetBlockDeviceMappingLinkDatesOk returns a tuple with the BlockDeviceMappingLinkDates field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBlockDeviceMappingLinkDates + +`func (o *FiltersVm) SetBlockDeviceMappingLinkDates(v []string)` + +SetBlockDeviceMappingLinkDates sets BlockDeviceMappingLinkDates field to given value. + +### HasBlockDeviceMappingLinkDates + +`func (o *FiltersVm) HasBlockDeviceMappingLinkDates() bool` + +HasBlockDeviceMappingLinkDates returns a boolean if a field has been set. + +### GetBlockDeviceMappingStates + +`func (o *FiltersVm) GetBlockDeviceMappingStates() []string` + +GetBlockDeviceMappingStates returns the BlockDeviceMappingStates field if non-nil, zero value otherwise. + +### GetBlockDeviceMappingStatesOk + +`func (o *FiltersVm) GetBlockDeviceMappingStatesOk() (*[]string, bool)` + +GetBlockDeviceMappingStatesOk returns a tuple with the BlockDeviceMappingStates field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBlockDeviceMappingStates + +`func (o *FiltersVm) SetBlockDeviceMappingStates(v []string)` + +SetBlockDeviceMappingStates sets BlockDeviceMappingStates field to given value. + +### HasBlockDeviceMappingStates + +`func (o *FiltersVm) HasBlockDeviceMappingStates() bool` + +HasBlockDeviceMappingStates returns a boolean if a field has been set. + +### GetBlockDeviceMappingVolumeIds + +`func (o *FiltersVm) GetBlockDeviceMappingVolumeIds() []string` + +GetBlockDeviceMappingVolumeIds returns the BlockDeviceMappingVolumeIds field if non-nil, zero value otherwise. + +### GetBlockDeviceMappingVolumeIdsOk + +`func (o *FiltersVm) GetBlockDeviceMappingVolumeIdsOk() (*[]string, bool)` + +GetBlockDeviceMappingVolumeIdsOk returns a tuple with the BlockDeviceMappingVolumeIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBlockDeviceMappingVolumeIds + +`func (o *FiltersVm) SetBlockDeviceMappingVolumeIds(v []string)` + +SetBlockDeviceMappingVolumeIds sets BlockDeviceMappingVolumeIds field to given value. + +### HasBlockDeviceMappingVolumeIds + +`func (o *FiltersVm) HasBlockDeviceMappingVolumeIds() bool` + +HasBlockDeviceMappingVolumeIds returns a boolean if a field has been set. + +### GetClientTokens + +`func (o *FiltersVm) GetClientTokens() []string` + +GetClientTokens returns the ClientTokens field if non-nil, zero value otherwise. + +### GetClientTokensOk + +`func (o *FiltersVm) GetClientTokensOk() (*[]string, bool)` + +GetClientTokensOk returns a tuple with the ClientTokens field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientTokens + +`func (o *FiltersVm) SetClientTokens(v []string)` + +SetClientTokens sets ClientTokens field to given value. + +### HasClientTokens + +`func (o *FiltersVm) HasClientTokens() bool` + +HasClientTokens returns a boolean if a field has been set. + +### GetCreationDates + +`func (o *FiltersVm) GetCreationDates() []string` + +GetCreationDates returns the CreationDates field if non-nil, zero value otherwise. + +### GetCreationDatesOk + +`func (o *FiltersVm) GetCreationDatesOk() (*[]string, bool)` + +GetCreationDatesOk returns a tuple with the CreationDates field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreationDates + +`func (o *FiltersVm) SetCreationDates(v []string)` + +SetCreationDates sets CreationDates field to given value. + +### HasCreationDates + +`func (o *FiltersVm) HasCreationDates() bool` + +HasCreationDates returns a boolean if a field has been set. + +### GetImageIds + +`func (o *FiltersVm) GetImageIds() []string` + +GetImageIds returns the ImageIds field if non-nil, zero value otherwise. + +### GetImageIdsOk + +`func (o *FiltersVm) GetImageIdsOk() (*[]string, bool)` + +GetImageIdsOk returns a tuple with the ImageIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetImageIds + +`func (o *FiltersVm) SetImageIds(v []string)` + +SetImageIds sets ImageIds field to given value. + +### HasImageIds + +`func (o *FiltersVm) HasImageIds() bool` + +HasImageIds returns a boolean if a field has been set. + +### GetIsSourceDestChecked + +`func (o *FiltersVm) GetIsSourceDestChecked() bool` + +GetIsSourceDestChecked returns the IsSourceDestChecked field if non-nil, zero value otherwise. + +### GetIsSourceDestCheckedOk + +`func (o *FiltersVm) GetIsSourceDestCheckedOk() (*bool, bool)` + +GetIsSourceDestCheckedOk returns a tuple with the IsSourceDestChecked field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsSourceDestChecked + +`func (o *FiltersVm) SetIsSourceDestChecked(v bool)` + +SetIsSourceDestChecked sets IsSourceDestChecked field to given value. + +### HasIsSourceDestChecked + +`func (o *FiltersVm) HasIsSourceDestChecked() bool` + +HasIsSourceDestChecked returns a boolean if a field has been set. + +### GetKeypairNames + +`func (o *FiltersVm) GetKeypairNames() []string` + +GetKeypairNames returns the KeypairNames field if non-nil, zero value otherwise. + +### GetKeypairNamesOk + +`func (o *FiltersVm) GetKeypairNamesOk() (*[]string, bool)` + +GetKeypairNamesOk returns a tuple with the KeypairNames field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKeypairNames + +`func (o *FiltersVm) SetKeypairNames(v []string)` + +SetKeypairNames sets KeypairNames field to given value. + +### HasKeypairNames + +`func (o *FiltersVm) HasKeypairNames() bool` + +HasKeypairNames returns a boolean if a field has been set. + +### GetLaunchNumbers + +`func (o *FiltersVm) GetLaunchNumbers() []int32` + +GetLaunchNumbers returns the LaunchNumbers field if non-nil, zero value otherwise. + +### GetLaunchNumbersOk + +`func (o *FiltersVm) GetLaunchNumbersOk() (*[]int32, bool)` + +GetLaunchNumbersOk returns a tuple with the LaunchNumbers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLaunchNumbers + +`func (o *FiltersVm) SetLaunchNumbers(v []int32)` + +SetLaunchNumbers sets LaunchNumbers field to given value. + +### HasLaunchNumbers + +`func (o *FiltersVm) HasLaunchNumbers() bool` + +HasLaunchNumbers returns a boolean if a field has been set. + +### GetLifecycles + +`func (o *FiltersVm) GetLifecycles() []string` + +GetLifecycles returns the Lifecycles field if non-nil, zero value otherwise. + +### GetLifecyclesOk + +`func (o *FiltersVm) GetLifecyclesOk() (*[]string, bool)` + +GetLifecyclesOk returns a tuple with the Lifecycles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLifecycles + +`func (o *FiltersVm) SetLifecycles(v []string)` + +SetLifecycles sets Lifecycles field to given value. + +### HasLifecycles + +`func (o *FiltersVm) HasLifecycles() bool` + +HasLifecycles returns a boolean if a field has been set. + +### GetNetIds + +`func (o *FiltersVm) GetNetIds() []string` + +GetNetIds returns the NetIds field if non-nil, zero value otherwise. + +### GetNetIdsOk + +`func (o *FiltersVm) GetNetIdsOk() (*[]string, bool)` + +GetNetIdsOk returns a tuple with the NetIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNetIds + +`func (o *FiltersVm) SetNetIds(v []string)` + +SetNetIds sets NetIds field to given value. + +### HasNetIds + +`func (o *FiltersVm) HasNetIds() bool` + +HasNetIds returns a boolean if a field has been set. + +### GetNicAccountIds + +`func (o *FiltersVm) GetNicAccountIds() []string` + +GetNicAccountIds returns the NicAccountIds field if non-nil, zero value otherwise. + +### GetNicAccountIdsOk + +`func (o *FiltersVm) GetNicAccountIdsOk() (*[]string, bool)` + +GetNicAccountIdsOk returns a tuple with the NicAccountIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNicAccountIds + +`func (o *FiltersVm) SetNicAccountIds(v []string)` + +SetNicAccountIds sets NicAccountIds field to given value. + +### HasNicAccountIds + +`func (o *FiltersVm) HasNicAccountIds() bool` + +HasNicAccountIds returns a boolean if a field has been set. + +### GetNicDescriptions + +`func (o *FiltersVm) GetNicDescriptions() []string` + +GetNicDescriptions returns the NicDescriptions field if non-nil, zero value otherwise. + +### GetNicDescriptionsOk + +`func (o *FiltersVm) GetNicDescriptionsOk() (*[]string, bool)` + +GetNicDescriptionsOk returns a tuple with the NicDescriptions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNicDescriptions + +`func (o *FiltersVm) SetNicDescriptions(v []string)` + +SetNicDescriptions sets NicDescriptions field to given value. + +### HasNicDescriptions + +`func (o *FiltersVm) HasNicDescriptions() bool` + +HasNicDescriptions returns a boolean if a field has been set. + +### GetNicIsSourceDestChecked + +`func (o *FiltersVm) GetNicIsSourceDestChecked() bool` + +GetNicIsSourceDestChecked returns the NicIsSourceDestChecked field if non-nil, zero value otherwise. + +### GetNicIsSourceDestCheckedOk + +`func (o *FiltersVm) GetNicIsSourceDestCheckedOk() (*bool, bool)` + +GetNicIsSourceDestCheckedOk returns a tuple with the NicIsSourceDestChecked field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNicIsSourceDestChecked + +`func (o *FiltersVm) SetNicIsSourceDestChecked(v bool)` + +SetNicIsSourceDestChecked sets NicIsSourceDestChecked field to given value. + +### HasNicIsSourceDestChecked + +`func (o *FiltersVm) HasNicIsSourceDestChecked() bool` + +HasNicIsSourceDestChecked returns a boolean if a field has been set. + +### GetNicLinkNicDeleteOnVmDeletion + +`func (o *FiltersVm) GetNicLinkNicDeleteOnVmDeletion() bool` + +GetNicLinkNicDeleteOnVmDeletion returns the NicLinkNicDeleteOnVmDeletion field if non-nil, zero value otherwise. + +### GetNicLinkNicDeleteOnVmDeletionOk + +`func (o *FiltersVm) GetNicLinkNicDeleteOnVmDeletionOk() (*bool, bool)` + +GetNicLinkNicDeleteOnVmDeletionOk returns a tuple with the NicLinkNicDeleteOnVmDeletion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNicLinkNicDeleteOnVmDeletion + +`func (o *FiltersVm) SetNicLinkNicDeleteOnVmDeletion(v bool)` + +SetNicLinkNicDeleteOnVmDeletion sets NicLinkNicDeleteOnVmDeletion field to given value. + +### HasNicLinkNicDeleteOnVmDeletion + +`func (o *FiltersVm) HasNicLinkNicDeleteOnVmDeletion() bool` + +HasNicLinkNicDeleteOnVmDeletion returns a boolean if a field has been set. + +### GetNicLinkNicDeviceNumbers + +`func (o *FiltersVm) GetNicLinkNicDeviceNumbers() []int32` + +GetNicLinkNicDeviceNumbers returns the NicLinkNicDeviceNumbers field if non-nil, zero value otherwise. + +### GetNicLinkNicDeviceNumbersOk + +`func (o *FiltersVm) GetNicLinkNicDeviceNumbersOk() (*[]int32, bool)` + +GetNicLinkNicDeviceNumbersOk returns a tuple with the NicLinkNicDeviceNumbers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNicLinkNicDeviceNumbers + +`func (o *FiltersVm) SetNicLinkNicDeviceNumbers(v []int32)` + +SetNicLinkNicDeviceNumbers sets NicLinkNicDeviceNumbers field to given value. + +### HasNicLinkNicDeviceNumbers + +`func (o *FiltersVm) HasNicLinkNicDeviceNumbers() bool` + +HasNicLinkNicDeviceNumbers returns a boolean if a field has been set. + +### GetNicLinkNicLinkNicDates + +`func (o *FiltersVm) GetNicLinkNicLinkNicDates() []string` + +GetNicLinkNicLinkNicDates returns the NicLinkNicLinkNicDates field if non-nil, zero value otherwise. + +### GetNicLinkNicLinkNicDatesOk + +`func (o *FiltersVm) GetNicLinkNicLinkNicDatesOk() (*[]string, bool)` + +GetNicLinkNicLinkNicDatesOk returns a tuple with the NicLinkNicLinkNicDates field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNicLinkNicLinkNicDates + +`func (o *FiltersVm) SetNicLinkNicLinkNicDates(v []string)` + +SetNicLinkNicLinkNicDates sets NicLinkNicLinkNicDates field to given value. + +### HasNicLinkNicLinkNicDates + +`func (o *FiltersVm) HasNicLinkNicLinkNicDates() bool` + +HasNicLinkNicLinkNicDates returns a boolean if a field has been set. + +### GetNicLinkNicLinkNicIds + +`func (o *FiltersVm) GetNicLinkNicLinkNicIds() []string` + +GetNicLinkNicLinkNicIds returns the NicLinkNicLinkNicIds field if non-nil, zero value otherwise. + +### GetNicLinkNicLinkNicIdsOk + +`func (o *FiltersVm) GetNicLinkNicLinkNicIdsOk() (*[]string, bool)` + +GetNicLinkNicLinkNicIdsOk returns a tuple with the NicLinkNicLinkNicIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNicLinkNicLinkNicIds + +`func (o *FiltersVm) SetNicLinkNicLinkNicIds(v []string)` + +SetNicLinkNicLinkNicIds sets NicLinkNicLinkNicIds field to given value. + +### HasNicLinkNicLinkNicIds + +`func (o *FiltersVm) HasNicLinkNicLinkNicIds() bool` + +HasNicLinkNicLinkNicIds returns a boolean if a field has been set. + +### GetNicLinkNicStates + +`func (o *FiltersVm) GetNicLinkNicStates() []string` + +GetNicLinkNicStates returns the NicLinkNicStates field if non-nil, zero value otherwise. + +### GetNicLinkNicStatesOk + +`func (o *FiltersVm) GetNicLinkNicStatesOk() (*[]string, bool)` + +GetNicLinkNicStatesOk returns a tuple with the NicLinkNicStates field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNicLinkNicStates + +`func (o *FiltersVm) SetNicLinkNicStates(v []string)` + +SetNicLinkNicStates sets NicLinkNicStates field to given value. + +### HasNicLinkNicStates + +`func (o *FiltersVm) HasNicLinkNicStates() bool` + +HasNicLinkNicStates returns a boolean if a field has been set. + +### GetNicLinkNicVmAccountIds + +`func (o *FiltersVm) GetNicLinkNicVmAccountIds() []string` + +GetNicLinkNicVmAccountIds returns the NicLinkNicVmAccountIds field if non-nil, zero value otherwise. + +### GetNicLinkNicVmAccountIdsOk + +`func (o *FiltersVm) GetNicLinkNicVmAccountIdsOk() (*[]string, bool)` + +GetNicLinkNicVmAccountIdsOk returns a tuple with the NicLinkNicVmAccountIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNicLinkNicVmAccountIds + +`func (o *FiltersVm) SetNicLinkNicVmAccountIds(v []string)` + +SetNicLinkNicVmAccountIds sets NicLinkNicVmAccountIds field to given value. + +### HasNicLinkNicVmAccountIds + +`func (o *FiltersVm) HasNicLinkNicVmAccountIds() bool` + +HasNicLinkNicVmAccountIds returns a boolean if a field has been set. + +### GetNicLinkNicVmIds + +`func (o *FiltersVm) GetNicLinkNicVmIds() []string` + +GetNicLinkNicVmIds returns the NicLinkNicVmIds field if non-nil, zero value otherwise. + +### GetNicLinkNicVmIdsOk + +`func (o *FiltersVm) GetNicLinkNicVmIdsOk() (*[]string, bool)` + +GetNicLinkNicVmIdsOk returns a tuple with the NicLinkNicVmIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNicLinkNicVmIds + +`func (o *FiltersVm) SetNicLinkNicVmIds(v []string)` + +SetNicLinkNicVmIds sets NicLinkNicVmIds field to given value. + +### HasNicLinkNicVmIds + +`func (o *FiltersVm) HasNicLinkNicVmIds() bool` + +HasNicLinkNicVmIds returns a boolean if a field has been set. + +### GetNicLinkPublicIpAccountIds + +`func (o *FiltersVm) GetNicLinkPublicIpAccountIds() []string` + +GetNicLinkPublicIpAccountIds returns the NicLinkPublicIpAccountIds field if non-nil, zero value otherwise. + +### GetNicLinkPublicIpAccountIdsOk + +`func (o *FiltersVm) GetNicLinkPublicIpAccountIdsOk() (*[]string, bool)` + +GetNicLinkPublicIpAccountIdsOk returns a tuple with the NicLinkPublicIpAccountIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNicLinkPublicIpAccountIds + +`func (o *FiltersVm) SetNicLinkPublicIpAccountIds(v []string)` + +SetNicLinkPublicIpAccountIds sets NicLinkPublicIpAccountIds field to given value. + +### HasNicLinkPublicIpAccountIds + +`func (o *FiltersVm) HasNicLinkPublicIpAccountIds() bool` + +HasNicLinkPublicIpAccountIds returns a boolean if a field has been set. + +### GetNicLinkPublicIpLinkPublicIpIds + +`func (o *FiltersVm) GetNicLinkPublicIpLinkPublicIpIds() []string` + +GetNicLinkPublicIpLinkPublicIpIds returns the NicLinkPublicIpLinkPublicIpIds field if non-nil, zero value otherwise. + +### GetNicLinkPublicIpLinkPublicIpIdsOk + +`func (o *FiltersVm) GetNicLinkPublicIpLinkPublicIpIdsOk() (*[]string, bool)` + +GetNicLinkPublicIpLinkPublicIpIdsOk returns a tuple with the NicLinkPublicIpLinkPublicIpIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNicLinkPublicIpLinkPublicIpIds + +`func (o *FiltersVm) SetNicLinkPublicIpLinkPublicIpIds(v []string)` + +SetNicLinkPublicIpLinkPublicIpIds sets NicLinkPublicIpLinkPublicIpIds field to given value. + +### HasNicLinkPublicIpLinkPublicIpIds + +`func (o *FiltersVm) HasNicLinkPublicIpLinkPublicIpIds() bool` + +HasNicLinkPublicIpLinkPublicIpIds returns a boolean if a field has been set. + +### GetNicLinkPublicIpPublicIpIds + +`func (o *FiltersVm) GetNicLinkPublicIpPublicIpIds() []string` + +GetNicLinkPublicIpPublicIpIds returns the NicLinkPublicIpPublicIpIds field if non-nil, zero value otherwise. + +### GetNicLinkPublicIpPublicIpIdsOk + +`func (o *FiltersVm) GetNicLinkPublicIpPublicIpIdsOk() (*[]string, bool)` + +GetNicLinkPublicIpPublicIpIdsOk returns a tuple with the NicLinkPublicIpPublicIpIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNicLinkPublicIpPublicIpIds + +`func (o *FiltersVm) SetNicLinkPublicIpPublicIpIds(v []string)` + +SetNicLinkPublicIpPublicIpIds sets NicLinkPublicIpPublicIpIds field to given value. + +### HasNicLinkPublicIpPublicIpIds + +`func (o *FiltersVm) HasNicLinkPublicIpPublicIpIds() bool` + +HasNicLinkPublicIpPublicIpIds returns a boolean if a field has been set. + +### GetNicLinkPublicIpPublicIps + +`func (o *FiltersVm) GetNicLinkPublicIpPublicIps() []string` + +GetNicLinkPublicIpPublicIps returns the NicLinkPublicIpPublicIps field if non-nil, zero value otherwise. + +### GetNicLinkPublicIpPublicIpsOk + +`func (o *FiltersVm) GetNicLinkPublicIpPublicIpsOk() (*[]string, bool)` + +GetNicLinkPublicIpPublicIpsOk returns a tuple with the NicLinkPublicIpPublicIps field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNicLinkPublicIpPublicIps + +`func (o *FiltersVm) SetNicLinkPublicIpPublicIps(v []string)` + +SetNicLinkPublicIpPublicIps sets NicLinkPublicIpPublicIps field to given value. + +### HasNicLinkPublicIpPublicIps + +`func (o *FiltersVm) HasNicLinkPublicIpPublicIps() bool` + +HasNicLinkPublicIpPublicIps returns a boolean if a field has been set. + +### GetNicMacAddresses + +`func (o *FiltersVm) GetNicMacAddresses() []string` + +GetNicMacAddresses returns the NicMacAddresses field if non-nil, zero value otherwise. + +### GetNicMacAddressesOk + +`func (o *FiltersVm) GetNicMacAddressesOk() (*[]string, bool)` + +GetNicMacAddressesOk returns a tuple with the NicMacAddresses field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNicMacAddresses + +`func (o *FiltersVm) SetNicMacAddresses(v []string)` + +SetNicMacAddresses sets NicMacAddresses field to given value. + +### HasNicMacAddresses + +`func (o *FiltersVm) HasNicMacAddresses() bool` + +HasNicMacAddresses returns a boolean if a field has been set. + +### GetNicNetIds + +`func (o *FiltersVm) GetNicNetIds() []string` + +GetNicNetIds returns the NicNetIds field if non-nil, zero value otherwise. + +### GetNicNetIdsOk + +`func (o *FiltersVm) GetNicNetIdsOk() (*[]string, bool)` + +GetNicNetIdsOk returns a tuple with the NicNetIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNicNetIds + +`func (o *FiltersVm) SetNicNetIds(v []string)` + +SetNicNetIds sets NicNetIds field to given value. + +### HasNicNetIds + +`func (o *FiltersVm) HasNicNetIds() bool` + +HasNicNetIds returns a boolean if a field has been set. + +### GetNicNicIds + +`func (o *FiltersVm) GetNicNicIds() []string` + +GetNicNicIds returns the NicNicIds field if non-nil, zero value otherwise. + +### GetNicNicIdsOk + +`func (o *FiltersVm) GetNicNicIdsOk() (*[]string, bool)` + +GetNicNicIdsOk returns a tuple with the NicNicIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNicNicIds + +`func (o *FiltersVm) SetNicNicIds(v []string)` + +SetNicNicIds sets NicNicIds field to given value. + +### HasNicNicIds + +`func (o *FiltersVm) HasNicNicIds() bool` + +HasNicNicIds returns a boolean if a field has been set. + +### GetNicPrivateIpsLinkPublicIpAccountIds + +`func (o *FiltersVm) GetNicPrivateIpsLinkPublicIpAccountIds() []string` + +GetNicPrivateIpsLinkPublicIpAccountIds returns the NicPrivateIpsLinkPublicIpAccountIds field if non-nil, zero value otherwise. + +### GetNicPrivateIpsLinkPublicIpAccountIdsOk + +`func (o *FiltersVm) GetNicPrivateIpsLinkPublicIpAccountIdsOk() (*[]string, bool)` + +GetNicPrivateIpsLinkPublicIpAccountIdsOk returns a tuple with the NicPrivateIpsLinkPublicIpAccountIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNicPrivateIpsLinkPublicIpAccountIds + +`func (o *FiltersVm) SetNicPrivateIpsLinkPublicIpAccountIds(v []string)` + +SetNicPrivateIpsLinkPublicIpAccountIds sets NicPrivateIpsLinkPublicIpAccountIds field to given value. + +### HasNicPrivateIpsLinkPublicIpAccountIds + +`func (o *FiltersVm) HasNicPrivateIpsLinkPublicIpAccountIds() bool` + +HasNicPrivateIpsLinkPublicIpAccountIds returns a boolean if a field has been set. + +### GetNicPrivateIpsLinkPublicIpIds + +`func (o *FiltersVm) GetNicPrivateIpsLinkPublicIpIds() []string` + +GetNicPrivateIpsLinkPublicIpIds returns the NicPrivateIpsLinkPublicIpIds field if non-nil, zero value otherwise. + +### GetNicPrivateIpsLinkPublicIpIdsOk + +`func (o *FiltersVm) GetNicPrivateIpsLinkPublicIpIdsOk() (*[]string, bool)` + +GetNicPrivateIpsLinkPublicIpIdsOk returns a tuple with the NicPrivateIpsLinkPublicIpIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNicPrivateIpsLinkPublicIpIds + +`func (o *FiltersVm) SetNicPrivateIpsLinkPublicIpIds(v []string)` + +SetNicPrivateIpsLinkPublicIpIds sets NicPrivateIpsLinkPublicIpIds field to given value. + +### HasNicPrivateIpsLinkPublicIpIds + +`func (o *FiltersVm) HasNicPrivateIpsLinkPublicIpIds() bool` + +HasNicPrivateIpsLinkPublicIpIds returns a boolean if a field has been set. + +### GetNicPrivateIpsPrimaryIp + +`func (o *FiltersVm) GetNicPrivateIpsPrimaryIp() bool` + +GetNicPrivateIpsPrimaryIp returns the NicPrivateIpsPrimaryIp field if non-nil, zero value otherwise. + +### GetNicPrivateIpsPrimaryIpOk + +`func (o *FiltersVm) GetNicPrivateIpsPrimaryIpOk() (*bool, bool)` + +GetNicPrivateIpsPrimaryIpOk returns a tuple with the NicPrivateIpsPrimaryIp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNicPrivateIpsPrimaryIp + +`func (o *FiltersVm) SetNicPrivateIpsPrimaryIp(v bool)` + +SetNicPrivateIpsPrimaryIp sets NicPrivateIpsPrimaryIp field to given value. + +### HasNicPrivateIpsPrimaryIp + +`func (o *FiltersVm) HasNicPrivateIpsPrimaryIp() bool` + +HasNicPrivateIpsPrimaryIp returns a boolean if a field has been set. + +### GetNicPrivateIpsPrivateIps + +`func (o *FiltersVm) GetNicPrivateIpsPrivateIps() []string` + +GetNicPrivateIpsPrivateIps returns the NicPrivateIpsPrivateIps field if non-nil, zero value otherwise. + +### GetNicPrivateIpsPrivateIpsOk + +`func (o *FiltersVm) GetNicPrivateIpsPrivateIpsOk() (*[]string, bool)` + +GetNicPrivateIpsPrivateIpsOk returns a tuple with the NicPrivateIpsPrivateIps field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNicPrivateIpsPrivateIps + +`func (o *FiltersVm) SetNicPrivateIpsPrivateIps(v []string)` + +SetNicPrivateIpsPrivateIps sets NicPrivateIpsPrivateIps field to given value. + +### HasNicPrivateIpsPrivateIps + +`func (o *FiltersVm) HasNicPrivateIpsPrivateIps() bool` + +HasNicPrivateIpsPrivateIps returns a boolean if a field has been set. + +### GetNicSecurityGroupIds + +`func (o *FiltersVm) GetNicSecurityGroupIds() []string` + +GetNicSecurityGroupIds returns the NicSecurityGroupIds field if non-nil, zero value otherwise. + +### GetNicSecurityGroupIdsOk + +`func (o *FiltersVm) GetNicSecurityGroupIdsOk() (*[]string, bool)` + +GetNicSecurityGroupIdsOk returns a tuple with the NicSecurityGroupIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNicSecurityGroupIds + +`func (o *FiltersVm) SetNicSecurityGroupIds(v []string)` + +SetNicSecurityGroupIds sets NicSecurityGroupIds field to given value. + +### HasNicSecurityGroupIds + +`func (o *FiltersVm) HasNicSecurityGroupIds() bool` + +HasNicSecurityGroupIds returns a boolean if a field has been set. + +### GetNicSecurityGroupNames + +`func (o *FiltersVm) GetNicSecurityGroupNames() []string` + +GetNicSecurityGroupNames returns the NicSecurityGroupNames field if non-nil, zero value otherwise. + +### GetNicSecurityGroupNamesOk + +`func (o *FiltersVm) GetNicSecurityGroupNamesOk() (*[]string, bool)` + +GetNicSecurityGroupNamesOk returns a tuple with the NicSecurityGroupNames field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNicSecurityGroupNames + +`func (o *FiltersVm) SetNicSecurityGroupNames(v []string)` + +SetNicSecurityGroupNames sets NicSecurityGroupNames field to given value. + +### HasNicSecurityGroupNames + +`func (o *FiltersVm) HasNicSecurityGroupNames() bool` + +HasNicSecurityGroupNames returns a boolean if a field has been set. + +### GetNicStates + +`func (o *FiltersVm) GetNicStates() []string` + +GetNicStates returns the NicStates field if non-nil, zero value otherwise. + +### GetNicStatesOk + +`func (o *FiltersVm) GetNicStatesOk() (*[]string, bool)` + +GetNicStatesOk returns a tuple with the NicStates field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNicStates + +`func (o *FiltersVm) SetNicStates(v []string)` + +SetNicStates sets NicStates field to given value. + +### HasNicStates + +`func (o *FiltersVm) HasNicStates() bool` + +HasNicStates returns a boolean if a field has been set. + +### GetNicSubnetIds + +`func (o *FiltersVm) GetNicSubnetIds() []string` + +GetNicSubnetIds returns the NicSubnetIds field if non-nil, zero value otherwise. + +### GetNicSubnetIdsOk + +`func (o *FiltersVm) GetNicSubnetIdsOk() (*[]string, bool)` + +GetNicSubnetIdsOk returns a tuple with the NicSubnetIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNicSubnetIds + +`func (o *FiltersVm) SetNicSubnetIds(v []string)` + +SetNicSubnetIds sets NicSubnetIds field to given value. + +### HasNicSubnetIds + +`func (o *FiltersVm) HasNicSubnetIds() bool` + +HasNicSubnetIds returns a boolean if a field has been set. + +### GetNicSubregionNames + +`func (o *FiltersVm) GetNicSubregionNames() []string` + +GetNicSubregionNames returns the NicSubregionNames field if non-nil, zero value otherwise. + +### GetNicSubregionNamesOk + +`func (o *FiltersVm) GetNicSubregionNamesOk() (*[]string, bool)` + +GetNicSubregionNamesOk returns a tuple with the NicSubregionNames field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNicSubregionNames + +`func (o *FiltersVm) SetNicSubregionNames(v []string)` + +SetNicSubregionNames sets NicSubregionNames field to given value. + +### HasNicSubregionNames + +`func (o *FiltersVm) HasNicSubregionNames() bool` + +HasNicSubregionNames returns a boolean if a field has been set. + +### GetPlatforms + +`func (o *FiltersVm) GetPlatforms() []string` + +GetPlatforms returns the Platforms field if non-nil, zero value otherwise. + +### GetPlatformsOk + +`func (o *FiltersVm) GetPlatformsOk() (*[]string, bool)` + +GetPlatformsOk returns a tuple with the Platforms field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPlatforms + +`func (o *FiltersVm) SetPlatforms(v []string)` + +SetPlatforms sets Platforms field to given value. + +### HasPlatforms + +`func (o *FiltersVm) HasPlatforms() bool` + +HasPlatforms returns a boolean if a field has been set. + +### GetPrivateIps + +`func (o *FiltersVm) GetPrivateIps() []string` + +GetPrivateIps returns the PrivateIps field if non-nil, zero value otherwise. + +### GetPrivateIpsOk + +`func (o *FiltersVm) GetPrivateIpsOk() (*[]string, bool)` + +GetPrivateIpsOk returns a tuple with the PrivateIps field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivateIps + +`func (o *FiltersVm) SetPrivateIps(v []string)` + +SetPrivateIps sets PrivateIps field to given value. + +### HasPrivateIps + +`func (o *FiltersVm) HasPrivateIps() bool` + +HasPrivateIps returns a boolean if a field has been set. + +### GetProductCodes + +`func (o *FiltersVm) GetProductCodes() []string` + +GetProductCodes returns the ProductCodes field if non-nil, zero value otherwise. + +### GetProductCodesOk + +`func (o *FiltersVm) GetProductCodesOk() (*[]string, bool)` + +GetProductCodesOk returns a tuple with the ProductCodes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProductCodes + +`func (o *FiltersVm) SetProductCodes(v []string)` + +SetProductCodes sets ProductCodes field to given value. + +### HasProductCodes + +`func (o *FiltersVm) HasProductCodes() bool` + +HasProductCodes returns a boolean if a field has been set. + +### GetPublicIps + +`func (o *FiltersVm) GetPublicIps() []string` + +GetPublicIps returns the PublicIps field if non-nil, zero value otherwise. + +### GetPublicIpsOk + +`func (o *FiltersVm) GetPublicIpsOk() (*[]string, bool)` + +GetPublicIpsOk returns a tuple with the PublicIps field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicIps + +`func (o *FiltersVm) SetPublicIps(v []string)` + +SetPublicIps sets PublicIps field to given value. + +### HasPublicIps + +`func (o *FiltersVm) HasPublicIps() bool` + +HasPublicIps returns a boolean if a field has been set. + +### GetReservationIds + +`func (o *FiltersVm) GetReservationIds() []string` + +GetReservationIds returns the ReservationIds field if non-nil, zero value otherwise. + +### GetReservationIdsOk + +`func (o *FiltersVm) GetReservationIdsOk() (*[]string, bool)` + +GetReservationIdsOk returns a tuple with the ReservationIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReservationIds + +`func (o *FiltersVm) SetReservationIds(v []string)` + +SetReservationIds sets ReservationIds field to given value. + +### HasReservationIds + +`func (o *FiltersVm) HasReservationIds() bool` + +HasReservationIds returns a boolean if a field has been set. + +### GetRootDeviceNames + +`func (o *FiltersVm) GetRootDeviceNames() []string` + +GetRootDeviceNames returns the RootDeviceNames field if non-nil, zero value otherwise. + +### GetRootDeviceNamesOk + +`func (o *FiltersVm) GetRootDeviceNamesOk() (*[]string, bool)` + +GetRootDeviceNamesOk returns a tuple with the RootDeviceNames field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRootDeviceNames + +`func (o *FiltersVm) SetRootDeviceNames(v []string)` + +SetRootDeviceNames sets RootDeviceNames field to given value. + +### HasRootDeviceNames + +`func (o *FiltersVm) HasRootDeviceNames() bool` + +HasRootDeviceNames returns a boolean if a field has been set. + +### GetRootDeviceTypes + +`func (o *FiltersVm) GetRootDeviceTypes() []string` + +GetRootDeviceTypes returns the RootDeviceTypes field if non-nil, zero value otherwise. + +### GetRootDeviceTypesOk + +`func (o *FiltersVm) GetRootDeviceTypesOk() (*[]string, bool)` + +GetRootDeviceTypesOk returns a tuple with the RootDeviceTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRootDeviceTypes + +`func (o *FiltersVm) SetRootDeviceTypes(v []string)` + +SetRootDeviceTypes sets RootDeviceTypes field to given value. + +### HasRootDeviceTypes + +`func (o *FiltersVm) HasRootDeviceTypes() bool` + +HasRootDeviceTypes returns a boolean if a field has been set. + +### GetSecurityGroupIds + +`func (o *FiltersVm) GetSecurityGroupIds() []string` + +GetSecurityGroupIds returns the SecurityGroupIds field if non-nil, zero value otherwise. + +### GetSecurityGroupIdsOk + +`func (o *FiltersVm) GetSecurityGroupIdsOk() (*[]string, bool)` + +GetSecurityGroupIdsOk returns a tuple with the SecurityGroupIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSecurityGroupIds + +`func (o *FiltersVm) SetSecurityGroupIds(v []string)` + +SetSecurityGroupIds sets SecurityGroupIds field to given value. + +### HasSecurityGroupIds + +`func (o *FiltersVm) HasSecurityGroupIds() bool` + +HasSecurityGroupIds returns a boolean if a field has been set. + +### GetSecurityGroupNames + +`func (o *FiltersVm) GetSecurityGroupNames() []string` + +GetSecurityGroupNames returns the SecurityGroupNames field if non-nil, zero value otherwise. + +### GetSecurityGroupNamesOk + +`func (o *FiltersVm) GetSecurityGroupNamesOk() (*[]string, bool)` + +GetSecurityGroupNamesOk returns a tuple with the SecurityGroupNames field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSecurityGroupNames + +`func (o *FiltersVm) SetSecurityGroupNames(v []string)` + +SetSecurityGroupNames sets SecurityGroupNames field to given value. + +### HasSecurityGroupNames + +`func (o *FiltersVm) HasSecurityGroupNames() bool` + +HasSecurityGroupNames returns a boolean if a field has been set. + +### GetStateReasonCodes + +`func (o *FiltersVm) GetStateReasonCodes() []int32` + +GetStateReasonCodes returns the StateReasonCodes field if non-nil, zero value otherwise. + +### GetStateReasonCodesOk + +`func (o *FiltersVm) GetStateReasonCodesOk() (*[]int32, bool)` + +GetStateReasonCodesOk returns a tuple with the StateReasonCodes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStateReasonCodes + +`func (o *FiltersVm) SetStateReasonCodes(v []int32)` + +SetStateReasonCodes sets StateReasonCodes field to given value. + +### HasStateReasonCodes + +`func (o *FiltersVm) HasStateReasonCodes() bool` + +HasStateReasonCodes returns a boolean if a field has been set. + +### GetStateReasonMessages + +`func (o *FiltersVm) GetStateReasonMessages() []string` + +GetStateReasonMessages returns the StateReasonMessages field if non-nil, zero value otherwise. + +### GetStateReasonMessagesOk + +`func (o *FiltersVm) GetStateReasonMessagesOk() (*[]string, bool)` + +GetStateReasonMessagesOk returns a tuple with the StateReasonMessages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStateReasonMessages + +`func (o *FiltersVm) SetStateReasonMessages(v []string)` + +SetStateReasonMessages sets StateReasonMessages field to given value. + +### HasStateReasonMessages + +`func (o *FiltersVm) HasStateReasonMessages() bool` + +HasStateReasonMessages returns a boolean if a field has been set. + +### GetStateReasons + +`func (o *FiltersVm) GetStateReasons() []string` + +GetStateReasons returns the StateReasons field if non-nil, zero value otherwise. + +### GetStateReasonsOk + +`func (o *FiltersVm) GetStateReasonsOk() (*[]string, bool)` + +GetStateReasonsOk returns a tuple with the StateReasons field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStateReasons + +`func (o *FiltersVm) SetStateReasons(v []string)` + +SetStateReasons sets StateReasons field to given value. + +### HasStateReasons + +`func (o *FiltersVm) HasStateReasons() bool` + +HasStateReasons returns a boolean if a field has been set. + +### GetSubnetIds + +`func (o *FiltersVm) GetSubnetIds() []string` + +GetSubnetIds returns the SubnetIds field if non-nil, zero value otherwise. + +### GetSubnetIdsOk + +`func (o *FiltersVm) GetSubnetIdsOk() (*[]string, bool)` + +GetSubnetIdsOk returns a tuple with the SubnetIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubnetIds + +`func (o *FiltersVm) SetSubnetIds(v []string)` + +SetSubnetIds sets SubnetIds field to given value. + +### HasSubnetIds + +`func (o *FiltersVm) HasSubnetIds() bool` + +HasSubnetIds returns a boolean if a field has been set. + +### GetSubregionNames + +`func (o *FiltersVm) GetSubregionNames() []string` + +GetSubregionNames returns the SubregionNames field if non-nil, zero value otherwise. + +### GetSubregionNamesOk + +`func (o *FiltersVm) GetSubregionNamesOk() (*[]string, bool)` + +GetSubregionNamesOk returns a tuple with the SubregionNames field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubregionNames + +`func (o *FiltersVm) SetSubregionNames(v []string)` + +SetSubregionNames sets SubregionNames field to given value. + +### HasSubregionNames + +`func (o *FiltersVm) HasSubregionNames() bool` + +HasSubregionNames returns a boolean if a field has been set. + ### GetTagKeys `func (o *FiltersVm) GetTagKeys() []string` @@ -103,6 +1513,31 @@ SetTags sets Tags field to given value. HasTags returns a boolean if a field has been set. +### GetTenancies + +`func (o *FiltersVm) GetTenancies() []string` + +GetTenancies returns the Tenancies field if non-nil, zero value otherwise. + +### GetTenanciesOk + +`func (o *FiltersVm) GetTenanciesOk() (*[]string, bool)` + +GetTenanciesOk returns a tuple with the Tenancies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTenancies + +`func (o *FiltersVm) SetTenancies(v []string)` + +SetTenancies sets Tenancies field to given value. + +### HasTenancies + +`func (o *FiltersVm) HasTenancies() bool` + +HasTenancies returns a boolean if a field has been set. + ### GetVmIds `func (o *FiltersVm) GetVmIds() []string` @@ -128,6 +1563,131 @@ SetVmIds sets VmIds field to given value. HasVmIds returns a boolean if a field has been set. +### GetVmSecurityGroupIds + +`func (o *FiltersVm) GetVmSecurityGroupIds() []string` + +GetVmSecurityGroupIds returns the VmSecurityGroupIds field if non-nil, zero value otherwise. + +### GetVmSecurityGroupIdsOk + +`func (o *FiltersVm) GetVmSecurityGroupIdsOk() (*[]string, bool)` + +GetVmSecurityGroupIdsOk returns a tuple with the VmSecurityGroupIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVmSecurityGroupIds + +`func (o *FiltersVm) SetVmSecurityGroupIds(v []string)` + +SetVmSecurityGroupIds sets VmSecurityGroupIds field to given value. + +### HasVmSecurityGroupIds + +`func (o *FiltersVm) HasVmSecurityGroupIds() bool` + +HasVmSecurityGroupIds returns a boolean if a field has been set. + +### GetVmSecurityGroupNames + +`func (o *FiltersVm) GetVmSecurityGroupNames() []string` + +GetVmSecurityGroupNames returns the VmSecurityGroupNames field if non-nil, zero value otherwise. + +### GetVmSecurityGroupNamesOk + +`func (o *FiltersVm) GetVmSecurityGroupNamesOk() (*[]string, bool)` + +GetVmSecurityGroupNamesOk returns a tuple with the VmSecurityGroupNames field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVmSecurityGroupNames + +`func (o *FiltersVm) SetVmSecurityGroupNames(v []string)` + +SetVmSecurityGroupNames sets VmSecurityGroupNames field to given value. + +### HasVmSecurityGroupNames + +`func (o *FiltersVm) HasVmSecurityGroupNames() bool` + +HasVmSecurityGroupNames returns a boolean if a field has been set. + +### GetVmStateCodes + +`func (o *FiltersVm) GetVmStateCodes() []int32` + +GetVmStateCodes returns the VmStateCodes field if non-nil, zero value otherwise. + +### GetVmStateCodesOk + +`func (o *FiltersVm) GetVmStateCodesOk() (*[]int32, bool)` + +GetVmStateCodesOk returns a tuple with the VmStateCodes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVmStateCodes + +`func (o *FiltersVm) SetVmStateCodes(v []int32)` + +SetVmStateCodes sets VmStateCodes field to given value. + +### HasVmStateCodes + +`func (o *FiltersVm) HasVmStateCodes() bool` + +HasVmStateCodes returns a boolean if a field has been set. + +### GetVmStateNames + +`func (o *FiltersVm) GetVmStateNames() []string` + +GetVmStateNames returns the VmStateNames field if non-nil, zero value otherwise. + +### GetVmStateNamesOk + +`func (o *FiltersVm) GetVmStateNamesOk() (*[]string, bool)` + +GetVmStateNamesOk returns a tuple with the VmStateNames field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVmStateNames + +`func (o *FiltersVm) SetVmStateNames(v []string)` + +SetVmStateNames sets VmStateNames field to given value. + +### HasVmStateNames + +`func (o *FiltersVm) HasVmStateNames() bool` + +HasVmStateNames returns a boolean if a field has been set. + +### GetVmTypes + +`func (o *FiltersVm) GetVmTypes() []string` + +GetVmTypes returns the VmTypes field if non-nil, zero value otherwise. + +### GetVmTypesOk + +`func (o *FiltersVm) GetVmTypesOk() (*[]string, bool)` + +GetVmTypesOk returns a tuple with the VmTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVmTypes + +`func (o *FiltersVm) SetVmTypes(v []string)` + +SetVmTypes sets VmTypes field to given value. + +### HasVmTypes + +`func (o *FiltersVm) HasVmTypes() bool` + +HasVmTypes returns a boolean if a field has been set. + [[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/v2/docs/FiltersVmTemplate.md b/v2/docs/FiltersVmTemplate.md index c2e8119d3..fff4a42df 100644 --- a/v2/docs/FiltersVmTemplate.md +++ b/v2/docs/FiltersVmTemplate.md @@ -13,7 +13,7 @@ Name | Type | Description | Notes **Rams** | Pointer to **[]int32** | The amount of RAM. | [optional] **TagKeys** | Pointer to **[]string** | The keys of the tags associated with the VM templates. | [optional] **TagValues** | Pointer to **[]string** | The values of the tags associated with the VM templates. | [optional] -**Tags** | Pointer to **[]string** | The key/value combination of the tags associated with the VM templates, in the following format: \"Filters\":{\"Tags\":[\"TAGKEY=TAGVALUE\"]}. | [optional] +**Tags** | Pointer to **[]string** | The key/value combination of the tags associated with the VM templates, in the following format: &quot;Filters&quot;:{&quot;Tags&quot;:[&quot;TAGKEY=TAGVALUE&quot;]}. | [optional] **VmTemplateIds** | Pointer to **[]string** | The IDs of the VM templates. | [optional] **VmTemplateNames** | Pointer to **[]string** | The names of the VM templates. | [optional] diff --git a/v2/docs/FiltersVmType.md b/v2/docs/FiltersVmType.md index 68b1839c8..8306b209d 100644 --- a/v2/docs/FiltersVmType.md +++ b/v2/docs/FiltersVmType.md @@ -5,9 +5,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **BsuOptimized** | Pointer to **bool** | This parameter is not available. It is present in our API for the sake of historical compatibility with AWS. | [optional] +**EphemeralsTypes** | Pointer to **[]string** | The types of ephemeral storage disk. | [optional] +**Eths** | Pointer to **[]int32** | The number of Ethernet interfaces available. | [optional] +**Gpus** | Pointer to **[]int32** | The number of GPUs available. | [optional] **MemorySizes** | Pointer to **[]float32** | The amounts of memory, in gibibytes (GiB). | [optional] **VcoreCounts** | Pointer to **[]int32** | The numbers of vCores. | [optional] -**VmTypeNames** | Pointer to **[]string** | The names of the VM types. For more information, see [Instance Types](https://docs.outscale.com/en/userguide/Instance-Types.html). | [optional] +**VmTypeNames** | Pointer to **[]string** | The names of the VM types. For more information, see [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html). | [optional] **VolumeCounts** | Pointer to **[]int32** | The maximum number of ephemeral storage disks. | [optional] **VolumeSizes** | Pointer to **[]int32** | The size of one ephemeral storage disk, in gibibytes (GiB). | [optional] @@ -55,6 +58,81 @@ SetBsuOptimized sets BsuOptimized field to given value. HasBsuOptimized returns a boolean if a field has been set. +### GetEphemeralsTypes + +`func (o *FiltersVmType) GetEphemeralsTypes() []string` + +GetEphemeralsTypes returns the EphemeralsTypes field if non-nil, zero value otherwise. + +### GetEphemeralsTypesOk + +`func (o *FiltersVmType) GetEphemeralsTypesOk() (*[]string, bool)` + +GetEphemeralsTypesOk returns a tuple with the EphemeralsTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEphemeralsTypes + +`func (o *FiltersVmType) SetEphemeralsTypes(v []string)` + +SetEphemeralsTypes sets EphemeralsTypes field to given value. + +### HasEphemeralsTypes + +`func (o *FiltersVmType) HasEphemeralsTypes() bool` + +HasEphemeralsTypes returns a boolean if a field has been set. + +### GetEths + +`func (o *FiltersVmType) GetEths() []int32` + +GetEths returns the Eths field if non-nil, zero value otherwise. + +### GetEthsOk + +`func (o *FiltersVmType) GetEthsOk() (*[]int32, bool)` + +GetEthsOk returns a tuple with the Eths field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEths + +`func (o *FiltersVmType) SetEths(v []int32)` + +SetEths sets Eths field to given value. + +### HasEths + +`func (o *FiltersVmType) HasEths() bool` + +HasEths returns a boolean if a field has been set. + +### GetGpus + +`func (o *FiltersVmType) GetGpus() []int32` + +GetGpus returns the Gpus field if non-nil, zero value otherwise. + +### GetGpusOk + +`func (o *FiltersVmType) GetGpusOk() (*[]int32, bool)` + +GetGpusOk returns a tuple with the Gpus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGpus + +`func (o *FiltersVmType) SetGpus(v []int32)` + +SetGpus sets Gpus field to given value. + +### HasGpus + +`func (o *FiltersVmType) HasGpus() bool` + +HasGpus returns a boolean if a field has been set. + ### GetMemorySizes `func (o *FiltersVmType) GetMemorySizes() []float32` diff --git a/v2/docs/HealthCheck.md b/v2/docs/HealthCheck.md index dd9d38920..191a36f8a 100644 --- a/v2/docs/HealthCheck.md +++ b/v2/docs/HealthCheck.md @@ -4,13 +4,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**CheckInterval** | **int32** | The number of seconds between two pings (between `5` and `600` both included). | -**HealthyThreshold** | **int32** | The number of consecutive successful pings before considering the VM as healthy (between `2` and `10` both included). | -**Path** | Pointer to **string** | If you use the HTTP or HTTPS protocols, the ping path. | [optional] +**CheckInterval** | **int32** | The number of seconds between two requests (between `5` and `600` both included). | +**HealthyThreshold** | **int32** | The number of consecutive successful requests before considering the VM as healthy (between `2` and `10` both included). | +**Path** | Pointer to **string** | If you use the HTTP or HTTPS protocols, the request URL path. | [optional] **Port** | **int32** | The port number (between `1` and `65535`, both included). | **Protocol** | **string** | The protocol for the URL of the VM (`HTTP` \\| `HTTPS` \\| `TCP` \\| `SSL`). | **Timeout** | **int32** | The maximum waiting time for a response before considering the VM as unhealthy, in seconds (between `2` and `60` both included). | -**UnhealthyThreshold** | **int32** | The number of consecutive failed pings before considering the VM as unhealthy (between `2` and `10` both included). | +**UnhealthyThreshold** | **int32** | The number of consecutive failed requests before considering the VM as unhealthy (between `2` and `10` both included). | ## Methods diff --git a/v2/docs/Image.md b/v2/docs/Image.md index 3f88f85a8..e4e8993c3 100644 --- a/v2/docs/Image.md +++ b/v2/docs/Image.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **AccountAlias** | Pointer to **string** | The account alias of the owner of the OMI. | [optional] **AccountId** | Pointer to **string** | The account ID of the owner of the OMI. | [optional] -**Architecture** | Pointer to **string** | The architecture of the OMI (by default, `i386`). | [optional] +**Architecture** | Pointer to **string** | The architecture of the OMI. | [optional] **BlockDeviceMappings** | Pointer to [**[]BlockDeviceMappingImage**](BlockDeviceMappingImage.md) | One or more block device mappings. | [optional] **CreationDate** | Pointer to **string** | The date and time of creation of the OMI, in ISO 8601 date-time format. | [optional] **Description** | Pointer to **string** | The description of the OMI. | [optional] -**FileLocation** | Pointer to **string** | The location of the bucket where the OMI files are stored. | [optional] +**FileLocation** | Pointer to **string** | The location from which the OMI files were created. | [optional] **ImageId** | Pointer to **string** | The ID of the OMI. | [optional] **ImageName** | Pointer to **string** | The name of the OMI. | [optional] **ImageType** | Pointer to **string** | The type of the OMI. | [optional] diff --git a/v2/docs/Keypair.md b/v2/docs/Keypair.md index 827fb0828..4801a25e7 100644 --- a/v2/docs/Keypair.md +++ b/v2/docs/Keypair.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **KeypairFingerprint** | Pointer to **string** | The MD5 public key fingerprint as specified in section 4 of RFC 4716. | [optional] **KeypairName** | Pointer to **string** | The name of the keypair. | [optional] +**KeypairType** | Pointer to **string** | The type of the keypair (`ssh-rsa`, `ssh-ed25519`, `ecdsa-sha2-nistp256`, `ecdsa-sha2-nistp384`, or `ecdsa-sha2-nistp521`). | [optional] ## Methods @@ -76,6 +77,31 @@ SetKeypairName sets KeypairName field to given value. HasKeypairName returns a boolean if a field has been set. +### GetKeypairType + +`func (o *Keypair) GetKeypairType() string` + +GetKeypairType returns the KeypairType field if non-nil, zero value otherwise. + +### GetKeypairTypeOk + +`func (o *Keypair) GetKeypairTypeOk() (*string, bool)` + +GetKeypairTypeOk returns a tuple with the KeypairType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKeypairType + +`func (o *Keypair) SetKeypairType(v string)` + +SetKeypairType sets KeypairType field to given value. + +### HasKeypairType + +`func (o *Keypair) HasKeypairType() bool` + +HasKeypairType returns a boolean if a field has been set. + [[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/v2/docs/KeypairCreated.md b/v2/docs/KeypairCreated.md index 5e21d0d32..0a73ac5a6 100644 --- a/v2/docs/KeypairCreated.md +++ b/v2/docs/KeypairCreated.md @@ -4,9 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**KeypairFingerprint** | Pointer to **string** | The MD5 public key fingerprint as specified in section 4 of RFC 4716. | [optional] +**KeypairFingerprint** | Pointer to **string** | The MD5 public key fingerprint, as specified in section 4 of RFC 4716. | [optional] **KeypairName** | Pointer to **string** | The name of the keypair. | [optional] -**PrivateKey** | Pointer to **string** | The private key. When saving the private key in a .rsa file, replace the `\\n` escape sequences with line breaks. | [optional] +**KeypairType** | Pointer to **string** | The type of the keypair (`ssh-rsa`, `ssh-ed25519`, `ecdsa-sha2-nistp256`, `ecdsa-sha2-nistp384`, or `ecdsa-sha2-nistp521`). | [optional] +**PrivateKey** | Pointer to **string** | 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. | [optional] ## Methods @@ -77,6 +78,31 @@ SetKeypairName sets KeypairName field to given value. HasKeypairName returns a boolean if a field has been set. +### GetKeypairType + +`func (o *KeypairCreated) GetKeypairType() string` + +GetKeypairType returns the KeypairType field if non-nil, zero value otherwise. + +### GetKeypairTypeOk + +`func (o *KeypairCreated) GetKeypairTypeOk() (*string, bool)` + +GetKeypairTypeOk returns a tuple with the KeypairType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKeypairType + +`func (o *KeypairCreated) SetKeypairType(v string)` + +SetKeypairType sets KeypairType field to given value. + +### HasKeypairType + +`func (o *KeypairCreated) HasKeypairType() bool` + +HasKeypairType returns a boolean if a field has been set. + ### GetPrivateKey `func (o *KeypairCreated) GetPrivateKey() string` diff --git a/v2/docs/LinkPolicyRequest.md b/v2/docs/LinkPolicyRequest.md new file mode 100644 index 000000000..5d64bf654 --- /dev/null +++ b/v2/docs/LinkPolicyRequest.md @@ -0,0 +1,98 @@ +# LinkPolicyRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] +**PolicyOrn** | **string** | The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). | +**UserName** | **string** | The name of the user you want to link the policy to (between 1 and 64 characters). | + +## Methods + +### NewLinkPolicyRequest + +`func NewLinkPolicyRequest(policyOrn string, userName string, ) *LinkPolicyRequest` + +NewLinkPolicyRequest instantiates a new LinkPolicyRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewLinkPolicyRequestWithDefaults + +`func NewLinkPolicyRequestWithDefaults() *LinkPolicyRequest` + +NewLinkPolicyRequestWithDefaults instantiates a new LinkPolicyRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDryRun + +`func (o *LinkPolicyRequest) GetDryRun() bool` + +GetDryRun returns the DryRun field if non-nil, zero value otherwise. + +### GetDryRunOk + +`func (o *LinkPolicyRequest) GetDryRunOk() (*bool, bool)` + +GetDryRunOk returns a tuple with the DryRun field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDryRun + +`func (o *LinkPolicyRequest) SetDryRun(v bool)` + +SetDryRun sets DryRun field to given value. + +### HasDryRun + +`func (o *LinkPolicyRequest) HasDryRun() bool` + +HasDryRun returns a boolean if a field has been set. + +### GetPolicyOrn + +`func (o *LinkPolicyRequest) GetPolicyOrn() string` + +GetPolicyOrn returns the PolicyOrn field if non-nil, zero value otherwise. + +### GetPolicyOrnOk + +`func (o *LinkPolicyRequest) GetPolicyOrnOk() (*string, bool)` + +GetPolicyOrnOk returns a tuple with the PolicyOrn field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicyOrn + +`func (o *LinkPolicyRequest) SetPolicyOrn(v string)` + +SetPolicyOrn sets PolicyOrn field to given value. + + +### GetUserName + +`func (o *LinkPolicyRequest) GetUserName() string` + +GetUserName returns the UserName field if non-nil, zero value otherwise. + +### GetUserNameOk + +`func (o *LinkPolicyRequest) GetUserNameOk() (*string, bool)` + +GetUserNameOk returns a tuple with the UserName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserName + +`func (o *LinkPolicyRequest) SetUserName(v string)` + +SetUserName sets UserName field to given value. + + + +[[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/v2/docs/LinkPolicyResponse.md b/v2/docs/LinkPolicyResponse.md new file mode 100644 index 000000000..0e8986a05 --- /dev/null +++ b/v2/docs/LinkPolicyResponse.md @@ -0,0 +1,56 @@ +# LinkPolicyResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ResponseContext** | Pointer to [**ResponseContext**](ResponseContext.md) | | [optional] + +## Methods + +### NewLinkPolicyResponse + +`func NewLinkPolicyResponse() *LinkPolicyResponse` + +NewLinkPolicyResponse instantiates a new LinkPolicyResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewLinkPolicyResponseWithDefaults + +`func NewLinkPolicyResponseWithDefaults() *LinkPolicyResponse` + +NewLinkPolicyResponseWithDefaults instantiates a new LinkPolicyResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetResponseContext + +`func (o *LinkPolicyResponse) GetResponseContext() ResponseContext` + +GetResponseContext returns the ResponseContext field if non-nil, zero value otherwise. + +### GetResponseContextOk + +`func (o *LinkPolicyResponse) GetResponseContextOk() (*ResponseContext, bool)` + +GetResponseContextOk returns a tuple with the ResponseContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseContext + +`func (o *LinkPolicyResponse) SetResponseContext(v ResponseContext)` + +SetResponseContext sets ResponseContext field to given value. + +### HasResponseContext + +`func (o *LinkPolicyResponse) HasResponseContext() bool` + +HasResponseContext returns a boolean if a field has been set. + + +[[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/v2/docs/LinkPublicIpRequest.md b/v2/docs/LinkPublicIpRequest.md index 3b75d145f..af9761901 100644 --- a/v2/docs/LinkPublicIpRequest.md +++ b/v2/docs/LinkPublicIpRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**AllowRelink** | Pointer to **bool** | 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 EIP 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.) | [optional] +**AllowRelink** | Pointer to **bool** | 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.) | [optional] **DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] **NicId** | Pointer to **string** | (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. | [optional] **PrivateIp** | Pointer to **string** | (Net only) The primary or secondary private IP of the specified NIC. By default, the primary private IP. | [optional] diff --git a/v2/docs/LinkRouteTable.md b/v2/docs/LinkRouteTable.md index c56e30f26..c472e81ee 100644 --- a/v2/docs/LinkRouteTable.md +++ b/v2/docs/LinkRouteTable.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **LinkRouteTableId** | Pointer to **string** | The ID of the association between the route table and the Subnet. | [optional] **Main** | Pointer to **bool** | If true, the route table is the main one. | [optional] +**NetId** | Pointer to **string** | The ID of the Net. | [optional] **RouteTableId** | Pointer to **string** | The ID of the route table. | [optional] **SubnetId** | Pointer to **string** | The ID of the Subnet. | [optional] @@ -78,6 +79,31 @@ SetMain sets Main field to given value. HasMain returns a boolean if a field has been set. +### GetNetId + +`func (o *LinkRouteTable) GetNetId() string` + +GetNetId returns the NetId field if non-nil, zero value otherwise. + +### GetNetIdOk + +`func (o *LinkRouteTable) GetNetIdOk() (*string, bool)` + +GetNetIdOk returns a tuple with the NetId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNetId + +`func (o *LinkRouteTable) SetNetId(v string)` + +SetNetId sets NetId field to given value. + +### HasNetId + +`func (o *LinkRouteTable) HasNetId() bool` + +HasNetId returns a boolean if a field has been set. + ### GetRouteTableId `func (o *LinkRouteTable) GetRouteTableId() string` diff --git a/v2/docs/LinkedPolicy.md b/v2/docs/LinkedPolicy.md new file mode 100644 index 000000000..db169b501 --- /dev/null +++ b/v2/docs/LinkedPolicy.md @@ -0,0 +1,160 @@ +# LinkedPolicy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CreationDate** | Pointer to **time.Time** | The date and time of creation of the attached policy. | [optional] +**LastModificationDate** | Pointer to **time.Time** | The date and time at which the attached policy was last modified. | [optional] +**Orn** | Pointer to **string** | The Outscale Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). | [optional] +**PolicyId** | Pointer to **string** | The ID of the policy. | [optional] +**PolicyName** | Pointer to **string** | The name of the policy. | [optional] + +## Methods + +### NewLinkedPolicy + +`func NewLinkedPolicy() *LinkedPolicy` + +NewLinkedPolicy instantiates a new LinkedPolicy object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewLinkedPolicyWithDefaults + +`func NewLinkedPolicyWithDefaults() *LinkedPolicy` + +NewLinkedPolicyWithDefaults instantiates a new LinkedPolicy object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCreationDate + +`func (o *LinkedPolicy) GetCreationDate() time.Time` + +GetCreationDate returns the CreationDate field if non-nil, zero value otherwise. + +### GetCreationDateOk + +`func (o *LinkedPolicy) GetCreationDateOk() (*time.Time, bool)` + +GetCreationDateOk returns a tuple with the CreationDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreationDate + +`func (o *LinkedPolicy) SetCreationDate(v time.Time)` + +SetCreationDate sets CreationDate field to given value. + +### HasCreationDate + +`func (o *LinkedPolicy) HasCreationDate() bool` + +HasCreationDate returns a boolean if a field has been set. + +### GetLastModificationDate + +`func (o *LinkedPolicy) GetLastModificationDate() time.Time` + +GetLastModificationDate returns the LastModificationDate field if non-nil, zero value otherwise. + +### GetLastModificationDateOk + +`func (o *LinkedPolicy) GetLastModificationDateOk() (*time.Time, bool)` + +GetLastModificationDateOk returns a tuple with the LastModificationDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastModificationDate + +`func (o *LinkedPolicy) SetLastModificationDate(v time.Time)` + +SetLastModificationDate sets LastModificationDate field to given value. + +### HasLastModificationDate + +`func (o *LinkedPolicy) HasLastModificationDate() bool` + +HasLastModificationDate returns a boolean if a field has been set. + +### GetOrn + +`func (o *LinkedPolicy) GetOrn() string` + +GetOrn returns the Orn field if non-nil, zero value otherwise. + +### GetOrnOk + +`func (o *LinkedPolicy) GetOrnOk() (*string, bool)` + +GetOrnOk returns a tuple with the Orn field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrn + +`func (o *LinkedPolicy) SetOrn(v string)` + +SetOrn sets Orn field to given value. + +### HasOrn + +`func (o *LinkedPolicy) HasOrn() bool` + +HasOrn returns a boolean if a field has been set. + +### GetPolicyId + +`func (o *LinkedPolicy) GetPolicyId() string` + +GetPolicyId returns the PolicyId field if non-nil, zero value otherwise. + +### GetPolicyIdOk + +`func (o *LinkedPolicy) GetPolicyIdOk() (*string, bool)` + +GetPolicyIdOk returns a tuple with the PolicyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicyId + +`func (o *LinkedPolicy) SetPolicyId(v string)` + +SetPolicyId sets PolicyId field to given value. + +### HasPolicyId + +`func (o *LinkedPolicy) HasPolicyId() bool` + +HasPolicyId returns a boolean if a field has been set. + +### GetPolicyName + +`func (o *LinkedPolicy) GetPolicyName() string` + +GetPolicyName returns the PolicyName field if non-nil, zero value otherwise. + +### GetPolicyNameOk + +`func (o *LinkedPolicy) GetPolicyNameOk() (*string, bool)` + +GetPolicyNameOk returns a tuple with the PolicyName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicyName + +`func (o *LinkedPolicy) SetPolicyName(v string)` + +SetPolicyName sets PolicyName field to given value. + +### HasPolicyName + +`func (o *LinkedPolicy) HasPolicyName() bool` + +HasPolicyName returns a boolean if a field has been set. + + +[[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/v2/docs/Net.md b/v2/docs/Net.md index 513fbf1fe..5ae12361a 100644 --- a/v2/docs/Net.md +++ b/v2/docs/Net.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **DhcpOptionsSetId** | Pointer to **string** | The ID of the DHCP options set (or `default` if you want to associate the default one). | [optional] **IpRange** | Pointer to **string** | The IP range for the Net, in CIDR notation (for example, `10.0.0.0/16`). | [optional] **NetId** | Pointer to **string** | The ID of the Net. | [optional] -**State** | Pointer to **string** | The state of the Net (`pending` \\| `available` \\| `deleted`). | [optional] +**State** | Pointer to **string** | The state of the Net (`pending` \\| `available` \\| `deleting`). | [optional] **Tags** | Pointer to [**[]ResourceTag**](ResourceTag.md) | One or more tags associated with the Net. | [optional] **Tenancy** | Pointer to **string** | The VM tenancy in a Net. | [optional] diff --git a/v2/docs/NetPeering.md b/v2/docs/NetPeering.md index 57e3ea89a..4c9c30670 100644 --- a/v2/docs/NetPeering.md +++ b/v2/docs/NetPeering.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **AccepterNet** | Pointer to [**AccepterNet**](AccepterNet.md) | | [optional] +**ExpirationDate** | Pointer to **NullableTime** | The date and time at which the Net peerings expire. | [optional] **NetPeeringId** | Pointer to **string** | The ID of the Net peering. | [optional] **SourceNet** | Pointer to [**SourceNet**](SourceNet.md) | | [optional] **State** | Pointer to [**NetPeeringState**](NetPeeringState.md) | | [optional] @@ -54,6 +55,41 @@ SetAccepterNet sets AccepterNet field to given value. HasAccepterNet returns a boolean if a field has been set. +### GetExpirationDate + +`func (o *NetPeering) GetExpirationDate() time.Time` + +GetExpirationDate returns the ExpirationDate field if non-nil, zero value otherwise. + +### GetExpirationDateOk + +`func (o *NetPeering) GetExpirationDateOk() (*time.Time, bool)` + +GetExpirationDateOk returns a tuple with the ExpirationDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpirationDate + +`func (o *NetPeering) SetExpirationDate(v time.Time)` + +SetExpirationDate sets ExpirationDate field to given value. + +### HasExpirationDate + +`func (o *NetPeering) HasExpirationDate() bool` + +HasExpirationDate returns a boolean if a field has been set. + +### SetExpirationDateNil + +`func (o *NetPeering) SetExpirationDateNil(b bool)` + + SetExpirationDateNil sets the value for ExpirationDate to be an explicit nil + +### UnsetExpirationDate +`func (o *NetPeering) UnsetExpirationDate()` + +UnsetExpirationDate ensures that no value is present for ExpirationDate, not even an explicit nil ### GetNetPeeringId `func (o *NetPeering) GetNetPeeringId() string` diff --git a/v2/docs/Phase2OptionsToUpdate.md b/v2/docs/Phase2OptionsToUpdate.md new file mode 100644 index 000000000..e5b9f6d82 --- /dev/null +++ b/v2/docs/Phase2OptionsToUpdate.md @@ -0,0 +1,56 @@ +# Phase2OptionsToUpdate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PreSharedKey** | Pointer to **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] + +## Methods + +### NewPhase2OptionsToUpdate + +`func NewPhase2OptionsToUpdate() *Phase2OptionsToUpdate` + +NewPhase2OptionsToUpdate instantiates a new Phase2OptionsToUpdate object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPhase2OptionsToUpdateWithDefaults + +`func NewPhase2OptionsToUpdateWithDefaults() *Phase2OptionsToUpdate` + +NewPhase2OptionsToUpdateWithDefaults instantiates a new Phase2OptionsToUpdate object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetPreSharedKey + +`func (o *Phase2OptionsToUpdate) GetPreSharedKey() string` + +GetPreSharedKey returns the PreSharedKey field if non-nil, zero value otherwise. + +### GetPreSharedKeyOk + +`func (o *Phase2OptionsToUpdate) GetPreSharedKeyOk() (*string, bool)` + +GetPreSharedKeyOk returns a tuple with the PreSharedKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreSharedKey + +`func (o *Phase2OptionsToUpdate) SetPreSharedKey(v string)` + +SetPreSharedKey sets PreSharedKey field to given value. + +### HasPreSharedKey + +`func (o *Phase2OptionsToUpdate) HasPreSharedKey() bool` + +HasPreSharedKey returns a boolean if a field has been set. + + +[[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/v2/docs/Placement.md b/v2/docs/Placement.md index 606bf7198..ea800d869 100644 --- a/v2/docs/Placement.md +++ b/v2/docs/Placement.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **SubregionName** | Pointer to **string** | The name of the Subregion. If you specify this parameter, you must not specify the `Nics` parameter. | [optional] -**Tenancy** | Pointer to **string** | The tenancy of the VM (`default` \\| `dedicated`). | [optional] +**Tenancy** | Pointer to **string** | The tenancy of the VM (`default`, `dedicated`, or a dedicated group ID). | [optional] ## Methods diff --git a/v2/docs/Policy.md b/v2/docs/Policy.md new file mode 100644 index 000000000..23176a35c --- /dev/null +++ b/v2/docs/Policy.md @@ -0,0 +1,290 @@ +# Policy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CreationDate** | Pointer to **time.Time** | The date and time of creation of the policy. | [optional] +**Description** | Pointer to **string** | A friendly name for the policy (between 0 and 1000 characters). | [optional] +**IsLinkable** | Pointer to **bool** | Indicates whether the policy can be linked to a group or an EIM user. | [optional] +**LastModificationDate** | Pointer to **time.Time** | The date and time at which the policy was last modified. | [optional] +**Orn** | Pointer to **string** | The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). | [optional] +**Path** | Pointer to **string** | The path to the policy. | [optional] +**PolicyDefaultVersionId** | Pointer to **string** | The ID of the policy default version. | [optional] +**PolicyId** | Pointer to **string** | The ID of the policy. | [optional] +**PolicyName** | Pointer to **string** | The name of the policy. | [optional] +**ResourcesCount** | Pointer to **int32** | The number of resources attached to the policy. | [optional] + +## Methods + +### NewPolicy + +`func NewPolicy() *Policy` + +NewPolicy instantiates a new Policy object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPolicyWithDefaults + +`func NewPolicyWithDefaults() *Policy` + +NewPolicyWithDefaults instantiates a new Policy object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCreationDate + +`func (o *Policy) GetCreationDate() time.Time` + +GetCreationDate returns the CreationDate field if non-nil, zero value otherwise. + +### GetCreationDateOk + +`func (o *Policy) GetCreationDateOk() (*time.Time, bool)` + +GetCreationDateOk returns a tuple with the CreationDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreationDate + +`func (o *Policy) SetCreationDate(v time.Time)` + +SetCreationDate sets CreationDate field to given value. + +### HasCreationDate + +`func (o *Policy) HasCreationDate() bool` + +HasCreationDate returns a boolean if a field has been set. + +### GetDescription + +`func (o *Policy) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Policy) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Policy) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Policy) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetIsLinkable + +`func (o *Policy) GetIsLinkable() bool` + +GetIsLinkable returns the IsLinkable field if non-nil, zero value otherwise. + +### GetIsLinkableOk + +`func (o *Policy) GetIsLinkableOk() (*bool, bool)` + +GetIsLinkableOk returns a tuple with the IsLinkable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsLinkable + +`func (o *Policy) SetIsLinkable(v bool)` + +SetIsLinkable sets IsLinkable field to given value. + +### HasIsLinkable + +`func (o *Policy) HasIsLinkable() bool` + +HasIsLinkable returns a boolean if a field has been set. + +### GetLastModificationDate + +`func (o *Policy) GetLastModificationDate() time.Time` + +GetLastModificationDate returns the LastModificationDate field if non-nil, zero value otherwise. + +### GetLastModificationDateOk + +`func (o *Policy) GetLastModificationDateOk() (*time.Time, bool)` + +GetLastModificationDateOk returns a tuple with the LastModificationDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastModificationDate + +`func (o *Policy) SetLastModificationDate(v time.Time)` + +SetLastModificationDate sets LastModificationDate field to given value. + +### HasLastModificationDate + +`func (o *Policy) HasLastModificationDate() bool` + +HasLastModificationDate returns a boolean if a field has been set. + +### GetOrn + +`func (o *Policy) GetOrn() string` + +GetOrn returns the Orn field if non-nil, zero value otherwise. + +### GetOrnOk + +`func (o *Policy) GetOrnOk() (*string, bool)` + +GetOrnOk returns a tuple with the Orn field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrn + +`func (o *Policy) SetOrn(v string)` + +SetOrn sets Orn field to given value. + +### HasOrn + +`func (o *Policy) HasOrn() bool` + +HasOrn returns a boolean if a field has been set. + +### GetPath + +`func (o *Policy) GetPath() string` + +GetPath returns the Path field if non-nil, zero value otherwise. + +### GetPathOk + +`func (o *Policy) GetPathOk() (*string, bool)` + +GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPath + +`func (o *Policy) SetPath(v string)` + +SetPath sets Path field to given value. + +### HasPath + +`func (o *Policy) HasPath() bool` + +HasPath returns a boolean if a field has been set. + +### GetPolicyDefaultVersionId + +`func (o *Policy) GetPolicyDefaultVersionId() string` + +GetPolicyDefaultVersionId returns the PolicyDefaultVersionId field if non-nil, zero value otherwise. + +### GetPolicyDefaultVersionIdOk + +`func (o *Policy) GetPolicyDefaultVersionIdOk() (*string, bool)` + +GetPolicyDefaultVersionIdOk returns a tuple with the PolicyDefaultVersionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicyDefaultVersionId + +`func (o *Policy) SetPolicyDefaultVersionId(v string)` + +SetPolicyDefaultVersionId sets PolicyDefaultVersionId field to given value. + +### HasPolicyDefaultVersionId + +`func (o *Policy) HasPolicyDefaultVersionId() bool` + +HasPolicyDefaultVersionId returns a boolean if a field has been set. + +### GetPolicyId + +`func (o *Policy) GetPolicyId() string` + +GetPolicyId returns the PolicyId field if non-nil, zero value otherwise. + +### GetPolicyIdOk + +`func (o *Policy) GetPolicyIdOk() (*string, bool)` + +GetPolicyIdOk returns a tuple with the PolicyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicyId + +`func (o *Policy) SetPolicyId(v string)` + +SetPolicyId sets PolicyId field to given value. + +### HasPolicyId + +`func (o *Policy) HasPolicyId() bool` + +HasPolicyId returns a boolean if a field has been set. + +### GetPolicyName + +`func (o *Policy) GetPolicyName() string` + +GetPolicyName returns the PolicyName field if non-nil, zero value otherwise. + +### GetPolicyNameOk + +`func (o *Policy) GetPolicyNameOk() (*string, bool)` + +GetPolicyNameOk returns a tuple with the PolicyName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicyName + +`func (o *Policy) SetPolicyName(v string)` + +SetPolicyName sets PolicyName field to given value. + +### HasPolicyName + +`func (o *Policy) HasPolicyName() bool` + +HasPolicyName returns a boolean if a field has been set. + +### GetResourcesCount + +`func (o *Policy) GetResourcesCount() int32` + +GetResourcesCount returns the ResourcesCount field if non-nil, zero value otherwise. + +### GetResourcesCountOk + +`func (o *Policy) GetResourcesCountOk() (*int32, bool)` + +GetResourcesCountOk returns a tuple with the ResourcesCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResourcesCount + +`func (o *Policy) SetResourcesCount(v int32)` + +SetResourcesCount sets ResourcesCount field to given value. + +### HasResourcesCount + +`func (o *Policy) HasResourcesCount() bool` + +HasResourcesCount returns a boolean if a field has been set. + + +[[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/v2/docs/PolicyApi.md b/v2/docs/PolicyApi.md new file mode 100644 index 000000000..ca894c83b --- /dev/null +++ b/v2/docs/PolicyApi.md @@ -0,0 +1,788 @@ +# \PolicyApi + +All URIs are relative to *https://api.eu-west-2.outscale.com/api/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CreatePolicy**](PolicyApi.md#CreatePolicy) | **Post** /CreatePolicy | +[**CreatePolicyVersion**](PolicyApi.md#CreatePolicyVersion) | **Post** /CreatePolicyVersion | +[**DeletePolicy**](PolicyApi.md#DeletePolicy) | **Post** /DeletePolicy | +[**DeletePolicyVersion**](PolicyApi.md#DeletePolicyVersion) | **Post** /DeletePolicyVersion | +[**LinkPolicy**](PolicyApi.md#LinkPolicy) | **Post** /LinkPolicy | +[**ReadLinkedPolicies**](PolicyApi.md#ReadLinkedPolicies) | **Post** /ReadLinkedPolicies | +[**ReadPolicies**](PolicyApi.md#ReadPolicies) | **Post** /ReadPolicies | +[**ReadPolicy**](PolicyApi.md#ReadPolicy) | **Post** /ReadPolicy | +[**ReadPolicyVersion**](PolicyApi.md#ReadPolicyVersion) | **Post** /ReadPolicyVersion | +[**ReadPolicyVersions**](PolicyApi.md#ReadPolicyVersions) | **Post** /ReadPolicyVersions | +[**SetDefaultPolicyVersion**](PolicyApi.md#SetDefaultPolicyVersion) | **Post** /SetDefaultPolicyVersion | +[**UnlinkPolicy**](PolicyApi.md#UnlinkPolicy) | **Post** /UnlinkPolicy | + + + +## CreatePolicy + +> CreatePolicyResponse CreatePolicy(ctx).CreatePolicyRequest(createPolicyRequest).Execute() + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "./openapi" +) + +func main() { + createPolicyRequest := *openapiclient.NewCreatePolicyRequest("Document_example", "PolicyName_example") // CreatePolicyRequest | (optional) + + configuration := openapiclient.NewConfiguration() + api_client := openapiclient.NewAPIClient(configuration) + resp, r, err := api_client.PolicyApi.CreatePolicy(context.Background()).CreatePolicyRequest(createPolicyRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PolicyApi.CreatePolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePolicy`: CreatePolicyResponse + fmt.Fprintf(os.Stdout, "Response from `PolicyApi.CreatePolicy`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreatePolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **createPolicyRequest** | [**CreatePolicyRequest**](CreatePolicyRequest.md) | | + +### Return type + +[**CreatePolicyResponse**](CreatePolicyResponse.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) + + +## CreatePolicyVersion + +> CreatePolicyVersionResponse CreatePolicyVersion(ctx).CreatePolicyVersionRequest(createPolicyVersionRequest).Execute() + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "./openapi" +) + +func main() { + createPolicyVersionRequest := *openapiclient.NewCreatePolicyVersionRequest("Document_example", "PolicyOrn_example") // CreatePolicyVersionRequest | (optional) + + configuration := openapiclient.NewConfiguration() + api_client := openapiclient.NewAPIClient(configuration) + resp, r, err := api_client.PolicyApi.CreatePolicyVersion(context.Background()).CreatePolicyVersionRequest(createPolicyVersionRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PolicyApi.CreatePolicyVersion``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePolicyVersion`: CreatePolicyVersionResponse + fmt.Fprintf(os.Stdout, "Response from `PolicyApi.CreatePolicyVersion`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreatePolicyVersionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **createPolicyVersionRequest** | [**CreatePolicyVersionRequest**](CreatePolicyVersionRequest.md) | | + +### Return type + +[**CreatePolicyVersionResponse**](CreatePolicyVersionResponse.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) + + +## DeletePolicy + +> DeletePolicyResponse DeletePolicy(ctx).DeletePolicyRequest(deletePolicyRequest).Execute() + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "./openapi" +) + +func main() { + deletePolicyRequest := *openapiclient.NewDeletePolicyRequest("PolicyOrn_example") // DeletePolicyRequest | (optional) + + configuration := openapiclient.NewConfiguration() + api_client := openapiclient.NewAPIClient(configuration) + resp, r, err := api_client.PolicyApi.DeletePolicy(context.Background()).DeletePolicyRequest(deletePolicyRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PolicyApi.DeletePolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeletePolicy`: DeletePolicyResponse + fmt.Fprintf(os.Stdout, "Response from `PolicyApi.DeletePolicy`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeletePolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **deletePolicyRequest** | [**DeletePolicyRequest**](DeletePolicyRequest.md) | | + +### Return type + +[**DeletePolicyResponse**](DeletePolicyResponse.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) + + +## DeletePolicyVersion + +> DeletePolicyVersionResponse DeletePolicyVersion(ctx).DeletePolicyVersionRequest(deletePolicyVersionRequest).Execute() + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "./openapi" +) + +func main() { + deletePolicyVersionRequest := *openapiclient.NewDeletePolicyVersionRequest("PolicyOrn_example", "VersionId_example") // DeletePolicyVersionRequest | (optional) + + configuration := openapiclient.NewConfiguration() + api_client := openapiclient.NewAPIClient(configuration) + resp, r, err := api_client.PolicyApi.DeletePolicyVersion(context.Background()).DeletePolicyVersionRequest(deletePolicyVersionRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PolicyApi.DeletePolicyVersion``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeletePolicyVersion`: DeletePolicyVersionResponse + fmt.Fprintf(os.Stdout, "Response from `PolicyApi.DeletePolicyVersion`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeletePolicyVersionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **deletePolicyVersionRequest** | [**DeletePolicyVersionRequest**](DeletePolicyVersionRequest.md) | | + +### Return type + +[**DeletePolicyVersionResponse**](DeletePolicyVersionResponse.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) + + +## LinkPolicy + +> LinkPolicyResponse LinkPolicy(ctx).LinkPolicyRequest(linkPolicyRequest).Execute() + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "./openapi" +) + +func main() { + linkPolicyRequest := *openapiclient.NewLinkPolicyRequest("PolicyOrn_example", "UserName_example") // LinkPolicyRequest | (optional) + + configuration := openapiclient.NewConfiguration() + api_client := openapiclient.NewAPIClient(configuration) + resp, r, err := api_client.PolicyApi.LinkPolicy(context.Background()).LinkPolicyRequest(linkPolicyRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PolicyApi.LinkPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `LinkPolicy`: LinkPolicyResponse + fmt.Fprintf(os.Stdout, "Response from `PolicyApi.LinkPolicy`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiLinkPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **linkPolicyRequest** | [**LinkPolicyRequest**](LinkPolicyRequest.md) | | + +### Return type + +[**LinkPolicyResponse**](LinkPolicyResponse.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) + + +## ReadLinkedPolicies + +> ReadLinkedPoliciesResponse ReadLinkedPolicies(ctx).ReadLinkedPoliciesRequest(readLinkedPoliciesRequest).Execute() + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "./openapi" +) + +func main() { + readLinkedPoliciesRequest := *openapiclient.NewReadLinkedPoliciesRequest() // ReadLinkedPoliciesRequest | (optional) + + configuration := openapiclient.NewConfiguration() + api_client := openapiclient.NewAPIClient(configuration) + resp, r, err := api_client.PolicyApi.ReadLinkedPolicies(context.Background()).ReadLinkedPoliciesRequest(readLinkedPoliciesRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PolicyApi.ReadLinkedPolicies``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ReadLinkedPolicies`: ReadLinkedPoliciesResponse + fmt.Fprintf(os.Stdout, "Response from `PolicyApi.ReadLinkedPolicies`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiReadLinkedPoliciesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **readLinkedPoliciesRequest** | [**ReadLinkedPoliciesRequest**](ReadLinkedPoliciesRequest.md) | | + +### Return type + +[**ReadLinkedPoliciesResponse**](ReadLinkedPoliciesResponse.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) + + +## ReadPolicies + +> ReadPoliciesResponse ReadPolicies(ctx).ReadPoliciesRequest(readPoliciesRequest).Execute() + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "./openapi" +) + +func main() { + readPoliciesRequest := *openapiclient.NewReadPoliciesRequest() // ReadPoliciesRequest | (optional) + + configuration := openapiclient.NewConfiguration() + api_client := openapiclient.NewAPIClient(configuration) + resp, r, err := api_client.PolicyApi.ReadPolicies(context.Background()).ReadPoliciesRequest(readPoliciesRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PolicyApi.ReadPolicies``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ReadPolicies`: ReadPoliciesResponse + fmt.Fprintf(os.Stdout, "Response from `PolicyApi.ReadPolicies`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiReadPoliciesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **readPoliciesRequest** | [**ReadPoliciesRequest**](ReadPoliciesRequest.md) | | + +### Return type + +[**ReadPoliciesResponse**](ReadPoliciesResponse.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) + + +## ReadPolicy + +> ReadPolicyResponse ReadPolicy(ctx).ReadPolicyRequest(readPolicyRequest).Execute() + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "./openapi" +) + +func main() { + readPolicyRequest := *openapiclient.NewReadPolicyRequest("PolicyOrn_example") // ReadPolicyRequest | (optional) + + configuration := openapiclient.NewConfiguration() + api_client := openapiclient.NewAPIClient(configuration) + resp, r, err := api_client.PolicyApi.ReadPolicy(context.Background()).ReadPolicyRequest(readPolicyRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PolicyApi.ReadPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ReadPolicy`: ReadPolicyResponse + fmt.Fprintf(os.Stdout, "Response from `PolicyApi.ReadPolicy`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiReadPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **readPolicyRequest** | [**ReadPolicyRequest**](ReadPolicyRequest.md) | | + +### Return type + +[**ReadPolicyResponse**](ReadPolicyResponse.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) + + +## ReadPolicyVersion + +> ReadPolicyVersionResponse ReadPolicyVersion(ctx).ReadPolicyVersionRequest(readPolicyVersionRequest).Execute() + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "./openapi" +) + +func main() { + readPolicyVersionRequest := *openapiclient.NewReadPolicyVersionRequest("PolicyOrn_example", "VersionId_example") // ReadPolicyVersionRequest | (optional) + + configuration := openapiclient.NewConfiguration() + api_client := openapiclient.NewAPIClient(configuration) + resp, r, err := api_client.PolicyApi.ReadPolicyVersion(context.Background()).ReadPolicyVersionRequest(readPolicyVersionRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PolicyApi.ReadPolicyVersion``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ReadPolicyVersion`: ReadPolicyVersionResponse + fmt.Fprintf(os.Stdout, "Response from `PolicyApi.ReadPolicyVersion`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiReadPolicyVersionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **readPolicyVersionRequest** | [**ReadPolicyVersionRequest**](ReadPolicyVersionRequest.md) | | + +### Return type + +[**ReadPolicyVersionResponse**](ReadPolicyVersionResponse.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) + + +## ReadPolicyVersions + +> ReadPolicyVersionsResponse ReadPolicyVersions(ctx).ReadPolicyVersionsRequest(readPolicyVersionsRequest).Execute() + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "./openapi" +) + +func main() { + readPolicyVersionsRequest := *openapiclient.NewReadPolicyVersionsRequest("PolicyOrn_example") // ReadPolicyVersionsRequest | (optional) + + configuration := openapiclient.NewConfiguration() + api_client := openapiclient.NewAPIClient(configuration) + resp, r, err := api_client.PolicyApi.ReadPolicyVersions(context.Background()).ReadPolicyVersionsRequest(readPolicyVersionsRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PolicyApi.ReadPolicyVersions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ReadPolicyVersions`: ReadPolicyVersionsResponse + fmt.Fprintf(os.Stdout, "Response from `PolicyApi.ReadPolicyVersions`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiReadPolicyVersionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **readPolicyVersionsRequest** | [**ReadPolicyVersionsRequest**](ReadPolicyVersionsRequest.md) | | + +### Return type + +[**ReadPolicyVersionsResponse**](ReadPolicyVersionsResponse.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) + + +## SetDefaultPolicyVersion + +> SetDefaultPolicyVersionResponse SetDefaultPolicyVersion(ctx).SetDefaultPolicyVersionRequest(setDefaultPolicyVersionRequest).Execute() + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "./openapi" +) + +func main() { + setDefaultPolicyVersionRequest := *openapiclient.NewSetDefaultPolicyVersionRequest("PolicyOrn_example", "VersionId_example") // SetDefaultPolicyVersionRequest | (optional) + + configuration := openapiclient.NewConfiguration() + api_client := openapiclient.NewAPIClient(configuration) + resp, r, err := api_client.PolicyApi.SetDefaultPolicyVersion(context.Background()).SetDefaultPolicyVersionRequest(setDefaultPolicyVersionRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PolicyApi.SetDefaultPolicyVersion``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetDefaultPolicyVersion`: SetDefaultPolicyVersionResponse + fmt.Fprintf(os.Stdout, "Response from `PolicyApi.SetDefaultPolicyVersion`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetDefaultPolicyVersionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **setDefaultPolicyVersionRequest** | [**SetDefaultPolicyVersionRequest**](SetDefaultPolicyVersionRequest.md) | | + +### Return type + +[**SetDefaultPolicyVersionResponse**](SetDefaultPolicyVersionResponse.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) + + +## UnlinkPolicy + +> UnlinkPolicyResponse UnlinkPolicy(ctx).UnlinkPolicyRequest(unlinkPolicyRequest).Execute() + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "./openapi" +) + +func main() { + unlinkPolicyRequest := *openapiclient.NewUnlinkPolicyRequest("PolicyOrn_example", "UserName_example") // UnlinkPolicyRequest | (optional) + + configuration := openapiclient.NewConfiguration() + api_client := openapiclient.NewAPIClient(configuration) + resp, r, err := api_client.PolicyApi.UnlinkPolicy(context.Background()).UnlinkPolicyRequest(unlinkPolicyRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PolicyApi.UnlinkPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UnlinkPolicy`: UnlinkPolicyResponse + fmt.Fprintf(os.Stdout, "Response from `PolicyApi.UnlinkPolicy`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUnlinkPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **unlinkPolicyRequest** | [**UnlinkPolicyRequest**](UnlinkPolicyRequest.md) | | + +### Return type + +[**UnlinkPolicyResponse**](UnlinkPolicyResponse.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/v2/docs/PolicyVersion.md b/v2/docs/PolicyVersion.md new file mode 100644 index 000000000..74aaef785 --- /dev/null +++ b/v2/docs/PolicyVersion.md @@ -0,0 +1,134 @@ +# PolicyVersion + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Body** | Pointer to **string** | The policy document as a json string. | [optional] +**CreationDate** | Pointer to **time.Time** | The date and time of creation of the version. | [optional] +**DefaultVersion** | Pointer to **bool** | If true, the version is the default one. | [optional] +**VersionId** | Pointer to **string** | The ID of the version. | [optional] + +## Methods + +### NewPolicyVersion + +`func NewPolicyVersion() *PolicyVersion` + +NewPolicyVersion instantiates a new PolicyVersion object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPolicyVersionWithDefaults + +`func NewPolicyVersionWithDefaults() *PolicyVersion` + +NewPolicyVersionWithDefaults instantiates a new PolicyVersion object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetBody + +`func (o *PolicyVersion) GetBody() string` + +GetBody returns the Body field if non-nil, zero value otherwise. + +### GetBodyOk + +`func (o *PolicyVersion) GetBodyOk() (*string, bool)` + +GetBodyOk returns a tuple with the Body field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBody + +`func (o *PolicyVersion) SetBody(v string)` + +SetBody sets Body field to given value. + +### HasBody + +`func (o *PolicyVersion) HasBody() bool` + +HasBody returns a boolean if a field has been set. + +### GetCreationDate + +`func (o *PolicyVersion) GetCreationDate() time.Time` + +GetCreationDate returns the CreationDate field if non-nil, zero value otherwise. + +### GetCreationDateOk + +`func (o *PolicyVersion) GetCreationDateOk() (*time.Time, bool)` + +GetCreationDateOk returns a tuple with the CreationDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreationDate + +`func (o *PolicyVersion) SetCreationDate(v time.Time)` + +SetCreationDate sets CreationDate field to given value. + +### HasCreationDate + +`func (o *PolicyVersion) HasCreationDate() bool` + +HasCreationDate returns a boolean if a field has been set. + +### GetDefaultVersion + +`func (o *PolicyVersion) GetDefaultVersion() bool` + +GetDefaultVersion returns the DefaultVersion field if non-nil, zero value otherwise. + +### GetDefaultVersionOk + +`func (o *PolicyVersion) GetDefaultVersionOk() (*bool, bool)` + +GetDefaultVersionOk returns a tuple with the DefaultVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefaultVersion + +`func (o *PolicyVersion) SetDefaultVersion(v bool)` + +SetDefaultVersion sets DefaultVersion field to given value. + +### HasDefaultVersion + +`func (o *PolicyVersion) HasDefaultVersion() bool` + +HasDefaultVersion returns a boolean if a field has been set. + +### GetVersionId + +`func (o *PolicyVersion) GetVersionId() string` + +GetVersionId returns the VersionId field if non-nil, zero value otherwise. + +### GetVersionIdOk + +`func (o *PolicyVersion) GetVersionIdOk() (*string, bool)` + +GetVersionIdOk returns a tuple with the VersionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersionId + +`func (o *PolicyVersion) SetVersionId(v string)` + +SetVersionId sets VersionId field to given value. + +### HasVersionId + +`func (o *PolicyVersion) HasVersionId() bool` + +HasVersionId returns a boolean if a field has been set. + + +[[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/v2/docs/ProductTypeApi.md b/v2/docs/ProductTypeApi.md index df798651c..09c7bd762 100644 --- a/v2/docs/ProductTypeApi.md +++ b/v2/docs/ProductTypeApi.md @@ -4,10 +4,75 @@ All URIs are relative to *https://api.eu-west-2.outscale.com/api/v1* Method | HTTP request | Description ------------- | ------------- | ------------- +[**CreateProductType**](ProductTypeApi.md#CreateProductType) | **Post** /CreateProductType | [**ReadProductTypes**](ProductTypeApi.md#ReadProductTypes) | **Post** /ReadProductTypes | +## CreateProductType + +> CreateProductTypeResponse CreateProductType(ctx).CreateProductTypeRequest(createProductTypeRequest).Execute() + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "./openapi" +) + +func main() { + createProductTypeRequest := *openapiclient.NewCreateProductTypeRequest("Description_example") // CreateProductTypeRequest | (optional) + + configuration := openapiclient.NewConfiguration() + api_client := openapiclient.NewAPIClient(configuration) + resp, r, err := api_client.ProductTypeApi.CreateProductType(context.Background()).CreateProductTypeRequest(createProductTypeRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProductTypeApi.CreateProductType``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateProductType`: CreateProductTypeResponse + fmt.Fprintf(os.Stdout, "Response from `ProductTypeApi.CreateProductType`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateProductTypeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **createProductTypeRequest** | [**CreateProductTypeRequest**](CreateProductTypeRequest.md) | | + +### Return type + +[**CreateProductTypeResponse**](CreateProductTypeResponse.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) + + ## ReadProductTypes > ReadProductTypesResponse ReadProductTypes(ctx).ReadProductTypesRequest(readProductTypesRequest).Execute() diff --git a/v2/docs/Quota.md b/v2/docs/Quota.md index e9834fa32..d86c365a6 100644 --- a/v2/docs/Quota.md +++ b/v2/docs/Quota.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **AccountId** | Pointer to **string** | The account ID of the owner of the quotas. | [optional] **Description** | Pointer to **string** | The description of the quota. | [optional] -**MaxValue** | Pointer to **int32** | The maximum value of the quota for the OUTSCALE user account (if there is no limit, `0`). | [optional] +**MaxValue** | Pointer to **int32** | The maximum value of the quota for the account (if there is no limit, `0`). | [optional] **Name** | Pointer to **string** | The unique name of the quota. | [optional] **QuotaCollection** | Pointer to **string** | The group name of the quota. | [optional] **ShortDescription** | Pointer to **string** | The description of the quota. | [optional] -**UsedValue** | Pointer to **int32** | The limit value currently used by the OUTSCALE user account. | [optional] +**UsedValue** | Pointer to **int32** | The limit value currently used by the account. | [optional] ## Methods diff --git a/v2/docs/QuotaTypes.md b/v2/docs/QuotaTypes.md index 03f620971..03b228640 100644 --- a/v2/docs/QuotaTypes.md +++ b/v2/docs/QuotaTypes.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **QuotaType** | Pointer to **string** | The resource ID if it is a resource-specific quota, `global` if it is not. | [optional] -**Quotas** | Pointer to [**[]Quota**](Quota.md) | One or more quotas associated with the user. | [optional] +**Quotas** | Pointer to [**[]Quota**](Quota.md) | One or more quotas associated with the account. | [optional] ## Methods diff --git a/v2/docs/ReadConsumptionAccountRequest.md b/v2/docs/ReadConsumptionAccountRequest.md index ccb847097..4e865c27e 100644 --- a/v2/docs/ReadConsumptionAccountRequest.md +++ b/v2/docs/ReadConsumptionAccountRequest.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] **FromDate** | **string** | 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`). | **Overall** | Pointer to **bool** | By default or 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). | [optional] [default to false] +**ShowPrice** | Pointer to **bool** | By default or if false, returns only the consumption of the specific account that sends this request. If true, returns the unit price of the consumed resource, and the total price of the consumed resource during the specified time period in the currency of the catalog of the Region where the API method was used. | [optional] **ToDate** | **string** | 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`). | ## Methods @@ -98,6 +99,31 @@ SetOverall sets Overall field to given value. HasOverall returns a boolean if a field has been set. +### GetShowPrice + +`func (o *ReadConsumptionAccountRequest) GetShowPrice() bool` + +GetShowPrice returns the ShowPrice field if non-nil, zero value otherwise. + +### GetShowPriceOk + +`func (o *ReadConsumptionAccountRequest) GetShowPriceOk() (*bool, bool)` + +GetShowPriceOk returns a tuple with the ShowPrice field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetShowPrice + +`func (o *ReadConsumptionAccountRequest) SetShowPrice(v bool)` + +SetShowPrice sets ShowPrice field to given value. + +### HasShowPrice + +`func (o *ReadConsumptionAccountRequest) HasShowPrice() bool` + +HasShowPrice returns a boolean if a field has been set. + ### GetToDate `func (o *ReadConsumptionAccountRequest) GetToDate() string` diff --git a/v2/docs/ReadDedicatedGroupsRequest.md b/v2/docs/ReadDedicatedGroupsRequest.md new file mode 100644 index 000000000..61bb0d0f9 --- /dev/null +++ b/v2/docs/ReadDedicatedGroupsRequest.md @@ -0,0 +1,82 @@ +# ReadDedicatedGroupsRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] +**Filters** | Pointer to [**FiltersDedicatedGroup**](FiltersDedicatedGroup.md) | | [optional] + +## Methods + +### NewReadDedicatedGroupsRequest + +`func NewReadDedicatedGroupsRequest() *ReadDedicatedGroupsRequest` + +NewReadDedicatedGroupsRequest instantiates a new ReadDedicatedGroupsRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewReadDedicatedGroupsRequestWithDefaults + +`func NewReadDedicatedGroupsRequestWithDefaults() *ReadDedicatedGroupsRequest` + +NewReadDedicatedGroupsRequestWithDefaults instantiates a new ReadDedicatedGroupsRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDryRun + +`func (o *ReadDedicatedGroupsRequest) GetDryRun() bool` + +GetDryRun returns the DryRun field if non-nil, zero value otherwise. + +### GetDryRunOk + +`func (o *ReadDedicatedGroupsRequest) GetDryRunOk() (*bool, bool)` + +GetDryRunOk returns a tuple with the DryRun field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDryRun + +`func (o *ReadDedicatedGroupsRequest) SetDryRun(v bool)` + +SetDryRun sets DryRun field to given value. + +### HasDryRun + +`func (o *ReadDedicatedGroupsRequest) HasDryRun() bool` + +HasDryRun returns a boolean if a field has been set. + +### GetFilters + +`func (o *ReadDedicatedGroupsRequest) GetFilters() FiltersDedicatedGroup` + +GetFilters returns the Filters field if non-nil, zero value otherwise. + +### GetFiltersOk + +`func (o *ReadDedicatedGroupsRequest) GetFiltersOk() (*FiltersDedicatedGroup, bool)` + +GetFiltersOk returns a tuple with the Filters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilters + +`func (o *ReadDedicatedGroupsRequest) SetFilters(v FiltersDedicatedGroup)` + +SetFilters sets Filters field to given value. + +### HasFilters + +`func (o *ReadDedicatedGroupsRequest) HasFilters() bool` + +HasFilters returns a boolean if a field has been set. + + +[[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/v2/docs/ReadDedicatedGroupsResponse.md b/v2/docs/ReadDedicatedGroupsResponse.md new file mode 100644 index 000000000..a3f5872d7 --- /dev/null +++ b/v2/docs/ReadDedicatedGroupsResponse.md @@ -0,0 +1,82 @@ +# ReadDedicatedGroupsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DedicatedGroups** | Pointer to [**[]DedicatedGroup**](DedicatedGroup.md) | Information about one or more dedicated groups. | [optional] +**ResponseContext** | Pointer to [**ResponseContext**](ResponseContext.md) | | [optional] + +## Methods + +### NewReadDedicatedGroupsResponse + +`func NewReadDedicatedGroupsResponse() *ReadDedicatedGroupsResponse` + +NewReadDedicatedGroupsResponse instantiates a new ReadDedicatedGroupsResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewReadDedicatedGroupsResponseWithDefaults + +`func NewReadDedicatedGroupsResponseWithDefaults() *ReadDedicatedGroupsResponse` + +NewReadDedicatedGroupsResponseWithDefaults instantiates a new ReadDedicatedGroupsResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDedicatedGroups + +`func (o *ReadDedicatedGroupsResponse) GetDedicatedGroups() []DedicatedGroup` + +GetDedicatedGroups returns the DedicatedGroups field if non-nil, zero value otherwise. + +### GetDedicatedGroupsOk + +`func (o *ReadDedicatedGroupsResponse) GetDedicatedGroupsOk() (*[]DedicatedGroup, bool)` + +GetDedicatedGroupsOk returns a tuple with the DedicatedGroups field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDedicatedGroups + +`func (o *ReadDedicatedGroupsResponse) SetDedicatedGroups(v []DedicatedGroup)` + +SetDedicatedGroups sets DedicatedGroups field to given value. + +### HasDedicatedGroups + +`func (o *ReadDedicatedGroupsResponse) HasDedicatedGroups() bool` + +HasDedicatedGroups returns a boolean if a field has been set. + +### GetResponseContext + +`func (o *ReadDedicatedGroupsResponse) GetResponseContext() ResponseContext` + +GetResponseContext returns the ResponseContext field if non-nil, zero value otherwise. + +### GetResponseContextOk + +`func (o *ReadDedicatedGroupsResponse) GetResponseContextOk() (*ResponseContext, bool)` + +GetResponseContextOk returns a tuple with the ResponseContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseContext + +`func (o *ReadDedicatedGroupsResponse) SetResponseContext(v ResponseContext)` + +SetResponseContext sets ResponseContext field to given value. + +### HasResponseContext + +`func (o *ReadDedicatedGroupsResponse) HasResponseContext() bool` + +HasResponseContext returns a boolean if a field has been set. + + +[[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/v2/docs/ReadDhcpOptionsRequest.md b/v2/docs/ReadDhcpOptionsRequest.md index 261b2e526..1c2bee031 100644 --- a/v2/docs/ReadDhcpOptionsRequest.md +++ b/v2/docs/ReadDhcpOptionsRequest.md @@ -6,6 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] **Filters** | Pointer to [**FiltersDhcpOptions**](FiltersDhcpOptions.md) | | [optional] +**NextPageToken** | Pointer to **string** | The token to request the next page of results. Each token refers to a specific page. | [optional] +**ResultsPerPage** | Pointer to **int32** | The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`. | [optional] ## Methods @@ -76,6 +78,56 @@ SetFilters sets Filters field to given value. HasFilters returns a boolean if a field has been set. +### GetNextPageToken + +`func (o *ReadDhcpOptionsRequest) GetNextPageToken() string` + +GetNextPageToken returns the NextPageToken field if non-nil, zero value otherwise. + +### GetNextPageTokenOk + +`func (o *ReadDhcpOptionsRequest) GetNextPageTokenOk() (*string, bool)` + +GetNextPageTokenOk returns a tuple with the NextPageToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNextPageToken + +`func (o *ReadDhcpOptionsRequest) SetNextPageToken(v string)` + +SetNextPageToken sets NextPageToken field to given value. + +### HasNextPageToken + +`func (o *ReadDhcpOptionsRequest) HasNextPageToken() bool` + +HasNextPageToken returns a boolean if a field has been set. + +### GetResultsPerPage + +`func (o *ReadDhcpOptionsRequest) GetResultsPerPage() int32` + +GetResultsPerPage returns the ResultsPerPage field if non-nil, zero value otherwise. + +### GetResultsPerPageOk + +`func (o *ReadDhcpOptionsRequest) GetResultsPerPageOk() (*int32, bool)` + +GetResultsPerPageOk returns a tuple with the ResultsPerPage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultsPerPage + +`func (o *ReadDhcpOptionsRequest) SetResultsPerPage(v int32)` + +SetResultsPerPage sets ResultsPerPage field to given value. + +### HasResultsPerPage + +`func (o *ReadDhcpOptionsRequest) HasResultsPerPage() bool` + +HasResultsPerPage returns a boolean if a field has been set. + [[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/v2/docs/ReadDhcpOptionsResponse.md b/v2/docs/ReadDhcpOptionsResponse.md index b3ea911ae..df483aa5d 100644 --- a/v2/docs/ReadDhcpOptionsResponse.md +++ b/v2/docs/ReadDhcpOptionsResponse.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **DhcpOptionsSets** | Pointer to [**[]DhcpOptionsSet**](DhcpOptionsSet.md) | Information about one or more DHCP options sets. | [optional] +**NextPageToken** | Pointer to **string** | The token to request the next page of results. Each token refers to a specific page. | [optional] **ResponseContext** | Pointer to [**ResponseContext**](ResponseContext.md) | | [optional] ## Methods @@ -51,6 +52,31 @@ SetDhcpOptionsSets sets DhcpOptionsSets field to given value. HasDhcpOptionsSets returns a boolean if a field has been set. +### GetNextPageToken + +`func (o *ReadDhcpOptionsResponse) GetNextPageToken() string` + +GetNextPageToken returns the NextPageToken field if non-nil, zero value otherwise. + +### GetNextPageTokenOk + +`func (o *ReadDhcpOptionsResponse) GetNextPageTokenOk() (*string, bool)` + +GetNextPageTokenOk returns a tuple with the NextPageToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNextPageToken + +`func (o *ReadDhcpOptionsResponse) SetNextPageToken(v string)` + +SetNextPageToken sets NextPageToken field to given value. + +### HasNextPageToken + +`func (o *ReadDhcpOptionsResponse) HasNextPageToken() bool` + +HasNextPageToken returns a boolean if a field has been set. + ### GetResponseContext `func (o *ReadDhcpOptionsResponse) GetResponseContext() ResponseContext` diff --git a/v2/docs/ReadImagesRequest.md b/v2/docs/ReadImagesRequest.md index 10f72a623..552a8c54d 100644 --- a/v2/docs/ReadImagesRequest.md +++ b/v2/docs/ReadImagesRequest.md @@ -6,6 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] **Filters** | Pointer to [**FiltersImage**](FiltersImage.md) | | [optional] +**NextPageToken** | Pointer to **string** | The token to request the next page of results. Each token refers to a specific page. | [optional] +**ResultsPerPage** | Pointer to **int32** | The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`. | [optional] ## Methods @@ -76,6 +78,56 @@ SetFilters sets Filters field to given value. HasFilters returns a boolean if a field has been set. +### GetNextPageToken + +`func (o *ReadImagesRequest) GetNextPageToken() string` + +GetNextPageToken returns the NextPageToken field if non-nil, zero value otherwise. + +### GetNextPageTokenOk + +`func (o *ReadImagesRequest) GetNextPageTokenOk() (*string, bool)` + +GetNextPageTokenOk returns a tuple with the NextPageToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNextPageToken + +`func (o *ReadImagesRequest) SetNextPageToken(v string)` + +SetNextPageToken sets NextPageToken field to given value. + +### HasNextPageToken + +`func (o *ReadImagesRequest) HasNextPageToken() bool` + +HasNextPageToken returns a boolean if a field has been set. + +### GetResultsPerPage + +`func (o *ReadImagesRequest) GetResultsPerPage() int32` + +GetResultsPerPage returns the ResultsPerPage field if non-nil, zero value otherwise. + +### GetResultsPerPageOk + +`func (o *ReadImagesRequest) GetResultsPerPageOk() (*int32, bool)` + +GetResultsPerPageOk returns a tuple with the ResultsPerPage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultsPerPage + +`func (o *ReadImagesRequest) SetResultsPerPage(v int32)` + +SetResultsPerPage sets ResultsPerPage field to given value. + +### HasResultsPerPage + +`func (o *ReadImagesRequest) HasResultsPerPage() bool` + +HasResultsPerPage returns a boolean if a field has been set. + [[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/v2/docs/ReadImagesResponse.md b/v2/docs/ReadImagesResponse.md index de214cdec..645a7c5d5 100644 --- a/v2/docs/ReadImagesResponse.md +++ b/v2/docs/ReadImagesResponse.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Images** | Pointer to [**[]Image**](Image.md) | Information about one or more OMIs. | [optional] +**NextPageToken** | Pointer to **string** | The token to request the next page of results. Each token refers to a specific page. | [optional] **ResponseContext** | Pointer to [**ResponseContext**](ResponseContext.md) | | [optional] ## Methods @@ -51,6 +52,31 @@ SetImages sets Images field to given value. HasImages returns a boolean if a field has been set. +### GetNextPageToken + +`func (o *ReadImagesResponse) GetNextPageToken() string` + +GetNextPageToken returns the NextPageToken field if non-nil, zero value otherwise. + +### GetNextPageTokenOk + +`func (o *ReadImagesResponse) GetNextPageTokenOk() (*string, bool)` + +GetNextPageTokenOk returns a tuple with the NextPageToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNextPageToken + +`func (o *ReadImagesResponse) SetNextPageToken(v string)` + +SetNextPageToken sets NextPageToken field to given value. + +### HasNextPageToken + +`func (o *ReadImagesResponse) HasNextPageToken() bool` + +HasNextPageToken returns a boolean if a field has been set. + ### GetResponseContext `func (o *ReadImagesResponse) GetResponseContext() ResponseContext` diff --git a/v2/docs/ReadKeypairsResponse.md b/v2/docs/ReadKeypairsResponse.md index 1cc3281a8..69fb6eac6 100644 --- a/v2/docs/ReadKeypairsResponse.md +++ b/v2/docs/ReadKeypairsResponse.md @@ -5,7 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Keypairs** | Pointer to [**[]Keypair**](Keypair.md) | Information about one or more keypairs. | [optional] -**ResponseContext** | Pointer to [**ResponseContext**](ResponseContext.md) | | [optional] ## Methods @@ -51,31 +50,6 @@ SetKeypairs sets Keypairs field to given value. HasKeypairs returns a boolean if a field has been set. -### GetResponseContext - -`func (o *ReadKeypairsResponse) GetResponseContext() ResponseContext` - -GetResponseContext returns the ResponseContext field if non-nil, zero value otherwise. - -### GetResponseContextOk - -`func (o *ReadKeypairsResponse) GetResponseContextOk() (*ResponseContext, bool)` - -GetResponseContextOk returns a tuple with the ResponseContext field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### SetResponseContext - -`func (o *ReadKeypairsResponse) SetResponseContext(v ResponseContext)` - -SetResponseContext sets ResponseContext field to given value. - -### HasResponseContext - -`func (o *ReadKeypairsResponse) HasResponseContext() bool` - -HasResponseContext returns a boolean if a field has been set. - [[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/v2/docs/ReadLinkedPoliciesFilters.md b/v2/docs/ReadLinkedPoliciesFilters.md new file mode 100644 index 000000000..2a01a9e68 --- /dev/null +++ b/v2/docs/ReadLinkedPoliciesFilters.md @@ -0,0 +1,56 @@ +# ReadLinkedPoliciesFilters + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PathPrefix** | Pointer to **string** | The path prefix of the policies, set to a slash (`/`) by default. | [optional] + +## Methods + +### NewReadLinkedPoliciesFilters + +`func NewReadLinkedPoliciesFilters() *ReadLinkedPoliciesFilters` + +NewReadLinkedPoliciesFilters instantiates a new ReadLinkedPoliciesFilters object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewReadLinkedPoliciesFiltersWithDefaults + +`func NewReadLinkedPoliciesFiltersWithDefaults() *ReadLinkedPoliciesFilters` + +NewReadLinkedPoliciesFiltersWithDefaults instantiates a new ReadLinkedPoliciesFilters object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetPathPrefix + +`func (o *ReadLinkedPoliciesFilters) GetPathPrefix() string` + +GetPathPrefix returns the PathPrefix field if non-nil, zero value otherwise. + +### GetPathPrefixOk + +`func (o *ReadLinkedPoliciesFilters) GetPathPrefixOk() (*string, bool)` + +GetPathPrefixOk returns a tuple with the PathPrefix field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPathPrefix + +`func (o *ReadLinkedPoliciesFilters) SetPathPrefix(v string)` + +SetPathPrefix sets PathPrefix field to given value. + +### HasPathPrefix + +`func (o *ReadLinkedPoliciesFilters) HasPathPrefix() bool` + +HasPathPrefix returns a boolean if a field has been set. + + +[[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/v2/docs/ReadLinkedPoliciesRequest.md b/v2/docs/ReadLinkedPoliciesRequest.md new file mode 100644 index 000000000..e3426b7d1 --- /dev/null +++ b/v2/docs/ReadLinkedPoliciesRequest.md @@ -0,0 +1,160 @@ +# ReadLinkedPoliciesRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] +**Filters** | Pointer to [**ReadLinkedPoliciesFilters**](ReadLinkedPoliciesFilters.md) | | [optional] +**FirstItem** | Pointer to **int32** | The item starting the list of policies requested. | [optional] +**ResultsPerPage** | Pointer to **int32** | The maximum number of items that can be returned in a single response (by default, 100). | [optional] +**UserName** | Pointer to **string** | The name of the user the policies are linked to. | [optional] + +## Methods + +### NewReadLinkedPoliciesRequest + +`func NewReadLinkedPoliciesRequest() *ReadLinkedPoliciesRequest` + +NewReadLinkedPoliciesRequest instantiates a new ReadLinkedPoliciesRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewReadLinkedPoliciesRequestWithDefaults + +`func NewReadLinkedPoliciesRequestWithDefaults() *ReadLinkedPoliciesRequest` + +NewReadLinkedPoliciesRequestWithDefaults instantiates a new ReadLinkedPoliciesRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDryRun + +`func (o *ReadLinkedPoliciesRequest) GetDryRun() bool` + +GetDryRun returns the DryRun field if non-nil, zero value otherwise. + +### GetDryRunOk + +`func (o *ReadLinkedPoliciesRequest) GetDryRunOk() (*bool, bool)` + +GetDryRunOk returns a tuple with the DryRun field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDryRun + +`func (o *ReadLinkedPoliciesRequest) SetDryRun(v bool)` + +SetDryRun sets DryRun field to given value. + +### HasDryRun + +`func (o *ReadLinkedPoliciesRequest) HasDryRun() bool` + +HasDryRun returns a boolean if a field has been set. + +### GetFilters + +`func (o *ReadLinkedPoliciesRequest) GetFilters() ReadLinkedPoliciesFilters` + +GetFilters returns the Filters field if non-nil, zero value otherwise. + +### GetFiltersOk + +`func (o *ReadLinkedPoliciesRequest) GetFiltersOk() (*ReadLinkedPoliciesFilters, bool)` + +GetFiltersOk returns a tuple with the Filters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilters + +`func (o *ReadLinkedPoliciesRequest) SetFilters(v ReadLinkedPoliciesFilters)` + +SetFilters sets Filters field to given value. + +### HasFilters + +`func (o *ReadLinkedPoliciesRequest) HasFilters() bool` + +HasFilters returns a boolean if a field has been set. + +### GetFirstItem + +`func (o *ReadLinkedPoliciesRequest) GetFirstItem() int32` + +GetFirstItem returns the FirstItem field if non-nil, zero value otherwise. + +### GetFirstItemOk + +`func (o *ReadLinkedPoliciesRequest) GetFirstItemOk() (*int32, bool)` + +GetFirstItemOk returns a tuple with the FirstItem field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstItem + +`func (o *ReadLinkedPoliciesRequest) SetFirstItem(v int32)` + +SetFirstItem sets FirstItem field to given value. + +### HasFirstItem + +`func (o *ReadLinkedPoliciesRequest) HasFirstItem() bool` + +HasFirstItem returns a boolean if a field has been set. + +### GetResultsPerPage + +`func (o *ReadLinkedPoliciesRequest) GetResultsPerPage() int32` + +GetResultsPerPage returns the ResultsPerPage field if non-nil, zero value otherwise. + +### GetResultsPerPageOk + +`func (o *ReadLinkedPoliciesRequest) GetResultsPerPageOk() (*int32, bool)` + +GetResultsPerPageOk returns a tuple with the ResultsPerPage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultsPerPage + +`func (o *ReadLinkedPoliciesRequest) SetResultsPerPage(v int32)` + +SetResultsPerPage sets ResultsPerPage field to given value. + +### HasResultsPerPage + +`func (o *ReadLinkedPoliciesRequest) HasResultsPerPage() bool` + +HasResultsPerPage returns a boolean if a field has been set. + +### GetUserName + +`func (o *ReadLinkedPoliciesRequest) GetUserName() string` + +GetUserName returns the UserName field if non-nil, zero value otherwise. + +### GetUserNameOk + +`func (o *ReadLinkedPoliciesRequest) GetUserNameOk() (*string, bool)` + +GetUserNameOk returns a tuple with the UserName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserName + +`func (o *ReadLinkedPoliciesRequest) SetUserName(v string)` + +SetUserName sets UserName field to given value. + +### HasUserName + +`func (o *ReadLinkedPoliciesRequest) HasUserName() bool` + +HasUserName returns a boolean if a field has been set. + + +[[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/v2/docs/ReadLinkedPoliciesResponse.md b/v2/docs/ReadLinkedPoliciesResponse.md new file mode 100644 index 000000000..37a823cd4 --- /dev/null +++ b/v2/docs/ReadLinkedPoliciesResponse.md @@ -0,0 +1,160 @@ +# ReadLinkedPoliciesResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**HasMoreItems** | Pointer to **bool** | If true, there are more items to return using the `FirstItem` parameter in a new request. | [optional] +**MaxResultsLimit** | Pointer to **int32** | Indicates maximum results defined for the operation. | [optional] +**MaxResultsTruncated** | Pointer to **bool** | If true, indicates whether requested page size is more than allowed. | [optional] +**Policies** | Pointer to [**[]LinkedPolicy**](LinkedPolicy.md) | One or more policies linked to the specified user. | [optional] +**ResponseContext** | Pointer to [**ResponseContext**](ResponseContext.md) | | [optional] + +## Methods + +### NewReadLinkedPoliciesResponse + +`func NewReadLinkedPoliciesResponse() *ReadLinkedPoliciesResponse` + +NewReadLinkedPoliciesResponse instantiates a new ReadLinkedPoliciesResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewReadLinkedPoliciesResponseWithDefaults + +`func NewReadLinkedPoliciesResponseWithDefaults() *ReadLinkedPoliciesResponse` + +NewReadLinkedPoliciesResponseWithDefaults instantiates a new ReadLinkedPoliciesResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetHasMoreItems + +`func (o *ReadLinkedPoliciesResponse) GetHasMoreItems() bool` + +GetHasMoreItems returns the HasMoreItems field if non-nil, zero value otherwise. + +### GetHasMoreItemsOk + +`func (o *ReadLinkedPoliciesResponse) GetHasMoreItemsOk() (*bool, bool)` + +GetHasMoreItemsOk returns a tuple with the HasMoreItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasMoreItems + +`func (o *ReadLinkedPoliciesResponse) SetHasMoreItems(v bool)` + +SetHasMoreItems sets HasMoreItems field to given value. + +### HasHasMoreItems + +`func (o *ReadLinkedPoliciesResponse) HasHasMoreItems() bool` + +HasHasMoreItems returns a boolean if a field has been set. + +### GetMaxResultsLimit + +`func (o *ReadLinkedPoliciesResponse) GetMaxResultsLimit() int32` + +GetMaxResultsLimit returns the MaxResultsLimit field if non-nil, zero value otherwise. + +### GetMaxResultsLimitOk + +`func (o *ReadLinkedPoliciesResponse) GetMaxResultsLimitOk() (*int32, bool)` + +GetMaxResultsLimitOk returns a tuple with the MaxResultsLimit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxResultsLimit + +`func (o *ReadLinkedPoliciesResponse) SetMaxResultsLimit(v int32)` + +SetMaxResultsLimit sets MaxResultsLimit field to given value. + +### HasMaxResultsLimit + +`func (o *ReadLinkedPoliciesResponse) HasMaxResultsLimit() bool` + +HasMaxResultsLimit returns a boolean if a field has been set. + +### GetMaxResultsTruncated + +`func (o *ReadLinkedPoliciesResponse) GetMaxResultsTruncated() bool` + +GetMaxResultsTruncated returns the MaxResultsTruncated field if non-nil, zero value otherwise. + +### GetMaxResultsTruncatedOk + +`func (o *ReadLinkedPoliciesResponse) GetMaxResultsTruncatedOk() (*bool, bool)` + +GetMaxResultsTruncatedOk returns a tuple with the MaxResultsTruncated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxResultsTruncated + +`func (o *ReadLinkedPoliciesResponse) SetMaxResultsTruncated(v bool)` + +SetMaxResultsTruncated sets MaxResultsTruncated field to given value. + +### HasMaxResultsTruncated + +`func (o *ReadLinkedPoliciesResponse) HasMaxResultsTruncated() bool` + +HasMaxResultsTruncated returns a boolean if a field has been set. + +### GetPolicies + +`func (o *ReadLinkedPoliciesResponse) GetPolicies() []LinkedPolicy` + +GetPolicies returns the Policies field if non-nil, zero value otherwise. + +### GetPoliciesOk + +`func (o *ReadLinkedPoliciesResponse) GetPoliciesOk() (*[]LinkedPolicy, bool)` + +GetPoliciesOk returns a tuple with the Policies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicies + +`func (o *ReadLinkedPoliciesResponse) SetPolicies(v []LinkedPolicy)` + +SetPolicies sets Policies field to given value. + +### HasPolicies + +`func (o *ReadLinkedPoliciesResponse) HasPolicies() bool` + +HasPolicies returns a boolean if a field has been set. + +### GetResponseContext + +`func (o *ReadLinkedPoliciesResponse) GetResponseContext() ResponseContext` + +GetResponseContext returns the ResponseContext field if non-nil, zero value otherwise. + +### GetResponseContextOk + +`func (o *ReadLinkedPoliciesResponse) GetResponseContextOk() (*ResponseContext, bool)` + +GetResponseContextOk returns a tuple with the ResponseContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseContext + +`func (o *ReadLinkedPoliciesResponse) SetResponseContext(v ResponseContext)` + +SetResponseContext sets ResponseContext field to given value. + +### HasResponseContext + +`func (o *ReadLinkedPoliciesResponse) HasResponseContext() bool` + +HasResponseContext returns a boolean if a field has been set. + + +[[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/v2/docs/ReadNatServicesRequest.md b/v2/docs/ReadNatServicesRequest.md index 21cfe74e1..348ec6520 100644 --- a/v2/docs/ReadNatServicesRequest.md +++ b/v2/docs/ReadNatServicesRequest.md @@ -6,6 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] **Filters** | Pointer to [**FiltersNatService**](FiltersNatService.md) | | [optional] +**NextPageToken** | Pointer to **string** | The token to request the next page of results. Each token refers to a specific page. | [optional] +**ResultsPerPage** | Pointer to **int32** | The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`. | [optional] ## Methods @@ -76,6 +78,56 @@ SetFilters sets Filters field to given value. HasFilters returns a boolean if a field has been set. +### GetNextPageToken + +`func (o *ReadNatServicesRequest) GetNextPageToken() string` + +GetNextPageToken returns the NextPageToken field if non-nil, zero value otherwise. + +### GetNextPageTokenOk + +`func (o *ReadNatServicesRequest) GetNextPageTokenOk() (*string, bool)` + +GetNextPageTokenOk returns a tuple with the NextPageToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNextPageToken + +`func (o *ReadNatServicesRequest) SetNextPageToken(v string)` + +SetNextPageToken sets NextPageToken field to given value. + +### HasNextPageToken + +`func (o *ReadNatServicesRequest) HasNextPageToken() bool` + +HasNextPageToken returns a boolean if a field has been set. + +### GetResultsPerPage + +`func (o *ReadNatServicesRequest) GetResultsPerPage() int32` + +GetResultsPerPage returns the ResultsPerPage field if non-nil, zero value otherwise. + +### GetResultsPerPageOk + +`func (o *ReadNatServicesRequest) GetResultsPerPageOk() (*int32, bool)` + +GetResultsPerPageOk returns a tuple with the ResultsPerPage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultsPerPage + +`func (o *ReadNatServicesRequest) SetResultsPerPage(v int32)` + +SetResultsPerPage sets ResultsPerPage field to given value. + +### HasResultsPerPage + +`func (o *ReadNatServicesRequest) HasResultsPerPage() bool` + +HasResultsPerPage returns a boolean if a field has been set. + [[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/v2/docs/ReadNatServicesResponse.md b/v2/docs/ReadNatServicesResponse.md index 1d9916ce8..acf73ceeb 100644 --- a/v2/docs/ReadNatServicesResponse.md +++ b/v2/docs/ReadNatServicesResponse.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **NatServices** | Pointer to [**[]NatService**](NatService.md) | Information about one or more NAT services. | [optional] +**NextPageToken** | Pointer to **string** | The token to request the next page of results. Each token refers to a specific page. | [optional] **ResponseContext** | Pointer to [**ResponseContext**](ResponseContext.md) | | [optional] ## Methods @@ -51,6 +52,31 @@ SetNatServices sets NatServices field to given value. HasNatServices returns a boolean if a field has been set. +### GetNextPageToken + +`func (o *ReadNatServicesResponse) GetNextPageToken() string` + +GetNextPageToken returns the NextPageToken field if non-nil, zero value otherwise. + +### GetNextPageTokenOk + +`func (o *ReadNatServicesResponse) GetNextPageTokenOk() (*string, bool)` + +GetNextPageTokenOk returns a tuple with the NextPageToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNextPageToken + +`func (o *ReadNatServicesResponse) SetNextPageToken(v string)` + +SetNextPageToken sets NextPageToken field to given value. + +### HasNextPageToken + +`func (o *ReadNatServicesResponse) HasNextPageToken() bool` + +HasNextPageToken returns a boolean if a field has been set. + ### GetResponseContext `func (o *ReadNatServicesResponse) GetResponseContext() ResponseContext` diff --git a/v2/docs/ReadNetAccessPointsRequest.md b/v2/docs/ReadNetAccessPointsRequest.md index c91330ed2..52afc3664 100644 --- a/v2/docs/ReadNetAccessPointsRequest.md +++ b/v2/docs/ReadNetAccessPointsRequest.md @@ -6,6 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] **Filters** | Pointer to [**FiltersNetAccessPoint**](FiltersNetAccessPoint.md) | | [optional] +**NextPageToken** | Pointer to **string** | The token to request the next page of results. Each token refers to a specific page. | [optional] +**ResultsPerPage** | Pointer to **int32** | The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`. | [optional] ## Methods @@ -76,6 +78,56 @@ SetFilters sets Filters field to given value. HasFilters returns a boolean if a field has been set. +### GetNextPageToken + +`func (o *ReadNetAccessPointsRequest) GetNextPageToken() string` + +GetNextPageToken returns the NextPageToken field if non-nil, zero value otherwise. + +### GetNextPageTokenOk + +`func (o *ReadNetAccessPointsRequest) GetNextPageTokenOk() (*string, bool)` + +GetNextPageTokenOk returns a tuple with the NextPageToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNextPageToken + +`func (o *ReadNetAccessPointsRequest) SetNextPageToken(v string)` + +SetNextPageToken sets NextPageToken field to given value. + +### HasNextPageToken + +`func (o *ReadNetAccessPointsRequest) HasNextPageToken() bool` + +HasNextPageToken returns a boolean if a field has been set. + +### GetResultsPerPage + +`func (o *ReadNetAccessPointsRequest) GetResultsPerPage() int32` + +GetResultsPerPage returns the ResultsPerPage field if non-nil, zero value otherwise. + +### GetResultsPerPageOk + +`func (o *ReadNetAccessPointsRequest) GetResultsPerPageOk() (*int32, bool)` + +GetResultsPerPageOk returns a tuple with the ResultsPerPage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultsPerPage + +`func (o *ReadNetAccessPointsRequest) SetResultsPerPage(v int32)` + +SetResultsPerPage sets ResultsPerPage field to given value. + +### HasResultsPerPage + +`func (o *ReadNetAccessPointsRequest) HasResultsPerPage() bool` + +HasResultsPerPage returns a boolean if a field has been set. + [[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/v2/docs/ReadNetAccessPointsResponse.md b/v2/docs/ReadNetAccessPointsResponse.md index 83d5c6532..b8ddf7486 100644 --- a/v2/docs/ReadNetAccessPointsResponse.md +++ b/v2/docs/ReadNetAccessPointsResponse.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **NetAccessPoints** | Pointer to [**[]NetAccessPoint**](NetAccessPoint.md) | One or more Net access points. | [optional] +**NextPageToken** | Pointer to **string** | The token to request the next page of results. Each token refers to a specific page. | [optional] **ResponseContext** | Pointer to [**ResponseContext**](ResponseContext.md) | | [optional] ## Methods @@ -51,6 +52,31 @@ SetNetAccessPoints sets NetAccessPoints field to given value. HasNetAccessPoints returns a boolean if a field has been set. +### GetNextPageToken + +`func (o *ReadNetAccessPointsResponse) GetNextPageToken() string` + +GetNextPageToken returns the NextPageToken field if non-nil, zero value otherwise. + +### GetNextPageTokenOk + +`func (o *ReadNetAccessPointsResponse) GetNextPageTokenOk() (*string, bool)` + +GetNextPageTokenOk returns a tuple with the NextPageToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNextPageToken + +`func (o *ReadNetAccessPointsResponse) SetNextPageToken(v string)` + +SetNextPageToken sets NextPageToken field to given value. + +### HasNextPageToken + +`func (o *ReadNetAccessPointsResponse) HasNextPageToken() bool` + +HasNextPageToken returns a boolean if a field has been set. + ### GetResponseContext `func (o *ReadNetAccessPointsResponse) GetResponseContext() ResponseContext` diff --git a/v2/docs/ReadNetPeeringsRequest.md b/v2/docs/ReadNetPeeringsRequest.md index 712b4ac71..15f7376f0 100644 --- a/v2/docs/ReadNetPeeringsRequest.md +++ b/v2/docs/ReadNetPeeringsRequest.md @@ -6,6 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] **Filters** | Pointer to [**FiltersNetPeering**](FiltersNetPeering.md) | | [optional] +**NextPageToken** | Pointer to **string** | The token to request the next page of results. Each token refers to a specific page. | [optional] +**ResultsPerPage** | Pointer to **int32** | The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`. | [optional] ## Methods @@ -76,6 +78,56 @@ SetFilters sets Filters field to given value. HasFilters returns a boolean if a field has been set. +### GetNextPageToken + +`func (o *ReadNetPeeringsRequest) GetNextPageToken() string` + +GetNextPageToken returns the NextPageToken field if non-nil, zero value otherwise. + +### GetNextPageTokenOk + +`func (o *ReadNetPeeringsRequest) GetNextPageTokenOk() (*string, bool)` + +GetNextPageTokenOk returns a tuple with the NextPageToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNextPageToken + +`func (o *ReadNetPeeringsRequest) SetNextPageToken(v string)` + +SetNextPageToken sets NextPageToken field to given value. + +### HasNextPageToken + +`func (o *ReadNetPeeringsRequest) HasNextPageToken() bool` + +HasNextPageToken returns a boolean if a field has been set. + +### GetResultsPerPage + +`func (o *ReadNetPeeringsRequest) GetResultsPerPage() int32` + +GetResultsPerPage returns the ResultsPerPage field if non-nil, zero value otherwise. + +### GetResultsPerPageOk + +`func (o *ReadNetPeeringsRequest) GetResultsPerPageOk() (*int32, bool)` + +GetResultsPerPageOk returns a tuple with the ResultsPerPage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultsPerPage + +`func (o *ReadNetPeeringsRequest) SetResultsPerPage(v int32)` + +SetResultsPerPage sets ResultsPerPage field to given value. + +### HasResultsPerPage + +`func (o *ReadNetPeeringsRequest) HasResultsPerPage() bool` + +HasResultsPerPage returns a boolean if a field has been set. + [[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/v2/docs/ReadNetPeeringsResponse.md b/v2/docs/ReadNetPeeringsResponse.md index 018a5f7a4..a2c8692d3 100644 --- a/v2/docs/ReadNetPeeringsResponse.md +++ b/v2/docs/ReadNetPeeringsResponse.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **NetPeerings** | Pointer to [**[]NetPeering**](NetPeering.md) | Information about one or more Net peerings. | [optional] +**NextPageToken** | Pointer to **string** | The token to request the next page of results. Each token refers to a specific page. | [optional] **ResponseContext** | Pointer to [**ResponseContext**](ResponseContext.md) | | [optional] ## Methods @@ -51,6 +52,31 @@ SetNetPeerings sets NetPeerings field to given value. HasNetPeerings returns a boolean if a field has been set. +### GetNextPageToken + +`func (o *ReadNetPeeringsResponse) GetNextPageToken() string` + +GetNextPageToken returns the NextPageToken field if non-nil, zero value otherwise. + +### GetNextPageTokenOk + +`func (o *ReadNetPeeringsResponse) GetNextPageTokenOk() (*string, bool)` + +GetNextPageTokenOk returns a tuple with the NextPageToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNextPageToken + +`func (o *ReadNetPeeringsResponse) SetNextPageToken(v string)` + +SetNextPageToken sets NextPageToken field to given value. + +### HasNextPageToken + +`func (o *ReadNetPeeringsResponse) HasNextPageToken() bool` + +HasNextPageToken returns a boolean if a field has been set. + ### GetResponseContext `func (o *ReadNetPeeringsResponse) GetResponseContext() ResponseContext` diff --git a/v2/docs/ReadPoliciesFilters.md b/v2/docs/ReadPoliciesFilters.md new file mode 100644 index 000000000..9a0ce3d08 --- /dev/null +++ b/v2/docs/ReadPoliciesFilters.md @@ -0,0 +1,108 @@ +# ReadPoliciesFilters + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OnlyLinked** | Pointer to **bool** | If set to true, lists only the policies attached to a user. | [optional] +**PathPrefix** | Pointer to **string** | The path prefix you can use to filter the results, set to a slash (`/`) by default. | [optional] +**Scope** | Pointer to **string** | The scope to filter policies (`ALL` \\| `OWS` \\| `local`). | [optional] + +## Methods + +### NewReadPoliciesFilters + +`func NewReadPoliciesFilters() *ReadPoliciesFilters` + +NewReadPoliciesFilters instantiates a new ReadPoliciesFilters object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewReadPoliciesFiltersWithDefaults + +`func NewReadPoliciesFiltersWithDefaults() *ReadPoliciesFilters` + +NewReadPoliciesFiltersWithDefaults instantiates a new ReadPoliciesFilters object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetOnlyLinked + +`func (o *ReadPoliciesFilters) GetOnlyLinked() bool` + +GetOnlyLinked returns the OnlyLinked field if non-nil, zero value otherwise. + +### GetOnlyLinkedOk + +`func (o *ReadPoliciesFilters) GetOnlyLinkedOk() (*bool, bool)` + +GetOnlyLinkedOk returns a tuple with the OnlyLinked field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOnlyLinked + +`func (o *ReadPoliciesFilters) SetOnlyLinked(v bool)` + +SetOnlyLinked sets OnlyLinked field to given value. + +### HasOnlyLinked + +`func (o *ReadPoliciesFilters) HasOnlyLinked() bool` + +HasOnlyLinked returns a boolean if a field has been set. + +### GetPathPrefix + +`func (o *ReadPoliciesFilters) GetPathPrefix() string` + +GetPathPrefix returns the PathPrefix field if non-nil, zero value otherwise. + +### GetPathPrefixOk + +`func (o *ReadPoliciesFilters) GetPathPrefixOk() (*string, bool)` + +GetPathPrefixOk returns a tuple with the PathPrefix field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPathPrefix + +`func (o *ReadPoliciesFilters) SetPathPrefix(v string)` + +SetPathPrefix sets PathPrefix field to given value. + +### HasPathPrefix + +`func (o *ReadPoliciesFilters) HasPathPrefix() bool` + +HasPathPrefix returns a boolean if a field has been set. + +### GetScope + +`func (o *ReadPoliciesFilters) GetScope() string` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *ReadPoliciesFilters) GetScopeOk() (*string, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *ReadPoliciesFilters) SetScope(v string)` + +SetScope sets Scope field to given value. + +### HasScope + +`func (o *ReadPoliciesFilters) HasScope() bool` + +HasScope returns a boolean if a field has been set. + + +[[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/v2/docs/ReadPoliciesRequest.md b/v2/docs/ReadPoliciesRequest.md new file mode 100644 index 000000000..b9af79062 --- /dev/null +++ b/v2/docs/ReadPoliciesRequest.md @@ -0,0 +1,134 @@ +# ReadPoliciesRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] +**Filters** | Pointer to [**ReadPoliciesFilters**](ReadPoliciesFilters.md) | | [optional] +**FirstItem** | Pointer to **int32** | The item starting the list of policies requested. | [optional] +**ResultsPerPage** | Pointer to **int32** | The maximum number of items that can be returned in a single response (by default, 100). | [optional] + +## Methods + +### NewReadPoliciesRequest + +`func NewReadPoliciesRequest() *ReadPoliciesRequest` + +NewReadPoliciesRequest instantiates a new ReadPoliciesRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewReadPoliciesRequestWithDefaults + +`func NewReadPoliciesRequestWithDefaults() *ReadPoliciesRequest` + +NewReadPoliciesRequestWithDefaults instantiates a new ReadPoliciesRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDryRun + +`func (o *ReadPoliciesRequest) GetDryRun() bool` + +GetDryRun returns the DryRun field if non-nil, zero value otherwise. + +### GetDryRunOk + +`func (o *ReadPoliciesRequest) GetDryRunOk() (*bool, bool)` + +GetDryRunOk returns a tuple with the DryRun field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDryRun + +`func (o *ReadPoliciesRequest) SetDryRun(v bool)` + +SetDryRun sets DryRun field to given value. + +### HasDryRun + +`func (o *ReadPoliciesRequest) HasDryRun() bool` + +HasDryRun returns a boolean if a field has been set. + +### GetFilters + +`func (o *ReadPoliciesRequest) GetFilters() ReadPoliciesFilters` + +GetFilters returns the Filters field if non-nil, zero value otherwise. + +### GetFiltersOk + +`func (o *ReadPoliciesRequest) GetFiltersOk() (*ReadPoliciesFilters, bool)` + +GetFiltersOk returns a tuple with the Filters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilters + +`func (o *ReadPoliciesRequest) SetFilters(v ReadPoliciesFilters)` + +SetFilters sets Filters field to given value. + +### HasFilters + +`func (o *ReadPoliciesRequest) HasFilters() bool` + +HasFilters returns a boolean if a field has been set. + +### GetFirstItem + +`func (o *ReadPoliciesRequest) GetFirstItem() int32` + +GetFirstItem returns the FirstItem field if non-nil, zero value otherwise. + +### GetFirstItemOk + +`func (o *ReadPoliciesRequest) GetFirstItemOk() (*int32, bool)` + +GetFirstItemOk returns a tuple with the FirstItem field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstItem + +`func (o *ReadPoliciesRequest) SetFirstItem(v int32)` + +SetFirstItem sets FirstItem field to given value. + +### HasFirstItem + +`func (o *ReadPoliciesRequest) HasFirstItem() bool` + +HasFirstItem returns a boolean if a field has been set. + +### GetResultsPerPage + +`func (o *ReadPoliciesRequest) GetResultsPerPage() int32` + +GetResultsPerPage returns the ResultsPerPage field if non-nil, zero value otherwise. + +### GetResultsPerPageOk + +`func (o *ReadPoliciesRequest) GetResultsPerPageOk() (*int32, bool)` + +GetResultsPerPageOk returns a tuple with the ResultsPerPage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultsPerPage + +`func (o *ReadPoliciesRequest) SetResultsPerPage(v int32)` + +SetResultsPerPage sets ResultsPerPage field to given value. + +### HasResultsPerPage + +`func (o *ReadPoliciesRequest) HasResultsPerPage() bool` + +HasResultsPerPage returns a boolean if a field has been set. + + +[[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/v2/docs/ReadPoliciesResponse.md b/v2/docs/ReadPoliciesResponse.md new file mode 100644 index 000000000..1e64a60d2 --- /dev/null +++ b/v2/docs/ReadPoliciesResponse.md @@ -0,0 +1,160 @@ +# ReadPoliciesResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**HasMoreItems** | Pointer to **bool** | If true, there are more items to return using the `FirstItem` parameter in a new request. | [optional] +**MaxResultsLimit** | Pointer to **int32** | Indicates maximum results defined for the operation. | [optional] +**MaxResultsTruncated** | Pointer to **bool** | If true, indicates whether requested page size is more than allowed. | [optional] +**Policies** | Pointer to [**[]Policy**](Policy.md) | Information about one or more policies. | [optional] +**ResponseContext** | Pointer to [**ResponseContext**](ResponseContext.md) | | [optional] + +## Methods + +### NewReadPoliciesResponse + +`func NewReadPoliciesResponse() *ReadPoliciesResponse` + +NewReadPoliciesResponse instantiates a new ReadPoliciesResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewReadPoliciesResponseWithDefaults + +`func NewReadPoliciesResponseWithDefaults() *ReadPoliciesResponse` + +NewReadPoliciesResponseWithDefaults instantiates a new ReadPoliciesResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetHasMoreItems + +`func (o *ReadPoliciesResponse) GetHasMoreItems() bool` + +GetHasMoreItems returns the HasMoreItems field if non-nil, zero value otherwise. + +### GetHasMoreItemsOk + +`func (o *ReadPoliciesResponse) GetHasMoreItemsOk() (*bool, bool)` + +GetHasMoreItemsOk returns a tuple with the HasMoreItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasMoreItems + +`func (o *ReadPoliciesResponse) SetHasMoreItems(v bool)` + +SetHasMoreItems sets HasMoreItems field to given value. + +### HasHasMoreItems + +`func (o *ReadPoliciesResponse) HasHasMoreItems() bool` + +HasHasMoreItems returns a boolean if a field has been set. + +### GetMaxResultsLimit + +`func (o *ReadPoliciesResponse) GetMaxResultsLimit() int32` + +GetMaxResultsLimit returns the MaxResultsLimit field if non-nil, zero value otherwise. + +### GetMaxResultsLimitOk + +`func (o *ReadPoliciesResponse) GetMaxResultsLimitOk() (*int32, bool)` + +GetMaxResultsLimitOk returns a tuple with the MaxResultsLimit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxResultsLimit + +`func (o *ReadPoliciesResponse) SetMaxResultsLimit(v int32)` + +SetMaxResultsLimit sets MaxResultsLimit field to given value. + +### HasMaxResultsLimit + +`func (o *ReadPoliciesResponse) HasMaxResultsLimit() bool` + +HasMaxResultsLimit returns a boolean if a field has been set. + +### GetMaxResultsTruncated + +`func (o *ReadPoliciesResponse) GetMaxResultsTruncated() bool` + +GetMaxResultsTruncated returns the MaxResultsTruncated field if non-nil, zero value otherwise. + +### GetMaxResultsTruncatedOk + +`func (o *ReadPoliciesResponse) GetMaxResultsTruncatedOk() (*bool, bool)` + +GetMaxResultsTruncatedOk returns a tuple with the MaxResultsTruncated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxResultsTruncated + +`func (o *ReadPoliciesResponse) SetMaxResultsTruncated(v bool)` + +SetMaxResultsTruncated sets MaxResultsTruncated field to given value. + +### HasMaxResultsTruncated + +`func (o *ReadPoliciesResponse) HasMaxResultsTruncated() bool` + +HasMaxResultsTruncated returns a boolean if a field has been set. + +### GetPolicies + +`func (o *ReadPoliciesResponse) GetPolicies() []Policy` + +GetPolicies returns the Policies field if non-nil, zero value otherwise. + +### GetPoliciesOk + +`func (o *ReadPoliciesResponse) GetPoliciesOk() (*[]Policy, bool)` + +GetPoliciesOk returns a tuple with the Policies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicies + +`func (o *ReadPoliciesResponse) SetPolicies(v []Policy)` + +SetPolicies sets Policies field to given value. + +### HasPolicies + +`func (o *ReadPoliciesResponse) HasPolicies() bool` + +HasPolicies returns a boolean if a field has been set. + +### GetResponseContext + +`func (o *ReadPoliciesResponse) GetResponseContext() ResponseContext` + +GetResponseContext returns the ResponseContext field if non-nil, zero value otherwise. + +### GetResponseContextOk + +`func (o *ReadPoliciesResponse) GetResponseContextOk() (*ResponseContext, bool)` + +GetResponseContextOk returns a tuple with the ResponseContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseContext + +`func (o *ReadPoliciesResponse) SetResponseContext(v ResponseContext)` + +SetResponseContext sets ResponseContext field to given value. + +### HasResponseContext + +`func (o *ReadPoliciesResponse) HasResponseContext() bool` + +HasResponseContext returns a boolean if a field has been set. + + +[[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/v2/docs/ReadPolicyRequest.md b/v2/docs/ReadPolicyRequest.md new file mode 100644 index 000000000..de668fd79 --- /dev/null +++ b/v2/docs/ReadPolicyRequest.md @@ -0,0 +1,51 @@ +# ReadPolicyRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PolicyOrn** | **string** | The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). | + +## Methods + +### NewReadPolicyRequest + +`func NewReadPolicyRequest(policyOrn string, ) *ReadPolicyRequest` + +NewReadPolicyRequest instantiates a new ReadPolicyRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewReadPolicyRequestWithDefaults + +`func NewReadPolicyRequestWithDefaults() *ReadPolicyRequest` + +NewReadPolicyRequestWithDefaults instantiates a new ReadPolicyRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetPolicyOrn + +`func (o *ReadPolicyRequest) GetPolicyOrn() string` + +GetPolicyOrn returns the PolicyOrn field if non-nil, zero value otherwise. + +### GetPolicyOrnOk + +`func (o *ReadPolicyRequest) GetPolicyOrnOk() (*string, bool)` + +GetPolicyOrnOk returns a tuple with the PolicyOrn field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicyOrn + +`func (o *ReadPolicyRequest) SetPolicyOrn(v string)` + +SetPolicyOrn sets PolicyOrn field to given value. + + + +[[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/v2/docs/ReadPolicyResponse.md b/v2/docs/ReadPolicyResponse.md new file mode 100644 index 000000000..053e4a14c --- /dev/null +++ b/v2/docs/ReadPolicyResponse.md @@ -0,0 +1,82 @@ +# ReadPolicyResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Policy** | Pointer to [**Policy**](Policy.md) | | [optional] +**ResponseContext** | Pointer to [**ResponseContext**](ResponseContext.md) | | [optional] + +## Methods + +### NewReadPolicyResponse + +`func NewReadPolicyResponse() *ReadPolicyResponse` + +NewReadPolicyResponse instantiates a new ReadPolicyResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewReadPolicyResponseWithDefaults + +`func NewReadPolicyResponseWithDefaults() *ReadPolicyResponse` + +NewReadPolicyResponseWithDefaults instantiates a new ReadPolicyResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetPolicy + +`func (o *ReadPolicyResponse) GetPolicy() Policy` + +GetPolicy returns the Policy field if non-nil, zero value otherwise. + +### GetPolicyOk + +`func (o *ReadPolicyResponse) GetPolicyOk() (*Policy, bool)` + +GetPolicyOk returns a tuple with the Policy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicy + +`func (o *ReadPolicyResponse) SetPolicy(v Policy)` + +SetPolicy sets Policy field to given value. + +### HasPolicy + +`func (o *ReadPolicyResponse) HasPolicy() bool` + +HasPolicy returns a boolean if a field has been set. + +### GetResponseContext + +`func (o *ReadPolicyResponse) GetResponseContext() ResponseContext` + +GetResponseContext returns the ResponseContext field if non-nil, zero value otherwise. + +### GetResponseContextOk + +`func (o *ReadPolicyResponse) GetResponseContextOk() (*ResponseContext, bool)` + +GetResponseContextOk returns a tuple with the ResponseContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseContext + +`func (o *ReadPolicyResponse) SetResponseContext(v ResponseContext)` + +SetResponseContext sets ResponseContext field to given value. + +### HasResponseContext + +`func (o *ReadPolicyResponse) HasResponseContext() bool` + +HasResponseContext returns a boolean if a field has been set. + + +[[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/v2/docs/ReadPolicyVersionRequest.md b/v2/docs/ReadPolicyVersionRequest.md new file mode 100644 index 000000000..f2a4f13a8 --- /dev/null +++ b/v2/docs/ReadPolicyVersionRequest.md @@ -0,0 +1,72 @@ +# ReadPolicyVersionRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PolicyOrn** | **string** | The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). | +**VersionId** | **string** | The ID of the policy version. | + +## Methods + +### NewReadPolicyVersionRequest + +`func NewReadPolicyVersionRequest(policyOrn string, versionId string, ) *ReadPolicyVersionRequest` + +NewReadPolicyVersionRequest instantiates a new ReadPolicyVersionRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewReadPolicyVersionRequestWithDefaults + +`func NewReadPolicyVersionRequestWithDefaults() *ReadPolicyVersionRequest` + +NewReadPolicyVersionRequestWithDefaults instantiates a new ReadPolicyVersionRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetPolicyOrn + +`func (o *ReadPolicyVersionRequest) GetPolicyOrn() string` + +GetPolicyOrn returns the PolicyOrn field if non-nil, zero value otherwise. + +### GetPolicyOrnOk + +`func (o *ReadPolicyVersionRequest) GetPolicyOrnOk() (*string, bool)` + +GetPolicyOrnOk returns a tuple with the PolicyOrn field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicyOrn + +`func (o *ReadPolicyVersionRequest) SetPolicyOrn(v string)` + +SetPolicyOrn sets PolicyOrn field to given value. + + +### GetVersionId + +`func (o *ReadPolicyVersionRequest) GetVersionId() string` + +GetVersionId returns the VersionId field if non-nil, zero value otherwise. + +### GetVersionIdOk + +`func (o *ReadPolicyVersionRequest) GetVersionIdOk() (*string, bool)` + +GetVersionIdOk returns a tuple with the VersionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersionId + +`func (o *ReadPolicyVersionRequest) SetVersionId(v string)` + +SetVersionId sets VersionId field to given value. + + + +[[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/v2/docs/ReadPolicyVersionResponse.md b/v2/docs/ReadPolicyVersionResponse.md new file mode 100644 index 000000000..f1a0e6c54 --- /dev/null +++ b/v2/docs/ReadPolicyVersionResponse.md @@ -0,0 +1,82 @@ +# ReadPolicyVersionResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PolicyVersion** | Pointer to [**PolicyVersion**](PolicyVersion.md) | | [optional] +**ResponseContext** | Pointer to [**ResponseContext**](ResponseContext.md) | | [optional] + +## Methods + +### NewReadPolicyVersionResponse + +`func NewReadPolicyVersionResponse() *ReadPolicyVersionResponse` + +NewReadPolicyVersionResponse instantiates a new ReadPolicyVersionResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewReadPolicyVersionResponseWithDefaults + +`func NewReadPolicyVersionResponseWithDefaults() *ReadPolicyVersionResponse` + +NewReadPolicyVersionResponseWithDefaults instantiates a new ReadPolicyVersionResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetPolicyVersion + +`func (o *ReadPolicyVersionResponse) GetPolicyVersion() PolicyVersion` + +GetPolicyVersion returns the PolicyVersion field if non-nil, zero value otherwise. + +### GetPolicyVersionOk + +`func (o *ReadPolicyVersionResponse) GetPolicyVersionOk() (*PolicyVersion, bool)` + +GetPolicyVersionOk returns a tuple with the PolicyVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicyVersion + +`func (o *ReadPolicyVersionResponse) SetPolicyVersion(v PolicyVersion)` + +SetPolicyVersion sets PolicyVersion field to given value. + +### HasPolicyVersion + +`func (o *ReadPolicyVersionResponse) HasPolicyVersion() bool` + +HasPolicyVersion returns a boolean if a field has been set. + +### GetResponseContext + +`func (o *ReadPolicyVersionResponse) GetResponseContext() ResponseContext` + +GetResponseContext returns the ResponseContext field if non-nil, zero value otherwise. + +### GetResponseContextOk + +`func (o *ReadPolicyVersionResponse) GetResponseContextOk() (*ResponseContext, bool)` + +GetResponseContextOk returns a tuple with the ResponseContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseContext + +`func (o *ReadPolicyVersionResponse) SetResponseContext(v ResponseContext)` + +SetResponseContext sets ResponseContext field to given value. + +### HasResponseContext + +`func (o *ReadPolicyVersionResponse) HasResponseContext() bool` + +HasResponseContext returns a boolean if a field has been set. + + +[[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/v2/docs/ReadPolicyVersionsRequest.md b/v2/docs/ReadPolicyVersionsRequest.md new file mode 100644 index 000000000..d0f75c30f --- /dev/null +++ b/v2/docs/ReadPolicyVersionsRequest.md @@ -0,0 +1,103 @@ +# ReadPolicyVersionsRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FirstItem** | Pointer to **int32** | The item starting the list of policies requested. | [optional] +**PolicyOrn** | **string** | The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). | +**ResultsPerPage** | Pointer to **int32** | The maximum number of items that can be returned in a single response (by default, 100). | [optional] + +## Methods + +### NewReadPolicyVersionsRequest + +`func NewReadPolicyVersionsRequest(policyOrn string, ) *ReadPolicyVersionsRequest` + +NewReadPolicyVersionsRequest instantiates a new ReadPolicyVersionsRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewReadPolicyVersionsRequestWithDefaults + +`func NewReadPolicyVersionsRequestWithDefaults() *ReadPolicyVersionsRequest` + +NewReadPolicyVersionsRequestWithDefaults instantiates a new ReadPolicyVersionsRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetFirstItem + +`func (o *ReadPolicyVersionsRequest) GetFirstItem() int32` + +GetFirstItem returns the FirstItem field if non-nil, zero value otherwise. + +### GetFirstItemOk + +`func (o *ReadPolicyVersionsRequest) GetFirstItemOk() (*int32, bool)` + +GetFirstItemOk returns a tuple with the FirstItem field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstItem + +`func (o *ReadPolicyVersionsRequest) SetFirstItem(v int32)` + +SetFirstItem sets FirstItem field to given value. + +### HasFirstItem + +`func (o *ReadPolicyVersionsRequest) HasFirstItem() bool` + +HasFirstItem returns a boolean if a field has been set. + +### GetPolicyOrn + +`func (o *ReadPolicyVersionsRequest) GetPolicyOrn() string` + +GetPolicyOrn returns the PolicyOrn field if non-nil, zero value otherwise. + +### GetPolicyOrnOk + +`func (o *ReadPolicyVersionsRequest) GetPolicyOrnOk() (*string, bool)` + +GetPolicyOrnOk returns a tuple with the PolicyOrn field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicyOrn + +`func (o *ReadPolicyVersionsRequest) SetPolicyOrn(v string)` + +SetPolicyOrn sets PolicyOrn field to given value. + + +### GetResultsPerPage + +`func (o *ReadPolicyVersionsRequest) GetResultsPerPage() int32` + +GetResultsPerPage returns the ResultsPerPage field if non-nil, zero value otherwise. + +### GetResultsPerPageOk + +`func (o *ReadPolicyVersionsRequest) GetResultsPerPageOk() (*int32, bool)` + +GetResultsPerPageOk returns a tuple with the ResultsPerPage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultsPerPage + +`func (o *ReadPolicyVersionsRequest) SetResultsPerPage(v int32)` + +SetResultsPerPage sets ResultsPerPage field to given value. + +### HasResultsPerPage + +`func (o *ReadPolicyVersionsRequest) HasResultsPerPage() bool` + +HasResultsPerPage returns a boolean if a field has been set. + + +[[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/v2/docs/ReadPolicyVersionsResponse.md b/v2/docs/ReadPolicyVersionsResponse.md new file mode 100644 index 000000000..e2be6e2bd --- /dev/null +++ b/v2/docs/ReadPolicyVersionsResponse.md @@ -0,0 +1,134 @@ +# ReadPolicyVersionsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**HasMoreItems** | Pointer to **bool** | If true, there are more items to return using the `FirstItem` parameter in a new request. | [optional] +**MaxResultsLimit** | Pointer to **int32** | Indicates maximum results defined for the operation. | [optional] +**PolicyVersions** | Pointer to [**[]PolicyVersion**](PolicyVersion.md) | A list of all the versions of the policy. | [optional] +**ResponseContext** | Pointer to [**ResponseContext**](ResponseContext.md) | | [optional] + +## Methods + +### NewReadPolicyVersionsResponse + +`func NewReadPolicyVersionsResponse() *ReadPolicyVersionsResponse` + +NewReadPolicyVersionsResponse instantiates a new ReadPolicyVersionsResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewReadPolicyVersionsResponseWithDefaults + +`func NewReadPolicyVersionsResponseWithDefaults() *ReadPolicyVersionsResponse` + +NewReadPolicyVersionsResponseWithDefaults instantiates a new ReadPolicyVersionsResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetHasMoreItems + +`func (o *ReadPolicyVersionsResponse) GetHasMoreItems() bool` + +GetHasMoreItems returns the HasMoreItems field if non-nil, zero value otherwise. + +### GetHasMoreItemsOk + +`func (o *ReadPolicyVersionsResponse) GetHasMoreItemsOk() (*bool, bool)` + +GetHasMoreItemsOk returns a tuple with the HasMoreItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasMoreItems + +`func (o *ReadPolicyVersionsResponse) SetHasMoreItems(v bool)` + +SetHasMoreItems sets HasMoreItems field to given value. + +### HasHasMoreItems + +`func (o *ReadPolicyVersionsResponse) HasHasMoreItems() bool` + +HasHasMoreItems returns a boolean if a field has been set. + +### GetMaxResultsLimit + +`func (o *ReadPolicyVersionsResponse) GetMaxResultsLimit() int32` + +GetMaxResultsLimit returns the MaxResultsLimit field if non-nil, zero value otherwise. + +### GetMaxResultsLimitOk + +`func (o *ReadPolicyVersionsResponse) GetMaxResultsLimitOk() (*int32, bool)` + +GetMaxResultsLimitOk returns a tuple with the MaxResultsLimit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxResultsLimit + +`func (o *ReadPolicyVersionsResponse) SetMaxResultsLimit(v int32)` + +SetMaxResultsLimit sets MaxResultsLimit field to given value. + +### HasMaxResultsLimit + +`func (o *ReadPolicyVersionsResponse) HasMaxResultsLimit() bool` + +HasMaxResultsLimit returns a boolean if a field has been set. + +### GetPolicyVersions + +`func (o *ReadPolicyVersionsResponse) GetPolicyVersions() []PolicyVersion` + +GetPolicyVersions returns the PolicyVersions field if non-nil, zero value otherwise. + +### GetPolicyVersionsOk + +`func (o *ReadPolicyVersionsResponse) GetPolicyVersionsOk() (*[]PolicyVersion, bool)` + +GetPolicyVersionsOk returns a tuple with the PolicyVersions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicyVersions + +`func (o *ReadPolicyVersionsResponse) SetPolicyVersions(v []PolicyVersion)` + +SetPolicyVersions sets PolicyVersions field to given value. + +### HasPolicyVersions + +`func (o *ReadPolicyVersionsResponse) HasPolicyVersions() bool` + +HasPolicyVersions returns a boolean if a field has been set. + +### GetResponseContext + +`func (o *ReadPolicyVersionsResponse) GetResponseContext() ResponseContext` + +GetResponseContext returns the ResponseContext field if non-nil, zero value otherwise. + +### GetResponseContextOk + +`func (o *ReadPolicyVersionsResponse) GetResponseContextOk() (*ResponseContext, bool)` + +GetResponseContextOk returns a tuple with the ResponseContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseContext + +`func (o *ReadPolicyVersionsResponse) SetResponseContext(v ResponseContext)` + +SetResponseContext sets ResponseContext field to given value. + +### HasResponseContext + +`func (o *ReadPolicyVersionsResponse) HasResponseContext() bool` + +HasResponseContext returns a boolean if a field has been set. + + +[[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/v2/docs/ReadPublicIpsRequest.md b/v2/docs/ReadPublicIpsRequest.md index 1bb87561f..3e6f11ec5 100644 --- a/v2/docs/ReadPublicIpsRequest.md +++ b/v2/docs/ReadPublicIpsRequest.md @@ -6,6 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] **Filters** | Pointer to [**FiltersPublicIp**](FiltersPublicIp.md) | | [optional] +**NextPageToken** | Pointer to **string** | The token to request the next page of results. Each token refers to a specific page. | [optional] +**ResultsPerPage** | Pointer to **int32** | The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`. | [optional] ## Methods @@ -76,6 +78,56 @@ SetFilters sets Filters field to given value. HasFilters returns a boolean if a field has been set. +### GetNextPageToken + +`func (o *ReadPublicIpsRequest) GetNextPageToken() string` + +GetNextPageToken returns the NextPageToken field if non-nil, zero value otherwise. + +### GetNextPageTokenOk + +`func (o *ReadPublicIpsRequest) GetNextPageTokenOk() (*string, bool)` + +GetNextPageTokenOk returns a tuple with the NextPageToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNextPageToken + +`func (o *ReadPublicIpsRequest) SetNextPageToken(v string)` + +SetNextPageToken sets NextPageToken field to given value. + +### HasNextPageToken + +`func (o *ReadPublicIpsRequest) HasNextPageToken() bool` + +HasNextPageToken returns a boolean if a field has been set. + +### GetResultsPerPage + +`func (o *ReadPublicIpsRequest) GetResultsPerPage() int32` + +GetResultsPerPage returns the ResultsPerPage field if non-nil, zero value otherwise. + +### GetResultsPerPageOk + +`func (o *ReadPublicIpsRequest) GetResultsPerPageOk() (*int32, bool)` + +GetResultsPerPageOk returns a tuple with the ResultsPerPage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultsPerPage + +`func (o *ReadPublicIpsRequest) SetResultsPerPage(v int32)` + +SetResultsPerPage sets ResultsPerPage field to given value. + +### HasResultsPerPage + +`func (o *ReadPublicIpsRequest) HasResultsPerPage() bool` + +HasResultsPerPage returns a boolean if a field has been set. + [[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/v2/docs/ReadPublicIpsResponse.md b/v2/docs/ReadPublicIpsResponse.md index a03617090..7d147472e 100644 --- a/v2/docs/ReadPublicIpsResponse.md +++ b/v2/docs/ReadPublicIpsResponse.md @@ -4,6 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**NextPageToken** | Pointer to **string** | The token to request the next page of results. Each token refers to a specific page. | [optional] **PublicIps** | Pointer to [**[]PublicIp**](PublicIp.md) | Information about one or more public IPs. | [optional] **ResponseContext** | Pointer to [**ResponseContext**](ResponseContext.md) | | [optional] @@ -26,6 +27,31 @@ NewReadPublicIpsResponseWithDefaults instantiates a new ReadPublicIpsResponse ob This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set +### GetNextPageToken + +`func (o *ReadPublicIpsResponse) GetNextPageToken() string` + +GetNextPageToken returns the NextPageToken field if non-nil, zero value otherwise. + +### GetNextPageTokenOk + +`func (o *ReadPublicIpsResponse) GetNextPageTokenOk() (*string, bool)` + +GetNextPageTokenOk returns a tuple with the NextPageToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNextPageToken + +`func (o *ReadPublicIpsResponse) SetNextPageToken(v string)` + +SetNextPageToken sets NextPageToken field to given value. + +### HasNextPageToken + +`func (o *ReadPublicIpsResponse) HasNextPageToken() bool` + +HasNextPageToken returns a boolean if a field has been set. + ### GetPublicIps `func (o *ReadPublicIpsResponse) GetPublicIps() []PublicIp` diff --git a/v2/docs/ReadRouteTablesRequest.md b/v2/docs/ReadRouteTablesRequest.md index f8b643e02..860f81e02 100644 --- a/v2/docs/ReadRouteTablesRequest.md +++ b/v2/docs/ReadRouteTablesRequest.md @@ -6,6 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] **Filters** | Pointer to [**FiltersRouteTable**](FiltersRouteTable.md) | | [optional] +**NextPageToken** | Pointer to **string** | The token to request the next page of results. Each token refers to a specific page. | [optional] +**ResultsPerPage** | Pointer to **int32** | The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`. | [optional] ## Methods @@ -76,6 +78,56 @@ SetFilters sets Filters field to given value. HasFilters returns a boolean if a field has been set. +### GetNextPageToken + +`func (o *ReadRouteTablesRequest) GetNextPageToken() string` + +GetNextPageToken returns the NextPageToken field if non-nil, zero value otherwise. + +### GetNextPageTokenOk + +`func (o *ReadRouteTablesRequest) GetNextPageTokenOk() (*string, bool)` + +GetNextPageTokenOk returns a tuple with the NextPageToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNextPageToken + +`func (o *ReadRouteTablesRequest) SetNextPageToken(v string)` + +SetNextPageToken sets NextPageToken field to given value. + +### HasNextPageToken + +`func (o *ReadRouteTablesRequest) HasNextPageToken() bool` + +HasNextPageToken returns a boolean if a field has been set. + +### GetResultsPerPage + +`func (o *ReadRouteTablesRequest) GetResultsPerPage() int32` + +GetResultsPerPage returns the ResultsPerPage field if non-nil, zero value otherwise. + +### GetResultsPerPageOk + +`func (o *ReadRouteTablesRequest) GetResultsPerPageOk() (*int32, bool)` + +GetResultsPerPageOk returns a tuple with the ResultsPerPage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultsPerPage + +`func (o *ReadRouteTablesRequest) SetResultsPerPage(v int32)` + +SetResultsPerPage sets ResultsPerPage field to given value. + +### HasResultsPerPage + +`func (o *ReadRouteTablesRequest) HasResultsPerPage() bool` + +HasResultsPerPage returns a boolean if a field has been set. + [[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/v2/docs/ReadRouteTablesResponse.md b/v2/docs/ReadRouteTablesResponse.md index 8f324fa7e..bc190d0e7 100644 --- a/v2/docs/ReadRouteTablesResponse.md +++ b/v2/docs/ReadRouteTablesResponse.md @@ -4,6 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**NextPageToken** | Pointer to **string** | The token to request the next page of results. Each token refers to a specific page. | [optional] **ResponseContext** | Pointer to [**ResponseContext**](ResponseContext.md) | | [optional] **RouteTables** | Pointer to [**[]RouteTable**](RouteTable.md) | Information about one or more route tables. | [optional] @@ -26,6 +27,31 @@ NewReadRouteTablesResponseWithDefaults instantiates a new ReadRouteTablesRespons This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set +### GetNextPageToken + +`func (o *ReadRouteTablesResponse) GetNextPageToken() string` + +GetNextPageToken returns the NextPageToken field if non-nil, zero value otherwise. + +### GetNextPageTokenOk + +`func (o *ReadRouteTablesResponse) GetNextPageTokenOk() (*string, bool)` + +GetNextPageTokenOk returns a tuple with the NextPageToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNextPageToken + +`func (o *ReadRouteTablesResponse) SetNextPageToken(v string)` + +SetNextPageToken sets NextPageToken field to given value. + +### HasNextPageToken + +`func (o *ReadRouteTablesResponse) HasNextPageToken() bool` + +HasNextPageToken returns a boolean if a field has been set. + ### GetResponseContext `func (o *ReadRouteTablesResponse) GetResponseContext() ResponseContext` diff --git a/v2/docs/ReadVirtualGatewaysRequest.md b/v2/docs/ReadVirtualGatewaysRequest.md index fc71cefb6..d873639ec 100644 --- a/v2/docs/ReadVirtualGatewaysRequest.md +++ b/v2/docs/ReadVirtualGatewaysRequest.md @@ -6,6 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] **Filters** | Pointer to [**FiltersVirtualGateway**](FiltersVirtualGateway.md) | | [optional] +**NextPageToken** | Pointer to **string** | The token to request the next page of results. Each token refers to a specific page. | [optional] +**ResultsPerPage** | Pointer to **int32** | The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`. | [optional] ## Methods @@ -76,6 +78,56 @@ SetFilters sets Filters field to given value. HasFilters returns a boolean if a field has been set. +### GetNextPageToken + +`func (o *ReadVirtualGatewaysRequest) GetNextPageToken() string` + +GetNextPageToken returns the NextPageToken field if non-nil, zero value otherwise. + +### GetNextPageTokenOk + +`func (o *ReadVirtualGatewaysRequest) GetNextPageTokenOk() (*string, bool)` + +GetNextPageTokenOk returns a tuple with the NextPageToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNextPageToken + +`func (o *ReadVirtualGatewaysRequest) SetNextPageToken(v string)` + +SetNextPageToken sets NextPageToken field to given value. + +### HasNextPageToken + +`func (o *ReadVirtualGatewaysRequest) HasNextPageToken() bool` + +HasNextPageToken returns a boolean if a field has been set. + +### GetResultsPerPage + +`func (o *ReadVirtualGatewaysRequest) GetResultsPerPage() int32` + +GetResultsPerPage returns the ResultsPerPage field if non-nil, zero value otherwise. + +### GetResultsPerPageOk + +`func (o *ReadVirtualGatewaysRequest) GetResultsPerPageOk() (*int32, bool)` + +GetResultsPerPageOk returns a tuple with the ResultsPerPage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultsPerPage + +`func (o *ReadVirtualGatewaysRequest) SetResultsPerPage(v int32)` + +SetResultsPerPage sets ResultsPerPage field to given value. + +### HasResultsPerPage + +`func (o *ReadVirtualGatewaysRequest) HasResultsPerPage() bool` + +HasResultsPerPage returns a boolean if a field has been set. + [[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/v2/docs/ReadVirtualGatewaysResponse.md b/v2/docs/ReadVirtualGatewaysResponse.md index 935d3b642..3a02d6453 100644 --- a/v2/docs/ReadVirtualGatewaysResponse.md +++ b/v2/docs/ReadVirtualGatewaysResponse.md @@ -4,6 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**NextPageToken** | Pointer to **string** | The token to request the next page of results. Each token refers to a specific page. | [optional] **ResponseContext** | Pointer to [**ResponseContext**](ResponseContext.md) | | [optional] **VirtualGateways** | Pointer to [**[]VirtualGateway**](VirtualGateway.md) | Information about one or more virtual gateways. | [optional] @@ -26,6 +27,31 @@ NewReadVirtualGatewaysResponseWithDefaults instantiates a new ReadVirtualGateway This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set +### GetNextPageToken + +`func (o *ReadVirtualGatewaysResponse) GetNextPageToken() string` + +GetNextPageToken returns the NextPageToken field if non-nil, zero value otherwise. + +### GetNextPageTokenOk + +`func (o *ReadVirtualGatewaysResponse) GetNextPageTokenOk() (*string, bool)` + +GetNextPageTokenOk returns a tuple with the NextPageToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNextPageToken + +`func (o *ReadVirtualGatewaysResponse) SetNextPageToken(v string)` + +SetNextPageToken sets NextPageToken field to given value. + +### HasNextPageToken + +`func (o *ReadVirtualGatewaysResponse) HasNextPageToken() bool` + +HasNextPageToken returns a boolean if a field has been set. + ### GetResponseContext `func (o *ReadVirtualGatewaysResponse) GetResponseContext() ResponseContext` diff --git a/v2/docs/ReadVmsRequest.md b/v2/docs/ReadVmsRequest.md index 46cfd192d..25c0446c9 100644 --- a/v2/docs/ReadVmsRequest.md +++ b/v2/docs/ReadVmsRequest.md @@ -6,6 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] **Filters** | Pointer to [**FiltersVm**](FiltersVm.md) | | [optional] +**NextPageToken** | Pointer to **string** | The token to request the next page of results. Each token refers to a specific page. | [optional] +**ResultsPerPage** | Pointer to **int32** | The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`. | [optional] ## Methods @@ -76,6 +78,56 @@ SetFilters sets Filters field to given value. HasFilters returns a boolean if a field has been set. +### GetNextPageToken + +`func (o *ReadVmsRequest) GetNextPageToken() string` + +GetNextPageToken returns the NextPageToken field if non-nil, zero value otherwise. + +### GetNextPageTokenOk + +`func (o *ReadVmsRequest) GetNextPageTokenOk() (*string, bool)` + +GetNextPageTokenOk returns a tuple with the NextPageToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNextPageToken + +`func (o *ReadVmsRequest) SetNextPageToken(v string)` + +SetNextPageToken sets NextPageToken field to given value. + +### HasNextPageToken + +`func (o *ReadVmsRequest) HasNextPageToken() bool` + +HasNextPageToken returns a boolean if a field has been set. + +### GetResultsPerPage + +`func (o *ReadVmsRequest) GetResultsPerPage() int32` + +GetResultsPerPage returns the ResultsPerPage field if non-nil, zero value otherwise. + +### GetResultsPerPageOk + +`func (o *ReadVmsRequest) GetResultsPerPageOk() (*int32, bool)` + +GetResultsPerPageOk returns a tuple with the ResultsPerPage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultsPerPage + +`func (o *ReadVmsRequest) SetResultsPerPage(v int32)` + +SetResultsPerPage sets ResultsPerPage field to given value. + +### HasResultsPerPage + +`func (o *ReadVmsRequest) HasResultsPerPage() bool` + +HasResultsPerPage returns a boolean if a field has been set. + [[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/v2/docs/ReadVmsResponse.md b/v2/docs/ReadVmsResponse.md index 44cf82445..5b33bf757 100644 --- a/v2/docs/ReadVmsResponse.md +++ b/v2/docs/ReadVmsResponse.md @@ -4,6 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**NextPageToken** | Pointer to **string** | The token to request the next page of results. Each token refers to a specific page. | [optional] **ResponseContext** | Pointer to [**ResponseContext**](ResponseContext.md) | | [optional] **Vms** | Pointer to [**[]Vm**](Vm.md) | Information about one or more VMs. | [optional] @@ -26,6 +27,31 @@ NewReadVmsResponseWithDefaults instantiates a new ReadVmsResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set +### GetNextPageToken + +`func (o *ReadVmsResponse) GetNextPageToken() string` + +GetNextPageToken returns the NextPageToken field if non-nil, zero value otherwise. + +### GetNextPageTokenOk + +`func (o *ReadVmsResponse) GetNextPageTokenOk() (*string, bool)` + +GetNextPageTokenOk returns a tuple with the NextPageToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNextPageToken + +`func (o *ReadVmsResponse) SetNextPageToken(v string)` + +SetNextPageToken sets NextPageToken field to given value. + +### HasNextPageToken + +`func (o *ReadVmsResponse) HasNextPageToken() bool` + +HasNextPageToken returns a boolean if a field has been set. + ### GetResponseContext `func (o *ReadVmsResponse) GetResponseContext() ResponseContext` diff --git a/v2/docs/ReadVolumesRequest.md b/v2/docs/ReadVolumesRequest.md index 192d69d3b..b2e6c725e 100644 --- a/v2/docs/ReadVolumesRequest.md +++ b/v2/docs/ReadVolumesRequest.md @@ -6,6 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] **Filters** | Pointer to [**FiltersVolume**](FiltersVolume.md) | | [optional] +**NextPageToken** | Pointer to **string** | The token to request the next page of results. Each token refers to a specific page. | [optional] +**ResultsPerPage** | Pointer to **int32** | The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`. | [optional] ## Methods @@ -76,6 +78,56 @@ SetFilters sets Filters field to given value. HasFilters returns a boolean if a field has been set. +### GetNextPageToken + +`func (o *ReadVolumesRequest) GetNextPageToken() string` + +GetNextPageToken returns the NextPageToken field if non-nil, zero value otherwise. + +### GetNextPageTokenOk + +`func (o *ReadVolumesRequest) GetNextPageTokenOk() (*string, bool)` + +GetNextPageTokenOk returns a tuple with the NextPageToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNextPageToken + +`func (o *ReadVolumesRequest) SetNextPageToken(v string)` + +SetNextPageToken sets NextPageToken field to given value. + +### HasNextPageToken + +`func (o *ReadVolumesRequest) HasNextPageToken() bool` + +HasNextPageToken returns a boolean if a field has been set. + +### GetResultsPerPage + +`func (o *ReadVolumesRequest) GetResultsPerPage() int32` + +GetResultsPerPage returns the ResultsPerPage field if non-nil, zero value otherwise. + +### GetResultsPerPageOk + +`func (o *ReadVolumesRequest) GetResultsPerPageOk() (*int32, bool)` + +GetResultsPerPageOk returns a tuple with the ResultsPerPage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultsPerPage + +`func (o *ReadVolumesRequest) SetResultsPerPage(v int32)` + +SetResultsPerPage sets ResultsPerPage field to given value. + +### HasResultsPerPage + +`func (o *ReadVolumesRequest) HasResultsPerPage() bool` + +HasResultsPerPage returns a boolean if a field has been set. + [[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/v2/docs/ReadVolumesResponse.md b/v2/docs/ReadVolumesResponse.md index 819c816c5..c02adb4d2 100644 --- a/v2/docs/ReadVolumesResponse.md +++ b/v2/docs/ReadVolumesResponse.md @@ -4,6 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**NextPageToken** | Pointer to **string** | The token to request the next page of results. Each token refers to a specific page. | [optional] **ResponseContext** | Pointer to [**ResponseContext**](ResponseContext.md) | | [optional] **Volumes** | Pointer to [**[]Volume**](Volume.md) | Information about one or more volumes. | [optional] @@ -26,6 +27,31 @@ NewReadVolumesResponseWithDefaults instantiates a new ReadVolumesResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set +### GetNextPageToken + +`func (o *ReadVolumesResponse) GetNextPageToken() string` + +GetNextPageToken returns the NextPageToken field if non-nil, zero value otherwise. + +### GetNextPageTokenOk + +`func (o *ReadVolumesResponse) GetNextPageTokenOk() (*string, bool)` + +GetNextPageTokenOk returns a tuple with the NextPageToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNextPageToken + +`func (o *ReadVolumesResponse) SetNextPageToken(v string)` + +SetNextPageToken sets NextPageToken field to given value. + +### HasNextPageToken + +`func (o *ReadVolumesResponse) HasNextPageToken() bool` + +HasNextPageToken returns a boolean if a field has been set. + ### GetResponseContext `func (o *ReadVolumesResponse) GetResponseContext() ResponseContext` diff --git a/v2/docs/ReadVpnConnectionsRequest.md b/v2/docs/ReadVpnConnectionsRequest.md index 6582d52d0..9c8be455a 100644 --- a/v2/docs/ReadVpnConnectionsRequest.md +++ b/v2/docs/ReadVpnConnectionsRequest.md @@ -6,6 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] **Filters** | Pointer to [**FiltersVpnConnection**](FiltersVpnConnection.md) | | [optional] +**NextPageToken** | Pointer to **string** | The token to request the next page of results. Each token refers to a specific page. | [optional] +**ResultsPerPage** | Pointer to **int32** | The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`. | [optional] ## Methods @@ -76,6 +78,56 @@ SetFilters sets Filters field to given value. HasFilters returns a boolean if a field has been set. +### GetNextPageToken + +`func (o *ReadVpnConnectionsRequest) GetNextPageToken() string` + +GetNextPageToken returns the NextPageToken field if non-nil, zero value otherwise. + +### GetNextPageTokenOk + +`func (o *ReadVpnConnectionsRequest) GetNextPageTokenOk() (*string, bool)` + +GetNextPageTokenOk returns a tuple with the NextPageToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNextPageToken + +`func (o *ReadVpnConnectionsRequest) SetNextPageToken(v string)` + +SetNextPageToken sets NextPageToken field to given value. + +### HasNextPageToken + +`func (o *ReadVpnConnectionsRequest) HasNextPageToken() bool` + +HasNextPageToken returns a boolean if a field has been set. + +### GetResultsPerPage + +`func (o *ReadVpnConnectionsRequest) GetResultsPerPage() int32` + +GetResultsPerPage returns the ResultsPerPage field if non-nil, zero value otherwise. + +### GetResultsPerPageOk + +`func (o *ReadVpnConnectionsRequest) GetResultsPerPageOk() (*int32, bool)` + +GetResultsPerPageOk returns a tuple with the ResultsPerPage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultsPerPage + +`func (o *ReadVpnConnectionsRequest) SetResultsPerPage(v int32)` + +SetResultsPerPage sets ResultsPerPage field to given value. + +### HasResultsPerPage + +`func (o *ReadVpnConnectionsRequest) HasResultsPerPage() bool` + +HasResultsPerPage returns a boolean if a field has been set. + [[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/v2/docs/ReadVpnConnectionsResponse.md b/v2/docs/ReadVpnConnectionsResponse.md index 7089f889d..27f2e659b 100644 --- a/v2/docs/ReadVpnConnectionsResponse.md +++ b/v2/docs/ReadVpnConnectionsResponse.md @@ -4,6 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**NextPageToken** | Pointer to **string** | The token to request the next page of results. Each token refers to a specific page. | [optional] **ResponseContext** | Pointer to [**ResponseContext**](ResponseContext.md) | | [optional] **VpnConnections** | Pointer to [**[]VpnConnection**](VpnConnection.md) | Information about one or more VPN connections. | [optional] @@ -26,6 +27,31 @@ NewReadVpnConnectionsResponseWithDefaults instantiates a new ReadVpnConnectionsR This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set +### GetNextPageToken + +`func (o *ReadVpnConnectionsResponse) GetNextPageToken() string` + +GetNextPageToken returns the NextPageToken field if non-nil, zero value otherwise. + +### GetNextPageTokenOk + +`func (o *ReadVpnConnectionsResponse) GetNextPageTokenOk() (*string, bool)` + +GetNextPageTokenOk returns a tuple with the NextPageToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNextPageToken + +`func (o *ReadVpnConnectionsResponse) SetNextPageToken(v string)` + +SetNextPageToken sets NextPageToken field to given value. + +### HasNextPageToken + +`func (o *ReadVpnConnectionsResponse) HasNextPageToken() bool` + +HasNextPageToken returns a boolean if a field has been set. + ### GetResponseContext `func (o *ReadVpnConnectionsResponse) GetResponseContext() ResponseContext` diff --git a/v2/docs/ResetAccountPasswordRequest.md b/v2/docs/ResetAccountPasswordRequest.md deleted file mode 100644 index c7b6a90ba..000000000 --- a/v2/docs/ResetAccountPasswordRequest.md +++ /dev/null @@ -1,98 +0,0 @@ -# ResetAccountPasswordRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] -**Password** | **string** | The new password for the account. | -**Token** | **string** | The token you received at the email address provided for the account. | - -## Methods - -### NewResetAccountPasswordRequest - -`func NewResetAccountPasswordRequest(password string, token string, ) *ResetAccountPasswordRequest` - -NewResetAccountPasswordRequest instantiates a new ResetAccountPasswordRequest object -This constructor will assign default values to properties that have it defined, -and makes sure properties required by API are set, but the set of arguments -will change when the set of required properties is changed - -### NewResetAccountPasswordRequestWithDefaults - -`func NewResetAccountPasswordRequestWithDefaults() *ResetAccountPasswordRequest` - -NewResetAccountPasswordRequestWithDefaults instantiates a new ResetAccountPasswordRequest object -This constructor will only assign default values to properties that have it defined, -but it doesn't guarantee that properties required by API are set - -### GetDryRun - -`func (o *ResetAccountPasswordRequest) GetDryRun() bool` - -GetDryRun returns the DryRun field if non-nil, zero value otherwise. - -### GetDryRunOk - -`func (o *ResetAccountPasswordRequest) GetDryRunOk() (*bool, bool)` - -GetDryRunOk returns a tuple with the DryRun field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### SetDryRun - -`func (o *ResetAccountPasswordRequest) SetDryRun(v bool)` - -SetDryRun sets DryRun field to given value. - -### HasDryRun - -`func (o *ResetAccountPasswordRequest) HasDryRun() bool` - -HasDryRun returns a boolean if a field has been set. - -### GetPassword - -`func (o *ResetAccountPasswordRequest) GetPassword() string` - -GetPassword returns the Password field if non-nil, zero value otherwise. - -### GetPasswordOk - -`func (o *ResetAccountPasswordRequest) GetPasswordOk() (*string, bool)` - -GetPasswordOk returns a tuple with the Password field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### SetPassword - -`func (o *ResetAccountPasswordRequest) SetPassword(v string)` - -SetPassword sets Password field to given value. - - -### GetToken - -`func (o *ResetAccountPasswordRequest) GetToken() string` - -GetToken returns the Token field if non-nil, zero value otherwise. - -### GetTokenOk - -`func (o *ResetAccountPasswordRequest) GetTokenOk() (*string, bool)` - -GetTokenOk returns a tuple with the Token field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### SetToken - -`func (o *ResetAccountPasswordRequest) SetToken(v string)` - -SetToken sets Token field to given value. - - - -[[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/v2/docs/RouteTableApi.md b/v2/docs/RouteTableApi.md index 28e91deb7..f2951fd49 100644 --- a/v2/docs/RouteTableApi.md +++ b/v2/docs/RouteTableApi.md @@ -9,6 +9,7 @@ Method | HTTP request | Description [**LinkRouteTable**](RouteTableApi.md#LinkRouteTable) | **Post** /LinkRouteTable | [**ReadRouteTables**](RouteTableApi.md#ReadRouteTables) | **Post** /ReadRouteTables | [**UnlinkRouteTable**](RouteTableApi.md#UnlinkRouteTable) | **Post** /UnlinkRouteTable | +[**UpdateRouteTableLink**](RouteTableApi.md#UpdateRouteTableLink) | **Post** /UpdateRouteTableLink | @@ -331,3 +332,67 @@ Name | Type | Description | Notes [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +## UpdateRouteTableLink + +> UpdateRouteTableLinkResponse UpdateRouteTableLink(ctx).UpdateRouteTableLinkRequest(updateRouteTableLinkRequest).Execute() + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "./openapi" +) + +func main() { + updateRouteTableLinkRequest := *openapiclient.NewUpdateRouteTableLinkRequest("LinkRouteTableId_example", "RouteTableId_example") // UpdateRouteTableLinkRequest | (optional) + + configuration := openapiclient.NewConfiguration() + api_client := openapiclient.NewAPIClient(configuration) + resp, r, err := api_client.RouteTableApi.UpdateRouteTableLink(context.Background()).UpdateRouteTableLinkRequest(updateRouteTableLinkRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RouteTableApi.UpdateRouteTableLink``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateRouteTableLink`: UpdateRouteTableLinkResponse + fmt.Fprintf(os.Stdout, "Response from `RouteTableApi.UpdateRouteTableLink`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateRouteTableLinkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **updateRouteTableLinkRequest** | [**UpdateRouteTableLinkRequest**](UpdateRouteTableLinkRequest.md) | | + +### Return type + +[**UpdateRouteTableLinkResponse**](UpdateRouteTableLinkResponse.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/v2/docs/SecurityGroup.md b/v2/docs/SecurityGroup.md index 5668536a3..358df1183 100644 --- a/v2/docs/SecurityGroup.md +++ b/v2/docs/SecurityGroup.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**AccountId** | Pointer to **string** | The account ID of a user that has been granted permission. | [optional] +**AccountId** | Pointer to **string** | The account ID that has been granted permission. | [optional] **Description** | Pointer to **string** | The description of the security group. | [optional] **InboundRules** | Pointer to [**[]SecurityGroupRule**](SecurityGroupRule.md) | The inbound rules associated with the security group. | [optional] **NetId** | Pointer to **string** | The ID of the Net for the security group. | [optional] diff --git a/v2/docs/SendResetPasswordEmailRequest.md b/v2/docs/SendResetPasswordEmailRequest.md deleted file mode 100644 index 8dd8ecfbc..000000000 --- a/v2/docs/SendResetPasswordEmailRequest.md +++ /dev/null @@ -1,77 +0,0 @@ -# SendResetPasswordEmailRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] -**Email** | **string** | The email address provided for the account. | - -## Methods - -### NewSendResetPasswordEmailRequest - -`func NewSendResetPasswordEmailRequest(email string, ) *SendResetPasswordEmailRequest` - -NewSendResetPasswordEmailRequest instantiates a new SendResetPasswordEmailRequest object -This constructor will assign default values to properties that have it defined, -and makes sure properties required by API are set, but the set of arguments -will change when the set of required properties is changed - -### NewSendResetPasswordEmailRequestWithDefaults - -`func NewSendResetPasswordEmailRequestWithDefaults() *SendResetPasswordEmailRequest` - -NewSendResetPasswordEmailRequestWithDefaults instantiates a new SendResetPasswordEmailRequest object -This constructor will only assign default values to properties that have it defined, -but it doesn't guarantee that properties required by API are set - -### GetDryRun - -`func (o *SendResetPasswordEmailRequest) GetDryRun() bool` - -GetDryRun returns the DryRun field if non-nil, zero value otherwise. - -### GetDryRunOk - -`func (o *SendResetPasswordEmailRequest) GetDryRunOk() (*bool, bool)` - -GetDryRunOk returns a tuple with the DryRun field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### SetDryRun - -`func (o *SendResetPasswordEmailRequest) SetDryRun(v bool)` - -SetDryRun sets DryRun field to given value. - -### HasDryRun - -`func (o *SendResetPasswordEmailRequest) HasDryRun() bool` - -HasDryRun returns a boolean if a field has been set. - -### GetEmail - -`func (o *SendResetPasswordEmailRequest) GetEmail() string` - -GetEmail returns the Email field if non-nil, zero value otherwise. - -### GetEmailOk - -`func (o *SendResetPasswordEmailRequest) GetEmailOk() (*string, bool)` - -GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### SetEmail - -`func (o *SendResetPasswordEmailRequest) SetEmail(v string)` - -SetEmail sets Email field to given value. - - - -[[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/v2/docs/SetDefaultPolicyVersionRequest.md b/v2/docs/SetDefaultPolicyVersionRequest.md new file mode 100644 index 000000000..3ed7a3559 --- /dev/null +++ b/v2/docs/SetDefaultPolicyVersionRequest.md @@ -0,0 +1,72 @@ +# SetDefaultPolicyVersionRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PolicyOrn** | **string** | The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). | +**VersionId** | **string** | The ID of the version. | + +## Methods + +### NewSetDefaultPolicyVersionRequest + +`func NewSetDefaultPolicyVersionRequest(policyOrn string, versionId string, ) *SetDefaultPolicyVersionRequest` + +NewSetDefaultPolicyVersionRequest instantiates a new SetDefaultPolicyVersionRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSetDefaultPolicyVersionRequestWithDefaults + +`func NewSetDefaultPolicyVersionRequestWithDefaults() *SetDefaultPolicyVersionRequest` + +NewSetDefaultPolicyVersionRequestWithDefaults instantiates a new SetDefaultPolicyVersionRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetPolicyOrn + +`func (o *SetDefaultPolicyVersionRequest) GetPolicyOrn() string` + +GetPolicyOrn returns the PolicyOrn field if non-nil, zero value otherwise. + +### GetPolicyOrnOk + +`func (o *SetDefaultPolicyVersionRequest) GetPolicyOrnOk() (*string, bool)` + +GetPolicyOrnOk returns a tuple with the PolicyOrn field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicyOrn + +`func (o *SetDefaultPolicyVersionRequest) SetPolicyOrn(v string)` + +SetPolicyOrn sets PolicyOrn field to given value. + + +### GetVersionId + +`func (o *SetDefaultPolicyVersionRequest) GetVersionId() string` + +GetVersionId returns the VersionId field if non-nil, zero value otherwise. + +### GetVersionIdOk + +`func (o *SetDefaultPolicyVersionRequest) GetVersionIdOk() (*string, bool)` + +GetVersionIdOk returns a tuple with the VersionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersionId + +`func (o *SetDefaultPolicyVersionRequest) SetVersionId(v string)` + +SetVersionId sets VersionId field to given value. + + + +[[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/v2/docs/SetDefaultPolicyVersionResponse.md b/v2/docs/SetDefaultPolicyVersionResponse.md new file mode 100644 index 000000000..0c03b8b0f --- /dev/null +++ b/v2/docs/SetDefaultPolicyVersionResponse.md @@ -0,0 +1,56 @@ +# SetDefaultPolicyVersionResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ResponseContext** | Pointer to [**ResponseContext**](ResponseContext.md) | | [optional] + +## Methods + +### NewSetDefaultPolicyVersionResponse + +`func NewSetDefaultPolicyVersionResponse() *SetDefaultPolicyVersionResponse` + +NewSetDefaultPolicyVersionResponse instantiates a new SetDefaultPolicyVersionResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSetDefaultPolicyVersionResponseWithDefaults + +`func NewSetDefaultPolicyVersionResponseWithDefaults() *SetDefaultPolicyVersionResponse` + +NewSetDefaultPolicyVersionResponseWithDefaults instantiates a new SetDefaultPolicyVersionResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetResponseContext + +`func (o *SetDefaultPolicyVersionResponse) GetResponseContext() ResponseContext` + +GetResponseContext returns the ResponseContext field if non-nil, zero value otherwise. + +### GetResponseContextOk + +`func (o *SetDefaultPolicyVersionResponse) GetResponseContextOk() (*ResponseContext, bool)` + +GetResponseContextOk returns a tuple with the ResponseContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseContext + +`func (o *SetDefaultPolicyVersionResponse) SetResponseContext(v ResponseContext)` + +SetResponseContext sets ResponseContext field to given value. + +### HasResponseContext + +`func (o *SetDefaultPolicyVersionResponse) HasResponseContext() bool` + +HasResponseContext returns a boolean if a field has been set. + + +[[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/v2/docs/Subregion.md b/v2/docs/Subregion.md index 658fa6b19..385534035 100644 --- a/v2/docs/Subregion.md +++ b/v2/docs/Subregion.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **LocationCode** | Pointer to **string** | The location code of the Subregion. | [optional] **RegionName** | Pointer to **string** | The name of the Region containing the Subregion. | [optional] -**State** | Pointer to **string** | The state of the Subregion (`available` \\| `information` \\| `impaired` \\| `unavailable`). | [optional] +**State** | Pointer to **string** | The state of the Subregion. | [optional] **SubregionName** | Pointer to **string** | The name of the Subregion. | [optional] ## Methods diff --git a/v2/docs/UnlinkPolicyRequest.md b/v2/docs/UnlinkPolicyRequest.md new file mode 100644 index 000000000..586832b14 --- /dev/null +++ b/v2/docs/UnlinkPolicyRequest.md @@ -0,0 +1,98 @@ +# UnlinkPolicyRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] +**PolicyOrn** | **string** | The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). | +**UserName** | **string** | The name of the user you want to detach the policy from. | + +## Methods + +### NewUnlinkPolicyRequest + +`func NewUnlinkPolicyRequest(policyOrn string, userName string, ) *UnlinkPolicyRequest` + +NewUnlinkPolicyRequest instantiates a new UnlinkPolicyRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewUnlinkPolicyRequestWithDefaults + +`func NewUnlinkPolicyRequestWithDefaults() *UnlinkPolicyRequest` + +NewUnlinkPolicyRequestWithDefaults instantiates a new UnlinkPolicyRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDryRun + +`func (o *UnlinkPolicyRequest) GetDryRun() bool` + +GetDryRun returns the DryRun field if non-nil, zero value otherwise. + +### GetDryRunOk + +`func (o *UnlinkPolicyRequest) GetDryRunOk() (*bool, bool)` + +GetDryRunOk returns a tuple with the DryRun field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDryRun + +`func (o *UnlinkPolicyRequest) SetDryRun(v bool)` + +SetDryRun sets DryRun field to given value. + +### HasDryRun + +`func (o *UnlinkPolicyRequest) HasDryRun() bool` + +HasDryRun returns a boolean if a field has been set. + +### GetPolicyOrn + +`func (o *UnlinkPolicyRequest) GetPolicyOrn() string` + +GetPolicyOrn returns the PolicyOrn field if non-nil, zero value otherwise. + +### GetPolicyOrnOk + +`func (o *UnlinkPolicyRequest) GetPolicyOrnOk() (*string, bool)` + +GetPolicyOrnOk returns a tuple with the PolicyOrn field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicyOrn + +`func (o *UnlinkPolicyRequest) SetPolicyOrn(v string)` + +SetPolicyOrn sets PolicyOrn field to given value. + + +### GetUserName + +`func (o *UnlinkPolicyRequest) GetUserName() string` + +GetUserName returns the UserName field if non-nil, zero value otherwise. + +### GetUserNameOk + +`func (o *UnlinkPolicyRequest) GetUserNameOk() (*string, bool)` + +GetUserNameOk returns a tuple with the UserName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserName + +`func (o *UnlinkPolicyRequest) SetUserName(v string)` + +SetUserName sets UserName field to given value. + + + +[[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/v2/docs/UnlinkPolicyResponse.md b/v2/docs/UnlinkPolicyResponse.md new file mode 100644 index 000000000..2acffcf8e --- /dev/null +++ b/v2/docs/UnlinkPolicyResponse.md @@ -0,0 +1,56 @@ +# UnlinkPolicyResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ResponseContext** | Pointer to [**ResponseContext**](ResponseContext.md) | | [optional] + +## Methods + +### NewUnlinkPolicyResponse + +`func NewUnlinkPolicyResponse() *UnlinkPolicyResponse` + +NewUnlinkPolicyResponse instantiates a new UnlinkPolicyResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewUnlinkPolicyResponseWithDefaults + +`func NewUnlinkPolicyResponseWithDefaults() *UnlinkPolicyResponse` + +NewUnlinkPolicyResponseWithDefaults instantiates a new UnlinkPolicyResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetResponseContext + +`func (o *UnlinkPolicyResponse) GetResponseContext() ResponseContext` + +GetResponseContext returns the ResponseContext field if non-nil, zero value otherwise. + +### GetResponseContextOk + +`func (o *UnlinkPolicyResponse) GetResponseContextOk() (*ResponseContext, bool)` + +GetResponseContextOk returns a tuple with the ResponseContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseContext + +`func (o *UnlinkPolicyResponse) SetResponseContext(v ResponseContext)` + +SetResponseContext sets ResponseContext field to given value. + +### HasResponseContext + +`func (o *UnlinkPolicyResponse) HasResponseContext() bool` + +HasResponseContext returns a boolean if a field has been set. + + +[[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/v2/docs/UpdateAccessKeyRequest.md b/v2/docs/UpdateAccessKeyRequest.md index 23197af73..4990e03b4 100644 --- a/v2/docs/UpdateAccessKeyRequest.md +++ b/v2/docs/UpdateAccessKeyRequest.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] **ExpirationDate** | Pointer to **string** | 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. | [optional] **State** | **string** | 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. | -**UserName** | Pointer to **string** | The name of the EIM 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). | [optional] +**UserName** | Pointer to **string** | 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). | [optional] ## Methods diff --git a/v2/docs/UpdateApiAccessPolicyRequest.md b/v2/docs/UpdateApiAccessPolicyRequest.md index dad3f445a..e10fb41f2 100644 --- a/v2/docs/UpdateApiAccessPolicyRequest.md +++ b/v2/docs/UpdateApiAccessPolicyRequest.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] **MaxAccessKeyExpirationSeconds** | **int64** | 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. | -**RequireTrustedEnv** | **bool** | If true, a trusted session is activated, provided that you specify the `MaxAccessKeyExpirationSeconds` parameter with a value greater than `0`. | +**RequireTrustedEnv** | **bool** | If true, a trusted session is activated, provided that you specify the `MaxAccessKeyExpirationSeconds` parameter with a value greater than `0`.<br /> Enabling this will require you and all your users to log in to Cockpit v2 using the WebAuthn method for multi-factor authentication. For more information, see [About Authentication > Multi-Factor Authentication](https://docs.outscale.com/en/userguide/About-Authentication.html#_multi_factor_authentication). | ## Methods diff --git a/v2/docs/UpdateDedicatedGroupRequest.md b/v2/docs/UpdateDedicatedGroupRequest.md new file mode 100644 index 000000000..d0e103e8e --- /dev/null +++ b/v2/docs/UpdateDedicatedGroupRequest.md @@ -0,0 +1,98 @@ +# UpdateDedicatedGroupRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DedicatedGroupId** | **string** | The ID of the dedicated group you want to update. | +**DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] +**Name** | **string** | The new name of the dedicated group. | + +## Methods + +### NewUpdateDedicatedGroupRequest + +`func NewUpdateDedicatedGroupRequest(dedicatedGroupId string, name string, ) *UpdateDedicatedGroupRequest` + +NewUpdateDedicatedGroupRequest instantiates a new UpdateDedicatedGroupRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewUpdateDedicatedGroupRequestWithDefaults + +`func NewUpdateDedicatedGroupRequestWithDefaults() *UpdateDedicatedGroupRequest` + +NewUpdateDedicatedGroupRequestWithDefaults instantiates a new UpdateDedicatedGroupRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDedicatedGroupId + +`func (o *UpdateDedicatedGroupRequest) GetDedicatedGroupId() string` + +GetDedicatedGroupId returns the DedicatedGroupId field if non-nil, zero value otherwise. + +### GetDedicatedGroupIdOk + +`func (o *UpdateDedicatedGroupRequest) GetDedicatedGroupIdOk() (*string, bool)` + +GetDedicatedGroupIdOk returns a tuple with the DedicatedGroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDedicatedGroupId + +`func (o *UpdateDedicatedGroupRequest) SetDedicatedGroupId(v string)` + +SetDedicatedGroupId sets DedicatedGroupId field to given value. + + +### GetDryRun + +`func (o *UpdateDedicatedGroupRequest) GetDryRun() bool` + +GetDryRun returns the DryRun field if non-nil, zero value otherwise. + +### GetDryRunOk + +`func (o *UpdateDedicatedGroupRequest) GetDryRunOk() (*bool, bool)` + +GetDryRunOk returns a tuple with the DryRun field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDryRun + +`func (o *UpdateDedicatedGroupRequest) SetDryRun(v bool)` + +SetDryRun sets DryRun field to given value. + +### HasDryRun + +`func (o *UpdateDedicatedGroupRequest) HasDryRun() bool` + +HasDryRun returns a boolean if a field has been set. + +### GetName + +`func (o *UpdateDedicatedGroupRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *UpdateDedicatedGroupRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *UpdateDedicatedGroupRequest) SetName(v string)` + +SetName sets Name field to given value. + + + +[[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/v2/docs/UpdateDedicatedGroupResponse.md b/v2/docs/UpdateDedicatedGroupResponse.md new file mode 100644 index 000000000..6ad92d655 --- /dev/null +++ b/v2/docs/UpdateDedicatedGroupResponse.md @@ -0,0 +1,82 @@ +# UpdateDedicatedGroupResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DedicatedGroup** | Pointer to [**DedicatedGroup**](DedicatedGroup.md) | | [optional] +**ResponseContext** | Pointer to [**ResponseContext**](ResponseContext.md) | | [optional] + +## Methods + +### NewUpdateDedicatedGroupResponse + +`func NewUpdateDedicatedGroupResponse() *UpdateDedicatedGroupResponse` + +NewUpdateDedicatedGroupResponse instantiates a new UpdateDedicatedGroupResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewUpdateDedicatedGroupResponseWithDefaults + +`func NewUpdateDedicatedGroupResponseWithDefaults() *UpdateDedicatedGroupResponse` + +NewUpdateDedicatedGroupResponseWithDefaults instantiates a new UpdateDedicatedGroupResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDedicatedGroup + +`func (o *UpdateDedicatedGroupResponse) GetDedicatedGroup() DedicatedGroup` + +GetDedicatedGroup returns the DedicatedGroup field if non-nil, zero value otherwise. + +### GetDedicatedGroupOk + +`func (o *UpdateDedicatedGroupResponse) GetDedicatedGroupOk() (*DedicatedGroup, bool)` + +GetDedicatedGroupOk returns a tuple with the DedicatedGroup field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDedicatedGroup + +`func (o *UpdateDedicatedGroupResponse) SetDedicatedGroup(v DedicatedGroup)` + +SetDedicatedGroup sets DedicatedGroup field to given value. + +### HasDedicatedGroup + +`func (o *UpdateDedicatedGroupResponse) HasDedicatedGroup() bool` + +HasDedicatedGroup returns a boolean if a field has been set. + +### GetResponseContext + +`func (o *UpdateDedicatedGroupResponse) GetResponseContext() ResponseContext` + +GetResponseContext returns the ResponseContext field if non-nil, zero value otherwise. + +### GetResponseContextOk + +`func (o *UpdateDedicatedGroupResponse) GetResponseContextOk() (*ResponseContext, bool)` + +GetResponseContextOk returns a tuple with the ResponseContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseContext + +`func (o *UpdateDedicatedGroupResponse) SetResponseContext(v ResponseContext)` + +SetResponseContext sets ResponseContext field to given value. + +### HasResponseContext + +`func (o *UpdateDedicatedGroupResponse) HasResponseContext() bool` + +HasResponseContext returns a boolean if a field has been set. + + +[[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/v2/docs/UpdateRouteTableLinkRequest.md b/v2/docs/UpdateRouteTableLinkRequest.md new file mode 100644 index 000000000..5cbfa4b1c --- /dev/null +++ b/v2/docs/UpdateRouteTableLinkRequest.md @@ -0,0 +1,98 @@ +# UpdateRouteTableLinkRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] +**LinkRouteTableId** | **string** | The ID of the current route table link. | +**RouteTableId** | **string** | The ID of the new route table to associate with the Subnet. | + +## Methods + +### NewUpdateRouteTableLinkRequest + +`func NewUpdateRouteTableLinkRequest(linkRouteTableId string, routeTableId string, ) *UpdateRouteTableLinkRequest` + +NewUpdateRouteTableLinkRequest instantiates a new UpdateRouteTableLinkRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewUpdateRouteTableLinkRequestWithDefaults + +`func NewUpdateRouteTableLinkRequestWithDefaults() *UpdateRouteTableLinkRequest` + +NewUpdateRouteTableLinkRequestWithDefaults instantiates a new UpdateRouteTableLinkRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDryRun + +`func (o *UpdateRouteTableLinkRequest) GetDryRun() bool` + +GetDryRun returns the DryRun field if non-nil, zero value otherwise. + +### GetDryRunOk + +`func (o *UpdateRouteTableLinkRequest) GetDryRunOk() (*bool, bool)` + +GetDryRunOk returns a tuple with the DryRun field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDryRun + +`func (o *UpdateRouteTableLinkRequest) SetDryRun(v bool)` + +SetDryRun sets DryRun field to given value. + +### HasDryRun + +`func (o *UpdateRouteTableLinkRequest) HasDryRun() bool` + +HasDryRun returns a boolean if a field has been set. + +### GetLinkRouteTableId + +`func (o *UpdateRouteTableLinkRequest) GetLinkRouteTableId() string` + +GetLinkRouteTableId returns the LinkRouteTableId field if non-nil, zero value otherwise. + +### GetLinkRouteTableIdOk + +`func (o *UpdateRouteTableLinkRequest) GetLinkRouteTableIdOk() (*string, bool)` + +GetLinkRouteTableIdOk returns a tuple with the LinkRouteTableId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinkRouteTableId + +`func (o *UpdateRouteTableLinkRequest) SetLinkRouteTableId(v string)` + +SetLinkRouteTableId sets LinkRouteTableId field to given value. + + +### GetRouteTableId + +`func (o *UpdateRouteTableLinkRequest) GetRouteTableId() string` + +GetRouteTableId returns the RouteTableId field if non-nil, zero value otherwise. + +### GetRouteTableIdOk + +`func (o *UpdateRouteTableLinkRequest) GetRouteTableIdOk() (*string, bool)` + +GetRouteTableIdOk returns a tuple with the RouteTableId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRouteTableId + +`func (o *UpdateRouteTableLinkRequest) SetRouteTableId(v string)` + +SetRouteTableId sets RouteTableId field to given value. + + + +[[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/v2/docs/UpdateRouteTableLinkResponse.md b/v2/docs/UpdateRouteTableLinkResponse.md new file mode 100644 index 000000000..1b6122226 --- /dev/null +++ b/v2/docs/UpdateRouteTableLinkResponse.md @@ -0,0 +1,82 @@ +# UpdateRouteTableLinkResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LinkRouteTableId** | Pointer to **string** | The ID of the association between the route table and the Subnet. | [optional] +**ResponseContext** | Pointer to [**ResponseContext**](ResponseContext.md) | | [optional] + +## Methods + +### NewUpdateRouteTableLinkResponse + +`func NewUpdateRouteTableLinkResponse() *UpdateRouteTableLinkResponse` + +NewUpdateRouteTableLinkResponse instantiates a new UpdateRouteTableLinkResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewUpdateRouteTableLinkResponseWithDefaults + +`func NewUpdateRouteTableLinkResponseWithDefaults() *UpdateRouteTableLinkResponse` + +NewUpdateRouteTableLinkResponseWithDefaults instantiates a new UpdateRouteTableLinkResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinkRouteTableId + +`func (o *UpdateRouteTableLinkResponse) GetLinkRouteTableId() string` + +GetLinkRouteTableId returns the LinkRouteTableId field if non-nil, zero value otherwise. + +### GetLinkRouteTableIdOk + +`func (o *UpdateRouteTableLinkResponse) GetLinkRouteTableIdOk() (*string, bool)` + +GetLinkRouteTableIdOk returns a tuple with the LinkRouteTableId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinkRouteTableId + +`func (o *UpdateRouteTableLinkResponse) SetLinkRouteTableId(v string)` + +SetLinkRouteTableId sets LinkRouteTableId field to given value. + +### HasLinkRouteTableId + +`func (o *UpdateRouteTableLinkResponse) HasLinkRouteTableId() bool` + +HasLinkRouteTableId returns a boolean if a field has been set. + +### GetResponseContext + +`func (o *UpdateRouteTableLinkResponse) GetResponseContext() ResponseContext` + +GetResponseContext returns the ResponseContext field if non-nil, zero value otherwise. + +### GetResponseContextOk + +`func (o *UpdateRouteTableLinkResponse) GetResponseContextOk() (*ResponseContext, bool)` + +GetResponseContextOk returns a tuple with the ResponseContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseContext + +`func (o *UpdateRouteTableLinkResponse) SetResponseContext(v ResponseContext)` + +SetResponseContext sets ResponseContext field to given value. + +### HasResponseContext + +`func (o *UpdateRouteTableLinkResponse) HasResponseContext() bool` + +HasResponseContext returns a boolean if a field has been set. + + +[[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/v2/docs/UpdateVmRequest.md b/v2/docs/UpdateVmRequest.md index 32664e1f1..51c7d4914 100644 --- a/v2/docs/UpdateVmRequest.md +++ b/v2/docs/UpdateVmRequest.md @@ -9,14 +9,14 @@ Name | Type | Description | Notes **DeletionProtection** | Pointer to **bool** | If true, you cannot delete the VM unless you change this parameter back to false. | [optional] **DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] **IsSourceDestChecked** | Pointer to **bool** | (Net only) If true, the source/destination check is enabled. If false, it is disabled. This value must be false for a NAT VM to perform network address translation (NAT) in a Net. | [optional] -**KeypairName** | Pointer to **string** | The name of a keypair you want to associate with the VM.<br /> 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 an Instance](https://docs.outscale.com/en/userguide/Modifying-the-Keypair-of-an-Instance.html). | [optional] +**KeypairName** | Pointer to **string** | The name of a keypair you want to associate with the VM.<br /> 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). | [optional] **NestedVirtualization** | Pointer to **bool** | (dedicated tenancy only) If true, nested virtualization is enabled. If false, it is disabled. | [optional] **Performance** | Pointer to **string** | The performance of the VM (`medium` \\| `high` \\| `highest`). | [optional] **SecurityGroupIds** | Pointer to **[]string** | One or more IDs of security groups for the VM. | [optional] **UserData** | Pointer to **string** | The Base64-encoded MIME user data, limited to 500 kibibytes (KiB). | [optional] **VmId** | **string** | The ID of the VM. | **VmInitiatedShutdownBehavior** | Pointer to **string** | 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. | [optional] -**VmType** | Pointer to **string** | The type of VM. For more information, see [Instance Types](https://docs.outscale.com/en/userguide/Instance-Types.html). | [optional] +**VmType** | Pointer to **string** | The type of VM. For more information, see [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html). | [optional] ## Methods diff --git a/v2/docs/UpdateVolumeRequest.md b/v2/docs/UpdateVolumeRequest.md index 453f2b7df..0f41ea307 100644 --- a/v2/docs/UpdateVolumeRequest.md +++ b/v2/docs/UpdateVolumeRequest.md @@ -5,10 +5,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] -**Iops** | Pointer to **int32** | The new number of I/O operations per second (IOPS). This parameter can be specified only if you update an `io1` volume. The maximum number of IOPS allowed for `io1` volumes is `13000` with a maximum performance ratio of 300 IOPS per gibibyte. This modification is instantaneous on a cold volume, not on a hot one. | [optional] -**Size** | Pointer to **int32** | (cold volume only) 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. | [optional] +**Iops** | Pointer to **int32** | **Cold volume**: 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`. This modification is instantaneous. <br /> **Hot volume**: the new number of I/O operations per second (IOPS). This parameter can be specified only if you update an `io1` volume. This modification is not instantaneous. <br /><br /> The maximum number of IOPS allowed for `io1` volumes is `13000` with a maximum performance ratio of 300 IOPS per gibibyte. | [optional] +**Size** | Pointer to **int32** | **Cold volume**: 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. <br /> **Hot volume**: you cannot change the size of a hot volume. | [optional] **VolumeId** | **string** | The ID of the volume you want to update. | -**VolumeType** | Pointer to **string** | (cold volume only) The new type of the volume (`standard` \\| `io1` \\| `gp2`). This modification is instantaneous. If you update to an `io1` volume, you must also specify the `Iops` parameter. | [optional] +**VolumeType** | Pointer to **string** | **Cold volume**: the new type of the volume (`standard` \\| `io1` \\| `gp2`). This modification is instantaneous. If you update to an `io1` volume, you must also specify the `Iops` parameter.<br /> **Hot volume**: you cannot change the type of a hot volume. | [optional] ## Methods diff --git a/v2/docs/UpdateVpnConnectionRequest.md b/v2/docs/UpdateVpnConnectionRequest.md index 53f2639cd..008f2967a 100644 --- a/v2/docs/UpdateVpnConnectionRequest.md +++ b/v2/docs/UpdateVpnConnectionRequest.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **DryRun** | Pointer to **bool** | If true, checks whether you have the required permissions to perform the action. | [optional] **VirtualGatewayId** | Pointer to **string** | The ID of the virtual gateway. | [optional] **VpnConnectionId** | **string** | The ID of the VPN connection you want to modify. | -**VpnOptions** | Pointer to [**VpnOptions**](VpnOptions.md) | | [optional] +**VpnOptions** | Pointer to [**VpnOptionsToUpdate**](VpnOptionsToUpdate.md) | | [optional] ## Methods @@ -126,20 +126,20 @@ SetVpnConnectionId sets VpnConnectionId field to given value. ### GetVpnOptions -`func (o *UpdateVpnConnectionRequest) GetVpnOptions() VpnOptions` +`func (o *UpdateVpnConnectionRequest) GetVpnOptions() VpnOptionsToUpdate` GetVpnOptions returns the VpnOptions field if non-nil, zero value otherwise. ### GetVpnOptionsOk -`func (o *UpdateVpnConnectionRequest) GetVpnOptionsOk() (*VpnOptions, bool)` +`func (o *UpdateVpnConnectionRequest) GetVpnOptionsOk() (*VpnOptionsToUpdate, bool)` GetVpnOptionsOk returns a tuple with the VpnOptions field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetVpnOptions -`func (o *UpdateVpnConnectionRequest) SetVpnOptions(v VpnOptions)` +`func (o *UpdateVpnConnectionRequest) SetVpnOptions(v VpnOptionsToUpdate)` SetVpnOptions sets VpnOptions field to given value. diff --git a/v2/docs/Vm.md b/v2/docs/Vm.md index 0f9212eb3..f0186003c 100644 --- a/v2/docs/Vm.md +++ b/v2/docs/Vm.md @@ -27,7 +27,7 @@ Name | Type | Description | Notes **PublicDnsName** | Pointer to **string** | The name of the public DNS. | [optional] **PublicIp** | Pointer to **string** | The public IP of the VM. | [optional] **ReservationId** | Pointer to **string** | The reservation ID of the VM. | [optional] -**RootDeviceName** | Pointer to **string** | The name of the root device for the VM (for example, `/dev/vda1`). | [optional] +**RootDeviceName** | Pointer to **string** | The name of the root device for the VM (for example, `/dev/sda1`). | [optional] **RootDeviceType** | Pointer to **string** | The type of root device used by the VM (always `bsu`). | [optional] **SecurityGroups** | Pointer to [**[]SecurityGroupLight**](SecurityGroupLight.md) | One or more security groups associated with the VM. | [optional] **State** | Pointer to **string** | The state of the VM (`pending` \\| `running` \\| `stopping` \\| `stopped` \\| `shutting-down` \\| `terminated` \\| `quarantine`). | [optional] @@ -37,7 +37,7 @@ Name | Type | Description | Notes **UserData** | Pointer to **string** | The Base64-encoded MIME user data. | [optional] **VmId** | Pointer to **string** | The ID of the VM. | [optional] **VmInitiatedShutdownBehavior** | Pointer to **string** | 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. | [optional] -**VmType** | Pointer to **string** | The type of VM. For more information, see [Instance Types](https://docs.outscale.com/en/userguide/Instance-Types.html). | [optional] +**VmType** | Pointer to **string** | The type of VM. For more information, see [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html). | [optional] ## Methods diff --git a/v2/docs/VmType.md b/v2/docs/VmType.md index d6ac0ec07..c6503c4d0 100644 --- a/v2/docs/VmType.md +++ b/v2/docs/VmType.md @@ -5,6 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **BsuOptimized** | Pointer to **bool** | This parameter is not available. It is present in our API for the sake of historical compatibility with AWS. | [optional] +**EphemeralsType** | Pointer to **string** | The type of ephemeral storage disk. | [optional] +**Eth** | Pointer to **int32** | The number of Ethernet interface available. | [optional] +**Gpu** | Pointer to **int32** | The number of GPU available. | [optional] **MaxPrivateIps** | Pointer to **int32** | The maximum number of private IPs per network interface card (NIC). | [optional] **MemorySize** | Pointer to **float32** | The amount of memory, in gibibytes. | [optional] **VcoreCount** | Pointer to **int32** | The number of vCores. | [optional] @@ -56,6 +59,81 @@ SetBsuOptimized sets BsuOptimized field to given value. HasBsuOptimized returns a boolean if a field has been set. +### GetEphemeralsType + +`func (o *VmType) GetEphemeralsType() string` + +GetEphemeralsType returns the EphemeralsType field if non-nil, zero value otherwise. + +### GetEphemeralsTypeOk + +`func (o *VmType) GetEphemeralsTypeOk() (*string, bool)` + +GetEphemeralsTypeOk returns a tuple with the EphemeralsType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEphemeralsType + +`func (o *VmType) SetEphemeralsType(v string)` + +SetEphemeralsType sets EphemeralsType field to given value. + +### HasEphemeralsType + +`func (o *VmType) HasEphemeralsType() bool` + +HasEphemeralsType returns a boolean if a field has been set. + +### GetEth + +`func (o *VmType) GetEth() int32` + +GetEth returns the Eth field if non-nil, zero value otherwise. + +### GetEthOk + +`func (o *VmType) GetEthOk() (*int32, bool)` + +GetEthOk returns a tuple with the Eth field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEth + +`func (o *VmType) SetEth(v int32)` + +SetEth sets Eth field to given value. + +### HasEth + +`func (o *VmType) HasEth() bool` + +HasEth returns a boolean if a field has been set. + +### GetGpu + +`func (o *VmType) GetGpu() int32` + +GetGpu returns the Gpu field if non-nil, zero value otherwise. + +### GetGpuOk + +`func (o *VmType) GetGpuOk() (*int32, bool)` + +GetGpuOk returns a tuple with the Gpu field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGpu + +`func (o *VmType) SetGpu(v int32)` + +SetGpu sets Gpu field to given value. + +### HasGpu + +`func (o *VmType) HasGpu() bool` + +HasGpu returns a boolean if a field has been set. + ### GetMaxPrivateIps `func (o *VmType) GetMaxPrivateIps() int32` diff --git a/v2/docs/VpnOptionsToUpdate.md b/v2/docs/VpnOptionsToUpdate.md new file mode 100644 index 000000000..e24923432 --- /dev/null +++ b/v2/docs/VpnOptionsToUpdate.md @@ -0,0 +1,82 @@ +# VpnOptionsToUpdate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Phase2Options** | Pointer to [**Phase2OptionsToUpdate**](Phase2OptionsToUpdate.md) | | [optional] +**TunnelInsideIpRange** | Pointer to **string** | The range of inside IPs for the tunnel. This must be a /30 CIDR block from the 169.254.254.0/24 range. | [optional] + +## Methods + +### NewVpnOptionsToUpdate + +`func NewVpnOptionsToUpdate() *VpnOptionsToUpdate` + +NewVpnOptionsToUpdate instantiates a new VpnOptionsToUpdate object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewVpnOptionsToUpdateWithDefaults + +`func NewVpnOptionsToUpdateWithDefaults() *VpnOptionsToUpdate` + +NewVpnOptionsToUpdateWithDefaults instantiates a new VpnOptionsToUpdate object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetPhase2Options + +`func (o *VpnOptionsToUpdate) GetPhase2Options() Phase2OptionsToUpdate` + +GetPhase2Options returns the Phase2Options field if non-nil, zero value otherwise. + +### GetPhase2OptionsOk + +`func (o *VpnOptionsToUpdate) GetPhase2OptionsOk() (*Phase2OptionsToUpdate, bool)` + +GetPhase2OptionsOk returns a tuple with the Phase2Options field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhase2Options + +`func (o *VpnOptionsToUpdate) SetPhase2Options(v Phase2OptionsToUpdate)` + +SetPhase2Options sets Phase2Options field to given value. + +### HasPhase2Options + +`func (o *VpnOptionsToUpdate) HasPhase2Options() bool` + +HasPhase2Options returns a boolean if a field has been set. + +### GetTunnelInsideIpRange + +`func (o *VpnOptionsToUpdate) GetTunnelInsideIpRange() string` + +GetTunnelInsideIpRange returns the TunnelInsideIpRange field if non-nil, zero value otherwise. + +### GetTunnelInsideIpRangeOk + +`func (o *VpnOptionsToUpdate) GetTunnelInsideIpRangeOk() (*string, bool)` + +GetTunnelInsideIpRangeOk returns a tuple with the TunnelInsideIpRange field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTunnelInsideIpRange + +`func (o *VpnOptionsToUpdate) SetTunnelInsideIpRange(v string)` + +SetTunnelInsideIpRange sets TunnelInsideIpRange field to given value. + +### HasTunnelInsideIpRange + +`func (o *VpnOptionsToUpdate) HasTunnelInsideIpRange() bool` + +HasTunnelInsideIpRange returns a boolean if a field has been set. + + +[[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/v2/model_accept_net_peering_request.go b/v2/model_accept_net_peering_request.go index df17717a5..dfad099f5 100644 --- a/v2/model_accept_net_peering_request.go +++ b/v2/model_accept_net_peering_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_accept_net_peering_response.go b/v2/model_accept_net_peering_response.go index 832bbb586..dae572bd5 100644 --- a/v2/model_accept_net_peering_response.go +++ b/v2/model_accept_net_peering_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_accepter_net.go b/v2/model_accepter_net.go index c1c0fa63b..85bfcae06 100644 --- a/v2/model_accepter_net.go +++ b/v2/model_accepter_net.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_access_key.go b/v2/model_access_key.go index 90b84b48a..686e25b1b 100644 --- a/v2/model_access_key.go +++ b/v2/model_access_key.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_access_key_secret_key.go b/v2/model_access_key_secret_key.go index 185b6df90..1174ace0c 100644 --- a/v2/model_access_key_secret_key.go +++ b/v2/model_access_key_secret_key.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_access_log.go b/v2/model_access_log.go index 6171758ea..d4ff34b4c 100644 --- a/v2/model_access_log.go +++ b/v2/model_access_log.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_account.go b/v2/model_account.go index 14e6bd3de..c8d5ff321 100644 --- a/v2/model_account.go +++ b/v2/model_account.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_api_access_policy.go b/v2/model_api_access_policy.go index 887819b5a..45b8d59bd 100644 --- a/v2/model_api_access_policy.go +++ b/v2/model_api_access_policy.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -19,7 +19,7 @@ import ( type ApiAccessPolicy struct { // The maximum possible lifetime for your access keys, in seconds. If `0`, your access keys can have unlimited lifetimes. MaxAccessKeyExpirationSeconds *int64 `json:"MaxAccessKeyExpirationSeconds,omitempty"` - // If true, a trusted session is activated, allowing you to bypass Certificate Authorities (CAs) enforcement. For more information, see the `ApiKeyAuth` authentication scheme in the [Authentication](#authentication) section. + // If true, a trusted session is activated, allowing you to bypass Certificate Authorities (CAs) enforcement. For more information, see [About Your API Access Policy](https://docs.outscale.com/en/userguide/About-Your-API-Access-Policy.html).
If this is enabled, it is required that you and all your users log in to Cockpit v2 using the WebAuthn method for multi-factor authentication. For more information, see [About Authentication > Multi-Factor Authentication](https://docs.outscale.com/en/userguide/About-Authentication.html#_multi_factor_authentication). RequireTrustedEnv *bool `json:"RequireTrustedEnv,omitempty"` } diff --git a/v2/model_api_access_rule.go b/v2/model_api_access_rule.go index 5d1b052af..03c672f36 100644 --- a/v2/model_api_access_rule.go +++ b/v2/model_api_access_rule.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_application_sticky_cookie_policy.go b/v2/model_application_sticky_cookie_policy.go index 64e49029b..63ebe549f 100644 --- a/v2/model_application_sticky_cookie_policy.go +++ b/v2/model_application_sticky_cookie_policy.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_backend_vm_health.go b/v2/model_backend_vm_health.go index 157e2baf2..0a307f455 100644 --- a/v2/model_backend_vm_health.go +++ b/v2/model_backend_vm_health.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_block_device_mapping_created.go b/v2/model_block_device_mapping_created.go index 1c61e7ba6..eddd80dc1 100644 --- a/v2/model_block_device_mapping_created.go +++ b/v2/model_block_device_mapping_created.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_block_device_mapping_image.go b/v2/model_block_device_mapping_image.go index d39cbcdd4..46f29d50f 100644 --- a/v2/model_block_device_mapping_image.go +++ b/v2/model_block_device_mapping_image.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_block_device_mapping_vm_creation.go b/v2/model_block_device_mapping_vm_creation.go index 0239949cf..0227b1d79 100644 --- a/v2/model_block_device_mapping_vm_creation.go +++ b/v2/model_block_device_mapping_vm_creation.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_block_device_mapping_vm_update.go b/v2/model_block_device_mapping_vm_update.go index 03a27244a..93a78956f 100644 --- a/v2/model_block_device_mapping_vm_update.go +++ b/v2/model_block_device_mapping_vm_update.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_bsu_created.go b/v2/model_bsu_created.go index c48aebb8a..985a5b1ce 100644 --- a/v2/model_bsu_created.go +++ b/v2/model_bsu_created.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_bsu_to_create.go b/v2/model_bsu_to_create.go index a15f72584..38bb075e3 100644 --- a/v2/model_bsu_to_create.go +++ b/v2/model_bsu_to_create.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_bsu_to_update_vm.go b/v2/model_bsu_to_update_vm.go index 5853a8d97..1f3cd67d8 100644 --- a/v2/model_bsu_to_update_vm.go +++ b/v2/model_bsu_to_update_vm.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_ca.go b/v2/model_ca.go index d1f2c29ea..8e65d8ecf 100644 --- a/v2/model_ca.go +++ b/v2/model_ca.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_catalog.go b/v2/model_catalog.go index 3b5eea5eb..e0cfd9bfe 100644 --- a/v2/model_catalog.go +++ b/v2/model_catalog.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_catalog_entry.go b/v2/model_catalog_entry.go index a237c5807..e73fbd252 100644 --- a/v2/model_catalog_entry.go +++ b/v2/model_catalog_entry.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_catalogs.go b/v2/model_catalogs.go index eca975ba3..fe2ca0bde 100644 --- a/v2/model_catalogs.go +++ b/v2/model_catalogs.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_check_authentication_request.go b/v2/model_check_authentication_request.go index 6e88b9aba..5b79ce708 100644 --- a/v2/model_check_authentication_request.go +++ b/v2/model_check_authentication_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_check_authentication_response.go b/v2/model_check_authentication_response.go index e14362241..03c0c6922 100644 --- a/v2/model_check_authentication_response.go +++ b/v2/model_check_authentication_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_client_gateway.go b/v2/model_client_gateway.go index 1f37bccff..bb16378e4 100644 --- a/v2/model_client_gateway.go +++ b/v2/model_client_gateway.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_consumption_entry.go b/v2/model_consumption_entry.go index c6afc19d7..7e5c847d1 100644 --- a/v2/model_consumption_entry.go +++ b/v2/model_consumption_entry.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -27,6 +27,8 @@ type ConsumptionEntry struct { Operation *string `json:"Operation,omitempty"` // The ID of the TINA account which is billed for your consumption. It can be different from your account in the `AccountId` parameter. PayingAccountId *string `json:"PayingAccountId,omitempty"` + // The total price of the consumed resource during the specified time period, in the currency of the catalog of the Region where the API method was used. + Price *float64 `json:"Price,omitempty"` // The service of the API call (`TinaOS-FCU`, `TinaOS-LBU`, `TinaOS-DirectLink`, `TinaOS-OOS`, or `TinaOS-OSU`). Service *string `json:"Service,omitempty"` // The name of the Subregion. @@ -37,6 +39,8 @@ type ConsumptionEntry struct { ToDate *string `json:"ToDate,omitempty"` // The type of resource, depending on the API call. Type *string `json:"Type,omitempty"` + // The unit price of the consumed resource, in the currency of the catalog of the Region where the API method was used. + UnitPrice *float64 `json:"UnitPrice,omitempty"` // The consumed amount for the resource. The unit depends on the resource type. For more information, see the `Title` element. Value *float64 `json:"Value,omitempty"` } @@ -218,6 +222,38 @@ func (o *ConsumptionEntry) SetPayingAccountId(v string) { o.PayingAccountId = &v } +// GetPrice returns the Price field value if set, zero value otherwise. +func (o *ConsumptionEntry) GetPrice() float64 { + if o == nil || o.Price == nil { + var ret float64 + return ret + } + return *o.Price +} + +// GetPriceOk returns a tuple with the Price field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ConsumptionEntry) GetPriceOk() (*float64, bool) { + if o == nil || o.Price == nil { + return nil, false + } + return o.Price, true +} + +// HasPrice returns a boolean if a field has been set. +func (o *ConsumptionEntry) HasPrice() bool { + if o != nil && o.Price != nil { + return true + } + + return false +} + +// SetPrice gets a reference to the given float64 and assigns it to the Price field. +func (o *ConsumptionEntry) SetPrice(v float64) { + o.Price = &v +} + // GetService returns the Service field value if set, zero value otherwise. func (o *ConsumptionEntry) GetService() string { if o == nil || o.Service == nil { @@ -378,6 +414,38 @@ func (o *ConsumptionEntry) SetType(v string) { o.Type = &v } +// GetUnitPrice returns the UnitPrice field value if set, zero value otherwise. +func (o *ConsumptionEntry) GetUnitPrice() float64 { + if o == nil || o.UnitPrice == nil { + var ret float64 + return ret + } + return *o.UnitPrice +} + +// GetUnitPriceOk returns a tuple with the UnitPrice field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ConsumptionEntry) GetUnitPriceOk() (*float64, bool) { + if o == nil || o.UnitPrice == nil { + return nil, false + } + return o.UnitPrice, true +} + +// HasUnitPrice returns a boolean if a field has been set. +func (o *ConsumptionEntry) HasUnitPrice() bool { + if o != nil && o.UnitPrice != nil { + return true + } + + return false +} + +// SetUnitPrice gets a reference to the given float64 and assigns it to the UnitPrice field. +func (o *ConsumptionEntry) SetUnitPrice(v float64) { + o.UnitPrice = &v +} + // GetValue returns the Value field value if set, zero value otherwise. func (o *ConsumptionEntry) GetValue() float64 { if o == nil || o.Value == nil { @@ -427,6 +495,9 @@ func (o ConsumptionEntry) MarshalJSON() ([]byte, error) { if o.PayingAccountId != nil { toSerialize["PayingAccountId"] = o.PayingAccountId } + if o.Price != nil { + toSerialize["Price"] = o.Price + } if o.Service != nil { toSerialize["Service"] = o.Service } @@ -442,6 +513,9 @@ func (o ConsumptionEntry) MarshalJSON() ([]byte, error) { if o.Type != nil { toSerialize["Type"] = o.Type } + if o.UnitPrice != nil { + toSerialize["UnitPrice"] = o.UnitPrice + } if o.Value != nil { toSerialize["Value"] = o.Value } diff --git a/v2/model_create_access_key_request.go b/v2/model_create_access_key_request.go index 88b7bc578..cd5716f2a 100644 --- a/v2/model_create_access_key_request.go +++ b/v2/model_create_access_key_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_access_key_response.go b/v2/model_create_access_key_response.go index eee852739..93c97f7c2 100644 --- a/v2/model_create_access_key_response.go +++ b/v2/model_create_access_key_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_account_request.go b/v2/model_create_account_request.go index e1bbd412b..99348c3af 100644 --- a/v2/model_create_account_request.go +++ b/v2/model_create_account_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_account_response.go b/v2/model_create_account_response.go index 1c758eaee..d0ad3a102 100644 --- a/v2/model_create_account_response.go +++ b/v2/model_create_account_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_api_access_rule_request.go b/v2/model_create_api_access_rule_request.go index 409e46421..4a9a8f48f 100644 --- a/v2/model_create_api_access_rule_request.go +++ b/v2/model_create_api_access_rule_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_api_access_rule_response.go b/v2/model_create_api_access_rule_response.go index 99d8fd0f2..7d6f8423f 100644 --- a/v2/model_create_api_access_rule_response.go +++ b/v2/model_create_api_access_rule_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_ca_request.go b/v2/model_create_ca_request.go index 4ba407498..cd73e29fb 100644 --- a/v2/model_create_ca_request.go +++ b/v2/model_create_ca_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_ca_response.go b/v2/model_create_ca_response.go index 5fd51473a..5f0377dad 100644 --- a/v2/model_create_ca_response.go +++ b/v2/model_create_ca_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_client_gateway_request.go b/v2/model_create_client_gateway_request.go index ee12d4839..66960e14f 100644 --- a/v2/model_create_client_gateway_request.go +++ b/v2/model_create_client_gateway_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -17,7 +17,7 @@ import ( // CreateClientGatewayRequest struct for CreateClientGatewayRequest type CreateClientGatewayRequest struct { - // The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your client gateway through the Internet. This number must be between `1` and `4294967295`. + // The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your client gateway through the Internet.
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. BgpAsn int32 `json:"BgpAsn"` // The communication protocol used to establish tunnel with your client gateway (only `ipsec.1` is supported). ConnectionType string `json:"ConnectionType"` diff --git a/v2/model_create_client_gateway_response.go b/v2/model_create_client_gateway_response.go index f8e2a1da3..e2f542b7e 100644 --- a/v2/model_create_client_gateway_response.go +++ b/v2/model_create_client_gateway_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_dedicated_group_request.go b/v2/model_create_dedicated_group_request.go new file mode 100644 index 000000000..0e6b6cc8f --- /dev/null +++ b/v2/model_create_dedicated_group_request.go @@ -0,0 +1,205 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// CreateDedicatedGroupRequest struct for CreateDedicatedGroupRequest +type CreateDedicatedGroupRequest struct { + // The processor generation for the VMs in the dedicated group (for example, `4`). + CpuGeneration int32 `json:"CpuGeneration"` + // If true, checks whether you have the required permissions to perform the action. + DryRun *bool `json:"DryRun,omitempty"` + // A name for the dedicated group. + Name string `json:"Name"` + // The Subregion in which you want to create the dedicated group. + SubregionName string `json:"SubregionName"` +} + +// NewCreateDedicatedGroupRequest instantiates a new CreateDedicatedGroupRequest object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewCreateDedicatedGroupRequest(cpuGeneration int32, name string, subregionName string) *CreateDedicatedGroupRequest { + this := CreateDedicatedGroupRequest{} + this.CpuGeneration = cpuGeneration + this.Name = name + this.SubregionName = subregionName + return &this +} + +// NewCreateDedicatedGroupRequestWithDefaults instantiates a new CreateDedicatedGroupRequest object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewCreateDedicatedGroupRequestWithDefaults() *CreateDedicatedGroupRequest { + this := CreateDedicatedGroupRequest{} + return &this +} + +// GetCpuGeneration returns the CpuGeneration field value +func (o *CreateDedicatedGroupRequest) GetCpuGeneration() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.CpuGeneration +} + +// GetCpuGenerationOk returns a tuple with the CpuGeneration field value +// and a boolean to check if the value has been set. +func (o *CreateDedicatedGroupRequest) GetCpuGenerationOk() (*int32, bool) { + if o == nil { + return nil, false + } + return &o.CpuGeneration, true +} + +// SetCpuGeneration sets field value +func (o *CreateDedicatedGroupRequest) SetCpuGeneration(v int32) { + o.CpuGeneration = v +} + +// GetDryRun returns the DryRun field value if set, zero value otherwise. +func (o *CreateDedicatedGroupRequest) GetDryRun() bool { + if o == nil || o.DryRun == nil { + var ret bool + return ret + } + return *o.DryRun +} + +// GetDryRunOk returns a tuple with the DryRun field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CreateDedicatedGroupRequest) GetDryRunOk() (*bool, bool) { + if o == nil || o.DryRun == nil { + return nil, false + } + return o.DryRun, true +} + +// HasDryRun returns a boolean if a field has been set. +func (o *CreateDedicatedGroupRequest) HasDryRun() bool { + if o != nil && o.DryRun != nil { + return true + } + + return false +} + +// SetDryRun gets a reference to the given bool and assigns it to the DryRun field. +func (o *CreateDedicatedGroupRequest) SetDryRun(v bool) { + o.DryRun = &v +} + +// GetName returns the Name field value +func (o *CreateDedicatedGroupRequest) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// GetNameOk returns a tuple with the Name field value +// and a boolean to check if the value has been set. +func (o *CreateDedicatedGroupRequest) GetNameOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.Name, true +} + +// SetName sets field value +func (o *CreateDedicatedGroupRequest) SetName(v string) { + o.Name = v +} + +// GetSubregionName returns the SubregionName field value +func (o *CreateDedicatedGroupRequest) GetSubregionName() string { + if o == nil { + var ret string + return ret + } + + return o.SubregionName +} + +// GetSubregionNameOk returns a tuple with the SubregionName field value +// and a boolean to check if the value has been set. +func (o *CreateDedicatedGroupRequest) GetSubregionNameOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.SubregionName, true +} + +// SetSubregionName sets field value +func (o *CreateDedicatedGroupRequest) SetSubregionName(v string) { + o.SubregionName = v +} + +func (o CreateDedicatedGroupRequest) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["CpuGeneration"] = o.CpuGeneration + } + if o.DryRun != nil { + toSerialize["DryRun"] = o.DryRun + } + if true { + toSerialize["Name"] = o.Name + } + if true { + toSerialize["SubregionName"] = o.SubregionName + } + return json.Marshal(toSerialize) +} + +type NullableCreateDedicatedGroupRequest struct { + value *CreateDedicatedGroupRequest + isSet bool +} + +func (v NullableCreateDedicatedGroupRequest) Get() *CreateDedicatedGroupRequest { + return v.value +} + +func (v *NullableCreateDedicatedGroupRequest) Set(val *CreateDedicatedGroupRequest) { + v.value = val + v.isSet = true +} + +func (v NullableCreateDedicatedGroupRequest) IsSet() bool { + return v.isSet +} + +func (v *NullableCreateDedicatedGroupRequest) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableCreateDedicatedGroupRequest(val *CreateDedicatedGroupRequest) *NullableCreateDedicatedGroupRequest { + return &NullableCreateDedicatedGroupRequest{value: val, isSet: true} +} + +func (v NullableCreateDedicatedGroupRequest) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableCreateDedicatedGroupRequest) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_create_dedicated_group_response.go b/v2/model_create_dedicated_group_response.go new file mode 100644 index 000000000..0dec25208 --- /dev/null +++ b/v2/model_create_dedicated_group_response.go @@ -0,0 +1,150 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// CreateDedicatedGroupResponse struct for CreateDedicatedGroupResponse +type CreateDedicatedGroupResponse struct { + DedicatedGroup *DedicatedGroup `json:"DedicatedGroup,omitempty"` + ResponseContext *ResponseContext `json:"ResponseContext,omitempty"` +} + +// NewCreateDedicatedGroupResponse instantiates a new CreateDedicatedGroupResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewCreateDedicatedGroupResponse() *CreateDedicatedGroupResponse { + this := CreateDedicatedGroupResponse{} + return &this +} + +// NewCreateDedicatedGroupResponseWithDefaults instantiates a new CreateDedicatedGroupResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewCreateDedicatedGroupResponseWithDefaults() *CreateDedicatedGroupResponse { + this := CreateDedicatedGroupResponse{} + return &this +} + +// GetDedicatedGroup returns the DedicatedGroup field value if set, zero value otherwise. +func (o *CreateDedicatedGroupResponse) GetDedicatedGroup() DedicatedGroup { + if o == nil || o.DedicatedGroup == nil { + var ret DedicatedGroup + return ret + } + return *o.DedicatedGroup +} + +// GetDedicatedGroupOk returns a tuple with the DedicatedGroup field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CreateDedicatedGroupResponse) GetDedicatedGroupOk() (*DedicatedGroup, bool) { + if o == nil || o.DedicatedGroup == nil { + return nil, false + } + return o.DedicatedGroup, true +} + +// HasDedicatedGroup returns a boolean if a field has been set. +func (o *CreateDedicatedGroupResponse) HasDedicatedGroup() bool { + if o != nil && o.DedicatedGroup != nil { + return true + } + + return false +} + +// SetDedicatedGroup gets a reference to the given DedicatedGroup and assigns it to the DedicatedGroup field. +func (o *CreateDedicatedGroupResponse) SetDedicatedGroup(v DedicatedGroup) { + o.DedicatedGroup = &v +} + +// GetResponseContext returns the ResponseContext field value if set, zero value otherwise. +func (o *CreateDedicatedGroupResponse) GetResponseContext() ResponseContext { + if o == nil || o.ResponseContext == nil { + var ret ResponseContext + return ret + } + return *o.ResponseContext +} + +// GetResponseContextOk returns a tuple with the ResponseContext field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CreateDedicatedGroupResponse) GetResponseContextOk() (*ResponseContext, bool) { + if o == nil || o.ResponseContext == nil { + return nil, false + } + return o.ResponseContext, true +} + +// HasResponseContext returns a boolean if a field has been set. +func (o *CreateDedicatedGroupResponse) HasResponseContext() bool { + if o != nil && o.ResponseContext != nil { + return true + } + + return false +} + +// SetResponseContext gets a reference to the given ResponseContext and assigns it to the ResponseContext field. +func (o *CreateDedicatedGroupResponse) SetResponseContext(v ResponseContext) { + o.ResponseContext = &v +} + +func (o CreateDedicatedGroupResponse) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.DedicatedGroup != nil { + toSerialize["DedicatedGroup"] = o.DedicatedGroup + } + if o.ResponseContext != nil { + toSerialize["ResponseContext"] = o.ResponseContext + } + return json.Marshal(toSerialize) +} + +type NullableCreateDedicatedGroupResponse struct { + value *CreateDedicatedGroupResponse + isSet bool +} + +func (v NullableCreateDedicatedGroupResponse) Get() *CreateDedicatedGroupResponse { + return v.value +} + +func (v *NullableCreateDedicatedGroupResponse) Set(val *CreateDedicatedGroupResponse) { + v.value = val + v.isSet = true +} + +func (v NullableCreateDedicatedGroupResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableCreateDedicatedGroupResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableCreateDedicatedGroupResponse(val *CreateDedicatedGroupResponse) *NullableCreateDedicatedGroupResponse { + return &NullableCreateDedicatedGroupResponse{value: val, isSet: true} +} + +func (v NullableCreateDedicatedGroupResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableCreateDedicatedGroupResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_create_dhcp_options_request.go b/v2/model_create_dhcp_options_request.go index 5da3e9d62..4ae78283b 100644 --- a/v2/model_create_dhcp_options_request.go +++ b/v2/model_create_dhcp_options_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_dhcp_options_response.go b/v2/model_create_dhcp_options_response.go index 64d6b5694..de0f8a350 100644 --- a/v2/model_create_dhcp_options_response.go +++ b/v2/model_create_dhcp_options_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_direct_link_interface_request.go b/v2/model_create_direct_link_interface_request.go index 3ca03e207..0acb4d63a 100644 --- a/v2/model_create_direct_link_interface_request.go +++ b/v2/model_create_direct_link_interface_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_direct_link_interface_response.go b/v2/model_create_direct_link_interface_response.go index 9de6f6ceb..63260b998 100644 --- a/v2/model_create_direct_link_interface_response.go +++ b/v2/model_create_direct_link_interface_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_direct_link_request.go b/v2/model_create_direct_link_request.go index 9ebf3d58e..74c6e96c4 100644 --- a/v2/model_create_direct_link_request.go +++ b/v2/model_create_direct_link_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_direct_link_response.go b/v2/model_create_direct_link_response.go index aa04704b8..16892addf 100644 --- a/v2/model_create_direct_link_response.go +++ b/v2/model_create_direct_link_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_flexible_gpu_request.go b/v2/model_create_flexible_gpu_request.go index 224a7743a..3d717b82a 100644 --- a/v2/model_create_flexible_gpu_request.go +++ b/v2/model_create_flexible_gpu_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_flexible_gpu_response.go b/v2/model_create_flexible_gpu_response.go index 6beec41fc..076b3c35f 100644 --- a/v2/model_create_flexible_gpu_response.go +++ b/v2/model_create_flexible_gpu_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_image_export_task_request.go b/v2/model_create_image_export_task_request.go index 39cfa6ce2..728e532bb 100644 --- a/v2/model_create_image_export_task_request.go +++ b/v2/model_create_image_export_task_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_image_export_task_response.go b/v2/model_create_image_export_task_response.go index b419e07e5..7c09a650a 100644 --- a/v2/model_create_image_export_task_response.go +++ b/v2/model_create_image_export_task_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_image_request.go b/v2/model_create_image_request.go index c448287b7..74c6bd153 100644 --- a/v2/model_create_image_request.go +++ b/v2/model_create_image_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -17,29 +17,29 @@ import ( // CreateImageRequest struct for CreateImageRequest type CreateImageRequest struct { - // The architecture of the OMI (by default, `i386` if you specified the `FileLocation` or `RootDeviceName` parameter). + // **(when registering from a snapshot, or from a bucket without using a manifest file)** The architecture of the OMI (`i386` or `x84_64`). Architecture *string `json:"Architecture,omitempty"` - // One or more block device mappings. + // **(when registering from a snapshot, or from a bucket without using a manifest file)** One or more block device mappings. BlockDeviceMappings *[]BlockDeviceMappingImage `json:"BlockDeviceMappings,omitempty"` // A description for the new OMI. Description *string `json:"Description,omitempty"` // If true, checks whether you have the required permissions to perform the action. DryRun *bool `json:"DryRun,omitempty"` - // The pre-signed URL of the OMI manifest file, or the full path to the OMI stored in a bucket. If you specify this parameter, a copy of the OMI is created in your account. You must specify only one of the following parameters: `FileLocation`, `RootDeviceName`, `SourceImageId` or `VmId`. + // **(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).
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. FileLocation *string `json:"FileLocation,omitempty"` - // A unique name for the new OMI.
Constraints: 3-128 alphanumeric characters, underscores (_), spaces ( ), parentheses (()), slashes (/), periods (.), or dashes (-). + // A unique name for the new OMI.
Constraints: 3-128 alphanumeric characters, underscores (`_`), spaces (` `), parentheses (`()`), slashes (`/`), periods (`.`), or dashes (`-`). ImageName *string `json:"ImageName,omitempty"` - // If false, the VM shuts down before creating the OMI and then reboots. If true, the VM does not. + // **(when creating from a VM)** If false, the VM shuts down before creating the OMI and then reboots. If true, the VM does not. NoReboot *bool `json:"NoReboot,omitempty"` // The product codes associated with the OMI. ProductCodes *[]string `json:"ProductCodes,omitempty"` - // The name of the root device. You must specify only one of the following parameters: `FileLocation`, `RootDeviceName`, `SourceImageId` or `VmId`. + // **(when registering from a snapshot, or from a bucket without using a manifest file)** The name of the root device for the new OMI. RootDeviceName *string `json:"RootDeviceName,omitempty"` - // The ID of the OMI you want to copy. You must specify only one of the following parameters: `FileLocation`, `RootDeviceName`, `SourceImageId` or `VmId`. + // **(when copying an OMI)** The ID of the OMI you want to copy. SourceImageId *string `json:"SourceImageId,omitempty"` - // The name of the source Region, which must be the same as the Region of your account. + // **(when copying an OMI)** The name of the source Region (always the same as the Region of your account). SourceRegionName *string `json:"SourceRegionName,omitempty"` - // The ID of the VM from which you want to create the OMI. You must specify only one of the following parameters: `FileLocation`, `RootDeviceName`, `SourceImageId` or `VmId`. + // **(when creating from a VM)** The ID of the VM from which you want to create the OMI. VmId *string `json:"VmId,omitempty"` } diff --git a/v2/model_create_image_response.go b/v2/model_create_image_response.go index 9c615f36f..fc2620ed8 100644 --- a/v2/model_create_image_response.go +++ b/v2/model_create_image_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_internet_service_request.go b/v2/model_create_internet_service_request.go index 70f368cf5..22aa0714c 100644 --- a/v2/model_create_internet_service_request.go +++ b/v2/model_create_internet_service_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_internet_service_response.go b/v2/model_create_internet_service_response.go index 4660bbac1..5b0e1ad46 100644 --- a/v2/model_create_internet_service_response.go +++ b/v2/model_create_internet_service_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_keypair_request.go b/v2/model_create_keypair_request.go index 44da83c2c..ab424001a 100644 --- a/v2/model_create_keypair_request.go +++ b/v2/model_create_keypair_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -21,7 +21,7 @@ type CreateKeypairRequest struct { DryRun *bool `json:"DryRun,omitempty"` // A unique name for the keypair, with a maximum length of 255 [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#Printable_characters). KeypairName string `json:"KeypairName"` - // The public key. It must be Base64-encoded. + // The public key to import in your account, if you are importing an existing keypair. This value must be Base64-encoded. PublicKey *string `json:"PublicKey,omitempty"` } diff --git a/v2/model_create_keypair_response.go b/v2/model_create_keypair_response.go index 3411d6482..6d4d8f978 100644 --- a/v2/model_create_keypair_response.go +++ b/v2/model_create_keypair_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_listener_rule_request.go b/v2/model_create_listener_rule_request.go index 0dbbc0e53..b00b2090b 100644 --- a/v2/model_create_listener_rule_request.go +++ b/v2/model_create_listener_rule_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_listener_rule_response.go b/v2/model_create_listener_rule_response.go index cb92cb44e..1e438332f 100644 --- a/v2/model_create_listener_rule_response.go +++ b/v2/model_create_listener_rule_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_load_balancer_listeners_request.go b/v2/model_create_load_balancer_listeners_request.go index b169ed4d6..a106a8d05 100644 --- a/v2/model_create_load_balancer_listeners_request.go +++ b/v2/model_create_load_balancer_listeners_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_load_balancer_listeners_response.go b/v2/model_create_load_balancer_listeners_response.go index 9e0eedfc9..3405973ed 100644 --- a/v2/model_create_load_balancer_listeners_response.go +++ b/v2/model_create_load_balancer_listeners_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_load_balancer_policy_request.go b/v2/model_create_load_balancer_policy_request.go index 7c4256628..e09694e07 100644 --- a/v2/model_create_load_balancer_policy_request.go +++ b/v2/model_create_load_balancer_policy_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_load_balancer_policy_response.go b/v2/model_create_load_balancer_policy_response.go index 2d0d65a45..280553892 100644 --- a/v2/model_create_load_balancer_policy_response.go +++ b/v2/model_create_load_balancer_policy_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_load_balancer_request.go b/v2/model_create_load_balancer_request.go index a47f8962e..4a31ac543 100644 --- a/v2/model_create_load_balancer_request.go +++ b/v2/model_create_load_balancer_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_load_balancer_response.go b/v2/model_create_load_balancer_response.go index 8a452b165..c0c7a00eb 100644 --- a/v2/model_create_load_balancer_response.go +++ b/v2/model_create_load_balancer_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_load_balancer_tags_request.go b/v2/model_create_load_balancer_tags_request.go index 4c3e37a3a..998c105b9 100644 --- a/v2/model_create_load_balancer_tags_request.go +++ b/v2/model_create_load_balancer_tags_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_load_balancer_tags_response.go b/v2/model_create_load_balancer_tags_response.go index 50f75ffca..5fac4c9cd 100644 --- a/v2/model_create_load_balancer_tags_response.go +++ b/v2/model_create_load_balancer_tags_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_nat_service_request.go b/v2/model_create_nat_service_request.go index 2f4f984d3..a60b2929b 100644 --- a/v2/model_create_nat_service_request.go +++ b/v2/model_create_nat_service_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_nat_service_response.go b/v2/model_create_nat_service_response.go index f1e4887cb..afe4509bb 100644 --- a/v2/model_create_nat_service_response.go +++ b/v2/model_create_nat_service_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_net_access_point_request.go b/v2/model_create_net_access_point_request.go index 1f80e2462..5a899585c 100644 --- a/v2/model_create_net_access_point_request.go +++ b/v2/model_create_net_access_point_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_net_access_point_response.go b/v2/model_create_net_access_point_response.go index eb454bb6b..e62542c51 100644 --- a/v2/model_create_net_access_point_response.go +++ b/v2/model_create_net_access_point_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_net_peering_request.go b/v2/model_create_net_peering_request.go index eb8584567..2a5e6a800 100644 --- a/v2/model_create_net_peering_request.go +++ b/v2/model_create_net_peering_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_net_peering_response.go b/v2/model_create_net_peering_response.go index 41cda80a8..38dc4d1a1 100644 --- a/v2/model_create_net_peering_response.go +++ b/v2/model_create_net_peering_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_net_request.go b/v2/model_create_net_request.go index df5b8e145..294779feb 100644 --- a/v2/model_create_net_request.go +++ b/v2/model_create_net_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -21,7 +21,7 @@ type CreateNetRequest struct { DryRun *bool `json:"DryRun,omitempty"` // The IP range for the Net, in CIDR notation (for example, `10.0.0.0/16`). IpRange string `json:"IpRange"` - // The tenancy options for the VMs (`default` if a VM created in a Net can be launched with any tenancy, `dedicated` if it can be launched with dedicated tenancy VMs running on single-tenant hardware). + // The tenancy options for the VMs:
- `default` if a VM created in a Net can be launched with any tenancy.
- `dedicated` if it can be launched with dedicated tenancy VMs running on single-tenant hardware.
- `dedicated group ID`: if it can be launched in a dedicated group on single-tenant hardware. Tenancy *string `json:"Tenancy,omitempty"` } diff --git a/v2/model_create_net_response.go b/v2/model_create_net_response.go index 6becbde23..bf7ae3d43 100644 --- a/v2/model_create_net_response.go +++ b/v2/model_create_net_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_nic_request.go b/v2/model_create_nic_request.go index e50353afe..091226907 100644 --- a/v2/model_create_nic_request.go +++ b/v2/model_create_nic_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_nic_response.go b/v2/model_create_nic_response.go index fe4647a5e..033a36985 100644 --- a/v2/model_create_nic_response.go +++ b/v2/model_create_nic_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_policy_request.go b/v2/model_create_policy_request.go new file mode 100644 index 000000000..f1c1048ad --- /dev/null +++ b/v2/model_create_policy_request.go @@ -0,0 +1,249 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// CreatePolicyRequest struct for CreatePolicyRequest +type CreatePolicyRequest struct { + // A description for the policy. + Description *string `json:"Description,omitempty"` + // 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 `json:"Document"` + // If true, checks whether you have the required permissions to perform the action. + DryRun *bool `json:"DryRun,omitempty"` + // The path of the policy. + Path *string `json:"Path,omitempty"` + // The name of the policy. + PolicyName string `json:"PolicyName"` +} + +// NewCreatePolicyRequest instantiates a new CreatePolicyRequest object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewCreatePolicyRequest(document string, policyName string) *CreatePolicyRequest { + this := CreatePolicyRequest{} + this.Document = document + this.PolicyName = policyName + return &this +} + +// NewCreatePolicyRequestWithDefaults instantiates a new CreatePolicyRequest object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewCreatePolicyRequestWithDefaults() *CreatePolicyRequest { + this := CreatePolicyRequest{} + return &this +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *CreatePolicyRequest) GetDescription() string { + if o == nil || o.Description == nil { + var ret string + return ret + } + return *o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CreatePolicyRequest) GetDescriptionOk() (*string, bool) { + if o == nil || o.Description == nil { + return nil, false + } + return o.Description, true +} + +// HasDescription returns a boolean if a field has been set. +func (o *CreatePolicyRequest) HasDescription() bool { + if o != nil && o.Description != nil { + return true + } + + return false +} + +// SetDescription gets a reference to the given string and assigns it to the Description field. +func (o *CreatePolicyRequest) SetDescription(v string) { + o.Description = &v +} + +// GetDocument returns the Document field value +func (o *CreatePolicyRequest) GetDocument() string { + if o == nil { + var ret string + return ret + } + + return o.Document +} + +// GetDocumentOk returns a tuple with the Document field value +// and a boolean to check if the value has been set. +func (o *CreatePolicyRequest) GetDocumentOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.Document, true +} + +// SetDocument sets field value +func (o *CreatePolicyRequest) SetDocument(v string) { + o.Document = v +} + +// GetDryRun returns the DryRun field value if set, zero value otherwise. +func (o *CreatePolicyRequest) GetDryRun() bool { + if o == nil || o.DryRun == nil { + var ret bool + return ret + } + return *o.DryRun +} + +// GetDryRunOk returns a tuple with the DryRun field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CreatePolicyRequest) GetDryRunOk() (*bool, bool) { + if o == nil || o.DryRun == nil { + return nil, false + } + return o.DryRun, true +} + +// HasDryRun returns a boolean if a field has been set. +func (o *CreatePolicyRequest) HasDryRun() bool { + if o != nil && o.DryRun != nil { + return true + } + + return false +} + +// SetDryRun gets a reference to the given bool and assigns it to the DryRun field. +func (o *CreatePolicyRequest) SetDryRun(v bool) { + o.DryRun = &v +} + +// GetPath returns the Path field value if set, zero value otherwise. +func (o *CreatePolicyRequest) GetPath() string { + if o == nil || o.Path == nil { + var ret string + return ret + } + return *o.Path +} + +// GetPathOk returns a tuple with the Path field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CreatePolicyRequest) GetPathOk() (*string, bool) { + if o == nil || o.Path == nil { + return nil, false + } + return o.Path, true +} + +// HasPath returns a boolean if a field has been set. +func (o *CreatePolicyRequest) HasPath() bool { + if o != nil && o.Path != nil { + return true + } + + return false +} + +// SetPath gets a reference to the given string and assigns it to the Path field. +func (o *CreatePolicyRequest) SetPath(v string) { + o.Path = &v +} + +// GetPolicyName returns the PolicyName field value +func (o *CreatePolicyRequest) GetPolicyName() string { + if o == nil { + var ret string + return ret + } + + return o.PolicyName +} + +// GetPolicyNameOk returns a tuple with the PolicyName field value +// and a boolean to check if the value has been set. +func (o *CreatePolicyRequest) GetPolicyNameOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.PolicyName, true +} + +// SetPolicyName sets field value +func (o *CreatePolicyRequest) SetPolicyName(v string) { + o.PolicyName = v +} + +func (o CreatePolicyRequest) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.Description != nil { + toSerialize["Description"] = o.Description + } + if true { + toSerialize["Document"] = o.Document + } + if o.DryRun != nil { + toSerialize["DryRun"] = o.DryRun + } + if o.Path != nil { + toSerialize["Path"] = o.Path + } + if true { + toSerialize["PolicyName"] = o.PolicyName + } + return json.Marshal(toSerialize) +} + +type NullableCreatePolicyRequest struct { + value *CreatePolicyRequest + isSet bool +} + +func (v NullableCreatePolicyRequest) Get() *CreatePolicyRequest { + return v.value +} + +func (v *NullableCreatePolicyRequest) Set(val *CreatePolicyRequest) { + v.value = val + v.isSet = true +} + +func (v NullableCreatePolicyRequest) IsSet() bool { + return v.isSet +} + +func (v *NullableCreatePolicyRequest) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableCreatePolicyRequest(val *CreatePolicyRequest) *NullableCreatePolicyRequest { + return &NullableCreatePolicyRequest{value: val, isSet: true} +} + +func (v NullableCreatePolicyRequest) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableCreatePolicyRequest) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_create_policy_response.go b/v2/model_create_policy_response.go new file mode 100644 index 000000000..44a7484d4 --- /dev/null +++ b/v2/model_create_policy_response.go @@ -0,0 +1,150 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// CreatePolicyResponse struct for CreatePolicyResponse +type CreatePolicyResponse struct { + Policy *Policy `json:"Policy,omitempty"` + ResponseContext *ResponseContext `json:"ResponseContext,omitempty"` +} + +// NewCreatePolicyResponse instantiates a new CreatePolicyResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewCreatePolicyResponse() *CreatePolicyResponse { + this := CreatePolicyResponse{} + return &this +} + +// NewCreatePolicyResponseWithDefaults instantiates a new CreatePolicyResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewCreatePolicyResponseWithDefaults() *CreatePolicyResponse { + this := CreatePolicyResponse{} + return &this +} + +// GetPolicy returns the Policy field value if set, zero value otherwise. +func (o *CreatePolicyResponse) GetPolicy() Policy { + if o == nil || o.Policy == nil { + var ret Policy + return ret + } + return *o.Policy +} + +// GetPolicyOk returns a tuple with the Policy field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CreatePolicyResponse) GetPolicyOk() (*Policy, bool) { + if o == nil || o.Policy == nil { + return nil, false + } + return o.Policy, true +} + +// HasPolicy returns a boolean if a field has been set. +func (o *CreatePolicyResponse) HasPolicy() bool { + if o != nil && o.Policy != nil { + return true + } + + return false +} + +// SetPolicy gets a reference to the given Policy and assigns it to the Policy field. +func (o *CreatePolicyResponse) SetPolicy(v Policy) { + o.Policy = &v +} + +// GetResponseContext returns the ResponseContext field value if set, zero value otherwise. +func (o *CreatePolicyResponse) GetResponseContext() ResponseContext { + if o == nil || o.ResponseContext == nil { + var ret ResponseContext + return ret + } + return *o.ResponseContext +} + +// GetResponseContextOk returns a tuple with the ResponseContext field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CreatePolicyResponse) GetResponseContextOk() (*ResponseContext, bool) { + if o == nil || o.ResponseContext == nil { + return nil, false + } + return o.ResponseContext, true +} + +// HasResponseContext returns a boolean if a field has been set. +func (o *CreatePolicyResponse) HasResponseContext() bool { + if o != nil && o.ResponseContext != nil { + return true + } + + return false +} + +// SetResponseContext gets a reference to the given ResponseContext and assigns it to the ResponseContext field. +func (o *CreatePolicyResponse) SetResponseContext(v ResponseContext) { + o.ResponseContext = &v +} + +func (o CreatePolicyResponse) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.Policy != nil { + toSerialize["Policy"] = o.Policy + } + if o.ResponseContext != nil { + toSerialize["ResponseContext"] = o.ResponseContext + } + return json.Marshal(toSerialize) +} + +type NullableCreatePolicyResponse struct { + value *CreatePolicyResponse + isSet bool +} + +func (v NullableCreatePolicyResponse) Get() *CreatePolicyResponse { + return v.value +} + +func (v *NullableCreatePolicyResponse) Set(val *CreatePolicyResponse) { + v.value = val + v.isSet = true +} + +func (v NullableCreatePolicyResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableCreatePolicyResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableCreatePolicyResponse(val *CreatePolicyResponse) *NullableCreatePolicyResponse { + return &NullableCreatePolicyResponse{value: val, isSet: true} +} + +func (v NullableCreatePolicyResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableCreatePolicyResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_create_policy_version_request.go b/v2/model_create_policy_version_request.go new file mode 100644 index 000000000..ad995ad75 --- /dev/null +++ b/v2/model_create_policy_version_request.go @@ -0,0 +1,175 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// CreatePolicyVersionRequest struct for CreatePolicyVersionRequest +type CreatePolicyVersionRequest struct { + // 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 `json:"Document"` + // The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + PolicyOrn string `json:"PolicyOrn"` + // If set to true, the new policy version is set as the default version and becomes the operative one. + SetAsDefault *bool `json:"SetAsDefault,omitempty"` +} + +// NewCreatePolicyVersionRequest instantiates a new CreatePolicyVersionRequest object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewCreatePolicyVersionRequest(document string, policyOrn string) *CreatePolicyVersionRequest { + this := CreatePolicyVersionRequest{} + this.Document = document + this.PolicyOrn = policyOrn + return &this +} + +// NewCreatePolicyVersionRequestWithDefaults instantiates a new CreatePolicyVersionRequest object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewCreatePolicyVersionRequestWithDefaults() *CreatePolicyVersionRequest { + this := CreatePolicyVersionRequest{} + return &this +} + +// GetDocument returns the Document field value +func (o *CreatePolicyVersionRequest) GetDocument() string { + if o == nil { + var ret string + return ret + } + + return o.Document +} + +// GetDocumentOk returns a tuple with the Document field value +// and a boolean to check if the value has been set. +func (o *CreatePolicyVersionRequest) GetDocumentOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.Document, true +} + +// SetDocument sets field value +func (o *CreatePolicyVersionRequest) SetDocument(v string) { + o.Document = v +} + +// GetPolicyOrn returns the PolicyOrn field value +func (o *CreatePolicyVersionRequest) GetPolicyOrn() string { + if o == nil { + var ret string + return ret + } + + return o.PolicyOrn +} + +// GetPolicyOrnOk returns a tuple with the PolicyOrn field value +// and a boolean to check if the value has been set. +func (o *CreatePolicyVersionRequest) GetPolicyOrnOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.PolicyOrn, true +} + +// SetPolicyOrn sets field value +func (o *CreatePolicyVersionRequest) SetPolicyOrn(v string) { + o.PolicyOrn = v +} + +// GetSetAsDefault returns the SetAsDefault field value if set, zero value otherwise. +func (o *CreatePolicyVersionRequest) GetSetAsDefault() bool { + if o == nil || o.SetAsDefault == nil { + var ret bool + return ret + } + return *o.SetAsDefault +} + +// GetSetAsDefaultOk returns a tuple with the SetAsDefault field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CreatePolicyVersionRequest) GetSetAsDefaultOk() (*bool, bool) { + if o == nil || o.SetAsDefault == nil { + return nil, false + } + return o.SetAsDefault, true +} + +// HasSetAsDefault returns a boolean if a field has been set. +func (o *CreatePolicyVersionRequest) HasSetAsDefault() bool { + if o != nil && o.SetAsDefault != nil { + return true + } + + return false +} + +// SetSetAsDefault gets a reference to the given bool and assigns it to the SetAsDefault field. +func (o *CreatePolicyVersionRequest) SetSetAsDefault(v bool) { + o.SetAsDefault = &v +} + +func (o CreatePolicyVersionRequest) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["Document"] = o.Document + } + if true { + toSerialize["PolicyOrn"] = o.PolicyOrn + } + if o.SetAsDefault != nil { + toSerialize["SetAsDefault"] = o.SetAsDefault + } + return json.Marshal(toSerialize) +} + +type NullableCreatePolicyVersionRequest struct { + value *CreatePolicyVersionRequest + isSet bool +} + +func (v NullableCreatePolicyVersionRequest) Get() *CreatePolicyVersionRequest { + return v.value +} + +func (v *NullableCreatePolicyVersionRequest) Set(val *CreatePolicyVersionRequest) { + v.value = val + v.isSet = true +} + +func (v NullableCreatePolicyVersionRequest) IsSet() bool { + return v.isSet +} + +func (v *NullableCreatePolicyVersionRequest) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableCreatePolicyVersionRequest(val *CreatePolicyVersionRequest) *NullableCreatePolicyVersionRequest { + return &NullableCreatePolicyVersionRequest{value: val, isSet: true} +} + +func (v NullableCreatePolicyVersionRequest) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableCreatePolicyVersionRequest) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_create_policy_version_response.go b/v2/model_create_policy_version_response.go new file mode 100644 index 000000000..c0ac3412e --- /dev/null +++ b/v2/model_create_policy_version_response.go @@ -0,0 +1,150 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// CreatePolicyVersionResponse struct for CreatePolicyVersionResponse +type CreatePolicyVersionResponse struct { + PolicyVersion *PolicyVersion `json:"PolicyVersion,omitempty"` + ResponseContext *ResponseContext `json:"ResponseContext,omitempty"` +} + +// NewCreatePolicyVersionResponse instantiates a new CreatePolicyVersionResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewCreatePolicyVersionResponse() *CreatePolicyVersionResponse { + this := CreatePolicyVersionResponse{} + return &this +} + +// NewCreatePolicyVersionResponseWithDefaults instantiates a new CreatePolicyVersionResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewCreatePolicyVersionResponseWithDefaults() *CreatePolicyVersionResponse { + this := CreatePolicyVersionResponse{} + return &this +} + +// GetPolicyVersion returns the PolicyVersion field value if set, zero value otherwise. +func (o *CreatePolicyVersionResponse) GetPolicyVersion() PolicyVersion { + if o == nil || o.PolicyVersion == nil { + var ret PolicyVersion + return ret + } + return *o.PolicyVersion +} + +// GetPolicyVersionOk returns a tuple with the PolicyVersion field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CreatePolicyVersionResponse) GetPolicyVersionOk() (*PolicyVersion, bool) { + if o == nil || o.PolicyVersion == nil { + return nil, false + } + return o.PolicyVersion, true +} + +// HasPolicyVersion returns a boolean if a field has been set. +func (o *CreatePolicyVersionResponse) HasPolicyVersion() bool { + if o != nil && o.PolicyVersion != nil { + return true + } + + return false +} + +// SetPolicyVersion gets a reference to the given PolicyVersion and assigns it to the PolicyVersion field. +func (o *CreatePolicyVersionResponse) SetPolicyVersion(v PolicyVersion) { + o.PolicyVersion = &v +} + +// GetResponseContext returns the ResponseContext field value if set, zero value otherwise. +func (o *CreatePolicyVersionResponse) GetResponseContext() ResponseContext { + if o == nil || o.ResponseContext == nil { + var ret ResponseContext + return ret + } + return *o.ResponseContext +} + +// GetResponseContextOk returns a tuple with the ResponseContext field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CreatePolicyVersionResponse) GetResponseContextOk() (*ResponseContext, bool) { + if o == nil || o.ResponseContext == nil { + return nil, false + } + return o.ResponseContext, true +} + +// HasResponseContext returns a boolean if a field has been set. +func (o *CreatePolicyVersionResponse) HasResponseContext() bool { + if o != nil && o.ResponseContext != nil { + return true + } + + return false +} + +// SetResponseContext gets a reference to the given ResponseContext and assigns it to the ResponseContext field. +func (o *CreatePolicyVersionResponse) SetResponseContext(v ResponseContext) { + o.ResponseContext = &v +} + +func (o CreatePolicyVersionResponse) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.PolicyVersion != nil { + toSerialize["PolicyVersion"] = o.PolicyVersion + } + if o.ResponseContext != nil { + toSerialize["ResponseContext"] = o.ResponseContext + } + return json.Marshal(toSerialize) +} + +type NullableCreatePolicyVersionResponse struct { + value *CreatePolicyVersionResponse + isSet bool +} + +func (v NullableCreatePolicyVersionResponse) Get() *CreatePolicyVersionResponse { + return v.value +} + +func (v *NullableCreatePolicyVersionResponse) Set(val *CreatePolicyVersionResponse) { + v.value = val + v.isSet = true +} + +func (v NullableCreatePolicyVersionResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableCreatePolicyVersionResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableCreatePolicyVersionResponse(val *CreatePolicyVersionResponse) *NullableCreatePolicyVersionResponse { + return &NullableCreatePolicyVersionResponse{value: val, isSet: true} +} + +func (v NullableCreatePolicyVersionResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableCreatePolicyVersionResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_create_product_type_request.go b/v2/model_create_product_type_request.go new file mode 100644 index 000000000..239b9f6fe --- /dev/null +++ b/v2/model_create_product_type_request.go @@ -0,0 +1,182 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// CreateProductTypeRequest struct for CreateProductTypeRequest +type CreateProductTypeRequest struct { + // The description of the product type. + Description string `json:"Description"` + // If true, checks whether you have the required permissions to perform the action. + DryRun *bool `json:"DryRun,omitempty"` + // The vendor of the product type. + Vendor *string `json:"Vendor,omitempty"` +} + +// NewCreateProductTypeRequest instantiates a new CreateProductTypeRequest object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewCreateProductTypeRequest(description string) *CreateProductTypeRequest { + this := CreateProductTypeRequest{} + this.Description = description + return &this +} + +// NewCreateProductTypeRequestWithDefaults instantiates a new CreateProductTypeRequest object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewCreateProductTypeRequestWithDefaults() *CreateProductTypeRequest { + this := CreateProductTypeRequest{} + return &this +} + +// GetDescription returns the Description field value +func (o *CreateProductTypeRequest) GetDescription() string { + if o == nil { + var ret string + return ret + } + + return o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value +// and a boolean to check if the value has been set. +func (o *CreateProductTypeRequest) GetDescriptionOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.Description, true +} + +// SetDescription sets field value +func (o *CreateProductTypeRequest) SetDescription(v string) { + o.Description = v +} + +// GetDryRun returns the DryRun field value if set, zero value otherwise. +func (o *CreateProductTypeRequest) GetDryRun() bool { + if o == nil || o.DryRun == nil { + var ret bool + return ret + } + return *o.DryRun +} + +// GetDryRunOk returns a tuple with the DryRun field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CreateProductTypeRequest) GetDryRunOk() (*bool, bool) { + if o == nil || o.DryRun == nil { + return nil, false + } + return o.DryRun, true +} + +// HasDryRun returns a boolean if a field has been set. +func (o *CreateProductTypeRequest) HasDryRun() bool { + if o != nil && o.DryRun != nil { + return true + } + + return false +} + +// SetDryRun gets a reference to the given bool and assigns it to the DryRun field. +func (o *CreateProductTypeRequest) SetDryRun(v bool) { + o.DryRun = &v +} + +// GetVendor returns the Vendor field value if set, zero value otherwise. +func (o *CreateProductTypeRequest) GetVendor() string { + if o == nil || o.Vendor == nil { + var ret string + return ret + } + return *o.Vendor +} + +// GetVendorOk returns a tuple with the Vendor field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CreateProductTypeRequest) GetVendorOk() (*string, bool) { + if o == nil || o.Vendor == nil { + return nil, false + } + return o.Vendor, true +} + +// HasVendor returns a boolean if a field has been set. +func (o *CreateProductTypeRequest) HasVendor() bool { + if o != nil && o.Vendor != nil { + return true + } + + return false +} + +// SetVendor gets a reference to the given string and assigns it to the Vendor field. +func (o *CreateProductTypeRequest) SetVendor(v string) { + o.Vendor = &v +} + +func (o CreateProductTypeRequest) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["Description"] = o.Description + } + if o.DryRun != nil { + toSerialize["DryRun"] = o.DryRun + } + if o.Vendor != nil { + toSerialize["Vendor"] = o.Vendor + } + return json.Marshal(toSerialize) +} + +type NullableCreateProductTypeRequest struct { + value *CreateProductTypeRequest + isSet bool +} + +func (v NullableCreateProductTypeRequest) Get() *CreateProductTypeRequest { + return v.value +} + +func (v *NullableCreateProductTypeRequest) Set(val *CreateProductTypeRequest) { + v.value = val + v.isSet = true +} + +func (v NullableCreateProductTypeRequest) IsSet() bool { + return v.isSet +} + +func (v *NullableCreateProductTypeRequest) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableCreateProductTypeRequest(val *CreateProductTypeRequest) *NullableCreateProductTypeRequest { + return &NullableCreateProductTypeRequest{value: val, isSet: true} +} + +func (v NullableCreateProductTypeRequest) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableCreateProductTypeRequest) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_create_product_type_response.go b/v2/model_create_product_type_response.go new file mode 100644 index 000000000..94b3a6b76 --- /dev/null +++ b/v2/model_create_product_type_response.go @@ -0,0 +1,150 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// CreateProductTypeResponse struct for CreateProductTypeResponse +type CreateProductTypeResponse struct { + ProductType *ProductType `json:"ProductType,omitempty"` + ResponseContext *ResponseContext `json:"ResponseContext,omitempty"` +} + +// NewCreateProductTypeResponse instantiates a new CreateProductTypeResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewCreateProductTypeResponse() *CreateProductTypeResponse { + this := CreateProductTypeResponse{} + return &this +} + +// NewCreateProductTypeResponseWithDefaults instantiates a new CreateProductTypeResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewCreateProductTypeResponseWithDefaults() *CreateProductTypeResponse { + this := CreateProductTypeResponse{} + return &this +} + +// GetProductType returns the ProductType field value if set, zero value otherwise. +func (o *CreateProductTypeResponse) GetProductType() ProductType { + if o == nil || o.ProductType == nil { + var ret ProductType + return ret + } + return *o.ProductType +} + +// GetProductTypeOk returns a tuple with the ProductType field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CreateProductTypeResponse) GetProductTypeOk() (*ProductType, bool) { + if o == nil || o.ProductType == nil { + return nil, false + } + return o.ProductType, true +} + +// HasProductType returns a boolean if a field has been set. +func (o *CreateProductTypeResponse) HasProductType() bool { + if o != nil && o.ProductType != nil { + return true + } + + return false +} + +// SetProductType gets a reference to the given ProductType and assigns it to the ProductType field. +func (o *CreateProductTypeResponse) SetProductType(v ProductType) { + o.ProductType = &v +} + +// GetResponseContext returns the ResponseContext field value if set, zero value otherwise. +func (o *CreateProductTypeResponse) GetResponseContext() ResponseContext { + if o == nil || o.ResponseContext == nil { + var ret ResponseContext + return ret + } + return *o.ResponseContext +} + +// GetResponseContextOk returns a tuple with the ResponseContext field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CreateProductTypeResponse) GetResponseContextOk() (*ResponseContext, bool) { + if o == nil || o.ResponseContext == nil { + return nil, false + } + return o.ResponseContext, true +} + +// HasResponseContext returns a boolean if a field has been set. +func (o *CreateProductTypeResponse) HasResponseContext() bool { + if o != nil && o.ResponseContext != nil { + return true + } + + return false +} + +// SetResponseContext gets a reference to the given ResponseContext and assigns it to the ResponseContext field. +func (o *CreateProductTypeResponse) SetResponseContext(v ResponseContext) { + o.ResponseContext = &v +} + +func (o CreateProductTypeResponse) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.ProductType != nil { + toSerialize["ProductType"] = o.ProductType + } + if o.ResponseContext != nil { + toSerialize["ResponseContext"] = o.ResponseContext + } + return json.Marshal(toSerialize) +} + +type NullableCreateProductTypeResponse struct { + value *CreateProductTypeResponse + isSet bool +} + +func (v NullableCreateProductTypeResponse) Get() *CreateProductTypeResponse { + return v.value +} + +func (v *NullableCreateProductTypeResponse) Set(val *CreateProductTypeResponse) { + v.value = val + v.isSet = true +} + +func (v NullableCreateProductTypeResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableCreateProductTypeResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableCreateProductTypeResponse(val *CreateProductTypeResponse) *NullableCreateProductTypeResponse { + return &NullableCreateProductTypeResponse{value: val, isSet: true} +} + +func (v NullableCreateProductTypeResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableCreateProductTypeResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_create_public_ip_request.go b/v2/model_create_public_ip_request.go index e51445e4d..56ab196d0 100644 --- a/v2/model_create_public_ip_request.go +++ b/v2/model_create_public_ip_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_public_ip_response.go b/v2/model_create_public_ip_response.go index 598a56130..ec6230d23 100644 --- a/v2/model_create_public_ip_response.go +++ b/v2/model_create_public_ip_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_route_request.go b/v2/model_create_route_request.go index d86c06395..c85176d2b 100644 --- a/v2/model_create_route_request.go +++ b/v2/model_create_route_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_route_response.go b/v2/model_create_route_response.go index 7fe7a5c24..08cec903c 100644 --- a/v2/model_create_route_response.go +++ b/v2/model_create_route_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_route_table_request.go b/v2/model_create_route_table_request.go index ae51496af..d50d3339f 100644 --- a/v2/model_create_route_table_request.go +++ b/v2/model_create_route_table_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_route_table_response.go b/v2/model_create_route_table_response.go index 455ea0348..38627c168 100644 --- a/v2/model_create_route_table_response.go +++ b/v2/model_create_route_table_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_security_group_request.go b/v2/model_create_security_group_request.go index b7320114f..d2a1f2371 100644 --- a/v2/model_create_security_group_request.go +++ b/v2/model_create_security_group_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -17,13 +17,13 @@ import ( // CreateSecurityGroupRequest struct for CreateSecurityGroupRequest type CreateSecurityGroupRequest struct { - // A description for the security group, with a maximum length of 255 [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#Printable_characters). + // A description for the security group.
This description can contain between 1 and 255 characters. Allowed characters are `a-z`, `A-Z`, `0-9`, accented letters, spaces, and `_.-:/()#,@[]+=&;{}!$*`. Description string `json:"Description"` // If true, checks whether you have the required permissions to perform the action. DryRun *bool `json:"DryRun,omitempty"` // The ID of the Net for the security group. NetId *string `json:"NetId,omitempty"` - // The name of the security group.
This name must not start with `sg-`.
This name must be unique and contain between 1 and 255 ASCII characters. Accented letters are not allowed. + // The name of the security group.
This name must not start with `sg-`.
This name must be unique and contain between 1 and 255 characters. Allowed characters are `a-z`, `A-Z`, `0-9`, spaces, and `_.-:/()#,@[]+=&;{}!$*`. SecurityGroupName string `json:"SecurityGroupName"` } diff --git a/v2/model_create_security_group_response.go b/v2/model_create_security_group_response.go index 1b279533b..6aefd2e2e 100644 --- a/v2/model_create_security_group_response.go +++ b/v2/model_create_security_group_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_security_group_rule_request.go b/v2/model_create_security_group_rule_request.go index a856a582d..3e554cfb2 100644 --- a/v2/model_create_security_group_rule_request.go +++ b/v2/model_create_security_group_rule_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_security_group_rule_response.go b/v2/model_create_security_group_rule_response.go index a4507807e..ef626d407 100644 --- a/v2/model_create_security_group_rule_response.go +++ b/v2/model_create_security_group_rule_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_server_certificate_request.go b/v2/model_create_server_certificate_request.go index 236df9357..5be184e87 100644 --- a/v2/model_create_server_certificate_request.go +++ b/v2/model_create_server_certificate_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_server_certificate_response.go b/v2/model_create_server_certificate_response.go index 43b51bebd..33eaf9bb1 100644 --- a/v2/model_create_server_certificate_response.go +++ b/v2/model_create_server_certificate_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_snapshot_export_task_request.go b/v2/model_create_snapshot_export_task_request.go index 1b248dd65..7380051c1 100644 --- a/v2/model_create_snapshot_export_task_request.go +++ b/v2/model_create_snapshot_export_task_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_snapshot_export_task_response.go b/v2/model_create_snapshot_export_task_response.go index e0455f691..3f699611e 100644 --- a/v2/model_create_snapshot_export_task_response.go +++ b/v2/model_create_snapshot_export_task_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_snapshot_request.go b/v2/model_create_snapshot_request.go index 4f38de968..0e570c7de 100644 --- a/v2/model_create_snapshot_request.go +++ b/v2/model_create_snapshot_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -21,15 +21,15 @@ type CreateSnapshotRequest struct { Description *string `json:"Description,omitempty"` // If true, checks whether you have the required permissions to perform the action. DryRun *bool `json:"DryRun,omitempty"` - // (When importing) 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). + // **(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). FileLocation *string `json:"FileLocation,omitempty"` - // (When importing) 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. + // **(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. SnapshotSize *int64 `json:"SnapshotSize,omitempty"` - // (When copying) The name of the source Region, which must be the same as the Region of your account. + // **(when copying a snapshot)** The name of the source Region, which must be the same as the Region of your account. SourceRegionName *string `json:"SourceRegionName,omitempty"` - // (When copying) The ID of the snapshot you want to copy. + // **(when copying a snapshot)** The ID of the snapshot you want to copy. SourceSnapshotId *string `json:"SourceSnapshotId,omitempty"` - // (When creating) The ID of the volume you want to create a snapshot of. + // **(when creating from a volume)** The ID of the volume you want to create a snapshot of. VolumeId *string `json:"VolumeId,omitempty"` } diff --git a/v2/model_create_snapshot_response.go b/v2/model_create_snapshot_response.go index 4a2b44a31..5679a9418 100644 --- a/v2/model_create_snapshot_response.go +++ b/v2/model_create_snapshot_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_subnet_request.go b/v2/model_create_subnet_request.go index 5004bc599..67fa0e3c5 100644 --- a/v2/model_create_subnet_request.go +++ b/v2/model_create_subnet_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -19,7 +19,7 @@ import ( type CreateSubnetRequest struct { // If true, checks whether you have the required permissions to perform the action. DryRun *bool `json:"DryRun,omitempty"` - // The IP range in the Subnet, in CIDR notation (for example, `10.0.0.0/16`).
The IP range of the Subnet can be either the same as the Net one if you create only a single Subnet in this Net, or a subset of the Net one. In case of several Subnets in a Net, their IP ranges must not overlap. The smallest Subnet you can create uses a /29 netmask (eight IPs). For more information, see [About VPCs](https://docs.outscale.com/en/userguide/About-VPCs.html). + // The IP range in the Subnet, in CIDR notation (for example, `10.0.0.0/16`).
The IP range of the Subnet can be either the same as the Net one if you create only a single Subnet in this Net, or a subset of the Net one. In case of several Subnets in a Net, their IP ranges must not overlap. The smallest Subnet you can create uses a /29 netmask (eight IPs). For more information, see [About Nets](https://docs.outscale.com/en/userguide/About-Nets.html). IpRange string `json:"IpRange"` // The ID of the Net for which you want to create a Subnet. NetId string `json:"NetId"` diff --git a/v2/model_create_subnet_response.go b/v2/model_create_subnet_response.go index 3169448f1..f7e1460ae 100644 --- a/v2/model_create_subnet_response.go +++ b/v2/model_create_subnet_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_tags_request.go b/v2/model_create_tags_request.go index d07b253af..54b711391 100644 --- a/v2/model_create_tags_request.go +++ b/v2/model_create_tags_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_tags_response.go b/v2/model_create_tags_response.go index 3b4dcaaac..c3d309281 100644 --- a/v2/model_create_tags_response.go +++ b/v2/model_create_tags_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_user_request.go b/v2/model_create_user_request.go index 8ff0ff7ec..e6ddc774e 100644 --- a/v2/model_create_user_request.go +++ b/v2/model_create_user_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -19,9 +19,9 @@ import ( type CreateUserRequest struct { // If true, checks whether you have the required permissions to perform the action. DryRun *bool `json:"DryRun,omitempty"` - // The path to the EIM user you want to create (by default, `/`). + // 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 (_). Path *string `json:"Path,omitempty"` - // The name of the EIM user you want to create. + // The name of the EIM user you want to create. This user name must contain between 1 and 64 alphanumeric characters and/or pluses (+), equals (=), commas (,), periods (.), at signs (@), dashes (-), or underscores (_). UserName string `json:"UserName"` } diff --git a/v2/model_create_user_response.go b/v2/model_create_user_response.go index 55621fdba..911f42d0b 100644 --- a/v2/model_create_user_response.go +++ b/v2/model_create_user_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_virtual_gateway_request.go b/v2/model_create_virtual_gateway_request.go index 3215a4726..a22d2bf24 100644 --- a/v2/model_create_virtual_gateway_request.go +++ b/v2/model_create_virtual_gateway_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_virtual_gateway_response.go b/v2/model_create_virtual_gateway_response.go index 86817a96d..3593f948e 100644 --- a/v2/model_create_virtual_gateway_response.go +++ b/v2/model_create_virtual_gateway_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_vm_group_request.go b/v2/model_create_vm_group_request.go index c4623c48c..85c6ac84c 100644 --- a/v2/model_create_vm_group_request.go +++ b/v2/model_create_vm_group_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_vm_group_response.go b/v2/model_create_vm_group_response.go index 89a821403..a7b637607 100644 --- a/v2/model_create_vm_group_response.go +++ b/v2/model_create_vm_group_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_vm_template_request.go b/v2/model_create_vm_template_request.go index 6fc624ae8..d9795353a 100644 --- a/v2/model_create_vm_template_request.go +++ b/v2/model_create_vm_template_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_vm_template_response.go b/v2/model_create_vm_template_response.go index 53b443dcd..0ab643fe0 100644 --- a/v2/model_create_vm_template_response.go +++ b/v2/model_create_vm_template_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_vms_request.go b/v2/model_create_vms_request.go index 3a6ac77a6..4ca7104ce 100644 --- a/v2/model_create_vms_request.go +++ b/v2/model_create_vms_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -56,7 +56,7 @@ type CreateVmsRequest struct { UserData *string `json:"UserData,omitempty"` // 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. VmInitiatedShutdownBehavior *string `json:"VmInitiatedShutdownBehavior,omitempty"` - // 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).
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 [Instance Types](https://docs.outscale.com/en/userguide/Instance-Types.html). + // 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).
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). VmType *string `json:"VmType,omitempty"` } diff --git a/v2/model_create_vms_response.go b/v2/model_create_vms_response.go index 2235ffe36..b8338cb27 100644 --- a/v2/model_create_vms_response.go +++ b/v2/model_create_vms_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_volume_request.go b/v2/model_create_volume_request.go index 5343c580b..7279b5591 100644 --- a/v2/model_create_volume_request.go +++ b/v2/model_create_volume_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_volume_response.go b/v2/model_create_volume_response.go index 2d796eced..f0fa0f41d 100644 --- a/v2/model_create_volume_response.go +++ b/v2/model_create_volume_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_vpn_connection_request.go b/v2/model_create_vpn_connection_request.go index c92c6c63b..8d11f04e2 100644 --- a/v2/model_create_vpn_connection_request.go +++ b/v2/model_create_vpn_connection_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -23,7 +23,7 @@ type CreateVpnConnectionRequest struct { ConnectionType string `json:"ConnectionType"` // If true, checks whether you have the required permissions to perform the action. DryRun *bool `json:"DryRun,omitempty"` - // 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). + // 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). StaticRoutesOnly *bool `json:"StaticRoutesOnly,omitempty"` // The ID of the virtual gateway. VirtualGatewayId string `json:"VirtualGatewayId"` diff --git a/v2/model_create_vpn_connection_response.go b/v2/model_create_vpn_connection_response.go index 716a3a7f3..77c39d12b 100644 --- a/v2/model_create_vpn_connection_response.go +++ b/v2/model_create_vpn_connection_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_vpn_connection_route_request.go b/v2/model_create_vpn_connection_route_request.go index 0ef18a21f..85549af71 100644 --- a/v2/model_create_vpn_connection_route_request.go +++ b/v2/model_create_vpn_connection_route_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_create_vpn_connection_route_response.go b/v2/model_create_vpn_connection_route_response.go index 041db2e23..f31e4607d 100644 --- a/v2/model_create_vpn_connection_route_response.go +++ b/v2/model_create_vpn_connection_route_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_dedicated_group.go b/v2/model_dedicated_group.go new file mode 100644 index 000000000..129fef12e --- /dev/null +++ b/v2/model_dedicated_group.go @@ -0,0 +1,337 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// DedicatedGroup Information about the dedicated group. +type DedicatedGroup struct { + // The account ID of the owners of the dedicated group. + AccountId *string `json:"AccountId,omitempty"` + // The processor generation. + CpuGeneration *int32 `json:"CpuGeneration,omitempty"` + // The ID of the dedicated group. + DedicatedGroupId *string `json:"DedicatedGroupId,omitempty"` + // The name of the dedicated group. + Name *string `json:"Name,omitempty"` + // The IDs of the Nets in the dedicated group. + NetIds *[]string `json:"NetIds,omitempty"` + // The name of the Subregion in which the dedicated group is located. + SubregionName *string `json:"SubregionName,omitempty"` + // The IDs of the VMs in the dedicated group. + VmIds *[]string `json:"VmIds,omitempty"` +} + +// NewDedicatedGroup instantiates a new DedicatedGroup object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewDedicatedGroup() *DedicatedGroup { + this := DedicatedGroup{} + return &this +} + +// NewDedicatedGroupWithDefaults instantiates a new DedicatedGroup object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewDedicatedGroupWithDefaults() *DedicatedGroup { + this := DedicatedGroup{} + return &this +} + +// GetAccountId returns the AccountId field value if set, zero value otherwise. +func (o *DedicatedGroup) GetAccountId() string { + if o == nil || o.AccountId == nil { + var ret string + return ret + } + return *o.AccountId +} + +// GetAccountIdOk returns a tuple with the AccountId field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *DedicatedGroup) GetAccountIdOk() (*string, bool) { + if o == nil || o.AccountId == nil { + return nil, false + } + return o.AccountId, true +} + +// HasAccountId returns a boolean if a field has been set. +func (o *DedicatedGroup) HasAccountId() bool { + if o != nil && o.AccountId != nil { + return true + } + + return false +} + +// SetAccountId gets a reference to the given string and assigns it to the AccountId field. +func (o *DedicatedGroup) SetAccountId(v string) { + o.AccountId = &v +} + +// GetCpuGeneration returns the CpuGeneration field value if set, zero value otherwise. +func (o *DedicatedGroup) GetCpuGeneration() int32 { + if o == nil || o.CpuGeneration == nil { + var ret int32 + return ret + } + return *o.CpuGeneration +} + +// GetCpuGenerationOk returns a tuple with the CpuGeneration field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *DedicatedGroup) GetCpuGenerationOk() (*int32, bool) { + if o == nil || o.CpuGeneration == nil { + return nil, false + } + return o.CpuGeneration, true +} + +// HasCpuGeneration returns a boolean if a field has been set. +func (o *DedicatedGroup) HasCpuGeneration() bool { + if o != nil && o.CpuGeneration != nil { + return true + } + + return false +} + +// SetCpuGeneration gets a reference to the given int32 and assigns it to the CpuGeneration field. +func (o *DedicatedGroup) SetCpuGeneration(v int32) { + o.CpuGeneration = &v +} + +// GetDedicatedGroupId returns the DedicatedGroupId field value if set, zero value otherwise. +func (o *DedicatedGroup) GetDedicatedGroupId() string { + if o == nil || o.DedicatedGroupId == nil { + var ret string + return ret + } + return *o.DedicatedGroupId +} + +// GetDedicatedGroupIdOk returns a tuple with the DedicatedGroupId field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *DedicatedGroup) GetDedicatedGroupIdOk() (*string, bool) { + if o == nil || o.DedicatedGroupId == nil { + return nil, false + } + return o.DedicatedGroupId, true +} + +// HasDedicatedGroupId returns a boolean if a field has been set. +func (o *DedicatedGroup) HasDedicatedGroupId() bool { + if o != nil && o.DedicatedGroupId != nil { + return true + } + + return false +} + +// SetDedicatedGroupId gets a reference to the given string and assigns it to the DedicatedGroupId field. +func (o *DedicatedGroup) SetDedicatedGroupId(v string) { + o.DedicatedGroupId = &v +} + +// GetName returns the Name field value if set, zero value otherwise. +func (o *DedicatedGroup) GetName() string { + if o == nil || o.Name == nil { + var ret string + return ret + } + return *o.Name +} + +// GetNameOk returns a tuple with the Name field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *DedicatedGroup) GetNameOk() (*string, bool) { + if o == nil || o.Name == nil { + return nil, false + } + return o.Name, true +} + +// HasName returns a boolean if a field has been set. +func (o *DedicatedGroup) HasName() bool { + if o != nil && o.Name != nil { + return true + } + + return false +} + +// SetName gets a reference to the given string and assigns it to the Name field. +func (o *DedicatedGroup) SetName(v string) { + o.Name = &v +} + +// GetNetIds returns the NetIds field value if set, zero value otherwise. +func (o *DedicatedGroup) GetNetIds() []string { + if o == nil || o.NetIds == nil { + var ret []string + return ret + } + return *o.NetIds +} + +// GetNetIdsOk returns a tuple with the NetIds field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *DedicatedGroup) GetNetIdsOk() (*[]string, bool) { + if o == nil || o.NetIds == nil { + return nil, false + } + return o.NetIds, true +} + +// HasNetIds returns a boolean if a field has been set. +func (o *DedicatedGroup) HasNetIds() bool { + if o != nil && o.NetIds != nil { + return true + } + + return false +} + +// SetNetIds gets a reference to the given []string and assigns it to the NetIds field. +func (o *DedicatedGroup) SetNetIds(v []string) { + o.NetIds = &v +} + +// GetSubregionName returns the SubregionName field value if set, zero value otherwise. +func (o *DedicatedGroup) GetSubregionName() string { + if o == nil || o.SubregionName == nil { + var ret string + return ret + } + return *o.SubregionName +} + +// GetSubregionNameOk returns a tuple with the SubregionName field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *DedicatedGroup) GetSubregionNameOk() (*string, bool) { + if o == nil || o.SubregionName == nil { + return nil, false + } + return o.SubregionName, true +} + +// HasSubregionName returns a boolean if a field has been set. +func (o *DedicatedGroup) HasSubregionName() bool { + if o != nil && o.SubregionName != nil { + return true + } + + return false +} + +// SetSubregionName gets a reference to the given string and assigns it to the SubregionName field. +func (o *DedicatedGroup) SetSubregionName(v string) { + o.SubregionName = &v +} + +// GetVmIds returns the VmIds field value if set, zero value otherwise. +func (o *DedicatedGroup) GetVmIds() []string { + if o == nil || o.VmIds == nil { + var ret []string + return ret + } + return *o.VmIds +} + +// GetVmIdsOk returns a tuple with the VmIds field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *DedicatedGroup) GetVmIdsOk() (*[]string, bool) { + if o == nil || o.VmIds == nil { + return nil, false + } + return o.VmIds, true +} + +// HasVmIds returns a boolean if a field has been set. +func (o *DedicatedGroup) HasVmIds() bool { + if o != nil && o.VmIds != nil { + return true + } + + return false +} + +// SetVmIds gets a reference to the given []string and assigns it to the VmIds field. +func (o *DedicatedGroup) SetVmIds(v []string) { + o.VmIds = &v +} + +func (o DedicatedGroup) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.AccountId != nil { + toSerialize["AccountId"] = o.AccountId + } + if o.CpuGeneration != nil { + toSerialize["CpuGeneration"] = o.CpuGeneration + } + if o.DedicatedGroupId != nil { + toSerialize["DedicatedGroupId"] = o.DedicatedGroupId + } + if o.Name != nil { + toSerialize["Name"] = o.Name + } + if o.NetIds != nil { + toSerialize["NetIds"] = o.NetIds + } + if o.SubregionName != nil { + toSerialize["SubregionName"] = o.SubregionName + } + if o.VmIds != nil { + toSerialize["VmIds"] = o.VmIds + } + return json.Marshal(toSerialize) +} + +type NullableDedicatedGroup struct { + value *DedicatedGroup + isSet bool +} + +func (v NullableDedicatedGroup) Get() *DedicatedGroup { + return v.value +} + +func (v *NullableDedicatedGroup) Set(val *DedicatedGroup) { + v.value = val + v.isSet = true +} + +func (v NullableDedicatedGroup) IsSet() bool { + return v.isSet +} + +func (v *NullableDedicatedGroup) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableDedicatedGroup(val *DedicatedGroup) *NullableDedicatedGroup { + return &NullableDedicatedGroup{value: val, isSet: true} +} + +func (v NullableDedicatedGroup) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableDedicatedGroup) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_delete_access_key_request.go b/v2/model_delete_access_key_request.go index 497a69907..114fdf5e5 100644 --- a/v2/model_delete_access_key_request.go +++ b/v2/model_delete_access_key_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_access_key_response.go b/v2/model_delete_access_key_response.go index ac09e3347..d1b27ce5e 100644 --- a/v2/model_delete_access_key_response.go +++ b/v2/model_delete_access_key_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_api_access_rule_request.go b/v2/model_delete_api_access_rule_request.go index e8d865ea0..6a3194620 100644 --- a/v2/model_delete_api_access_rule_request.go +++ b/v2/model_delete_api_access_rule_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_api_access_rule_response.go b/v2/model_delete_api_access_rule_response.go index 099170abd..fa050615f 100644 --- a/v2/model_delete_api_access_rule_response.go +++ b/v2/model_delete_api_access_rule_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_ca_request.go b/v2/model_delete_ca_request.go index 53e8c9f06..80ee854d7 100644 --- a/v2/model_delete_ca_request.go +++ b/v2/model_delete_ca_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_ca_response.go b/v2/model_delete_ca_response.go index 7ae3825bf..cd6d91796 100644 --- a/v2/model_delete_ca_response.go +++ b/v2/model_delete_ca_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_client_gateway_request.go b/v2/model_delete_client_gateway_request.go index 2fafe7469..8fa05c153 100644 --- a/v2/model_delete_client_gateway_request.go +++ b/v2/model_delete_client_gateway_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_client_gateway_response.go b/v2/model_delete_client_gateway_response.go index d70328880..2b5762d7d 100644 --- a/v2/model_delete_client_gateway_response.go +++ b/v2/model_delete_client_gateway_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_dedicated_group_request.go b/v2/model_delete_dedicated_group_request.go new file mode 100644 index 000000000..35e3fc307 --- /dev/null +++ b/v2/model_delete_dedicated_group_request.go @@ -0,0 +1,182 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// DeleteDedicatedGroupRequest struct for DeleteDedicatedGroupRequest +type DeleteDedicatedGroupRequest struct { + // The ID of the dedicated group you want to delete. + DedicatedGroupId string `json:"DedicatedGroupId"` + // If true, checks whether you have the required permissions to perform the action. + DryRun *bool `json:"DryRun,omitempty"` + // If true, forces the deletion of the dedicated group and all its dependencies. + Force *bool `json:"Force,omitempty"` +} + +// NewDeleteDedicatedGroupRequest instantiates a new DeleteDedicatedGroupRequest object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewDeleteDedicatedGroupRequest(dedicatedGroupId string) *DeleteDedicatedGroupRequest { + this := DeleteDedicatedGroupRequest{} + this.DedicatedGroupId = dedicatedGroupId + return &this +} + +// NewDeleteDedicatedGroupRequestWithDefaults instantiates a new DeleteDedicatedGroupRequest object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewDeleteDedicatedGroupRequestWithDefaults() *DeleteDedicatedGroupRequest { + this := DeleteDedicatedGroupRequest{} + return &this +} + +// GetDedicatedGroupId returns the DedicatedGroupId field value +func (o *DeleteDedicatedGroupRequest) GetDedicatedGroupId() string { + if o == nil { + var ret string + return ret + } + + return o.DedicatedGroupId +} + +// GetDedicatedGroupIdOk returns a tuple with the DedicatedGroupId field value +// and a boolean to check if the value has been set. +func (o *DeleteDedicatedGroupRequest) GetDedicatedGroupIdOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.DedicatedGroupId, true +} + +// SetDedicatedGroupId sets field value +func (o *DeleteDedicatedGroupRequest) SetDedicatedGroupId(v string) { + o.DedicatedGroupId = v +} + +// GetDryRun returns the DryRun field value if set, zero value otherwise. +func (o *DeleteDedicatedGroupRequest) GetDryRun() bool { + if o == nil || o.DryRun == nil { + var ret bool + return ret + } + return *o.DryRun +} + +// GetDryRunOk returns a tuple with the DryRun field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *DeleteDedicatedGroupRequest) GetDryRunOk() (*bool, bool) { + if o == nil || o.DryRun == nil { + return nil, false + } + return o.DryRun, true +} + +// HasDryRun returns a boolean if a field has been set. +func (o *DeleteDedicatedGroupRequest) HasDryRun() bool { + if o != nil && o.DryRun != nil { + return true + } + + return false +} + +// SetDryRun gets a reference to the given bool and assigns it to the DryRun field. +func (o *DeleteDedicatedGroupRequest) SetDryRun(v bool) { + o.DryRun = &v +} + +// GetForce returns the Force field value if set, zero value otherwise. +func (o *DeleteDedicatedGroupRequest) GetForce() bool { + if o == nil || o.Force == nil { + var ret bool + return ret + } + return *o.Force +} + +// GetForceOk returns a tuple with the Force field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *DeleteDedicatedGroupRequest) GetForceOk() (*bool, bool) { + if o == nil || o.Force == nil { + return nil, false + } + return o.Force, true +} + +// HasForce returns a boolean if a field has been set. +func (o *DeleteDedicatedGroupRequest) HasForce() bool { + if o != nil && o.Force != nil { + return true + } + + return false +} + +// SetForce gets a reference to the given bool and assigns it to the Force field. +func (o *DeleteDedicatedGroupRequest) SetForce(v bool) { + o.Force = &v +} + +func (o DeleteDedicatedGroupRequest) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["DedicatedGroupId"] = o.DedicatedGroupId + } + if o.DryRun != nil { + toSerialize["DryRun"] = o.DryRun + } + if o.Force != nil { + toSerialize["Force"] = o.Force + } + return json.Marshal(toSerialize) +} + +type NullableDeleteDedicatedGroupRequest struct { + value *DeleteDedicatedGroupRequest + isSet bool +} + +func (v NullableDeleteDedicatedGroupRequest) Get() *DeleteDedicatedGroupRequest { + return v.value +} + +func (v *NullableDeleteDedicatedGroupRequest) Set(val *DeleteDedicatedGroupRequest) { + v.value = val + v.isSet = true +} + +func (v NullableDeleteDedicatedGroupRequest) IsSet() bool { + return v.isSet +} + +func (v *NullableDeleteDedicatedGroupRequest) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableDeleteDedicatedGroupRequest(val *DeleteDedicatedGroupRequest) *NullableDeleteDedicatedGroupRequest { + return &NullableDeleteDedicatedGroupRequest{value: val, isSet: true} +} + +func (v NullableDeleteDedicatedGroupRequest) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableDeleteDedicatedGroupRequest) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_delete_dedicated_group_response.go b/v2/model_delete_dedicated_group_response.go new file mode 100644 index 000000000..905b76263 --- /dev/null +++ b/v2/model_delete_dedicated_group_response.go @@ -0,0 +1,114 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// DeleteDedicatedGroupResponse struct for DeleteDedicatedGroupResponse +type DeleteDedicatedGroupResponse struct { + ResponseContext *ResponseContext `json:"ResponseContext,omitempty"` +} + +// NewDeleteDedicatedGroupResponse instantiates a new DeleteDedicatedGroupResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewDeleteDedicatedGroupResponse() *DeleteDedicatedGroupResponse { + this := DeleteDedicatedGroupResponse{} + return &this +} + +// NewDeleteDedicatedGroupResponseWithDefaults instantiates a new DeleteDedicatedGroupResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewDeleteDedicatedGroupResponseWithDefaults() *DeleteDedicatedGroupResponse { + this := DeleteDedicatedGroupResponse{} + return &this +} + +// GetResponseContext returns the ResponseContext field value if set, zero value otherwise. +func (o *DeleteDedicatedGroupResponse) GetResponseContext() ResponseContext { + if o == nil || o.ResponseContext == nil { + var ret ResponseContext + return ret + } + return *o.ResponseContext +} + +// GetResponseContextOk returns a tuple with the ResponseContext field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *DeleteDedicatedGroupResponse) GetResponseContextOk() (*ResponseContext, bool) { + if o == nil || o.ResponseContext == nil { + return nil, false + } + return o.ResponseContext, true +} + +// HasResponseContext returns a boolean if a field has been set. +func (o *DeleteDedicatedGroupResponse) HasResponseContext() bool { + if o != nil && o.ResponseContext != nil { + return true + } + + return false +} + +// SetResponseContext gets a reference to the given ResponseContext and assigns it to the ResponseContext field. +func (o *DeleteDedicatedGroupResponse) SetResponseContext(v ResponseContext) { + o.ResponseContext = &v +} + +func (o DeleteDedicatedGroupResponse) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.ResponseContext != nil { + toSerialize["ResponseContext"] = o.ResponseContext + } + return json.Marshal(toSerialize) +} + +type NullableDeleteDedicatedGroupResponse struct { + value *DeleteDedicatedGroupResponse + isSet bool +} + +func (v NullableDeleteDedicatedGroupResponse) Get() *DeleteDedicatedGroupResponse { + return v.value +} + +func (v *NullableDeleteDedicatedGroupResponse) Set(val *DeleteDedicatedGroupResponse) { + v.value = val + v.isSet = true +} + +func (v NullableDeleteDedicatedGroupResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableDeleteDedicatedGroupResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableDeleteDedicatedGroupResponse(val *DeleteDedicatedGroupResponse) *NullableDeleteDedicatedGroupResponse { + return &NullableDeleteDedicatedGroupResponse{value: val, isSet: true} +} + +func (v NullableDeleteDedicatedGroupResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableDeleteDedicatedGroupResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_delete_dhcp_options_request.go b/v2/model_delete_dhcp_options_request.go index dfa69aa38..ef79f48e7 100644 --- a/v2/model_delete_dhcp_options_request.go +++ b/v2/model_delete_dhcp_options_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_dhcp_options_response.go b/v2/model_delete_dhcp_options_response.go index 8858d6fb3..d5994c3d5 100644 --- a/v2/model_delete_dhcp_options_response.go +++ b/v2/model_delete_dhcp_options_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_direct_link_interface_request.go b/v2/model_delete_direct_link_interface_request.go index 1ea5c8cc8..997845b4a 100644 --- a/v2/model_delete_direct_link_interface_request.go +++ b/v2/model_delete_direct_link_interface_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_direct_link_interface_response.go b/v2/model_delete_direct_link_interface_response.go index 63fd1b2f9..7cefe3f31 100644 --- a/v2/model_delete_direct_link_interface_response.go +++ b/v2/model_delete_direct_link_interface_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_direct_link_request.go b/v2/model_delete_direct_link_request.go index f3371df53..76ae5a9b7 100644 --- a/v2/model_delete_direct_link_request.go +++ b/v2/model_delete_direct_link_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_direct_link_response.go b/v2/model_delete_direct_link_response.go index ed95fbdcf..a16578117 100644 --- a/v2/model_delete_direct_link_response.go +++ b/v2/model_delete_direct_link_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_export_task_request.go b/v2/model_delete_export_task_request.go index eee826b8a..db8cf481a 100644 --- a/v2/model_delete_export_task_request.go +++ b/v2/model_delete_export_task_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_export_task_response.go b/v2/model_delete_export_task_response.go index 68498d760..5a67d0aa1 100644 --- a/v2/model_delete_export_task_response.go +++ b/v2/model_delete_export_task_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_flexible_gpu_request.go b/v2/model_delete_flexible_gpu_request.go index f96c8e330..908be51f4 100644 --- a/v2/model_delete_flexible_gpu_request.go +++ b/v2/model_delete_flexible_gpu_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_flexible_gpu_response.go b/v2/model_delete_flexible_gpu_response.go index d9d55e85b..57415b2f3 100644 --- a/v2/model_delete_flexible_gpu_response.go +++ b/v2/model_delete_flexible_gpu_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_image_request.go b/v2/model_delete_image_request.go index 1002075b9..b8d54cb05 100644 --- a/v2/model_delete_image_request.go +++ b/v2/model_delete_image_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_image_response.go b/v2/model_delete_image_response.go index 446879805..97b82f857 100644 --- a/v2/model_delete_image_response.go +++ b/v2/model_delete_image_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_internet_service_request.go b/v2/model_delete_internet_service_request.go index b9211a532..493aa36be 100644 --- a/v2/model_delete_internet_service_request.go +++ b/v2/model_delete_internet_service_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_internet_service_response.go b/v2/model_delete_internet_service_response.go index 31193d9a0..c89acb077 100644 --- a/v2/model_delete_internet_service_response.go +++ b/v2/model_delete_internet_service_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_keypair_request.go b/v2/model_delete_keypair_request.go index 5d2b90bdb..57def4b98 100644 --- a/v2/model_delete_keypair_request.go +++ b/v2/model_delete_keypair_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_keypair_response.go b/v2/model_delete_keypair_response.go index e1f207750..d985750c3 100644 --- a/v2/model_delete_keypair_response.go +++ b/v2/model_delete_keypair_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_listener_rule_request.go b/v2/model_delete_listener_rule_request.go index 5f6afeac7..ad6200d94 100644 --- a/v2/model_delete_listener_rule_request.go +++ b/v2/model_delete_listener_rule_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_listener_rule_response.go b/v2/model_delete_listener_rule_response.go index 26212f57a..e2d4e2a71 100644 --- a/v2/model_delete_listener_rule_response.go +++ b/v2/model_delete_listener_rule_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_load_balancer_listeners_request.go b/v2/model_delete_load_balancer_listeners_request.go index 90d4ed33a..507030175 100644 --- a/v2/model_delete_load_balancer_listeners_request.go +++ b/v2/model_delete_load_balancer_listeners_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_load_balancer_listeners_response.go b/v2/model_delete_load_balancer_listeners_response.go index 152e27a8e..21673a92e 100644 --- a/v2/model_delete_load_balancer_listeners_response.go +++ b/v2/model_delete_load_balancer_listeners_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_load_balancer_policy_request.go b/v2/model_delete_load_balancer_policy_request.go index 75c02f26c..ca1aad18d 100644 --- a/v2/model_delete_load_balancer_policy_request.go +++ b/v2/model_delete_load_balancer_policy_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_load_balancer_policy_response.go b/v2/model_delete_load_balancer_policy_response.go index 8f979b27e..24d4279fd 100644 --- a/v2/model_delete_load_balancer_policy_response.go +++ b/v2/model_delete_load_balancer_policy_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_load_balancer_request.go b/v2/model_delete_load_balancer_request.go index 31e14357a..f4712cd04 100644 --- a/v2/model_delete_load_balancer_request.go +++ b/v2/model_delete_load_balancer_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_load_balancer_response.go b/v2/model_delete_load_balancer_response.go index 75dbf24c0..8047d1766 100644 --- a/v2/model_delete_load_balancer_response.go +++ b/v2/model_delete_load_balancer_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_load_balancer_tags_request.go b/v2/model_delete_load_balancer_tags_request.go index 55c6e82e7..b8ab519c9 100644 --- a/v2/model_delete_load_balancer_tags_request.go +++ b/v2/model_delete_load_balancer_tags_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_load_balancer_tags_response.go b/v2/model_delete_load_balancer_tags_response.go index a6c71e0ed..df086fd68 100644 --- a/v2/model_delete_load_balancer_tags_response.go +++ b/v2/model_delete_load_balancer_tags_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_nat_service_request.go b/v2/model_delete_nat_service_request.go index 9992453dc..1cf4f5eb9 100644 --- a/v2/model_delete_nat_service_request.go +++ b/v2/model_delete_nat_service_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_nat_service_response.go b/v2/model_delete_nat_service_response.go index 586e0b0ef..5640ebe8f 100644 --- a/v2/model_delete_nat_service_response.go +++ b/v2/model_delete_nat_service_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_net_access_point_request.go b/v2/model_delete_net_access_point_request.go index 592b34d80..fd0b2cfba 100644 --- a/v2/model_delete_net_access_point_request.go +++ b/v2/model_delete_net_access_point_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_net_access_point_response.go b/v2/model_delete_net_access_point_response.go index 48ed39a46..2bf80c3aa 100644 --- a/v2/model_delete_net_access_point_response.go +++ b/v2/model_delete_net_access_point_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_net_peering_request.go b/v2/model_delete_net_peering_request.go index ae1bee1f3..98a13dc37 100644 --- a/v2/model_delete_net_peering_request.go +++ b/v2/model_delete_net_peering_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_net_peering_response.go b/v2/model_delete_net_peering_response.go index fa608b002..63f69b99f 100644 --- a/v2/model_delete_net_peering_response.go +++ b/v2/model_delete_net_peering_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_net_request.go b/v2/model_delete_net_request.go index e2ad300d2..4d3804117 100644 --- a/v2/model_delete_net_request.go +++ b/v2/model_delete_net_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_net_response.go b/v2/model_delete_net_response.go index f920fc9ed..84403492e 100644 --- a/v2/model_delete_net_response.go +++ b/v2/model_delete_net_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_nic_request.go b/v2/model_delete_nic_request.go index a8e90f6cc..0cbaeba81 100644 --- a/v2/model_delete_nic_request.go +++ b/v2/model_delete_nic_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_nic_response.go b/v2/model_delete_nic_response.go index 05ca50ed8..411340fc0 100644 --- a/v2/model_delete_nic_response.go +++ b/v2/model_delete_nic_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_policy_request.go b/v2/model_delete_policy_request.go new file mode 100644 index 000000000..3a08e963e --- /dev/null +++ b/v2/model_delete_policy_request.go @@ -0,0 +1,145 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// DeletePolicyRequest struct for DeletePolicyRequest +type DeletePolicyRequest struct { + // If true, checks whether you have the required permissions to perform the action. + DryRun *bool `json:"DryRun,omitempty"` + // 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). + PolicyOrn string `json:"PolicyOrn"` +} + +// NewDeletePolicyRequest instantiates a new DeletePolicyRequest object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewDeletePolicyRequest(policyOrn string) *DeletePolicyRequest { + this := DeletePolicyRequest{} + this.PolicyOrn = policyOrn + return &this +} + +// NewDeletePolicyRequestWithDefaults instantiates a new DeletePolicyRequest object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewDeletePolicyRequestWithDefaults() *DeletePolicyRequest { + this := DeletePolicyRequest{} + return &this +} + +// GetDryRun returns the DryRun field value if set, zero value otherwise. +func (o *DeletePolicyRequest) GetDryRun() bool { + if o == nil || o.DryRun == nil { + var ret bool + return ret + } + return *o.DryRun +} + +// GetDryRunOk returns a tuple with the DryRun field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *DeletePolicyRequest) GetDryRunOk() (*bool, bool) { + if o == nil || o.DryRun == nil { + return nil, false + } + return o.DryRun, true +} + +// HasDryRun returns a boolean if a field has been set. +func (o *DeletePolicyRequest) HasDryRun() bool { + if o != nil && o.DryRun != nil { + return true + } + + return false +} + +// SetDryRun gets a reference to the given bool and assigns it to the DryRun field. +func (o *DeletePolicyRequest) SetDryRun(v bool) { + o.DryRun = &v +} + +// GetPolicyOrn returns the PolicyOrn field value +func (o *DeletePolicyRequest) GetPolicyOrn() string { + if o == nil { + var ret string + return ret + } + + return o.PolicyOrn +} + +// GetPolicyOrnOk returns a tuple with the PolicyOrn field value +// and a boolean to check if the value has been set. +func (o *DeletePolicyRequest) GetPolicyOrnOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.PolicyOrn, true +} + +// SetPolicyOrn sets field value +func (o *DeletePolicyRequest) SetPolicyOrn(v string) { + o.PolicyOrn = v +} + +func (o DeletePolicyRequest) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.DryRun != nil { + toSerialize["DryRun"] = o.DryRun + } + if true { + toSerialize["PolicyOrn"] = o.PolicyOrn + } + return json.Marshal(toSerialize) +} + +type NullableDeletePolicyRequest struct { + value *DeletePolicyRequest + isSet bool +} + +func (v NullableDeletePolicyRequest) Get() *DeletePolicyRequest { + return v.value +} + +func (v *NullableDeletePolicyRequest) Set(val *DeletePolicyRequest) { + v.value = val + v.isSet = true +} + +func (v NullableDeletePolicyRequest) IsSet() bool { + return v.isSet +} + +func (v *NullableDeletePolicyRequest) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableDeletePolicyRequest(val *DeletePolicyRequest) *NullableDeletePolicyRequest { + return &NullableDeletePolicyRequest{value: val, isSet: true} +} + +func (v NullableDeletePolicyRequest) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableDeletePolicyRequest) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_delete_policy_response.go b/v2/model_delete_policy_response.go new file mode 100644 index 000000000..d0fc5062e --- /dev/null +++ b/v2/model_delete_policy_response.go @@ -0,0 +1,114 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// DeletePolicyResponse struct for DeletePolicyResponse +type DeletePolicyResponse struct { + ResponseContext *ResponseContext `json:"ResponseContext,omitempty"` +} + +// NewDeletePolicyResponse instantiates a new DeletePolicyResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewDeletePolicyResponse() *DeletePolicyResponse { + this := DeletePolicyResponse{} + return &this +} + +// NewDeletePolicyResponseWithDefaults instantiates a new DeletePolicyResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewDeletePolicyResponseWithDefaults() *DeletePolicyResponse { + this := DeletePolicyResponse{} + return &this +} + +// GetResponseContext returns the ResponseContext field value if set, zero value otherwise. +func (o *DeletePolicyResponse) GetResponseContext() ResponseContext { + if o == nil || o.ResponseContext == nil { + var ret ResponseContext + return ret + } + return *o.ResponseContext +} + +// GetResponseContextOk returns a tuple with the ResponseContext field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *DeletePolicyResponse) GetResponseContextOk() (*ResponseContext, bool) { + if o == nil || o.ResponseContext == nil { + return nil, false + } + return o.ResponseContext, true +} + +// HasResponseContext returns a boolean if a field has been set. +func (o *DeletePolicyResponse) HasResponseContext() bool { + if o != nil && o.ResponseContext != nil { + return true + } + + return false +} + +// SetResponseContext gets a reference to the given ResponseContext and assigns it to the ResponseContext field. +func (o *DeletePolicyResponse) SetResponseContext(v ResponseContext) { + o.ResponseContext = &v +} + +func (o DeletePolicyResponse) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.ResponseContext != nil { + toSerialize["ResponseContext"] = o.ResponseContext + } + return json.Marshal(toSerialize) +} + +type NullableDeletePolicyResponse struct { + value *DeletePolicyResponse + isSet bool +} + +func (v NullableDeletePolicyResponse) Get() *DeletePolicyResponse { + return v.value +} + +func (v *NullableDeletePolicyResponse) Set(val *DeletePolicyResponse) { + v.value = val + v.isSet = true +} + +func (v NullableDeletePolicyResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableDeletePolicyResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableDeletePolicyResponse(val *DeletePolicyResponse) *NullableDeletePolicyResponse { + return &NullableDeletePolicyResponse{value: val, isSet: true} +} + +func (v NullableDeletePolicyResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableDeletePolicyResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_delete_policy_version_request.go b/v2/model_delete_policy_version_request.go new file mode 100644 index 000000000..62f920b15 --- /dev/null +++ b/v2/model_delete_policy_version_request.go @@ -0,0 +1,138 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// DeletePolicyVersionRequest struct for DeletePolicyVersionRequest +type DeletePolicyVersionRequest struct { + // The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + PolicyOrn string `json:"PolicyOrn"` + // The ID of the version of the policy you want to delete. + VersionId string `json:"VersionId"` +} + +// NewDeletePolicyVersionRequest instantiates a new DeletePolicyVersionRequest object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewDeletePolicyVersionRequest(policyOrn string, versionId string) *DeletePolicyVersionRequest { + this := DeletePolicyVersionRequest{} + this.PolicyOrn = policyOrn + this.VersionId = versionId + return &this +} + +// NewDeletePolicyVersionRequestWithDefaults instantiates a new DeletePolicyVersionRequest object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewDeletePolicyVersionRequestWithDefaults() *DeletePolicyVersionRequest { + this := DeletePolicyVersionRequest{} + return &this +} + +// GetPolicyOrn returns the PolicyOrn field value +func (o *DeletePolicyVersionRequest) GetPolicyOrn() string { + if o == nil { + var ret string + return ret + } + + return o.PolicyOrn +} + +// GetPolicyOrnOk returns a tuple with the PolicyOrn field value +// and a boolean to check if the value has been set. +func (o *DeletePolicyVersionRequest) GetPolicyOrnOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.PolicyOrn, true +} + +// SetPolicyOrn sets field value +func (o *DeletePolicyVersionRequest) SetPolicyOrn(v string) { + o.PolicyOrn = v +} + +// GetVersionId returns the VersionId field value +func (o *DeletePolicyVersionRequest) GetVersionId() string { + if o == nil { + var ret string + return ret + } + + return o.VersionId +} + +// GetVersionIdOk returns a tuple with the VersionId field value +// and a boolean to check if the value has been set. +func (o *DeletePolicyVersionRequest) GetVersionIdOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.VersionId, true +} + +// SetVersionId sets field value +func (o *DeletePolicyVersionRequest) SetVersionId(v string) { + o.VersionId = v +} + +func (o DeletePolicyVersionRequest) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["PolicyOrn"] = o.PolicyOrn + } + if true { + toSerialize["VersionId"] = o.VersionId + } + return json.Marshal(toSerialize) +} + +type NullableDeletePolicyVersionRequest struct { + value *DeletePolicyVersionRequest + isSet bool +} + +func (v NullableDeletePolicyVersionRequest) Get() *DeletePolicyVersionRequest { + return v.value +} + +func (v *NullableDeletePolicyVersionRequest) Set(val *DeletePolicyVersionRequest) { + v.value = val + v.isSet = true +} + +func (v NullableDeletePolicyVersionRequest) IsSet() bool { + return v.isSet +} + +func (v *NullableDeletePolicyVersionRequest) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableDeletePolicyVersionRequest(val *DeletePolicyVersionRequest) *NullableDeletePolicyVersionRequest { + return &NullableDeletePolicyVersionRequest{value: val, isSet: true} +} + +func (v NullableDeletePolicyVersionRequest) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableDeletePolicyVersionRequest) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_delete_policy_version_response.go b/v2/model_delete_policy_version_response.go new file mode 100644 index 000000000..284896630 --- /dev/null +++ b/v2/model_delete_policy_version_response.go @@ -0,0 +1,114 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// DeletePolicyVersionResponse struct for DeletePolicyVersionResponse +type DeletePolicyVersionResponse struct { + ResponseContext *ResponseContext `json:"ResponseContext,omitempty"` +} + +// NewDeletePolicyVersionResponse instantiates a new DeletePolicyVersionResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewDeletePolicyVersionResponse() *DeletePolicyVersionResponse { + this := DeletePolicyVersionResponse{} + return &this +} + +// NewDeletePolicyVersionResponseWithDefaults instantiates a new DeletePolicyVersionResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewDeletePolicyVersionResponseWithDefaults() *DeletePolicyVersionResponse { + this := DeletePolicyVersionResponse{} + return &this +} + +// GetResponseContext returns the ResponseContext field value if set, zero value otherwise. +func (o *DeletePolicyVersionResponse) GetResponseContext() ResponseContext { + if o == nil || o.ResponseContext == nil { + var ret ResponseContext + return ret + } + return *o.ResponseContext +} + +// GetResponseContextOk returns a tuple with the ResponseContext field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *DeletePolicyVersionResponse) GetResponseContextOk() (*ResponseContext, bool) { + if o == nil || o.ResponseContext == nil { + return nil, false + } + return o.ResponseContext, true +} + +// HasResponseContext returns a boolean if a field has been set. +func (o *DeletePolicyVersionResponse) HasResponseContext() bool { + if o != nil && o.ResponseContext != nil { + return true + } + + return false +} + +// SetResponseContext gets a reference to the given ResponseContext and assigns it to the ResponseContext field. +func (o *DeletePolicyVersionResponse) SetResponseContext(v ResponseContext) { + o.ResponseContext = &v +} + +func (o DeletePolicyVersionResponse) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.ResponseContext != nil { + toSerialize["ResponseContext"] = o.ResponseContext + } + return json.Marshal(toSerialize) +} + +type NullableDeletePolicyVersionResponse struct { + value *DeletePolicyVersionResponse + isSet bool +} + +func (v NullableDeletePolicyVersionResponse) Get() *DeletePolicyVersionResponse { + return v.value +} + +func (v *NullableDeletePolicyVersionResponse) Set(val *DeletePolicyVersionResponse) { + v.value = val + v.isSet = true +} + +func (v NullableDeletePolicyVersionResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableDeletePolicyVersionResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableDeletePolicyVersionResponse(val *DeletePolicyVersionResponse) *NullableDeletePolicyVersionResponse { + return &NullableDeletePolicyVersionResponse{value: val, isSet: true} +} + +func (v NullableDeletePolicyVersionResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableDeletePolicyVersionResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_delete_public_ip_request.go b/v2/model_delete_public_ip_request.go index 51be527fe..f2292e561 100644 --- a/v2/model_delete_public_ip_request.go +++ b/v2/model_delete_public_ip_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_public_ip_response.go b/v2/model_delete_public_ip_response.go index 3d125a01d..b64f326e6 100644 --- a/v2/model_delete_public_ip_response.go +++ b/v2/model_delete_public_ip_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_route_request.go b/v2/model_delete_route_request.go index 6b3c6ad9d..0f4dad113 100644 --- a/v2/model_delete_route_request.go +++ b/v2/model_delete_route_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_route_response.go b/v2/model_delete_route_response.go index fe0535ca5..7f1043b71 100644 --- a/v2/model_delete_route_response.go +++ b/v2/model_delete_route_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_route_table_request.go b/v2/model_delete_route_table_request.go index c52745c0c..18d1f6223 100644 --- a/v2/model_delete_route_table_request.go +++ b/v2/model_delete_route_table_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_route_table_response.go b/v2/model_delete_route_table_response.go index 7dee34ddd..09591708d 100644 --- a/v2/model_delete_route_table_response.go +++ b/v2/model_delete_route_table_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_security_group_request.go b/v2/model_delete_security_group_request.go index d448d8716..f1af38b52 100644 --- a/v2/model_delete_security_group_request.go +++ b/v2/model_delete_security_group_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_security_group_response.go b/v2/model_delete_security_group_response.go index e3c1baae9..16c4f4554 100644 --- a/v2/model_delete_security_group_response.go +++ b/v2/model_delete_security_group_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_security_group_rule_request.go b/v2/model_delete_security_group_rule_request.go index 090d1e3d1..1bc40f4ce 100644 --- a/v2/model_delete_security_group_rule_request.go +++ b/v2/model_delete_security_group_rule_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_security_group_rule_response.go b/v2/model_delete_security_group_rule_response.go index 871f01b92..cdf2b424a 100644 --- a/v2/model_delete_security_group_rule_response.go +++ b/v2/model_delete_security_group_rule_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_server_certificate_request.go b/v2/model_delete_server_certificate_request.go index a3b01853e..0bd29fc2b 100644 --- a/v2/model_delete_server_certificate_request.go +++ b/v2/model_delete_server_certificate_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_server_certificate_response.go b/v2/model_delete_server_certificate_response.go index e570185ec..5347b7cb2 100644 --- a/v2/model_delete_server_certificate_response.go +++ b/v2/model_delete_server_certificate_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_snapshot_request.go b/v2/model_delete_snapshot_request.go index 2ebbcdd26..e63106db7 100644 --- a/v2/model_delete_snapshot_request.go +++ b/v2/model_delete_snapshot_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_snapshot_response.go b/v2/model_delete_snapshot_response.go index 5e38eaf77..ae29cb6b8 100644 --- a/v2/model_delete_snapshot_response.go +++ b/v2/model_delete_snapshot_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_subnet_request.go b/v2/model_delete_subnet_request.go index 68778bd57..83549e6cc 100644 --- a/v2/model_delete_subnet_request.go +++ b/v2/model_delete_subnet_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_subnet_response.go b/v2/model_delete_subnet_response.go index 2968c3ce7..cb6f030a5 100644 --- a/v2/model_delete_subnet_response.go +++ b/v2/model_delete_subnet_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_tags_request.go b/v2/model_delete_tags_request.go index 69749b566..74a3fb4a7 100644 --- a/v2/model_delete_tags_request.go +++ b/v2/model_delete_tags_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_tags_response.go b/v2/model_delete_tags_response.go index c315896ca..16a7d0b6a 100644 --- a/v2/model_delete_tags_response.go +++ b/v2/model_delete_tags_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_user_request.go b/v2/model_delete_user_request.go index a8c83d0e7..d144f16d2 100644 --- a/v2/model_delete_user_request.go +++ b/v2/model_delete_user_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_user_response.go b/v2/model_delete_user_response.go index 1dc74dd89..793305b41 100644 --- a/v2/model_delete_user_response.go +++ b/v2/model_delete_user_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_virtual_gateway_request.go b/v2/model_delete_virtual_gateway_request.go index a8020b226..eb01f0406 100644 --- a/v2/model_delete_virtual_gateway_request.go +++ b/v2/model_delete_virtual_gateway_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_virtual_gateway_response.go b/v2/model_delete_virtual_gateway_response.go index dabdc39a7..2e809e71a 100644 --- a/v2/model_delete_virtual_gateway_response.go +++ b/v2/model_delete_virtual_gateway_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_vm_group_request.go b/v2/model_delete_vm_group_request.go index 8d9443007..043f15771 100644 --- a/v2/model_delete_vm_group_request.go +++ b/v2/model_delete_vm_group_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_vm_group_response.go b/v2/model_delete_vm_group_response.go index deba6f88e..94909de31 100644 --- a/v2/model_delete_vm_group_response.go +++ b/v2/model_delete_vm_group_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_vm_template_request.go b/v2/model_delete_vm_template_request.go index c1b6e0a0c..95a61b25d 100644 --- a/v2/model_delete_vm_template_request.go +++ b/v2/model_delete_vm_template_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_vm_template_response.go b/v2/model_delete_vm_template_response.go index 60a4aa3f9..29a1366e0 100644 --- a/v2/model_delete_vm_template_response.go +++ b/v2/model_delete_vm_template_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_vms_request.go b/v2/model_delete_vms_request.go index 449d38879..7353ecf8f 100644 --- a/v2/model_delete_vms_request.go +++ b/v2/model_delete_vms_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_vms_response.go b/v2/model_delete_vms_response.go index 03db01de6..810e817ee 100644 --- a/v2/model_delete_vms_response.go +++ b/v2/model_delete_vms_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_volume_request.go b/v2/model_delete_volume_request.go index cfdf343d5..c5b204d34 100644 --- a/v2/model_delete_volume_request.go +++ b/v2/model_delete_volume_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_volume_response.go b/v2/model_delete_volume_response.go index 4b2e8921e..c6297f691 100644 --- a/v2/model_delete_volume_response.go +++ b/v2/model_delete_volume_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_vpn_connection_request.go b/v2/model_delete_vpn_connection_request.go index 75a990e2a..92e2a78aa 100644 --- a/v2/model_delete_vpn_connection_request.go +++ b/v2/model_delete_vpn_connection_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_vpn_connection_response.go b/v2/model_delete_vpn_connection_response.go index 1296dcc34..5d5550a49 100644 --- a/v2/model_delete_vpn_connection_response.go +++ b/v2/model_delete_vpn_connection_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_vpn_connection_route_request.go b/v2/model_delete_vpn_connection_route_request.go index d8bd56286..a9c94a275 100644 --- a/v2/model_delete_vpn_connection_route_request.go +++ b/v2/model_delete_vpn_connection_route_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_delete_vpn_connection_route_response.go b/v2/model_delete_vpn_connection_route_response.go index 15a6ee693..2c1de7d77 100644 --- a/v2/model_delete_vpn_connection_route_response.go +++ b/v2/model_delete_vpn_connection_route_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_deregister_vms_in_load_balancer_request.go b/v2/model_deregister_vms_in_load_balancer_request.go index 88f481210..a39b21f94 100644 --- a/v2/model_deregister_vms_in_load_balancer_request.go +++ b/v2/model_deregister_vms_in_load_balancer_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_deregister_vms_in_load_balancer_response.go b/v2/model_deregister_vms_in_load_balancer_response.go index 3e46a75bb..1908d150a 100644 --- a/v2/model_deregister_vms_in_load_balancer_response.go +++ b/v2/model_deregister_vms_in_load_balancer_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_dhcp_options_set.go b/v2/model_dhcp_options_set.go index d781967ad..16eef7b27 100644 --- a/v2/model_dhcp_options_set.go +++ b/v2/model_dhcp_options_set.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_direct_link.go b/v2/model_direct_link.go index 2c95245d7..2d8c02b46 100644 --- a/v2/model_direct_link.go +++ b/v2/model_direct_link.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_direct_link_interface.go b/v2/model_direct_link_interface.go index 876c302fe..2d2dca43b 100644 --- a/v2/model_direct_link_interface.go +++ b/v2/model_direct_link_interface.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -29,7 +29,7 @@ type DirectLinkInterface struct { OutscalePrivateIp *string `json:"OutscalePrivateIp,omitempty"` // The ID of the target virtual gateway. VirtualGatewayId string `json:"VirtualGatewayId"` - // The VLAN number associated with the DirectLink interface. + // The VLAN number associated with the DirectLink interface. This number must be unique and be between `2` and `4094`. Vlan int32 `json:"Vlan"` } diff --git a/v2/model_direct_link_interfaces.go b/v2/model_direct_link_interfaces.go index dcb1fb991..d1d964da0 100644 --- a/v2/model_direct_link_interfaces.go +++ b/v2/model_direct_link_interfaces.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_error_response.go b/v2/model_error_response.go index 50504fcc7..95a552a80 100644 --- a/v2/model_error_response.go +++ b/v2/model_error_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_errors.go b/v2/model_errors.go index 521d2a4cd..5a44f9799 100644 --- a/v2/model_errors.go +++ b/v2/model_errors.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_filters_access_keys.go b/v2/model_filters_access_keys.go index ed82102d1..e5dfe95fe 100644 --- a/v2/model_filters_access_keys.go +++ b/v2/model_filters_access_keys.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_filters_api_access_rule.go b/v2/model_filters_api_access_rule.go index 67c30f84e..ce334aaed 100644 --- a/v2/model_filters_api_access_rule.go +++ b/v2/model_filters_api_access_rule.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_filters_api_log.go b/v2/model_filters_api_log.go index 487a0683b..6b2424707 100644 --- a/v2/model_filters_api_log.go +++ b/v2/model_filters_api_log.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_filters_ca.go b/v2/model_filters_ca.go index 4c533b09a..d8e55d02d 100644 --- a/v2/model_filters_ca.go +++ b/v2/model_filters_ca.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_filters_catalogs.go b/v2/model_filters_catalogs.go index 9b29399e9..1f7348c50 100644 --- a/v2/model_filters_catalogs.go +++ b/v2/model_filters_catalogs.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_filters_client_gateway.go b/v2/model_filters_client_gateway.go index d98c7e4a7..f59674c66 100644 --- a/v2/model_filters_client_gateway.go +++ b/v2/model_filters_client_gateway.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_filters_dedicated_group.go b/v2/model_filters_dedicated_group.go new file mode 100644 index 000000000..a78df58b2 --- /dev/null +++ b/v2/model_filters_dedicated_group.go @@ -0,0 +1,226 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// FiltersDedicatedGroup One or more filters. +type FiltersDedicatedGroup struct { + // The processor generation for the VMs in the dedicated group (for example, `4`). + CpuGenerations *[]int32 `json:"CpuGenerations,omitempty"` + // The IDs of the dedicated groups. + DedicatedGroupIds *[]string `json:"DedicatedGroupIds,omitempty"` + // The names of the dedicated groups. + Names *[]string `json:"Names,omitempty"` + // The names of the Subregions in which the dedicated groups are located. + SubregionNames *[]string `json:"SubregionNames,omitempty"` +} + +// NewFiltersDedicatedGroup instantiates a new FiltersDedicatedGroup object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewFiltersDedicatedGroup() *FiltersDedicatedGroup { + this := FiltersDedicatedGroup{} + return &this +} + +// NewFiltersDedicatedGroupWithDefaults instantiates a new FiltersDedicatedGroup object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewFiltersDedicatedGroupWithDefaults() *FiltersDedicatedGroup { + this := FiltersDedicatedGroup{} + return &this +} + +// GetCpuGenerations returns the CpuGenerations field value if set, zero value otherwise. +func (o *FiltersDedicatedGroup) GetCpuGenerations() []int32 { + if o == nil || o.CpuGenerations == nil { + var ret []int32 + return ret + } + return *o.CpuGenerations +} + +// GetCpuGenerationsOk returns a tuple with the CpuGenerations field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersDedicatedGroup) GetCpuGenerationsOk() (*[]int32, bool) { + if o == nil || o.CpuGenerations == nil { + return nil, false + } + return o.CpuGenerations, true +} + +// HasCpuGenerations returns a boolean if a field has been set. +func (o *FiltersDedicatedGroup) HasCpuGenerations() bool { + if o != nil && o.CpuGenerations != nil { + return true + } + + return false +} + +// SetCpuGenerations gets a reference to the given []int32 and assigns it to the CpuGenerations field. +func (o *FiltersDedicatedGroup) SetCpuGenerations(v []int32) { + o.CpuGenerations = &v +} + +// GetDedicatedGroupIds returns the DedicatedGroupIds field value if set, zero value otherwise. +func (o *FiltersDedicatedGroup) GetDedicatedGroupIds() []string { + if o == nil || o.DedicatedGroupIds == nil { + var ret []string + return ret + } + return *o.DedicatedGroupIds +} + +// GetDedicatedGroupIdsOk returns a tuple with the DedicatedGroupIds field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersDedicatedGroup) GetDedicatedGroupIdsOk() (*[]string, bool) { + if o == nil || o.DedicatedGroupIds == nil { + return nil, false + } + return o.DedicatedGroupIds, true +} + +// HasDedicatedGroupIds returns a boolean if a field has been set. +func (o *FiltersDedicatedGroup) HasDedicatedGroupIds() bool { + if o != nil && o.DedicatedGroupIds != nil { + return true + } + + return false +} + +// SetDedicatedGroupIds gets a reference to the given []string and assigns it to the DedicatedGroupIds field. +func (o *FiltersDedicatedGroup) SetDedicatedGroupIds(v []string) { + o.DedicatedGroupIds = &v +} + +// GetNames returns the Names field value if set, zero value otherwise. +func (o *FiltersDedicatedGroup) GetNames() []string { + if o == nil || o.Names == nil { + var ret []string + return ret + } + return *o.Names +} + +// GetNamesOk returns a tuple with the Names field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersDedicatedGroup) GetNamesOk() (*[]string, bool) { + if o == nil || o.Names == nil { + return nil, false + } + return o.Names, true +} + +// HasNames returns a boolean if a field has been set. +func (o *FiltersDedicatedGroup) HasNames() bool { + if o != nil && o.Names != nil { + return true + } + + return false +} + +// SetNames gets a reference to the given []string and assigns it to the Names field. +func (o *FiltersDedicatedGroup) SetNames(v []string) { + o.Names = &v +} + +// GetSubregionNames returns the SubregionNames field value if set, zero value otherwise. +func (o *FiltersDedicatedGroup) GetSubregionNames() []string { + if o == nil || o.SubregionNames == nil { + var ret []string + return ret + } + return *o.SubregionNames +} + +// GetSubregionNamesOk returns a tuple with the SubregionNames field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersDedicatedGroup) GetSubregionNamesOk() (*[]string, bool) { + if o == nil || o.SubregionNames == nil { + return nil, false + } + return o.SubregionNames, true +} + +// HasSubregionNames returns a boolean if a field has been set. +func (o *FiltersDedicatedGroup) HasSubregionNames() bool { + if o != nil && o.SubregionNames != nil { + return true + } + + return false +} + +// SetSubregionNames gets a reference to the given []string and assigns it to the SubregionNames field. +func (o *FiltersDedicatedGroup) SetSubregionNames(v []string) { + o.SubregionNames = &v +} + +func (o FiltersDedicatedGroup) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.CpuGenerations != nil { + toSerialize["CpuGenerations"] = o.CpuGenerations + } + if o.DedicatedGroupIds != nil { + toSerialize["DedicatedGroupIds"] = o.DedicatedGroupIds + } + if o.Names != nil { + toSerialize["Names"] = o.Names + } + if o.SubregionNames != nil { + toSerialize["SubregionNames"] = o.SubregionNames + } + return json.Marshal(toSerialize) +} + +type NullableFiltersDedicatedGroup struct { + value *FiltersDedicatedGroup + isSet bool +} + +func (v NullableFiltersDedicatedGroup) Get() *FiltersDedicatedGroup { + return v.value +} + +func (v *NullableFiltersDedicatedGroup) Set(val *FiltersDedicatedGroup) { + v.value = val + v.isSet = true +} + +func (v NullableFiltersDedicatedGroup) IsSet() bool { + return v.isSet +} + +func (v *NullableFiltersDedicatedGroup) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableFiltersDedicatedGroup(val *FiltersDedicatedGroup) *NullableFiltersDedicatedGroup { + return &NullableFiltersDedicatedGroup{value: val, isSet: true} +} + +func (v NullableFiltersDedicatedGroup) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableFiltersDedicatedGroup) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_filters_dhcp_options.go b/v2/model_filters_dhcp_options.go index 9a8e61d19..d4394cfa7 100644 --- a/v2/model_filters_dhcp_options.go +++ b/v2/model_filters_dhcp_options.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_filters_direct_link.go b/v2/model_filters_direct_link.go index 8fbaa9789..6d642931d 100644 --- a/v2/model_filters_direct_link.go +++ b/v2/model_filters_direct_link.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_filters_direct_link_interface.go b/v2/model_filters_direct_link_interface.go index 1ada29bbe..77b066586 100644 --- a/v2/model_filters_direct_link_interface.go +++ b/v2/model_filters_direct_link_interface.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_filters_export_task.go b/v2/model_filters_export_task.go index 19cc2a384..617b9821b 100644 --- a/v2/model_filters_export_task.go +++ b/v2/model_filters_export_task.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_filters_flexible_gpu.go b/v2/model_filters_flexible_gpu.go index 396b68b35..87a5a8253 100644 --- a/v2/model_filters_flexible_gpu.go +++ b/v2/model_filters_flexible_gpu.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_filters_image.go b/v2/model_filters_image.go index 8e89fdb69..fc678d68d 100644 --- a/v2/model_filters_image.go +++ b/v2/model_filters_image.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -43,15 +43,17 @@ type FiltersImage struct { ImageIds *[]string `json:"ImageIds,omitempty"` // The names of the OMIs, provided when they were created. ImageNames *[]string `json:"ImageNames,omitempty"` - // The account IDs of the users who have launch permissions for the OMIs. + // The account IDs which have launch permissions for the OMIs. PermissionsToLaunchAccountIds *[]string `json:"PermissionsToLaunchAccountIds,omitempty"` // If true, lists all public OMIs. If false, lists all private OMIs. PermissionsToLaunchGlobalPermission *bool `json:"PermissionsToLaunchGlobalPermission,omitempty"` + // The names of the product codes associated with the OMI. + ProductCodeNames *[]string `json:"ProductCodeNames,omitempty"` // The product codes associated with the OMI. ProductCodes *[]string `json:"ProductCodes,omitempty"` // The name of the root device. This value must be /dev/sda1. RootDeviceNames *[]string `json:"RootDeviceNames,omitempty"` - // The types of root device used by the OMIs (always `bsu`). + // The types of root device used by the OMIs (`bsu` or `ebs`). RootDeviceTypes *[]string `json:"RootDeviceTypes,omitempty"` // The states of the OMIs (`pending` \\| `available` \\| `failed`). States *[]string `json:"States,omitempty"` @@ -562,6 +564,38 @@ func (o *FiltersImage) SetPermissionsToLaunchGlobalPermission(v bool) { o.PermissionsToLaunchGlobalPermission = &v } +// GetProductCodeNames returns the ProductCodeNames field value if set, zero value otherwise. +func (o *FiltersImage) GetProductCodeNames() []string { + if o == nil || o.ProductCodeNames == nil { + var ret []string + return ret + } + return *o.ProductCodeNames +} + +// GetProductCodeNamesOk returns a tuple with the ProductCodeNames field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersImage) GetProductCodeNamesOk() (*[]string, bool) { + if o == nil || o.ProductCodeNames == nil { + return nil, false + } + return o.ProductCodeNames, true +} + +// HasProductCodeNames returns a boolean if a field has been set. +func (o *FiltersImage) HasProductCodeNames() bool { + if o != nil && o.ProductCodeNames != nil { + return true + } + + return false +} + +// SetProductCodeNames gets a reference to the given []string and assigns it to the ProductCodeNames field. +func (o *FiltersImage) SetProductCodeNames(v []string) { + o.ProductCodeNames = &v +} + // GetProductCodes returns the ProductCodes field value if set, zero value otherwise. func (o *FiltersImage) GetProductCodes() []string { if o == nil || o.ProductCodes == nil { @@ -865,6 +899,9 @@ func (o FiltersImage) MarshalJSON() ([]byte, error) { if o.PermissionsToLaunchGlobalPermission != nil { toSerialize["PermissionsToLaunchGlobalPermission"] = o.PermissionsToLaunchGlobalPermission } + if o.ProductCodeNames != nil { + toSerialize["ProductCodeNames"] = o.ProductCodeNames + } if o.ProductCodes != nil { toSerialize["ProductCodes"] = o.ProductCodes } diff --git a/v2/model_filters_internet_service.go b/v2/model_filters_internet_service.go index dfe59d1ab..c9a90e9e2 100644 --- a/v2/model_filters_internet_service.go +++ b/v2/model_filters_internet_service.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -21,7 +21,7 @@ type FiltersInternetService struct { InternetServiceIds *[]string `json:"InternetServiceIds,omitempty"` // The IDs of the Nets the Internet services are attached to. LinkNetIds *[]string `json:"LinkNetIds,omitempty"` - // The current states of the attachments between the Internet services and the Nets (only `available`, if the Internet gateway is attached to a VPC). + // The current states of the attachments between the Internet services and the Nets (only `available`, if the Internet gateway is attached to a Net). LinkStates *[]string `json:"LinkStates,omitempty"` // The keys of the tags associated with the Internet services. TagKeys *[]string `json:"TagKeys,omitempty"` diff --git a/v2/model_filters_keypair.go b/v2/model_filters_keypair.go index 298ecba7e..8ecfa3e65 100644 --- a/v2/model_filters_keypair.go +++ b/v2/model_filters_keypair.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -21,6 +21,8 @@ type FiltersKeypair struct { KeypairFingerprints *[]string `json:"KeypairFingerprints,omitempty"` // The names of the keypairs. KeypairNames *[]string `json:"KeypairNames,omitempty"` + // The types of the keypairs (`ssh-rsa`, `ssh-ed25519`, `ecdsa-sha2-nistp256`, `ecdsa-sha2-nistp384`, or `ecdsa-sha2-nistp521`). + KeypairTypes *[]string `json:"KeypairTypes,omitempty"` } // NewFiltersKeypair instantiates a new FiltersKeypair object @@ -104,6 +106,38 @@ func (o *FiltersKeypair) SetKeypairNames(v []string) { o.KeypairNames = &v } +// GetKeypairTypes returns the KeypairTypes field value if set, zero value otherwise. +func (o *FiltersKeypair) GetKeypairTypes() []string { + if o == nil || o.KeypairTypes == nil { + var ret []string + return ret + } + return *o.KeypairTypes +} + +// GetKeypairTypesOk returns a tuple with the KeypairTypes field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersKeypair) GetKeypairTypesOk() (*[]string, bool) { + if o == nil || o.KeypairTypes == nil { + return nil, false + } + return o.KeypairTypes, true +} + +// HasKeypairTypes returns a boolean if a field has been set. +func (o *FiltersKeypair) HasKeypairTypes() bool { + if o != nil && o.KeypairTypes != nil { + return true + } + + return false +} + +// SetKeypairTypes gets a reference to the given []string and assigns it to the KeypairTypes field. +func (o *FiltersKeypair) SetKeypairTypes(v []string) { + o.KeypairTypes = &v +} + func (o FiltersKeypair) MarshalJSON() ([]byte, error) { toSerialize := map[string]interface{}{} if o.KeypairFingerprints != nil { @@ -112,6 +146,9 @@ func (o FiltersKeypair) MarshalJSON() ([]byte, error) { if o.KeypairNames != nil { toSerialize["KeypairNames"] = o.KeypairNames } + if o.KeypairTypes != nil { + toSerialize["KeypairTypes"] = o.KeypairTypes + } return json.Marshal(toSerialize) } diff --git a/v2/model_filters_listener_rule.go b/v2/model_filters_listener_rule.go index e8676b17a..7f00cbfcc 100644 --- a/v2/model_filters_listener_rule.go +++ b/v2/model_filters_listener_rule.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_filters_load_balancer.go b/v2/model_filters_load_balancer.go index b68fe81f1..69d7a86fa 100644 --- a/v2/model_filters_load_balancer.go +++ b/v2/model_filters_load_balancer.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_filters_nat_service.go b/v2/model_filters_nat_service.go index 065f7e622..7770f02d2 100644 --- a/v2/model_filters_nat_service.go +++ b/v2/model_filters_nat_service.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_filters_net.go b/v2/model_filters_net.go index 4bd6689ea..c40f06c97 100644 --- a/v2/model_filters_net.go +++ b/v2/model_filters_net.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -25,7 +25,7 @@ type FiltersNet struct { IsDefault *bool `json:"IsDefault,omitempty"` // The IDs of the Nets. NetIds *[]string `json:"NetIds,omitempty"` - // The states of the Nets (`pending` \\| `available` \\| `deleted`). + // The states of the Nets (`pending` \\| `available` \\| `deleting`). States *[]string `json:"States,omitempty"` // The keys of the tags associated with the Nets. TagKeys *[]string `json:"TagKeys,omitempty"` diff --git a/v2/model_filters_net_access_point.go b/v2/model_filters_net_access_point.go index 7934b6bbc..aa515ed53 100644 --- a/v2/model_filters_net_access_point.go +++ b/v2/model_filters_net_access_point.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_filters_net_peering.go b/v2/model_filters_net_peering.go index 0926a35dd..0959fb476 100644 --- a/v2/model_filters_net_peering.go +++ b/v2/model_filters_net_peering.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -13,6 +13,7 @@ package osc import ( "encoding/json" + "time" ) // FiltersNetPeering One or more filters. @@ -23,6 +24,8 @@ type FiltersNetPeering struct { AccepterNetIpRanges *[]string `json:"AccepterNetIpRanges,omitempty"` // The IDs of the peer Nets. AccepterNetNetIds *[]string `json:"AccepterNetNetIds,omitempty"` + // The dates and times at which the Net peerings expire, in ISO 8601 date-time format (for example, `2020-06-14T00:00:00.000Z`). + ExpirationDates *[]time.Time `json:"ExpirationDates,omitempty"` // The IDs of the Net peerings. NetPeeringIds *[]string `json:"NetPeeringIds,omitempty"` // The account IDs of the owners of the peer Nets. @@ -156,6 +159,38 @@ func (o *FiltersNetPeering) SetAccepterNetNetIds(v []string) { o.AccepterNetNetIds = &v } +// GetExpirationDates returns the ExpirationDates field value if set, zero value otherwise. +func (o *FiltersNetPeering) GetExpirationDates() []time.Time { + if o == nil || o.ExpirationDates == nil { + var ret []time.Time + return ret + } + return *o.ExpirationDates +} + +// GetExpirationDatesOk returns a tuple with the ExpirationDates field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersNetPeering) GetExpirationDatesOk() (*[]time.Time, bool) { + if o == nil || o.ExpirationDates == nil { + return nil, false + } + return o.ExpirationDates, true +} + +// HasExpirationDates returns a boolean if a field has been set. +func (o *FiltersNetPeering) HasExpirationDates() bool { + if o != nil && o.ExpirationDates != nil { + return true + } + + return false +} + +// SetExpirationDates gets a reference to the given []time.Time and assigns it to the ExpirationDates field. +func (o *FiltersNetPeering) SetExpirationDates(v []time.Time) { + o.ExpirationDates = &v +} + // GetNetPeeringIds returns the NetPeeringIds field value if set, zero value otherwise. func (o *FiltersNetPeering) GetNetPeeringIds() []string { if o == nil || o.NetPeeringIds == nil { @@ -455,6 +490,9 @@ func (o FiltersNetPeering) MarshalJSON() ([]byte, error) { if o.AccepterNetNetIds != nil { toSerialize["AccepterNetNetIds"] = o.AccepterNetNetIds } + if o.ExpirationDates != nil { + toSerialize["ExpirationDates"] = o.ExpirationDates + } if o.NetPeeringIds != nil { toSerialize["NetPeeringIds"] = o.NetPeeringIds } diff --git a/v2/model_filters_nic.go b/v2/model_filters_nic.go index 266d1ec50..1fd799322 100644 --- a/v2/model_filters_nic.go +++ b/v2/model_filters_nic.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_filters_product_type.go b/v2/model_filters_product_type.go index cff1432bc..5ee8b7e4b 100644 --- a/v2/model_filters_product_type.go +++ b/v2/model_filters_product_type.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_filters_public_ip.go b/v2/model_filters_public_ip.go index 050cba0f5..1ee05e593 100644 --- a/v2/model_filters_public_ip.go +++ b/v2/model_filters_public_ip.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_filters_quota.go b/v2/model_filters_quota.go index 4811a418b..e1e1b3c86 100644 --- a/v2/model_filters_quota.go +++ b/v2/model_filters_quota.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_filters_route_table.go b/v2/model_filters_route_table.go index 4bc5fe8cb..c55c65c6c 100644 --- a/v2/model_filters_route_table.go +++ b/v2/model_filters_route_table.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_filters_security_group.go b/v2/model_filters_security_group.go index ef7ddf544..bf4a31b9d 100644 --- a/v2/model_filters_security_group.go +++ b/v2/model_filters_security_group.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -17,8 +17,6 @@ import ( // FiltersSecurityGroup One or more filters. type FiltersSecurityGroup struct { - // The account IDs of the owners of the security groups. - AccountIds *[]string `json:"AccountIds,omitempty"` // The descriptions of the security groups. Descriptions *[]string `json:"Descriptions,omitempty"` // The account IDs that have been granted permissions. @@ -80,38 +78,6 @@ func NewFiltersSecurityGroupWithDefaults() *FiltersSecurityGroup { return &this } -// GetAccountIds returns the AccountIds field value if set, zero value otherwise. -func (o *FiltersSecurityGroup) GetAccountIds() []string { - if o == nil || o.AccountIds == nil { - var ret []string - return ret - } - return *o.AccountIds -} - -// GetAccountIdsOk returns a tuple with the AccountIds field value if set, nil otherwise -// and a boolean to check if the value has been set. -func (o *FiltersSecurityGroup) GetAccountIdsOk() (*[]string, bool) { - if o == nil || o.AccountIds == nil { - return nil, false - } - return o.AccountIds, true -} - -// HasAccountIds returns a boolean if a field has been set. -func (o *FiltersSecurityGroup) HasAccountIds() bool { - if o != nil && o.AccountIds != nil { - return true - } - - return false -} - -// SetAccountIds gets a reference to the given []string and assigns it to the AccountIds field. -func (o *FiltersSecurityGroup) SetAccountIds(v []string) { - o.AccountIds = &v -} - // GetDescriptions returns the Descriptions field value if set, zero value otherwise. func (o *FiltersSecurityGroup) GetDescriptions() []string { if o == nil || o.Descriptions == nil { @@ -786,9 +752,6 @@ func (o *FiltersSecurityGroup) SetTags(v []string) { func (o FiltersSecurityGroup) MarshalJSON() ([]byte, error) { toSerialize := map[string]interface{}{} - if o.AccountIds != nil { - toSerialize["AccountIds"] = o.AccountIds - } if o.Descriptions != nil { toSerialize["Descriptions"] = o.Descriptions } diff --git a/v2/model_filters_server_certificate.go b/v2/model_filters_server_certificate.go index 22340562f..36b37ddbb 100644 --- a/v2/model_filters_server_certificate.go +++ b/v2/model_filters_server_certificate.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_filters_service.go b/v2/model_filters_service.go index fe8d8e72d..dee839a49 100644 --- a/v2/model_filters_service.go +++ b/v2/model_filters_service.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_filters_snapshot.go b/v2/model_filters_snapshot.go index 6f3f2af27..2a8d30734 100644 --- a/v2/model_filters_snapshot.go +++ b/v2/model_filters_snapshot.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -26,7 +26,7 @@ type FiltersSnapshot struct { Descriptions *[]string `json:"Descriptions,omitempty"` // The beginning of the time period, in ISO 8601 date-time format (for example, `2020-06-14T00:00:00.000Z`). FromCreationDate *time.Time `json:"FromCreationDate,omitempty"` - // The account IDs of one or more users who have permissions to create volumes. + // The account IDs which have permissions to create volumes. PermissionsToCreateVolumeAccountIds *[]string `json:"PermissionsToCreateVolumeAccountIds,omitempty"` // If true, lists all public volumes. If false, lists all private volumes. PermissionsToCreateVolumeGlobalPermission *bool `json:"PermissionsToCreateVolumeGlobalPermission,omitempty"` diff --git a/v2/model_filters_subnet.go b/v2/model_filters_subnet.go index 99f98d44d..422d8971d 100644 --- a/v2/model_filters_subnet.go +++ b/v2/model_filters_subnet.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_filters_subregion.go b/v2/model_filters_subregion.go index 31dc0f8ef..da304f13c 100644 --- a/v2/model_filters_subregion.go +++ b/v2/model_filters_subregion.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -17,6 +17,10 @@ import ( // FiltersSubregion One or more filters. type FiltersSubregion struct { + // The names of the Regions containing the Subregions. + RegionNames *[]string `json:"RegionNames,omitempty"` + // The states of the Subregions. + States *[]string `json:"States,omitempty"` // The names of the Subregions. SubregionNames *[]string `json:"SubregionNames,omitempty"` } @@ -38,6 +42,70 @@ func NewFiltersSubregionWithDefaults() *FiltersSubregion { return &this } +// GetRegionNames returns the RegionNames field value if set, zero value otherwise. +func (o *FiltersSubregion) GetRegionNames() []string { + if o == nil || o.RegionNames == nil { + var ret []string + return ret + } + return *o.RegionNames +} + +// GetRegionNamesOk returns a tuple with the RegionNames field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersSubregion) GetRegionNamesOk() (*[]string, bool) { + if o == nil || o.RegionNames == nil { + return nil, false + } + return o.RegionNames, true +} + +// HasRegionNames returns a boolean if a field has been set. +func (o *FiltersSubregion) HasRegionNames() bool { + if o != nil && o.RegionNames != nil { + return true + } + + return false +} + +// SetRegionNames gets a reference to the given []string and assigns it to the RegionNames field. +func (o *FiltersSubregion) SetRegionNames(v []string) { + o.RegionNames = &v +} + +// GetStates returns the States field value if set, zero value otherwise. +func (o *FiltersSubregion) GetStates() []string { + if o == nil || o.States == nil { + var ret []string + return ret + } + return *o.States +} + +// GetStatesOk returns a tuple with the States field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersSubregion) GetStatesOk() (*[]string, bool) { + if o == nil || o.States == nil { + return nil, false + } + return o.States, true +} + +// HasStates returns a boolean if a field has been set. +func (o *FiltersSubregion) HasStates() bool { + if o != nil && o.States != nil { + return true + } + + return false +} + +// SetStates gets a reference to the given []string and assigns it to the States field. +func (o *FiltersSubregion) SetStates(v []string) { + o.States = &v +} + // GetSubregionNames returns the SubregionNames field value if set, zero value otherwise. func (o *FiltersSubregion) GetSubregionNames() []string { if o == nil || o.SubregionNames == nil { @@ -72,6 +140,12 @@ func (o *FiltersSubregion) SetSubregionNames(v []string) { func (o FiltersSubregion) MarshalJSON() ([]byte, error) { toSerialize := map[string]interface{}{} + if o.RegionNames != nil { + toSerialize["RegionNames"] = o.RegionNames + } + if o.States != nil { + toSerialize["States"] = o.States + } if o.SubregionNames != nil { toSerialize["SubregionNames"] = o.SubregionNames } diff --git a/v2/model_filters_tag.go b/v2/model_filters_tag.go index 456db1ae9..90b93b3a7 100644 --- a/v2/model_filters_tag.go +++ b/v2/model_filters_tag.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_filters_virtual_gateway.go b/v2/model_filters_virtual_gateway.go index b36bfa818..c79e678ee 100644 --- a/v2/model_filters_virtual_gateway.go +++ b/v2/model_filters_virtual_gateway.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_filters_vm.go b/v2/model_filters_vm.go index f4479ff5d..f70d01dc3 100644 --- a/v2/model_filters_vm.go +++ b/v2/model_filters_vm.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -17,14 +17,134 @@ import ( // FiltersVm One or more filters. type FiltersVm struct { + // The architectures of the VMs (`i386` \\| `x86_64`). + Architectures *[]string `json:"Architectures,omitempty"` + // Whether the BSU volumes are deleted when terminating the VMs. + BlockDeviceMappingDeleteOnVmDeletion *bool `json:"BlockDeviceMappingDeleteOnVmDeletion,omitempty"` + // The device names for the BSU volumes (in the format `/dev/sdX`, `/dev/sdXX`, `/dev/xvdX`, or `/dev/xvdXX`). + BlockDeviceMappingDeviceNames *[]string `json:"BlockDeviceMappingDeviceNames,omitempty"` + // The link dates for the BSU volumes mapped to the VMs (for example, `2016-01-23T18:45:30.000Z`). + BlockDeviceMappingLinkDates *[]string `json:"BlockDeviceMappingLinkDates,omitempty"` + // The states for the BSU volumes (`attaching` \\| `attached` \\| `detaching` \\| `detached`). + BlockDeviceMappingStates *[]string `json:"BlockDeviceMappingStates,omitempty"` + // The volume IDs of the BSU volumes. + BlockDeviceMappingVolumeIds *[]string `json:"BlockDeviceMappingVolumeIds,omitempty"` + // The idempotency tokens provided when launching the VMs. + ClientTokens *[]string `json:"ClientTokens,omitempty"` + // The dates when the VMs were launched. + CreationDates *[]string `json:"CreationDates,omitempty"` + // The IDs of the OMIs used to launch the VMs. + ImageIds *[]string `json:"ImageIds,omitempty"` + // Whether the source/destination checking is enabled (true) or disabled (false). + IsSourceDestChecked *bool `json:"IsSourceDestChecked,omitempty"` + // The names of the keypairs used when launching the VMs. + KeypairNames *[]string `json:"KeypairNames,omitempty"` + // The numbers for the VMs when launching a group of several VMs (for example, `0`, `1`, `2`, and so on). + LaunchNumbers *[]int32 `json:"LaunchNumbers,omitempty"` + // Whether the VMs are Spot Instances (spot). + Lifecycles *[]string `json:"Lifecycles,omitempty"` + // The IDs of the Nets in which the VMs are running. + NetIds *[]string `json:"NetIds,omitempty"` + // The IDs of the NICs. + NicAccountIds *[]string `json:"NicAccountIds,omitempty"` + // The descriptions of the NICs. + NicDescriptions *[]string `json:"NicDescriptions,omitempty"` + // Whether the source/destination checking is enabled (true) or disabled (false). + NicIsSourceDestChecked *bool `json:"NicIsSourceDestChecked,omitempty"` + // Whether the NICs are deleted when the VMs they are attached to are deleted. + NicLinkNicDeleteOnVmDeletion *bool `json:"NicLinkNicDeleteOnVmDeletion,omitempty"` + // The device numbers the NICs are attached to. + NicLinkNicDeviceNumbers *[]int32 `json:"NicLinkNicDeviceNumbers,omitempty"` + // The dates and time when the NICs were attached to the VMs. + NicLinkNicLinkNicDates *[]string `json:"NicLinkNicLinkNicDates,omitempty"` + // The IDs of the NIC attachments. + NicLinkNicLinkNicIds *[]string `json:"NicLinkNicLinkNicIds,omitempty"` + // The states of the attachments. + NicLinkNicStates *[]string `json:"NicLinkNicStates,omitempty"` + // The account IDs of the owners of the VMs the NICs are attached to. + NicLinkNicVmAccountIds *[]string `json:"NicLinkNicVmAccountIds,omitempty"` + // The IDs of the VMs the NICs are attached to. + NicLinkNicVmIds *[]string `json:"NicLinkNicVmIds,omitempty"` + // The account IDs of the owners of the public IPs associated with the NICs. + NicLinkPublicIpAccountIds *[]string `json:"NicLinkPublicIpAccountIds,omitempty"` + // The association IDs returned when the public IPs were associated with the NICs. + NicLinkPublicIpLinkPublicIpIds *[]string `json:"NicLinkPublicIpLinkPublicIpIds,omitempty"` + // The allocation IDs returned when the public IPs were allocated to their accounts. + NicLinkPublicIpPublicIpIds *[]string `json:"NicLinkPublicIpPublicIpIds,omitempty"` + // The public IPs associated with the NICs. + NicLinkPublicIpPublicIps *[]string `json:"NicLinkPublicIpPublicIps,omitempty"` + // The Media Access Control (MAC) addresses of the NICs. + NicMacAddresses *[]string `json:"NicMacAddresses,omitempty"` + // The IDs of the Nets where the NICs are located. + NicNetIds *[]string `json:"NicNetIds,omitempty"` + // The IDs of the NICs. + NicNicIds *[]string `json:"NicNicIds,omitempty"` + // The account IDs of the owner of the public IPs associated with the private IPs. + NicPrivateIpsLinkPublicIpAccountIds *[]string `json:"NicPrivateIpsLinkPublicIpAccountIds,omitempty"` + // The public IPs associated with the private IPs. + NicPrivateIpsLinkPublicIpIds *[]string `json:"NicPrivateIpsLinkPublicIpIds,omitempty"` + // Whether the private IPs are the primary IPs associated with the NICs. + NicPrivateIpsPrimaryIp *bool `json:"NicPrivateIpsPrimaryIp,omitempty"` + // The private IPs of the NICs. + NicPrivateIpsPrivateIps *[]string `json:"NicPrivateIpsPrivateIps,omitempty"` + // The IDs of the security groups associated with the NICs. + NicSecurityGroupIds *[]string `json:"NicSecurityGroupIds,omitempty"` + // The names of the security groups associated with the NICs. + NicSecurityGroupNames *[]string `json:"NicSecurityGroupNames,omitempty"` + // The states of the NICs (`available` \\| `in-use`). + NicStates *[]string `json:"NicStates,omitempty"` + // The IDs of the Subnets for the NICs. + NicSubnetIds *[]string `json:"NicSubnetIds,omitempty"` + // The Subregions where the NICs are located. + NicSubregionNames *[]string `json:"NicSubregionNames,omitempty"` + // The platforms. Use windows if you have Windows VMs. Otherwise, leave this filter blank. + Platforms *[]string `json:"Platforms,omitempty"` + // The private IPs of the VMs. + PrivateIps *[]string `json:"PrivateIps,omitempty"` + // The product codes associated with the OMI used to create the VMs. + ProductCodes *[]string `json:"ProductCodes,omitempty"` + // The public IPs of the VMs. + PublicIps *[]string `json:"PublicIps,omitempty"` + // 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 lauch a group of VMs using the same launch request. + ReservationIds *[]string `json:"ReservationIds,omitempty"` + // The names of the root devices for the VMs (for example, `/dev/sda1`) + RootDeviceNames *[]string `json:"RootDeviceNames,omitempty"` + // The root devices types used by the VMs (always `ebs`) + RootDeviceTypes *[]string `json:"RootDeviceTypes,omitempty"` + // The IDs of the security groups for the VMs (only in the public Cloud). + SecurityGroupIds *[]string `json:"SecurityGroupIds,omitempty"` + // The names of the security groups for the VMs (only in the public Cloud). + SecurityGroupNames *[]string `json:"SecurityGroupNames,omitempty"` + // The reason codes for the state changes. + StateReasonCodes *[]int32 `json:"StateReasonCodes,omitempty"` + // The messages describing the state changes. + StateReasonMessages *[]string `json:"StateReasonMessages,omitempty"` + // The reasons explaining the current states of the VMs. This filter is like the `StateReasonCodes` one. + StateReasons *[]string `json:"StateReasons,omitempty"` + // The IDs of the Subnets for the VMs. + SubnetIds *[]string `json:"SubnetIds,omitempty"` + // The names of the Subregions of the VMs. + SubregionNames *[]string `json:"SubregionNames,omitempty"` // The keys of the tags associated with the VMs. TagKeys *[]string `json:"TagKeys,omitempty"` // The values of the tags associated with the VMs. TagValues *[]string `json:"TagValues,omitempty"` // The key/value combination of the tags associated with the VMs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}. Tags *[]string `json:"Tags,omitempty"` + // The tenancies of the VMs (`dedicated` \\| `default` \\| `host`). + Tenancies *[]string `json:"Tenancies,omitempty"` // One or more IDs of VMs. VmIds *[]string `json:"VmIds,omitempty"` + // The IDs of the security groups for the VMs. + VmSecurityGroupIds *[]string `json:"VmSecurityGroupIds,omitempty"` + // The names of the security group for the VMs. + VmSecurityGroupNames *[]string `json:"VmSecurityGroupNames,omitempty"` + // The state codes of the VMs: `-1` (quarantine), `0` (pending), `16` (running), `32` (shutting-down), `48` (terminated), `64` (stopping), and `80` (stopped). + VmStateCodes *[]int32 `json:"VmStateCodes,omitempty"` + // The state names of the VMs (`pending` \\| `running` \\| `stopping` \\| `stopped` \\| `shutting-down` \\| `terminated` \\| `quarantine`). + VmStateNames *[]string `json:"VmStateNames,omitempty"` + // The VM types (for example, t2.micro). For more information, see [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html). + VmTypes *[]string `json:"VmTypes,omitempty"` } // NewFiltersVm instantiates a new FiltersVm object @@ -44,6 +164,1734 @@ func NewFiltersVmWithDefaults() *FiltersVm { return &this } +// GetArchitectures returns the Architectures field value if set, zero value otherwise. +func (o *FiltersVm) GetArchitectures() []string { + if o == nil || o.Architectures == nil { + var ret []string + return ret + } + return *o.Architectures +} + +// GetArchitecturesOk returns a tuple with the Architectures field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetArchitecturesOk() (*[]string, bool) { + if o == nil || o.Architectures == nil { + return nil, false + } + return o.Architectures, true +} + +// HasArchitectures returns a boolean if a field has been set. +func (o *FiltersVm) HasArchitectures() bool { + if o != nil && o.Architectures != nil { + return true + } + + return false +} + +// SetArchitectures gets a reference to the given []string and assigns it to the Architectures field. +func (o *FiltersVm) SetArchitectures(v []string) { + o.Architectures = &v +} + +// GetBlockDeviceMappingDeleteOnVmDeletion returns the BlockDeviceMappingDeleteOnVmDeletion field value if set, zero value otherwise. +func (o *FiltersVm) GetBlockDeviceMappingDeleteOnVmDeletion() bool { + if o == nil || o.BlockDeviceMappingDeleteOnVmDeletion == nil { + var ret bool + return ret + } + return *o.BlockDeviceMappingDeleteOnVmDeletion +} + +// GetBlockDeviceMappingDeleteOnVmDeletionOk returns a tuple with the BlockDeviceMappingDeleteOnVmDeletion field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetBlockDeviceMappingDeleteOnVmDeletionOk() (*bool, bool) { + if o == nil || o.BlockDeviceMappingDeleteOnVmDeletion == nil { + return nil, false + } + return o.BlockDeviceMappingDeleteOnVmDeletion, true +} + +// HasBlockDeviceMappingDeleteOnVmDeletion returns a boolean if a field has been set. +func (o *FiltersVm) HasBlockDeviceMappingDeleteOnVmDeletion() bool { + if o != nil && o.BlockDeviceMappingDeleteOnVmDeletion != nil { + return true + } + + return false +} + +// SetBlockDeviceMappingDeleteOnVmDeletion gets a reference to the given bool and assigns it to the BlockDeviceMappingDeleteOnVmDeletion field. +func (o *FiltersVm) SetBlockDeviceMappingDeleteOnVmDeletion(v bool) { + o.BlockDeviceMappingDeleteOnVmDeletion = &v +} + +// GetBlockDeviceMappingDeviceNames returns the BlockDeviceMappingDeviceNames field value if set, zero value otherwise. +func (o *FiltersVm) GetBlockDeviceMappingDeviceNames() []string { + if o == nil || o.BlockDeviceMappingDeviceNames == nil { + var ret []string + return ret + } + return *o.BlockDeviceMappingDeviceNames +} + +// GetBlockDeviceMappingDeviceNamesOk returns a tuple with the BlockDeviceMappingDeviceNames field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetBlockDeviceMappingDeviceNamesOk() (*[]string, bool) { + if o == nil || o.BlockDeviceMappingDeviceNames == nil { + return nil, false + } + return o.BlockDeviceMappingDeviceNames, true +} + +// HasBlockDeviceMappingDeviceNames returns a boolean if a field has been set. +func (o *FiltersVm) HasBlockDeviceMappingDeviceNames() bool { + if o != nil && o.BlockDeviceMappingDeviceNames != nil { + return true + } + + return false +} + +// SetBlockDeviceMappingDeviceNames gets a reference to the given []string and assigns it to the BlockDeviceMappingDeviceNames field. +func (o *FiltersVm) SetBlockDeviceMappingDeviceNames(v []string) { + o.BlockDeviceMappingDeviceNames = &v +} + +// GetBlockDeviceMappingLinkDates returns the BlockDeviceMappingLinkDates field value if set, zero value otherwise. +func (o *FiltersVm) GetBlockDeviceMappingLinkDates() []string { + if o == nil || o.BlockDeviceMappingLinkDates == nil { + var ret []string + return ret + } + return *o.BlockDeviceMappingLinkDates +} + +// GetBlockDeviceMappingLinkDatesOk returns a tuple with the BlockDeviceMappingLinkDates field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetBlockDeviceMappingLinkDatesOk() (*[]string, bool) { + if o == nil || o.BlockDeviceMappingLinkDates == nil { + return nil, false + } + return o.BlockDeviceMappingLinkDates, true +} + +// HasBlockDeviceMappingLinkDates returns a boolean if a field has been set. +func (o *FiltersVm) HasBlockDeviceMappingLinkDates() bool { + if o != nil && o.BlockDeviceMappingLinkDates != nil { + return true + } + + return false +} + +// SetBlockDeviceMappingLinkDates gets a reference to the given []string and assigns it to the BlockDeviceMappingLinkDates field. +func (o *FiltersVm) SetBlockDeviceMappingLinkDates(v []string) { + o.BlockDeviceMappingLinkDates = &v +} + +// GetBlockDeviceMappingStates returns the BlockDeviceMappingStates field value if set, zero value otherwise. +func (o *FiltersVm) GetBlockDeviceMappingStates() []string { + if o == nil || o.BlockDeviceMappingStates == nil { + var ret []string + return ret + } + return *o.BlockDeviceMappingStates +} + +// GetBlockDeviceMappingStatesOk returns a tuple with the BlockDeviceMappingStates field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetBlockDeviceMappingStatesOk() (*[]string, bool) { + if o == nil || o.BlockDeviceMappingStates == nil { + return nil, false + } + return o.BlockDeviceMappingStates, true +} + +// HasBlockDeviceMappingStates returns a boolean if a field has been set. +func (o *FiltersVm) HasBlockDeviceMappingStates() bool { + if o != nil && o.BlockDeviceMappingStates != nil { + return true + } + + return false +} + +// SetBlockDeviceMappingStates gets a reference to the given []string and assigns it to the BlockDeviceMappingStates field. +func (o *FiltersVm) SetBlockDeviceMappingStates(v []string) { + o.BlockDeviceMappingStates = &v +} + +// GetBlockDeviceMappingVolumeIds returns the BlockDeviceMappingVolumeIds field value if set, zero value otherwise. +func (o *FiltersVm) GetBlockDeviceMappingVolumeIds() []string { + if o == nil || o.BlockDeviceMappingVolumeIds == nil { + var ret []string + return ret + } + return *o.BlockDeviceMappingVolumeIds +} + +// GetBlockDeviceMappingVolumeIdsOk returns a tuple with the BlockDeviceMappingVolumeIds field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetBlockDeviceMappingVolumeIdsOk() (*[]string, bool) { + if o == nil || o.BlockDeviceMappingVolumeIds == nil { + return nil, false + } + return o.BlockDeviceMappingVolumeIds, true +} + +// HasBlockDeviceMappingVolumeIds returns a boolean if a field has been set. +func (o *FiltersVm) HasBlockDeviceMappingVolumeIds() bool { + if o != nil && o.BlockDeviceMappingVolumeIds != nil { + return true + } + + return false +} + +// SetBlockDeviceMappingVolumeIds gets a reference to the given []string and assigns it to the BlockDeviceMappingVolumeIds field. +func (o *FiltersVm) SetBlockDeviceMappingVolumeIds(v []string) { + o.BlockDeviceMappingVolumeIds = &v +} + +// GetClientTokens returns the ClientTokens field value if set, zero value otherwise. +func (o *FiltersVm) GetClientTokens() []string { + if o == nil || o.ClientTokens == nil { + var ret []string + return ret + } + return *o.ClientTokens +} + +// GetClientTokensOk returns a tuple with the ClientTokens field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetClientTokensOk() (*[]string, bool) { + if o == nil || o.ClientTokens == nil { + return nil, false + } + return o.ClientTokens, true +} + +// HasClientTokens returns a boolean if a field has been set. +func (o *FiltersVm) HasClientTokens() bool { + if o != nil && o.ClientTokens != nil { + return true + } + + return false +} + +// SetClientTokens gets a reference to the given []string and assigns it to the ClientTokens field. +func (o *FiltersVm) SetClientTokens(v []string) { + o.ClientTokens = &v +} + +// GetCreationDates returns the CreationDates field value if set, zero value otherwise. +func (o *FiltersVm) GetCreationDates() []string { + if o == nil || o.CreationDates == nil { + var ret []string + return ret + } + return *o.CreationDates +} + +// GetCreationDatesOk returns a tuple with the CreationDates field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetCreationDatesOk() (*[]string, bool) { + if o == nil || o.CreationDates == nil { + return nil, false + } + return o.CreationDates, true +} + +// HasCreationDates returns a boolean if a field has been set. +func (o *FiltersVm) HasCreationDates() bool { + if o != nil && o.CreationDates != nil { + return true + } + + return false +} + +// SetCreationDates gets a reference to the given []string and assigns it to the CreationDates field. +func (o *FiltersVm) SetCreationDates(v []string) { + o.CreationDates = &v +} + +// GetImageIds returns the ImageIds field value if set, zero value otherwise. +func (o *FiltersVm) GetImageIds() []string { + if o == nil || o.ImageIds == nil { + var ret []string + return ret + } + return *o.ImageIds +} + +// GetImageIdsOk returns a tuple with the ImageIds field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetImageIdsOk() (*[]string, bool) { + if o == nil || o.ImageIds == nil { + return nil, false + } + return o.ImageIds, true +} + +// HasImageIds returns a boolean if a field has been set. +func (o *FiltersVm) HasImageIds() bool { + if o != nil && o.ImageIds != nil { + return true + } + + return false +} + +// SetImageIds gets a reference to the given []string and assigns it to the ImageIds field. +func (o *FiltersVm) SetImageIds(v []string) { + o.ImageIds = &v +} + +// GetIsSourceDestChecked returns the IsSourceDestChecked field value if set, zero value otherwise. +func (o *FiltersVm) GetIsSourceDestChecked() bool { + if o == nil || o.IsSourceDestChecked == nil { + var ret bool + return ret + } + return *o.IsSourceDestChecked +} + +// GetIsSourceDestCheckedOk returns a tuple with the IsSourceDestChecked field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetIsSourceDestCheckedOk() (*bool, bool) { + if o == nil || o.IsSourceDestChecked == nil { + return nil, false + } + return o.IsSourceDestChecked, true +} + +// HasIsSourceDestChecked returns a boolean if a field has been set. +func (o *FiltersVm) HasIsSourceDestChecked() bool { + if o != nil && o.IsSourceDestChecked != nil { + return true + } + + return false +} + +// SetIsSourceDestChecked gets a reference to the given bool and assigns it to the IsSourceDestChecked field. +func (o *FiltersVm) SetIsSourceDestChecked(v bool) { + o.IsSourceDestChecked = &v +} + +// GetKeypairNames returns the KeypairNames field value if set, zero value otherwise. +func (o *FiltersVm) GetKeypairNames() []string { + if o == nil || o.KeypairNames == nil { + var ret []string + return ret + } + return *o.KeypairNames +} + +// GetKeypairNamesOk returns a tuple with the KeypairNames field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetKeypairNamesOk() (*[]string, bool) { + if o == nil || o.KeypairNames == nil { + return nil, false + } + return o.KeypairNames, true +} + +// HasKeypairNames returns a boolean if a field has been set. +func (o *FiltersVm) HasKeypairNames() bool { + if o != nil && o.KeypairNames != nil { + return true + } + + return false +} + +// SetKeypairNames gets a reference to the given []string and assigns it to the KeypairNames field. +func (o *FiltersVm) SetKeypairNames(v []string) { + o.KeypairNames = &v +} + +// GetLaunchNumbers returns the LaunchNumbers field value if set, zero value otherwise. +func (o *FiltersVm) GetLaunchNumbers() []int32 { + if o == nil || o.LaunchNumbers == nil { + var ret []int32 + return ret + } + return *o.LaunchNumbers +} + +// GetLaunchNumbersOk returns a tuple with the LaunchNumbers field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetLaunchNumbersOk() (*[]int32, bool) { + if o == nil || o.LaunchNumbers == nil { + return nil, false + } + return o.LaunchNumbers, true +} + +// HasLaunchNumbers returns a boolean if a field has been set. +func (o *FiltersVm) HasLaunchNumbers() bool { + if o != nil && o.LaunchNumbers != nil { + return true + } + + return false +} + +// SetLaunchNumbers gets a reference to the given []int32 and assigns it to the LaunchNumbers field. +func (o *FiltersVm) SetLaunchNumbers(v []int32) { + o.LaunchNumbers = &v +} + +// GetLifecycles returns the Lifecycles field value if set, zero value otherwise. +func (o *FiltersVm) GetLifecycles() []string { + if o == nil || o.Lifecycles == nil { + var ret []string + return ret + } + return *o.Lifecycles +} + +// GetLifecyclesOk returns a tuple with the Lifecycles field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetLifecyclesOk() (*[]string, bool) { + if o == nil || o.Lifecycles == nil { + return nil, false + } + return o.Lifecycles, true +} + +// HasLifecycles returns a boolean if a field has been set. +func (o *FiltersVm) HasLifecycles() bool { + if o != nil && o.Lifecycles != nil { + return true + } + + return false +} + +// SetLifecycles gets a reference to the given []string and assigns it to the Lifecycles field. +func (o *FiltersVm) SetLifecycles(v []string) { + o.Lifecycles = &v +} + +// GetNetIds returns the NetIds field value if set, zero value otherwise. +func (o *FiltersVm) GetNetIds() []string { + if o == nil || o.NetIds == nil { + var ret []string + return ret + } + return *o.NetIds +} + +// GetNetIdsOk returns a tuple with the NetIds field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetNetIdsOk() (*[]string, bool) { + if o == nil || o.NetIds == nil { + return nil, false + } + return o.NetIds, true +} + +// HasNetIds returns a boolean if a field has been set. +func (o *FiltersVm) HasNetIds() bool { + if o != nil && o.NetIds != nil { + return true + } + + return false +} + +// SetNetIds gets a reference to the given []string and assigns it to the NetIds field. +func (o *FiltersVm) SetNetIds(v []string) { + o.NetIds = &v +} + +// GetNicAccountIds returns the NicAccountIds field value if set, zero value otherwise. +func (o *FiltersVm) GetNicAccountIds() []string { + if o == nil || o.NicAccountIds == nil { + var ret []string + return ret + } + return *o.NicAccountIds +} + +// GetNicAccountIdsOk returns a tuple with the NicAccountIds field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetNicAccountIdsOk() (*[]string, bool) { + if o == nil || o.NicAccountIds == nil { + return nil, false + } + return o.NicAccountIds, true +} + +// HasNicAccountIds returns a boolean if a field has been set. +func (o *FiltersVm) HasNicAccountIds() bool { + if o != nil && o.NicAccountIds != nil { + return true + } + + return false +} + +// SetNicAccountIds gets a reference to the given []string and assigns it to the NicAccountIds field. +func (o *FiltersVm) SetNicAccountIds(v []string) { + o.NicAccountIds = &v +} + +// GetNicDescriptions returns the NicDescriptions field value if set, zero value otherwise. +func (o *FiltersVm) GetNicDescriptions() []string { + if o == nil || o.NicDescriptions == nil { + var ret []string + return ret + } + return *o.NicDescriptions +} + +// GetNicDescriptionsOk returns a tuple with the NicDescriptions field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetNicDescriptionsOk() (*[]string, bool) { + if o == nil || o.NicDescriptions == nil { + return nil, false + } + return o.NicDescriptions, true +} + +// HasNicDescriptions returns a boolean if a field has been set. +func (o *FiltersVm) HasNicDescriptions() bool { + if o != nil && o.NicDescriptions != nil { + return true + } + + return false +} + +// SetNicDescriptions gets a reference to the given []string and assigns it to the NicDescriptions field. +func (o *FiltersVm) SetNicDescriptions(v []string) { + o.NicDescriptions = &v +} + +// GetNicIsSourceDestChecked returns the NicIsSourceDestChecked field value if set, zero value otherwise. +func (o *FiltersVm) GetNicIsSourceDestChecked() bool { + if o == nil || o.NicIsSourceDestChecked == nil { + var ret bool + return ret + } + return *o.NicIsSourceDestChecked +} + +// GetNicIsSourceDestCheckedOk returns a tuple with the NicIsSourceDestChecked field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetNicIsSourceDestCheckedOk() (*bool, bool) { + if o == nil || o.NicIsSourceDestChecked == nil { + return nil, false + } + return o.NicIsSourceDestChecked, true +} + +// HasNicIsSourceDestChecked returns a boolean if a field has been set. +func (o *FiltersVm) HasNicIsSourceDestChecked() bool { + if o != nil && o.NicIsSourceDestChecked != nil { + return true + } + + return false +} + +// SetNicIsSourceDestChecked gets a reference to the given bool and assigns it to the NicIsSourceDestChecked field. +func (o *FiltersVm) SetNicIsSourceDestChecked(v bool) { + o.NicIsSourceDestChecked = &v +} + +// GetNicLinkNicDeleteOnVmDeletion returns the NicLinkNicDeleteOnVmDeletion field value if set, zero value otherwise. +func (o *FiltersVm) GetNicLinkNicDeleteOnVmDeletion() bool { + if o == nil || o.NicLinkNicDeleteOnVmDeletion == nil { + var ret bool + return ret + } + return *o.NicLinkNicDeleteOnVmDeletion +} + +// GetNicLinkNicDeleteOnVmDeletionOk returns a tuple with the NicLinkNicDeleteOnVmDeletion field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetNicLinkNicDeleteOnVmDeletionOk() (*bool, bool) { + if o == nil || o.NicLinkNicDeleteOnVmDeletion == nil { + return nil, false + } + return o.NicLinkNicDeleteOnVmDeletion, true +} + +// HasNicLinkNicDeleteOnVmDeletion returns a boolean if a field has been set. +func (o *FiltersVm) HasNicLinkNicDeleteOnVmDeletion() bool { + if o != nil && o.NicLinkNicDeleteOnVmDeletion != nil { + return true + } + + return false +} + +// SetNicLinkNicDeleteOnVmDeletion gets a reference to the given bool and assigns it to the NicLinkNicDeleteOnVmDeletion field. +func (o *FiltersVm) SetNicLinkNicDeleteOnVmDeletion(v bool) { + o.NicLinkNicDeleteOnVmDeletion = &v +} + +// GetNicLinkNicDeviceNumbers returns the NicLinkNicDeviceNumbers field value if set, zero value otherwise. +func (o *FiltersVm) GetNicLinkNicDeviceNumbers() []int32 { + if o == nil || o.NicLinkNicDeviceNumbers == nil { + var ret []int32 + return ret + } + return *o.NicLinkNicDeviceNumbers +} + +// GetNicLinkNicDeviceNumbersOk returns a tuple with the NicLinkNicDeviceNumbers field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetNicLinkNicDeviceNumbersOk() (*[]int32, bool) { + if o == nil || o.NicLinkNicDeviceNumbers == nil { + return nil, false + } + return o.NicLinkNicDeviceNumbers, true +} + +// HasNicLinkNicDeviceNumbers returns a boolean if a field has been set. +func (o *FiltersVm) HasNicLinkNicDeviceNumbers() bool { + if o != nil && o.NicLinkNicDeviceNumbers != nil { + return true + } + + return false +} + +// SetNicLinkNicDeviceNumbers gets a reference to the given []int32 and assigns it to the NicLinkNicDeviceNumbers field. +func (o *FiltersVm) SetNicLinkNicDeviceNumbers(v []int32) { + o.NicLinkNicDeviceNumbers = &v +} + +// GetNicLinkNicLinkNicDates returns the NicLinkNicLinkNicDates field value if set, zero value otherwise. +func (o *FiltersVm) GetNicLinkNicLinkNicDates() []string { + if o == nil || o.NicLinkNicLinkNicDates == nil { + var ret []string + return ret + } + return *o.NicLinkNicLinkNicDates +} + +// GetNicLinkNicLinkNicDatesOk returns a tuple with the NicLinkNicLinkNicDates field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetNicLinkNicLinkNicDatesOk() (*[]string, bool) { + if o == nil || o.NicLinkNicLinkNicDates == nil { + return nil, false + } + return o.NicLinkNicLinkNicDates, true +} + +// HasNicLinkNicLinkNicDates returns a boolean if a field has been set. +func (o *FiltersVm) HasNicLinkNicLinkNicDates() bool { + if o != nil && o.NicLinkNicLinkNicDates != nil { + return true + } + + return false +} + +// SetNicLinkNicLinkNicDates gets a reference to the given []string and assigns it to the NicLinkNicLinkNicDates field. +func (o *FiltersVm) SetNicLinkNicLinkNicDates(v []string) { + o.NicLinkNicLinkNicDates = &v +} + +// GetNicLinkNicLinkNicIds returns the NicLinkNicLinkNicIds field value if set, zero value otherwise. +func (o *FiltersVm) GetNicLinkNicLinkNicIds() []string { + if o == nil || o.NicLinkNicLinkNicIds == nil { + var ret []string + return ret + } + return *o.NicLinkNicLinkNicIds +} + +// GetNicLinkNicLinkNicIdsOk returns a tuple with the NicLinkNicLinkNicIds field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetNicLinkNicLinkNicIdsOk() (*[]string, bool) { + if o == nil || o.NicLinkNicLinkNicIds == nil { + return nil, false + } + return o.NicLinkNicLinkNicIds, true +} + +// HasNicLinkNicLinkNicIds returns a boolean if a field has been set. +func (o *FiltersVm) HasNicLinkNicLinkNicIds() bool { + if o != nil && o.NicLinkNicLinkNicIds != nil { + return true + } + + return false +} + +// SetNicLinkNicLinkNicIds gets a reference to the given []string and assigns it to the NicLinkNicLinkNicIds field. +func (o *FiltersVm) SetNicLinkNicLinkNicIds(v []string) { + o.NicLinkNicLinkNicIds = &v +} + +// GetNicLinkNicStates returns the NicLinkNicStates field value if set, zero value otherwise. +func (o *FiltersVm) GetNicLinkNicStates() []string { + if o == nil || o.NicLinkNicStates == nil { + var ret []string + return ret + } + return *o.NicLinkNicStates +} + +// GetNicLinkNicStatesOk returns a tuple with the NicLinkNicStates field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetNicLinkNicStatesOk() (*[]string, bool) { + if o == nil || o.NicLinkNicStates == nil { + return nil, false + } + return o.NicLinkNicStates, true +} + +// HasNicLinkNicStates returns a boolean if a field has been set. +func (o *FiltersVm) HasNicLinkNicStates() bool { + if o != nil && o.NicLinkNicStates != nil { + return true + } + + return false +} + +// SetNicLinkNicStates gets a reference to the given []string and assigns it to the NicLinkNicStates field. +func (o *FiltersVm) SetNicLinkNicStates(v []string) { + o.NicLinkNicStates = &v +} + +// GetNicLinkNicVmAccountIds returns the NicLinkNicVmAccountIds field value if set, zero value otherwise. +func (o *FiltersVm) GetNicLinkNicVmAccountIds() []string { + if o == nil || o.NicLinkNicVmAccountIds == nil { + var ret []string + return ret + } + return *o.NicLinkNicVmAccountIds +} + +// GetNicLinkNicVmAccountIdsOk returns a tuple with the NicLinkNicVmAccountIds field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetNicLinkNicVmAccountIdsOk() (*[]string, bool) { + if o == nil || o.NicLinkNicVmAccountIds == nil { + return nil, false + } + return o.NicLinkNicVmAccountIds, true +} + +// HasNicLinkNicVmAccountIds returns a boolean if a field has been set. +func (o *FiltersVm) HasNicLinkNicVmAccountIds() bool { + if o != nil && o.NicLinkNicVmAccountIds != nil { + return true + } + + return false +} + +// SetNicLinkNicVmAccountIds gets a reference to the given []string and assigns it to the NicLinkNicVmAccountIds field. +func (o *FiltersVm) SetNicLinkNicVmAccountIds(v []string) { + o.NicLinkNicVmAccountIds = &v +} + +// GetNicLinkNicVmIds returns the NicLinkNicVmIds field value if set, zero value otherwise. +func (o *FiltersVm) GetNicLinkNicVmIds() []string { + if o == nil || o.NicLinkNicVmIds == nil { + var ret []string + return ret + } + return *o.NicLinkNicVmIds +} + +// GetNicLinkNicVmIdsOk returns a tuple with the NicLinkNicVmIds field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetNicLinkNicVmIdsOk() (*[]string, bool) { + if o == nil || o.NicLinkNicVmIds == nil { + return nil, false + } + return o.NicLinkNicVmIds, true +} + +// HasNicLinkNicVmIds returns a boolean if a field has been set. +func (o *FiltersVm) HasNicLinkNicVmIds() bool { + if o != nil && o.NicLinkNicVmIds != nil { + return true + } + + return false +} + +// SetNicLinkNicVmIds gets a reference to the given []string and assigns it to the NicLinkNicVmIds field. +func (o *FiltersVm) SetNicLinkNicVmIds(v []string) { + o.NicLinkNicVmIds = &v +} + +// GetNicLinkPublicIpAccountIds returns the NicLinkPublicIpAccountIds field value if set, zero value otherwise. +func (o *FiltersVm) GetNicLinkPublicIpAccountIds() []string { + if o == nil || o.NicLinkPublicIpAccountIds == nil { + var ret []string + return ret + } + return *o.NicLinkPublicIpAccountIds +} + +// GetNicLinkPublicIpAccountIdsOk returns a tuple with the NicLinkPublicIpAccountIds field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetNicLinkPublicIpAccountIdsOk() (*[]string, bool) { + if o == nil || o.NicLinkPublicIpAccountIds == nil { + return nil, false + } + return o.NicLinkPublicIpAccountIds, true +} + +// HasNicLinkPublicIpAccountIds returns a boolean if a field has been set. +func (o *FiltersVm) HasNicLinkPublicIpAccountIds() bool { + if o != nil && o.NicLinkPublicIpAccountIds != nil { + return true + } + + return false +} + +// SetNicLinkPublicIpAccountIds gets a reference to the given []string and assigns it to the NicLinkPublicIpAccountIds field. +func (o *FiltersVm) SetNicLinkPublicIpAccountIds(v []string) { + o.NicLinkPublicIpAccountIds = &v +} + +// GetNicLinkPublicIpLinkPublicIpIds returns the NicLinkPublicIpLinkPublicIpIds field value if set, zero value otherwise. +func (o *FiltersVm) GetNicLinkPublicIpLinkPublicIpIds() []string { + if o == nil || o.NicLinkPublicIpLinkPublicIpIds == nil { + var ret []string + return ret + } + return *o.NicLinkPublicIpLinkPublicIpIds +} + +// GetNicLinkPublicIpLinkPublicIpIdsOk returns a tuple with the NicLinkPublicIpLinkPublicIpIds field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetNicLinkPublicIpLinkPublicIpIdsOk() (*[]string, bool) { + if o == nil || o.NicLinkPublicIpLinkPublicIpIds == nil { + return nil, false + } + return o.NicLinkPublicIpLinkPublicIpIds, true +} + +// HasNicLinkPublicIpLinkPublicIpIds returns a boolean if a field has been set. +func (o *FiltersVm) HasNicLinkPublicIpLinkPublicIpIds() bool { + if o != nil && o.NicLinkPublicIpLinkPublicIpIds != nil { + return true + } + + return false +} + +// SetNicLinkPublicIpLinkPublicIpIds gets a reference to the given []string and assigns it to the NicLinkPublicIpLinkPublicIpIds field. +func (o *FiltersVm) SetNicLinkPublicIpLinkPublicIpIds(v []string) { + o.NicLinkPublicIpLinkPublicIpIds = &v +} + +// GetNicLinkPublicIpPublicIpIds returns the NicLinkPublicIpPublicIpIds field value if set, zero value otherwise. +func (o *FiltersVm) GetNicLinkPublicIpPublicIpIds() []string { + if o == nil || o.NicLinkPublicIpPublicIpIds == nil { + var ret []string + return ret + } + return *o.NicLinkPublicIpPublicIpIds +} + +// GetNicLinkPublicIpPublicIpIdsOk returns a tuple with the NicLinkPublicIpPublicIpIds field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetNicLinkPublicIpPublicIpIdsOk() (*[]string, bool) { + if o == nil || o.NicLinkPublicIpPublicIpIds == nil { + return nil, false + } + return o.NicLinkPublicIpPublicIpIds, true +} + +// HasNicLinkPublicIpPublicIpIds returns a boolean if a field has been set. +func (o *FiltersVm) HasNicLinkPublicIpPublicIpIds() bool { + if o != nil && o.NicLinkPublicIpPublicIpIds != nil { + return true + } + + return false +} + +// SetNicLinkPublicIpPublicIpIds gets a reference to the given []string and assigns it to the NicLinkPublicIpPublicIpIds field. +func (o *FiltersVm) SetNicLinkPublicIpPublicIpIds(v []string) { + o.NicLinkPublicIpPublicIpIds = &v +} + +// GetNicLinkPublicIpPublicIps returns the NicLinkPublicIpPublicIps field value if set, zero value otherwise. +func (o *FiltersVm) GetNicLinkPublicIpPublicIps() []string { + if o == nil || o.NicLinkPublicIpPublicIps == nil { + var ret []string + return ret + } + return *o.NicLinkPublicIpPublicIps +} + +// GetNicLinkPublicIpPublicIpsOk returns a tuple with the NicLinkPublicIpPublicIps field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetNicLinkPublicIpPublicIpsOk() (*[]string, bool) { + if o == nil || o.NicLinkPublicIpPublicIps == nil { + return nil, false + } + return o.NicLinkPublicIpPublicIps, true +} + +// HasNicLinkPublicIpPublicIps returns a boolean if a field has been set. +func (o *FiltersVm) HasNicLinkPublicIpPublicIps() bool { + if o != nil && o.NicLinkPublicIpPublicIps != nil { + return true + } + + return false +} + +// SetNicLinkPublicIpPublicIps gets a reference to the given []string and assigns it to the NicLinkPublicIpPublicIps field. +func (o *FiltersVm) SetNicLinkPublicIpPublicIps(v []string) { + o.NicLinkPublicIpPublicIps = &v +} + +// GetNicMacAddresses returns the NicMacAddresses field value if set, zero value otherwise. +func (o *FiltersVm) GetNicMacAddresses() []string { + if o == nil || o.NicMacAddresses == nil { + var ret []string + return ret + } + return *o.NicMacAddresses +} + +// GetNicMacAddressesOk returns a tuple with the NicMacAddresses field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetNicMacAddressesOk() (*[]string, bool) { + if o == nil || o.NicMacAddresses == nil { + return nil, false + } + return o.NicMacAddresses, true +} + +// HasNicMacAddresses returns a boolean if a field has been set. +func (o *FiltersVm) HasNicMacAddresses() bool { + if o != nil && o.NicMacAddresses != nil { + return true + } + + return false +} + +// SetNicMacAddresses gets a reference to the given []string and assigns it to the NicMacAddresses field. +func (o *FiltersVm) SetNicMacAddresses(v []string) { + o.NicMacAddresses = &v +} + +// GetNicNetIds returns the NicNetIds field value if set, zero value otherwise. +func (o *FiltersVm) GetNicNetIds() []string { + if o == nil || o.NicNetIds == nil { + var ret []string + return ret + } + return *o.NicNetIds +} + +// GetNicNetIdsOk returns a tuple with the NicNetIds field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetNicNetIdsOk() (*[]string, bool) { + if o == nil || o.NicNetIds == nil { + return nil, false + } + return o.NicNetIds, true +} + +// HasNicNetIds returns a boolean if a field has been set. +func (o *FiltersVm) HasNicNetIds() bool { + if o != nil && o.NicNetIds != nil { + return true + } + + return false +} + +// SetNicNetIds gets a reference to the given []string and assigns it to the NicNetIds field. +func (o *FiltersVm) SetNicNetIds(v []string) { + o.NicNetIds = &v +} + +// GetNicNicIds returns the NicNicIds field value if set, zero value otherwise. +func (o *FiltersVm) GetNicNicIds() []string { + if o == nil || o.NicNicIds == nil { + var ret []string + return ret + } + return *o.NicNicIds +} + +// GetNicNicIdsOk returns a tuple with the NicNicIds field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetNicNicIdsOk() (*[]string, bool) { + if o == nil || o.NicNicIds == nil { + return nil, false + } + return o.NicNicIds, true +} + +// HasNicNicIds returns a boolean if a field has been set. +func (o *FiltersVm) HasNicNicIds() bool { + if o != nil && o.NicNicIds != nil { + return true + } + + return false +} + +// SetNicNicIds gets a reference to the given []string and assigns it to the NicNicIds field. +func (o *FiltersVm) SetNicNicIds(v []string) { + o.NicNicIds = &v +} + +// GetNicPrivateIpsLinkPublicIpAccountIds returns the NicPrivateIpsLinkPublicIpAccountIds field value if set, zero value otherwise. +func (o *FiltersVm) GetNicPrivateIpsLinkPublicIpAccountIds() []string { + if o == nil || o.NicPrivateIpsLinkPublicIpAccountIds == nil { + var ret []string + return ret + } + return *o.NicPrivateIpsLinkPublicIpAccountIds +} + +// GetNicPrivateIpsLinkPublicIpAccountIdsOk returns a tuple with the NicPrivateIpsLinkPublicIpAccountIds field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetNicPrivateIpsLinkPublicIpAccountIdsOk() (*[]string, bool) { + if o == nil || o.NicPrivateIpsLinkPublicIpAccountIds == nil { + return nil, false + } + return o.NicPrivateIpsLinkPublicIpAccountIds, true +} + +// HasNicPrivateIpsLinkPublicIpAccountIds returns a boolean if a field has been set. +func (o *FiltersVm) HasNicPrivateIpsLinkPublicIpAccountIds() bool { + if o != nil && o.NicPrivateIpsLinkPublicIpAccountIds != nil { + return true + } + + return false +} + +// SetNicPrivateIpsLinkPublicIpAccountIds gets a reference to the given []string and assigns it to the NicPrivateIpsLinkPublicIpAccountIds field. +func (o *FiltersVm) SetNicPrivateIpsLinkPublicIpAccountIds(v []string) { + o.NicPrivateIpsLinkPublicIpAccountIds = &v +} + +// GetNicPrivateIpsLinkPublicIpIds returns the NicPrivateIpsLinkPublicIpIds field value if set, zero value otherwise. +func (o *FiltersVm) GetNicPrivateIpsLinkPublicIpIds() []string { + if o == nil || o.NicPrivateIpsLinkPublicIpIds == nil { + var ret []string + return ret + } + return *o.NicPrivateIpsLinkPublicIpIds +} + +// GetNicPrivateIpsLinkPublicIpIdsOk returns a tuple with the NicPrivateIpsLinkPublicIpIds field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetNicPrivateIpsLinkPublicIpIdsOk() (*[]string, bool) { + if o == nil || o.NicPrivateIpsLinkPublicIpIds == nil { + return nil, false + } + return o.NicPrivateIpsLinkPublicIpIds, true +} + +// HasNicPrivateIpsLinkPublicIpIds returns a boolean if a field has been set. +func (o *FiltersVm) HasNicPrivateIpsLinkPublicIpIds() bool { + if o != nil && o.NicPrivateIpsLinkPublicIpIds != nil { + return true + } + + return false +} + +// SetNicPrivateIpsLinkPublicIpIds gets a reference to the given []string and assigns it to the NicPrivateIpsLinkPublicIpIds field. +func (o *FiltersVm) SetNicPrivateIpsLinkPublicIpIds(v []string) { + o.NicPrivateIpsLinkPublicIpIds = &v +} + +// GetNicPrivateIpsPrimaryIp returns the NicPrivateIpsPrimaryIp field value if set, zero value otherwise. +func (o *FiltersVm) GetNicPrivateIpsPrimaryIp() bool { + if o == nil || o.NicPrivateIpsPrimaryIp == nil { + var ret bool + return ret + } + return *o.NicPrivateIpsPrimaryIp +} + +// GetNicPrivateIpsPrimaryIpOk returns a tuple with the NicPrivateIpsPrimaryIp field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetNicPrivateIpsPrimaryIpOk() (*bool, bool) { + if o == nil || o.NicPrivateIpsPrimaryIp == nil { + return nil, false + } + return o.NicPrivateIpsPrimaryIp, true +} + +// HasNicPrivateIpsPrimaryIp returns a boolean if a field has been set. +func (o *FiltersVm) HasNicPrivateIpsPrimaryIp() bool { + if o != nil && o.NicPrivateIpsPrimaryIp != nil { + return true + } + + return false +} + +// SetNicPrivateIpsPrimaryIp gets a reference to the given bool and assigns it to the NicPrivateIpsPrimaryIp field. +func (o *FiltersVm) SetNicPrivateIpsPrimaryIp(v bool) { + o.NicPrivateIpsPrimaryIp = &v +} + +// GetNicPrivateIpsPrivateIps returns the NicPrivateIpsPrivateIps field value if set, zero value otherwise. +func (o *FiltersVm) GetNicPrivateIpsPrivateIps() []string { + if o == nil || o.NicPrivateIpsPrivateIps == nil { + var ret []string + return ret + } + return *o.NicPrivateIpsPrivateIps +} + +// GetNicPrivateIpsPrivateIpsOk returns a tuple with the NicPrivateIpsPrivateIps field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetNicPrivateIpsPrivateIpsOk() (*[]string, bool) { + if o == nil || o.NicPrivateIpsPrivateIps == nil { + return nil, false + } + return o.NicPrivateIpsPrivateIps, true +} + +// HasNicPrivateIpsPrivateIps returns a boolean if a field has been set. +func (o *FiltersVm) HasNicPrivateIpsPrivateIps() bool { + if o != nil && o.NicPrivateIpsPrivateIps != nil { + return true + } + + return false +} + +// SetNicPrivateIpsPrivateIps gets a reference to the given []string and assigns it to the NicPrivateIpsPrivateIps field. +func (o *FiltersVm) SetNicPrivateIpsPrivateIps(v []string) { + o.NicPrivateIpsPrivateIps = &v +} + +// GetNicSecurityGroupIds returns the NicSecurityGroupIds field value if set, zero value otherwise. +func (o *FiltersVm) GetNicSecurityGroupIds() []string { + if o == nil || o.NicSecurityGroupIds == nil { + var ret []string + return ret + } + return *o.NicSecurityGroupIds +} + +// GetNicSecurityGroupIdsOk returns a tuple with the NicSecurityGroupIds field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetNicSecurityGroupIdsOk() (*[]string, bool) { + if o == nil || o.NicSecurityGroupIds == nil { + return nil, false + } + return o.NicSecurityGroupIds, true +} + +// HasNicSecurityGroupIds returns a boolean if a field has been set. +func (o *FiltersVm) HasNicSecurityGroupIds() bool { + if o != nil && o.NicSecurityGroupIds != nil { + return true + } + + return false +} + +// SetNicSecurityGroupIds gets a reference to the given []string and assigns it to the NicSecurityGroupIds field. +func (o *FiltersVm) SetNicSecurityGroupIds(v []string) { + o.NicSecurityGroupIds = &v +} + +// GetNicSecurityGroupNames returns the NicSecurityGroupNames field value if set, zero value otherwise. +func (o *FiltersVm) GetNicSecurityGroupNames() []string { + if o == nil || o.NicSecurityGroupNames == nil { + var ret []string + return ret + } + return *o.NicSecurityGroupNames +} + +// GetNicSecurityGroupNamesOk returns a tuple with the NicSecurityGroupNames field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetNicSecurityGroupNamesOk() (*[]string, bool) { + if o == nil || o.NicSecurityGroupNames == nil { + return nil, false + } + return o.NicSecurityGroupNames, true +} + +// HasNicSecurityGroupNames returns a boolean if a field has been set. +func (o *FiltersVm) HasNicSecurityGroupNames() bool { + if o != nil && o.NicSecurityGroupNames != nil { + return true + } + + return false +} + +// SetNicSecurityGroupNames gets a reference to the given []string and assigns it to the NicSecurityGroupNames field. +func (o *FiltersVm) SetNicSecurityGroupNames(v []string) { + o.NicSecurityGroupNames = &v +} + +// GetNicStates returns the NicStates field value if set, zero value otherwise. +func (o *FiltersVm) GetNicStates() []string { + if o == nil || o.NicStates == nil { + var ret []string + return ret + } + return *o.NicStates +} + +// GetNicStatesOk returns a tuple with the NicStates field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetNicStatesOk() (*[]string, bool) { + if o == nil || o.NicStates == nil { + return nil, false + } + return o.NicStates, true +} + +// HasNicStates returns a boolean if a field has been set. +func (o *FiltersVm) HasNicStates() bool { + if o != nil && o.NicStates != nil { + return true + } + + return false +} + +// SetNicStates gets a reference to the given []string and assigns it to the NicStates field. +func (o *FiltersVm) SetNicStates(v []string) { + o.NicStates = &v +} + +// GetNicSubnetIds returns the NicSubnetIds field value if set, zero value otherwise. +func (o *FiltersVm) GetNicSubnetIds() []string { + if o == nil || o.NicSubnetIds == nil { + var ret []string + return ret + } + return *o.NicSubnetIds +} + +// GetNicSubnetIdsOk returns a tuple with the NicSubnetIds field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetNicSubnetIdsOk() (*[]string, bool) { + if o == nil || o.NicSubnetIds == nil { + return nil, false + } + return o.NicSubnetIds, true +} + +// HasNicSubnetIds returns a boolean if a field has been set. +func (o *FiltersVm) HasNicSubnetIds() bool { + if o != nil && o.NicSubnetIds != nil { + return true + } + + return false +} + +// SetNicSubnetIds gets a reference to the given []string and assigns it to the NicSubnetIds field. +func (o *FiltersVm) SetNicSubnetIds(v []string) { + o.NicSubnetIds = &v +} + +// GetNicSubregionNames returns the NicSubregionNames field value if set, zero value otherwise. +func (o *FiltersVm) GetNicSubregionNames() []string { + if o == nil || o.NicSubregionNames == nil { + var ret []string + return ret + } + return *o.NicSubregionNames +} + +// GetNicSubregionNamesOk returns a tuple with the NicSubregionNames field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetNicSubregionNamesOk() (*[]string, bool) { + if o == nil || o.NicSubregionNames == nil { + return nil, false + } + return o.NicSubregionNames, true +} + +// HasNicSubregionNames returns a boolean if a field has been set. +func (o *FiltersVm) HasNicSubregionNames() bool { + if o != nil && o.NicSubregionNames != nil { + return true + } + + return false +} + +// SetNicSubregionNames gets a reference to the given []string and assigns it to the NicSubregionNames field. +func (o *FiltersVm) SetNicSubregionNames(v []string) { + o.NicSubregionNames = &v +} + +// GetPlatforms returns the Platforms field value if set, zero value otherwise. +func (o *FiltersVm) GetPlatforms() []string { + if o == nil || o.Platforms == nil { + var ret []string + return ret + } + return *o.Platforms +} + +// GetPlatformsOk returns a tuple with the Platforms field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetPlatformsOk() (*[]string, bool) { + if o == nil || o.Platforms == nil { + return nil, false + } + return o.Platforms, true +} + +// HasPlatforms returns a boolean if a field has been set. +func (o *FiltersVm) HasPlatforms() bool { + if o != nil && o.Platforms != nil { + return true + } + + return false +} + +// SetPlatforms gets a reference to the given []string and assigns it to the Platforms field. +func (o *FiltersVm) SetPlatforms(v []string) { + o.Platforms = &v +} + +// GetPrivateIps returns the PrivateIps field value if set, zero value otherwise. +func (o *FiltersVm) GetPrivateIps() []string { + if o == nil || o.PrivateIps == nil { + var ret []string + return ret + } + return *o.PrivateIps +} + +// GetPrivateIpsOk returns a tuple with the PrivateIps field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetPrivateIpsOk() (*[]string, bool) { + if o == nil || o.PrivateIps == nil { + return nil, false + } + return o.PrivateIps, true +} + +// HasPrivateIps returns a boolean if a field has been set. +func (o *FiltersVm) HasPrivateIps() bool { + if o != nil && o.PrivateIps != nil { + return true + } + + return false +} + +// SetPrivateIps gets a reference to the given []string and assigns it to the PrivateIps field. +func (o *FiltersVm) SetPrivateIps(v []string) { + o.PrivateIps = &v +} + +// GetProductCodes returns the ProductCodes field value if set, zero value otherwise. +func (o *FiltersVm) GetProductCodes() []string { + if o == nil || o.ProductCodes == nil { + var ret []string + return ret + } + return *o.ProductCodes +} + +// GetProductCodesOk returns a tuple with the ProductCodes field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetProductCodesOk() (*[]string, bool) { + if o == nil || o.ProductCodes == nil { + return nil, false + } + return o.ProductCodes, true +} + +// HasProductCodes returns a boolean if a field has been set. +func (o *FiltersVm) HasProductCodes() bool { + if o != nil && o.ProductCodes != nil { + return true + } + + return false +} + +// SetProductCodes gets a reference to the given []string and assigns it to the ProductCodes field. +func (o *FiltersVm) SetProductCodes(v []string) { + o.ProductCodes = &v +} + +// GetPublicIps returns the PublicIps field value if set, zero value otherwise. +func (o *FiltersVm) GetPublicIps() []string { + if o == nil || o.PublicIps == nil { + var ret []string + return ret + } + return *o.PublicIps +} + +// GetPublicIpsOk returns a tuple with the PublicIps field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetPublicIpsOk() (*[]string, bool) { + if o == nil || o.PublicIps == nil { + return nil, false + } + return o.PublicIps, true +} + +// HasPublicIps returns a boolean if a field has been set. +func (o *FiltersVm) HasPublicIps() bool { + if o != nil && o.PublicIps != nil { + return true + } + + return false +} + +// SetPublicIps gets a reference to the given []string and assigns it to the PublicIps field. +func (o *FiltersVm) SetPublicIps(v []string) { + o.PublicIps = &v +} + +// GetReservationIds returns the ReservationIds field value if set, zero value otherwise. +func (o *FiltersVm) GetReservationIds() []string { + if o == nil || o.ReservationIds == nil { + var ret []string + return ret + } + return *o.ReservationIds +} + +// GetReservationIdsOk returns a tuple with the ReservationIds field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetReservationIdsOk() (*[]string, bool) { + if o == nil || o.ReservationIds == nil { + return nil, false + } + return o.ReservationIds, true +} + +// HasReservationIds returns a boolean if a field has been set. +func (o *FiltersVm) HasReservationIds() bool { + if o != nil && o.ReservationIds != nil { + return true + } + + return false +} + +// SetReservationIds gets a reference to the given []string and assigns it to the ReservationIds field. +func (o *FiltersVm) SetReservationIds(v []string) { + o.ReservationIds = &v +} + +// GetRootDeviceNames returns the RootDeviceNames field value if set, zero value otherwise. +func (o *FiltersVm) GetRootDeviceNames() []string { + if o == nil || o.RootDeviceNames == nil { + var ret []string + return ret + } + return *o.RootDeviceNames +} + +// GetRootDeviceNamesOk returns a tuple with the RootDeviceNames field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetRootDeviceNamesOk() (*[]string, bool) { + if o == nil || o.RootDeviceNames == nil { + return nil, false + } + return o.RootDeviceNames, true +} + +// HasRootDeviceNames returns a boolean if a field has been set. +func (o *FiltersVm) HasRootDeviceNames() bool { + if o != nil && o.RootDeviceNames != nil { + return true + } + + return false +} + +// SetRootDeviceNames gets a reference to the given []string and assigns it to the RootDeviceNames field. +func (o *FiltersVm) SetRootDeviceNames(v []string) { + o.RootDeviceNames = &v +} + +// GetRootDeviceTypes returns the RootDeviceTypes field value if set, zero value otherwise. +func (o *FiltersVm) GetRootDeviceTypes() []string { + if o == nil || o.RootDeviceTypes == nil { + var ret []string + return ret + } + return *o.RootDeviceTypes +} + +// GetRootDeviceTypesOk returns a tuple with the RootDeviceTypes field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetRootDeviceTypesOk() (*[]string, bool) { + if o == nil || o.RootDeviceTypes == nil { + return nil, false + } + return o.RootDeviceTypes, true +} + +// HasRootDeviceTypes returns a boolean if a field has been set. +func (o *FiltersVm) HasRootDeviceTypes() bool { + if o != nil && o.RootDeviceTypes != nil { + return true + } + + return false +} + +// SetRootDeviceTypes gets a reference to the given []string and assigns it to the RootDeviceTypes field. +func (o *FiltersVm) SetRootDeviceTypes(v []string) { + o.RootDeviceTypes = &v +} + +// GetSecurityGroupIds returns the SecurityGroupIds field value if set, zero value otherwise. +func (o *FiltersVm) GetSecurityGroupIds() []string { + if o == nil || o.SecurityGroupIds == nil { + var ret []string + return ret + } + return *o.SecurityGroupIds +} + +// GetSecurityGroupIdsOk returns a tuple with the SecurityGroupIds field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetSecurityGroupIdsOk() (*[]string, bool) { + if o == nil || o.SecurityGroupIds == nil { + return nil, false + } + return o.SecurityGroupIds, true +} + +// HasSecurityGroupIds returns a boolean if a field has been set. +func (o *FiltersVm) HasSecurityGroupIds() bool { + if o != nil && o.SecurityGroupIds != nil { + return true + } + + return false +} + +// SetSecurityGroupIds gets a reference to the given []string and assigns it to the SecurityGroupIds field. +func (o *FiltersVm) SetSecurityGroupIds(v []string) { + o.SecurityGroupIds = &v +} + +// GetSecurityGroupNames returns the SecurityGroupNames field value if set, zero value otherwise. +func (o *FiltersVm) GetSecurityGroupNames() []string { + if o == nil || o.SecurityGroupNames == nil { + var ret []string + return ret + } + return *o.SecurityGroupNames +} + +// GetSecurityGroupNamesOk returns a tuple with the SecurityGroupNames field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetSecurityGroupNamesOk() (*[]string, bool) { + if o == nil || o.SecurityGroupNames == nil { + return nil, false + } + return o.SecurityGroupNames, true +} + +// HasSecurityGroupNames returns a boolean if a field has been set. +func (o *FiltersVm) HasSecurityGroupNames() bool { + if o != nil && o.SecurityGroupNames != nil { + return true + } + + return false +} + +// SetSecurityGroupNames gets a reference to the given []string and assigns it to the SecurityGroupNames field. +func (o *FiltersVm) SetSecurityGroupNames(v []string) { + o.SecurityGroupNames = &v +} + +// GetStateReasonCodes returns the StateReasonCodes field value if set, zero value otherwise. +func (o *FiltersVm) GetStateReasonCodes() []int32 { + if o == nil || o.StateReasonCodes == nil { + var ret []int32 + return ret + } + return *o.StateReasonCodes +} + +// GetStateReasonCodesOk returns a tuple with the StateReasonCodes field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetStateReasonCodesOk() (*[]int32, bool) { + if o == nil || o.StateReasonCodes == nil { + return nil, false + } + return o.StateReasonCodes, true +} + +// HasStateReasonCodes returns a boolean if a field has been set. +func (o *FiltersVm) HasStateReasonCodes() bool { + if o != nil && o.StateReasonCodes != nil { + return true + } + + return false +} + +// SetStateReasonCodes gets a reference to the given []int32 and assigns it to the StateReasonCodes field. +func (o *FiltersVm) SetStateReasonCodes(v []int32) { + o.StateReasonCodes = &v +} + +// GetStateReasonMessages returns the StateReasonMessages field value if set, zero value otherwise. +func (o *FiltersVm) GetStateReasonMessages() []string { + if o == nil || o.StateReasonMessages == nil { + var ret []string + return ret + } + return *o.StateReasonMessages +} + +// GetStateReasonMessagesOk returns a tuple with the StateReasonMessages field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetStateReasonMessagesOk() (*[]string, bool) { + if o == nil || o.StateReasonMessages == nil { + return nil, false + } + return o.StateReasonMessages, true +} + +// HasStateReasonMessages returns a boolean if a field has been set. +func (o *FiltersVm) HasStateReasonMessages() bool { + if o != nil && o.StateReasonMessages != nil { + return true + } + + return false +} + +// SetStateReasonMessages gets a reference to the given []string and assigns it to the StateReasonMessages field. +func (o *FiltersVm) SetStateReasonMessages(v []string) { + o.StateReasonMessages = &v +} + +// GetStateReasons returns the StateReasons field value if set, zero value otherwise. +func (o *FiltersVm) GetStateReasons() []string { + if o == nil || o.StateReasons == nil { + var ret []string + return ret + } + return *o.StateReasons +} + +// GetStateReasonsOk returns a tuple with the StateReasons field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetStateReasonsOk() (*[]string, bool) { + if o == nil || o.StateReasons == nil { + return nil, false + } + return o.StateReasons, true +} + +// HasStateReasons returns a boolean if a field has been set. +func (o *FiltersVm) HasStateReasons() bool { + if o != nil && o.StateReasons != nil { + return true + } + + return false +} + +// SetStateReasons gets a reference to the given []string and assigns it to the StateReasons field. +func (o *FiltersVm) SetStateReasons(v []string) { + o.StateReasons = &v +} + +// GetSubnetIds returns the SubnetIds field value if set, zero value otherwise. +func (o *FiltersVm) GetSubnetIds() []string { + if o == nil || o.SubnetIds == nil { + var ret []string + return ret + } + return *o.SubnetIds +} + +// GetSubnetIdsOk returns a tuple with the SubnetIds field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetSubnetIdsOk() (*[]string, bool) { + if o == nil || o.SubnetIds == nil { + return nil, false + } + return o.SubnetIds, true +} + +// HasSubnetIds returns a boolean if a field has been set. +func (o *FiltersVm) HasSubnetIds() bool { + if o != nil && o.SubnetIds != nil { + return true + } + + return false +} + +// SetSubnetIds gets a reference to the given []string and assigns it to the SubnetIds field. +func (o *FiltersVm) SetSubnetIds(v []string) { + o.SubnetIds = &v +} + +// GetSubregionNames returns the SubregionNames field value if set, zero value otherwise. +func (o *FiltersVm) GetSubregionNames() []string { + if o == nil || o.SubregionNames == nil { + var ret []string + return ret + } + return *o.SubregionNames +} + +// GetSubregionNamesOk returns a tuple with the SubregionNames field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetSubregionNamesOk() (*[]string, bool) { + if o == nil || o.SubregionNames == nil { + return nil, false + } + return o.SubregionNames, true +} + +// HasSubregionNames returns a boolean if a field has been set. +func (o *FiltersVm) HasSubregionNames() bool { + if o != nil && o.SubregionNames != nil { + return true + } + + return false +} + +// SetSubregionNames gets a reference to the given []string and assigns it to the SubregionNames field. +func (o *FiltersVm) SetSubregionNames(v []string) { + o.SubregionNames = &v +} + // GetTagKeys returns the TagKeys field value if set, zero value otherwise. func (o *FiltersVm) GetTagKeys() []string { if o == nil || o.TagKeys == nil { @@ -140,6 +1988,38 @@ func (o *FiltersVm) SetTags(v []string) { o.Tags = &v } +// GetTenancies returns the Tenancies field value if set, zero value otherwise. +func (o *FiltersVm) GetTenancies() []string { + if o == nil || o.Tenancies == nil { + var ret []string + return ret + } + return *o.Tenancies +} + +// GetTenanciesOk returns a tuple with the Tenancies field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetTenanciesOk() (*[]string, bool) { + if o == nil || o.Tenancies == nil { + return nil, false + } + return o.Tenancies, true +} + +// HasTenancies returns a boolean if a field has been set. +func (o *FiltersVm) HasTenancies() bool { + if o != nil && o.Tenancies != nil { + return true + } + + return false +} + +// SetTenancies gets a reference to the given []string and assigns it to the Tenancies field. +func (o *FiltersVm) SetTenancies(v []string) { + o.Tenancies = &v +} + // GetVmIds returns the VmIds field value if set, zero value otherwise. func (o *FiltersVm) GetVmIds() []string { if o == nil || o.VmIds == nil { @@ -172,8 +2052,330 @@ func (o *FiltersVm) SetVmIds(v []string) { o.VmIds = &v } +// GetVmSecurityGroupIds returns the VmSecurityGroupIds field value if set, zero value otherwise. +func (o *FiltersVm) GetVmSecurityGroupIds() []string { + if o == nil || o.VmSecurityGroupIds == nil { + var ret []string + return ret + } + return *o.VmSecurityGroupIds +} + +// GetVmSecurityGroupIdsOk returns a tuple with the VmSecurityGroupIds field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetVmSecurityGroupIdsOk() (*[]string, bool) { + if o == nil || o.VmSecurityGroupIds == nil { + return nil, false + } + return o.VmSecurityGroupIds, true +} + +// HasVmSecurityGroupIds returns a boolean if a field has been set. +func (o *FiltersVm) HasVmSecurityGroupIds() bool { + if o != nil && o.VmSecurityGroupIds != nil { + return true + } + + return false +} + +// SetVmSecurityGroupIds gets a reference to the given []string and assigns it to the VmSecurityGroupIds field. +func (o *FiltersVm) SetVmSecurityGroupIds(v []string) { + o.VmSecurityGroupIds = &v +} + +// GetVmSecurityGroupNames returns the VmSecurityGroupNames field value if set, zero value otherwise. +func (o *FiltersVm) GetVmSecurityGroupNames() []string { + if o == nil || o.VmSecurityGroupNames == nil { + var ret []string + return ret + } + return *o.VmSecurityGroupNames +} + +// GetVmSecurityGroupNamesOk returns a tuple with the VmSecurityGroupNames field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetVmSecurityGroupNamesOk() (*[]string, bool) { + if o == nil || o.VmSecurityGroupNames == nil { + return nil, false + } + return o.VmSecurityGroupNames, true +} + +// HasVmSecurityGroupNames returns a boolean if a field has been set. +func (o *FiltersVm) HasVmSecurityGroupNames() bool { + if o != nil && o.VmSecurityGroupNames != nil { + return true + } + + return false +} + +// SetVmSecurityGroupNames gets a reference to the given []string and assigns it to the VmSecurityGroupNames field. +func (o *FiltersVm) SetVmSecurityGroupNames(v []string) { + o.VmSecurityGroupNames = &v +} + +// GetVmStateCodes returns the VmStateCodes field value if set, zero value otherwise. +func (o *FiltersVm) GetVmStateCodes() []int32 { + if o == nil || o.VmStateCodes == nil { + var ret []int32 + return ret + } + return *o.VmStateCodes +} + +// GetVmStateCodesOk returns a tuple with the VmStateCodes field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetVmStateCodesOk() (*[]int32, bool) { + if o == nil || o.VmStateCodes == nil { + return nil, false + } + return o.VmStateCodes, true +} + +// HasVmStateCodes returns a boolean if a field has been set. +func (o *FiltersVm) HasVmStateCodes() bool { + if o != nil && o.VmStateCodes != nil { + return true + } + + return false +} + +// SetVmStateCodes gets a reference to the given []int32 and assigns it to the VmStateCodes field. +func (o *FiltersVm) SetVmStateCodes(v []int32) { + o.VmStateCodes = &v +} + +// GetVmStateNames returns the VmStateNames field value if set, zero value otherwise. +func (o *FiltersVm) GetVmStateNames() []string { + if o == nil || o.VmStateNames == nil { + var ret []string + return ret + } + return *o.VmStateNames +} + +// GetVmStateNamesOk returns a tuple with the VmStateNames field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetVmStateNamesOk() (*[]string, bool) { + if o == nil || o.VmStateNames == nil { + return nil, false + } + return o.VmStateNames, true +} + +// HasVmStateNames returns a boolean if a field has been set. +func (o *FiltersVm) HasVmStateNames() bool { + if o != nil && o.VmStateNames != nil { + return true + } + + return false +} + +// SetVmStateNames gets a reference to the given []string and assigns it to the VmStateNames field. +func (o *FiltersVm) SetVmStateNames(v []string) { + o.VmStateNames = &v +} + +// GetVmTypes returns the VmTypes field value if set, zero value otherwise. +func (o *FiltersVm) GetVmTypes() []string { + if o == nil || o.VmTypes == nil { + var ret []string + return ret + } + return *o.VmTypes +} + +// GetVmTypesOk returns a tuple with the VmTypes field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVm) GetVmTypesOk() (*[]string, bool) { + if o == nil || o.VmTypes == nil { + return nil, false + } + return o.VmTypes, true +} + +// HasVmTypes returns a boolean if a field has been set. +func (o *FiltersVm) HasVmTypes() bool { + if o != nil && o.VmTypes != nil { + return true + } + + return false +} + +// SetVmTypes gets a reference to the given []string and assigns it to the VmTypes field. +func (o *FiltersVm) SetVmTypes(v []string) { + o.VmTypes = &v +} + func (o FiltersVm) MarshalJSON() ([]byte, error) { toSerialize := map[string]interface{}{} + if o.Architectures != nil { + toSerialize["Architectures"] = o.Architectures + } + if o.BlockDeviceMappingDeleteOnVmDeletion != nil { + toSerialize["BlockDeviceMappingDeleteOnVmDeletion"] = o.BlockDeviceMappingDeleteOnVmDeletion + } + if o.BlockDeviceMappingDeviceNames != nil { + toSerialize["BlockDeviceMappingDeviceNames"] = o.BlockDeviceMappingDeviceNames + } + if o.BlockDeviceMappingLinkDates != nil { + toSerialize["BlockDeviceMappingLinkDates"] = o.BlockDeviceMappingLinkDates + } + if o.BlockDeviceMappingStates != nil { + toSerialize["BlockDeviceMappingStates"] = o.BlockDeviceMappingStates + } + if o.BlockDeviceMappingVolumeIds != nil { + toSerialize["BlockDeviceMappingVolumeIds"] = o.BlockDeviceMappingVolumeIds + } + if o.ClientTokens != nil { + toSerialize["ClientTokens"] = o.ClientTokens + } + if o.CreationDates != nil { + toSerialize["CreationDates"] = o.CreationDates + } + if o.ImageIds != nil { + toSerialize["ImageIds"] = o.ImageIds + } + if o.IsSourceDestChecked != nil { + toSerialize["IsSourceDestChecked"] = o.IsSourceDestChecked + } + if o.KeypairNames != nil { + toSerialize["KeypairNames"] = o.KeypairNames + } + if o.LaunchNumbers != nil { + toSerialize["LaunchNumbers"] = o.LaunchNumbers + } + if o.Lifecycles != nil { + toSerialize["Lifecycles"] = o.Lifecycles + } + if o.NetIds != nil { + toSerialize["NetIds"] = o.NetIds + } + if o.NicAccountIds != nil { + toSerialize["NicAccountIds"] = o.NicAccountIds + } + if o.NicDescriptions != nil { + toSerialize["NicDescriptions"] = o.NicDescriptions + } + if o.NicIsSourceDestChecked != nil { + toSerialize["NicIsSourceDestChecked"] = o.NicIsSourceDestChecked + } + if o.NicLinkNicDeleteOnVmDeletion != nil { + toSerialize["NicLinkNicDeleteOnVmDeletion"] = o.NicLinkNicDeleteOnVmDeletion + } + if o.NicLinkNicDeviceNumbers != nil { + toSerialize["NicLinkNicDeviceNumbers"] = o.NicLinkNicDeviceNumbers + } + if o.NicLinkNicLinkNicDates != nil { + toSerialize["NicLinkNicLinkNicDates"] = o.NicLinkNicLinkNicDates + } + if o.NicLinkNicLinkNicIds != nil { + toSerialize["NicLinkNicLinkNicIds"] = o.NicLinkNicLinkNicIds + } + if o.NicLinkNicStates != nil { + toSerialize["NicLinkNicStates"] = o.NicLinkNicStates + } + if o.NicLinkNicVmAccountIds != nil { + toSerialize["NicLinkNicVmAccountIds"] = o.NicLinkNicVmAccountIds + } + if o.NicLinkNicVmIds != nil { + toSerialize["NicLinkNicVmIds"] = o.NicLinkNicVmIds + } + if o.NicLinkPublicIpAccountIds != nil { + toSerialize["NicLinkPublicIpAccountIds"] = o.NicLinkPublicIpAccountIds + } + if o.NicLinkPublicIpLinkPublicIpIds != nil { + toSerialize["NicLinkPublicIpLinkPublicIpIds"] = o.NicLinkPublicIpLinkPublicIpIds + } + if o.NicLinkPublicIpPublicIpIds != nil { + toSerialize["NicLinkPublicIpPublicIpIds"] = o.NicLinkPublicIpPublicIpIds + } + if o.NicLinkPublicIpPublicIps != nil { + toSerialize["NicLinkPublicIpPublicIps"] = o.NicLinkPublicIpPublicIps + } + if o.NicMacAddresses != nil { + toSerialize["NicMacAddresses"] = o.NicMacAddresses + } + if o.NicNetIds != nil { + toSerialize["NicNetIds"] = o.NicNetIds + } + if o.NicNicIds != nil { + toSerialize["NicNicIds"] = o.NicNicIds + } + if o.NicPrivateIpsLinkPublicIpAccountIds != nil { + toSerialize["NicPrivateIpsLinkPublicIpAccountIds"] = o.NicPrivateIpsLinkPublicIpAccountIds + } + if o.NicPrivateIpsLinkPublicIpIds != nil { + toSerialize["NicPrivateIpsLinkPublicIpIds"] = o.NicPrivateIpsLinkPublicIpIds + } + if o.NicPrivateIpsPrimaryIp != nil { + toSerialize["NicPrivateIpsPrimaryIp"] = o.NicPrivateIpsPrimaryIp + } + if o.NicPrivateIpsPrivateIps != nil { + toSerialize["NicPrivateIpsPrivateIps"] = o.NicPrivateIpsPrivateIps + } + if o.NicSecurityGroupIds != nil { + toSerialize["NicSecurityGroupIds"] = o.NicSecurityGroupIds + } + if o.NicSecurityGroupNames != nil { + toSerialize["NicSecurityGroupNames"] = o.NicSecurityGroupNames + } + if o.NicStates != nil { + toSerialize["NicStates"] = o.NicStates + } + if o.NicSubnetIds != nil { + toSerialize["NicSubnetIds"] = o.NicSubnetIds + } + if o.NicSubregionNames != nil { + toSerialize["NicSubregionNames"] = o.NicSubregionNames + } + if o.Platforms != nil { + toSerialize["Platforms"] = o.Platforms + } + if o.PrivateIps != nil { + toSerialize["PrivateIps"] = o.PrivateIps + } + if o.ProductCodes != nil { + toSerialize["ProductCodes"] = o.ProductCodes + } + if o.PublicIps != nil { + toSerialize["PublicIps"] = o.PublicIps + } + if o.ReservationIds != nil { + toSerialize["ReservationIds"] = o.ReservationIds + } + if o.RootDeviceNames != nil { + toSerialize["RootDeviceNames"] = o.RootDeviceNames + } + if o.RootDeviceTypes != nil { + toSerialize["RootDeviceTypes"] = o.RootDeviceTypes + } + if o.SecurityGroupIds != nil { + toSerialize["SecurityGroupIds"] = o.SecurityGroupIds + } + if o.SecurityGroupNames != nil { + toSerialize["SecurityGroupNames"] = o.SecurityGroupNames + } + if o.StateReasonCodes != nil { + toSerialize["StateReasonCodes"] = o.StateReasonCodes + } + if o.StateReasonMessages != nil { + toSerialize["StateReasonMessages"] = o.StateReasonMessages + } + if o.StateReasons != nil { + toSerialize["StateReasons"] = o.StateReasons + } + if o.SubnetIds != nil { + toSerialize["SubnetIds"] = o.SubnetIds + } + if o.SubregionNames != nil { + toSerialize["SubregionNames"] = o.SubregionNames + } if o.TagKeys != nil { toSerialize["TagKeys"] = o.TagKeys } @@ -183,9 +2385,27 @@ func (o FiltersVm) MarshalJSON() ([]byte, error) { if o.Tags != nil { toSerialize["Tags"] = o.Tags } + if o.Tenancies != nil { + toSerialize["Tenancies"] = o.Tenancies + } if o.VmIds != nil { toSerialize["VmIds"] = o.VmIds } + if o.VmSecurityGroupIds != nil { + toSerialize["VmSecurityGroupIds"] = o.VmSecurityGroupIds + } + if o.VmSecurityGroupNames != nil { + toSerialize["VmSecurityGroupNames"] = o.VmSecurityGroupNames + } + if o.VmStateCodes != nil { + toSerialize["VmStateCodes"] = o.VmStateCodes + } + if o.VmStateNames != nil { + toSerialize["VmStateNames"] = o.VmStateNames + } + if o.VmTypes != nil { + toSerialize["VmTypes"] = o.VmTypes + } return json.Marshal(toSerialize) } diff --git a/v2/model_filters_vm_group.go b/v2/model_filters_vm_group.go index 4b2bd8f26..9dbba2e87 100644 --- a/v2/model_filters_vm_group.go +++ b/v2/model_filters_vm_group.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_filters_vm_template.go b/v2/model_filters_vm_template.go index 147464755..ba045e85b 100644 --- a/v2/model_filters_vm_template.go +++ b/v2/model_filters_vm_template.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -35,7 +35,7 @@ type FiltersVmTemplate struct { TagKeys *[]string `json:"TagKeys,omitempty"` // The values of the tags associated with the VM templates. TagValues *[]string `json:"TagValues,omitempty"` - // The key/value combination of the tags associated with the VM templates, in the following format: \"Filters\":{\"Tags\":[\"TAGKEY=TAGVALUE\"]}. + // The key/value combination of the tags associated with the VM templates, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}. Tags *[]string `json:"Tags,omitempty"` // The IDs of the VM templates. VmTemplateIds *[]string `json:"VmTemplateIds,omitempty"` diff --git a/v2/model_filters_vm_type.go b/v2/model_filters_vm_type.go index 55b03dd91..f960eafd6 100644 --- a/v2/model_filters_vm_type.go +++ b/v2/model_filters_vm_type.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -19,11 +19,17 @@ import ( type FiltersVmType struct { // This parameter is not available. It is present in our API for the sake of historical compatibility with AWS. BsuOptimized *bool `json:"BsuOptimized,omitempty"` + // The types of ephemeral storage disk. + EphemeralsTypes *[]string `json:"EphemeralsTypes,omitempty"` + // The number of Ethernet interfaces available. + Eths *[]int32 `json:"Eths,omitempty"` + // The number of GPUs available. + Gpus *[]int32 `json:"Gpus,omitempty"` // The amounts of memory, in gibibytes (GiB). MemorySizes *[]float32 `json:"MemorySizes,omitempty"` // The numbers of vCores. VcoreCounts *[]int32 `json:"VcoreCounts,omitempty"` - // The names of the VM types. For more information, see [Instance Types](https://docs.outscale.com/en/userguide/Instance-Types.html). + // The names of the VM types. For more information, see [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html). VmTypeNames *[]string `json:"VmTypeNames,omitempty"` // The maximum number of ephemeral storage disks. VolumeCounts *[]int32 `json:"VolumeCounts,omitempty"` @@ -80,6 +86,102 @@ func (o *FiltersVmType) SetBsuOptimized(v bool) { o.BsuOptimized = &v } +// GetEphemeralsTypes returns the EphemeralsTypes field value if set, zero value otherwise. +func (o *FiltersVmType) GetEphemeralsTypes() []string { + if o == nil || o.EphemeralsTypes == nil { + var ret []string + return ret + } + return *o.EphemeralsTypes +} + +// GetEphemeralsTypesOk returns a tuple with the EphemeralsTypes field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVmType) GetEphemeralsTypesOk() (*[]string, bool) { + if o == nil || o.EphemeralsTypes == nil { + return nil, false + } + return o.EphemeralsTypes, true +} + +// HasEphemeralsTypes returns a boolean if a field has been set. +func (o *FiltersVmType) HasEphemeralsTypes() bool { + if o != nil && o.EphemeralsTypes != nil { + return true + } + + return false +} + +// SetEphemeralsTypes gets a reference to the given []string and assigns it to the EphemeralsTypes field. +func (o *FiltersVmType) SetEphemeralsTypes(v []string) { + o.EphemeralsTypes = &v +} + +// GetEths returns the Eths field value if set, zero value otherwise. +func (o *FiltersVmType) GetEths() []int32 { + if o == nil || o.Eths == nil { + var ret []int32 + return ret + } + return *o.Eths +} + +// GetEthsOk returns a tuple with the Eths field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVmType) GetEthsOk() (*[]int32, bool) { + if o == nil || o.Eths == nil { + return nil, false + } + return o.Eths, true +} + +// HasEths returns a boolean if a field has been set. +func (o *FiltersVmType) HasEths() bool { + if o != nil && o.Eths != nil { + return true + } + + return false +} + +// SetEths gets a reference to the given []int32 and assigns it to the Eths field. +func (o *FiltersVmType) SetEths(v []int32) { + o.Eths = &v +} + +// GetGpus returns the Gpus field value if set, zero value otherwise. +func (o *FiltersVmType) GetGpus() []int32 { + if o == nil || o.Gpus == nil { + var ret []int32 + return ret + } + return *o.Gpus +} + +// GetGpusOk returns a tuple with the Gpus field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FiltersVmType) GetGpusOk() (*[]int32, bool) { + if o == nil || o.Gpus == nil { + return nil, false + } + return o.Gpus, true +} + +// HasGpus returns a boolean if a field has been set. +func (o *FiltersVmType) HasGpus() bool { + if o != nil && o.Gpus != nil { + return true + } + + return false +} + +// SetGpus gets a reference to the given []int32 and assigns it to the Gpus field. +func (o *FiltersVmType) SetGpus(v []int32) { + o.Gpus = &v +} + // GetMemorySizes returns the MemorySizes field value if set, zero value otherwise. func (o *FiltersVmType) GetMemorySizes() []float32 { if o == nil || o.MemorySizes == nil { @@ -245,6 +347,15 @@ func (o FiltersVmType) MarshalJSON() ([]byte, error) { if o.BsuOptimized != nil { toSerialize["BsuOptimized"] = o.BsuOptimized } + if o.EphemeralsTypes != nil { + toSerialize["EphemeralsTypes"] = o.EphemeralsTypes + } + if o.Eths != nil { + toSerialize["Eths"] = o.Eths + } + if o.Gpus != nil { + toSerialize["Gpus"] = o.Gpus + } if o.MemorySizes != nil { toSerialize["MemorySizes"] = o.MemorySizes } diff --git a/v2/model_filters_vms_state.go b/v2/model_filters_vms_state.go index 7c2b4cc17..4ab0ce05e 100644 --- a/v2/model_filters_vms_state.go +++ b/v2/model_filters_vms_state.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_filters_volume.go b/v2/model_filters_volume.go index 52a6b0972..7ae6c3ba4 100644 --- a/v2/model_filters_volume.go +++ b/v2/model_filters_volume.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_filters_vpn_connection.go b/v2/model_filters_vpn_connection.go index cfa6f96be..cfbf479c7 100644 --- a/v2/model_filters_vpn_connection.go +++ b/v2/model_filters_vpn_connection.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_flexible_gpu.go b/v2/model_flexible_gpu.go index 4138e3ed0..3c9e221e0 100644 --- a/v2/model_flexible_gpu.go +++ b/v2/model_flexible_gpu.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_flexible_gpu_catalog.go b/v2/model_flexible_gpu_catalog.go index deb423e78..3195745a9 100644 --- a/v2/model_flexible_gpu_catalog.go +++ b/v2/model_flexible_gpu_catalog.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_health_check.go b/v2/model_health_check.go index baa3ed93c..100c080a4 100644 --- a/v2/model_health_check.go +++ b/v2/model_health_check.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -17,11 +17,11 @@ import ( // HealthCheck Information about the health check configuration. type HealthCheck struct { - // The number of seconds between two pings (between `5` and `600` both included). + // The number of seconds between two requests (between `5` and `600` both included). CheckInterval int32 `json:"CheckInterval"` - // The number of consecutive successful pings before considering the VM as healthy (between `2` and `10` both included). + // The number of consecutive successful requests before considering the VM as healthy (between `2` and `10` both included). HealthyThreshold int32 `json:"HealthyThreshold"` - // If you use the HTTP or HTTPS protocols, the ping path. + // If you use the HTTP or HTTPS protocols, the request URL path. Path *string `json:"Path,omitempty"` // The port number (between `1` and `65535`, both included). Port int32 `json:"Port"` @@ -29,7 +29,7 @@ type HealthCheck struct { Protocol string `json:"Protocol"` // The maximum waiting time for a response before considering the VM as unhealthy, in seconds (between `2` and `60` both included). Timeout int32 `json:"Timeout"` - // The number of consecutive failed pings before considering the VM as unhealthy (between `2` and `10` both included). + // The number of consecutive failed requests before considering the VM as unhealthy (between `2` and `10` both included). UnhealthyThreshold int32 `json:"UnhealthyThreshold"` } diff --git a/v2/model_image.go b/v2/model_image.go index 41a9609b4..3c1861a78 100644 --- a/v2/model_image.go +++ b/v2/model_image.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -21,7 +21,7 @@ type Image struct { AccountAlias *string `json:"AccountAlias,omitempty"` // The account ID of the owner of the OMI. AccountId *string `json:"AccountId,omitempty"` - // The architecture of the OMI (by default, `i386`). + // The architecture of the OMI. Architecture *string `json:"Architecture,omitempty"` // One or more block device mappings. BlockDeviceMappings *[]BlockDeviceMappingImage `json:"BlockDeviceMappings,omitempty"` @@ -29,7 +29,7 @@ type Image struct { CreationDate *string `json:"CreationDate,omitempty"` // The description of the OMI. Description *string `json:"Description,omitempty"` - // The location of the bucket where the OMI files are stored. + // The location from which the OMI files were created. FileLocation *string `json:"FileLocation,omitempty"` // The ID of the OMI. ImageId *string `json:"ImageId,omitempty"` diff --git a/v2/model_image_export_task.go b/v2/model_image_export_task.go index f80696506..818ffac67 100644 --- a/v2/model_image_export_task.go +++ b/v2/model_image_export_task.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_internet_service.go b/v2/model_internet_service.go index c9534ae62..8032aa854 100644 --- a/v2/model_internet_service.go +++ b/v2/model_internet_service.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_keypair.go b/v2/model_keypair.go index 1136ff5eb..fb750a7f8 100644 --- a/v2/model_keypair.go +++ b/v2/model_keypair.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -21,6 +21,8 @@ type Keypair struct { KeypairFingerprint *string `json:"KeypairFingerprint,omitempty"` // The name of the keypair. KeypairName *string `json:"KeypairName,omitempty"` + // The type of the keypair (`ssh-rsa`, `ssh-ed25519`, `ecdsa-sha2-nistp256`, `ecdsa-sha2-nistp384`, or `ecdsa-sha2-nistp521`). + KeypairType *string `json:"KeypairType,omitempty"` } // NewKeypair instantiates a new Keypair object @@ -104,6 +106,38 @@ func (o *Keypair) SetKeypairName(v string) { o.KeypairName = &v } +// GetKeypairType returns the KeypairType field value if set, zero value otherwise. +func (o *Keypair) GetKeypairType() string { + if o == nil || o.KeypairType == nil { + var ret string + return ret + } + return *o.KeypairType +} + +// GetKeypairTypeOk returns a tuple with the KeypairType field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Keypair) GetKeypairTypeOk() (*string, bool) { + if o == nil || o.KeypairType == nil { + return nil, false + } + return o.KeypairType, true +} + +// HasKeypairType returns a boolean if a field has been set. +func (o *Keypair) HasKeypairType() bool { + if o != nil && o.KeypairType != nil { + return true + } + + return false +} + +// SetKeypairType gets a reference to the given string and assigns it to the KeypairType field. +func (o *Keypair) SetKeypairType(v string) { + o.KeypairType = &v +} + func (o Keypair) MarshalJSON() ([]byte, error) { toSerialize := map[string]interface{}{} if o.KeypairFingerprint != nil { @@ -112,6 +146,9 @@ func (o Keypair) MarshalJSON() ([]byte, error) { if o.KeypairName != nil { toSerialize["KeypairName"] = o.KeypairName } + if o.KeypairType != nil { + toSerialize["KeypairType"] = o.KeypairType + } return json.Marshal(toSerialize) } diff --git a/v2/model_keypair_created.go b/v2/model_keypair_created.go index ec13030c0..5b1aa3522 100644 --- a/v2/model_keypair_created.go +++ b/v2/model_keypair_created.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -17,11 +17,13 @@ import ( // KeypairCreated Information about the created keypair. type KeypairCreated struct { - // The MD5 public key fingerprint as specified in section 4 of RFC 4716. + // The MD5 public key fingerprint, as specified in section 4 of RFC 4716. KeypairFingerprint *string `json:"KeypairFingerprint,omitempty"` // The name of the keypair. KeypairName *string `json:"KeypairName,omitempty"` - // The private key. When saving the private key in a .rsa file, replace the `\\n` escape sequences with line breaks. + // The type of the keypair (`ssh-rsa`, `ssh-ed25519`, `ecdsa-sha2-nistp256`, `ecdsa-sha2-nistp384`, or `ecdsa-sha2-nistp521`). + KeypairType *string `json:"KeypairType,omitempty"` + // 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. PrivateKey *string `json:"PrivateKey,omitempty"` } @@ -106,6 +108,38 @@ func (o *KeypairCreated) SetKeypairName(v string) { o.KeypairName = &v } +// GetKeypairType returns the KeypairType field value if set, zero value otherwise. +func (o *KeypairCreated) GetKeypairType() string { + if o == nil || o.KeypairType == nil { + var ret string + return ret + } + return *o.KeypairType +} + +// GetKeypairTypeOk returns a tuple with the KeypairType field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *KeypairCreated) GetKeypairTypeOk() (*string, bool) { + if o == nil || o.KeypairType == nil { + return nil, false + } + return o.KeypairType, true +} + +// HasKeypairType returns a boolean if a field has been set. +func (o *KeypairCreated) HasKeypairType() bool { + if o != nil && o.KeypairType != nil { + return true + } + + return false +} + +// SetKeypairType gets a reference to the given string and assigns it to the KeypairType field. +func (o *KeypairCreated) SetKeypairType(v string) { + o.KeypairType = &v +} + // GetPrivateKey returns the PrivateKey field value if set, zero value otherwise. func (o *KeypairCreated) GetPrivateKey() string { if o == nil || o.PrivateKey == nil { @@ -146,6 +180,9 @@ func (o KeypairCreated) MarshalJSON() ([]byte, error) { if o.KeypairName != nil { toSerialize["KeypairName"] = o.KeypairName } + if o.KeypairType != nil { + toSerialize["KeypairType"] = o.KeypairType + } if o.PrivateKey != nil { toSerialize["PrivateKey"] = o.PrivateKey } diff --git a/v2/model_link_flexible_gpu_request.go b/v2/model_link_flexible_gpu_request.go index 82fec1aed..288a90639 100644 --- a/v2/model_link_flexible_gpu_request.go +++ b/v2/model_link_flexible_gpu_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_link_flexible_gpu_response.go b/v2/model_link_flexible_gpu_response.go index dedff8a14..2dce6a1ff 100644 --- a/v2/model_link_flexible_gpu_response.go +++ b/v2/model_link_flexible_gpu_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_link_internet_service_request.go b/v2/model_link_internet_service_request.go index 3902b0c0b..77598850d 100644 --- a/v2/model_link_internet_service_request.go +++ b/v2/model_link_internet_service_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_link_internet_service_response.go b/v2/model_link_internet_service_response.go index 34b933f51..f5d4fc47b 100644 --- a/v2/model_link_internet_service_response.go +++ b/v2/model_link_internet_service_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_link_load_balancer_backend_machines_request.go b/v2/model_link_load_balancer_backend_machines_request.go index b6d6ad200..92c282f1e 100644 --- a/v2/model_link_load_balancer_backend_machines_request.go +++ b/v2/model_link_load_balancer_backend_machines_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_link_load_balancer_backend_machines_response.go b/v2/model_link_load_balancer_backend_machines_response.go index 1b5e309e3..488332762 100644 --- a/v2/model_link_load_balancer_backend_machines_response.go +++ b/v2/model_link_load_balancer_backend_machines_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_link_nic.go b/v2/model_link_nic.go index c8e0e79d8..96e2d158a 100644 --- a/v2/model_link_nic.go +++ b/v2/model_link_nic.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_link_nic_light.go b/v2/model_link_nic_light.go index b8ed8d020..6f2b935d1 100644 --- a/v2/model_link_nic_light.go +++ b/v2/model_link_nic_light.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_link_nic_request.go b/v2/model_link_nic_request.go index ed0e78669..7e61cd871 100644 --- a/v2/model_link_nic_request.go +++ b/v2/model_link_nic_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_link_nic_response.go b/v2/model_link_nic_response.go index 22cca6e09..70598da20 100644 --- a/v2/model_link_nic_response.go +++ b/v2/model_link_nic_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_link_nic_to_update.go b/v2/model_link_nic_to_update.go index 759586224..aaa105a3c 100644 --- a/v2/model_link_nic_to_update.go +++ b/v2/model_link_nic_to_update.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_link_policy_request.go b/v2/model_link_policy_request.go new file mode 100644 index 000000000..63abedc2d --- /dev/null +++ b/v2/model_link_policy_request.go @@ -0,0 +1,175 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// LinkPolicyRequest struct for LinkPolicyRequest +type LinkPolicyRequest struct { + // If true, checks whether you have the required permissions to perform the action. + DryRun *bool `json:"DryRun,omitempty"` + // The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + PolicyOrn string `json:"PolicyOrn"` + // The name of the user you want to link the policy to (between 1 and 64 characters). + UserName string `json:"UserName"` +} + +// NewLinkPolicyRequest instantiates a new LinkPolicyRequest object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewLinkPolicyRequest(policyOrn string, userName string) *LinkPolicyRequest { + this := LinkPolicyRequest{} + this.PolicyOrn = policyOrn + this.UserName = userName + return &this +} + +// NewLinkPolicyRequestWithDefaults instantiates a new LinkPolicyRequest object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewLinkPolicyRequestWithDefaults() *LinkPolicyRequest { + this := LinkPolicyRequest{} + return &this +} + +// GetDryRun returns the DryRun field value if set, zero value otherwise. +func (o *LinkPolicyRequest) GetDryRun() bool { + if o == nil || o.DryRun == nil { + var ret bool + return ret + } + return *o.DryRun +} + +// GetDryRunOk returns a tuple with the DryRun field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *LinkPolicyRequest) GetDryRunOk() (*bool, bool) { + if o == nil || o.DryRun == nil { + return nil, false + } + return o.DryRun, true +} + +// HasDryRun returns a boolean if a field has been set. +func (o *LinkPolicyRequest) HasDryRun() bool { + if o != nil && o.DryRun != nil { + return true + } + + return false +} + +// SetDryRun gets a reference to the given bool and assigns it to the DryRun field. +func (o *LinkPolicyRequest) SetDryRun(v bool) { + o.DryRun = &v +} + +// GetPolicyOrn returns the PolicyOrn field value +func (o *LinkPolicyRequest) GetPolicyOrn() string { + if o == nil { + var ret string + return ret + } + + return o.PolicyOrn +} + +// GetPolicyOrnOk returns a tuple with the PolicyOrn field value +// and a boolean to check if the value has been set. +func (o *LinkPolicyRequest) GetPolicyOrnOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.PolicyOrn, true +} + +// SetPolicyOrn sets field value +func (o *LinkPolicyRequest) SetPolicyOrn(v string) { + o.PolicyOrn = v +} + +// GetUserName returns the UserName field value +func (o *LinkPolicyRequest) GetUserName() string { + if o == nil { + var ret string + return ret + } + + return o.UserName +} + +// GetUserNameOk returns a tuple with the UserName field value +// and a boolean to check if the value has been set. +func (o *LinkPolicyRequest) GetUserNameOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.UserName, true +} + +// SetUserName sets field value +func (o *LinkPolicyRequest) SetUserName(v string) { + o.UserName = v +} + +func (o LinkPolicyRequest) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.DryRun != nil { + toSerialize["DryRun"] = o.DryRun + } + if true { + toSerialize["PolicyOrn"] = o.PolicyOrn + } + if true { + toSerialize["UserName"] = o.UserName + } + return json.Marshal(toSerialize) +} + +type NullableLinkPolicyRequest struct { + value *LinkPolicyRequest + isSet bool +} + +func (v NullableLinkPolicyRequest) Get() *LinkPolicyRequest { + return v.value +} + +func (v *NullableLinkPolicyRequest) Set(val *LinkPolicyRequest) { + v.value = val + v.isSet = true +} + +func (v NullableLinkPolicyRequest) IsSet() bool { + return v.isSet +} + +func (v *NullableLinkPolicyRequest) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableLinkPolicyRequest(val *LinkPolicyRequest) *NullableLinkPolicyRequest { + return &NullableLinkPolicyRequest{value: val, isSet: true} +} + +func (v NullableLinkPolicyRequest) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableLinkPolicyRequest) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_link_policy_response.go b/v2/model_link_policy_response.go new file mode 100644 index 000000000..5a7d4590d --- /dev/null +++ b/v2/model_link_policy_response.go @@ -0,0 +1,114 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// LinkPolicyResponse struct for LinkPolicyResponse +type LinkPolicyResponse struct { + ResponseContext *ResponseContext `json:"ResponseContext,omitempty"` +} + +// NewLinkPolicyResponse instantiates a new LinkPolicyResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewLinkPolicyResponse() *LinkPolicyResponse { + this := LinkPolicyResponse{} + return &this +} + +// NewLinkPolicyResponseWithDefaults instantiates a new LinkPolicyResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewLinkPolicyResponseWithDefaults() *LinkPolicyResponse { + this := LinkPolicyResponse{} + return &this +} + +// GetResponseContext returns the ResponseContext field value if set, zero value otherwise. +func (o *LinkPolicyResponse) GetResponseContext() ResponseContext { + if o == nil || o.ResponseContext == nil { + var ret ResponseContext + return ret + } + return *o.ResponseContext +} + +// GetResponseContextOk returns a tuple with the ResponseContext field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *LinkPolicyResponse) GetResponseContextOk() (*ResponseContext, bool) { + if o == nil || o.ResponseContext == nil { + return nil, false + } + return o.ResponseContext, true +} + +// HasResponseContext returns a boolean if a field has been set. +func (o *LinkPolicyResponse) HasResponseContext() bool { + if o != nil && o.ResponseContext != nil { + return true + } + + return false +} + +// SetResponseContext gets a reference to the given ResponseContext and assigns it to the ResponseContext field. +func (o *LinkPolicyResponse) SetResponseContext(v ResponseContext) { + o.ResponseContext = &v +} + +func (o LinkPolicyResponse) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.ResponseContext != nil { + toSerialize["ResponseContext"] = o.ResponseContext + } + return json.Marshal(toSerialize) +} + +type NullableLinkPolicyResponse struct { + value *LinkPolicyResponse + isSet bool +} + +func (v NullableLinkPolicyResponse) Get() *LinkPolicyResponse { + return v.value +} + +func (v *NullableLinkPolicyResponse) Set(val *LinkPolicyResponse) { + v.value = val + v.isSet = true +} + +func (v NullableLinkPolicyResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableLinkPolicyResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableLinkPolicyResponse(val *LinkPolicyResponse) *NullableLinkPolicyResponse { + return &NullableLinkPolicyResponse{value: val, isSet: true} +} + +func (v NullableLinkPolicyResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableLinkPolicyResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_link_private_ips_request.go b/v2/model_link_private_ips_request.go index d51f69180..b993e7d85 100644 --- a/v2/model_link_private_ips_request.go +++ b/v2/model_link_private_ips_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_link_private_ips_response.go b/v2/model_link_private_ips_response.go index f8e47df7e..eb89c99de 100644 --- a/v2/model_link_private_ips_response.go +++ b/v2/model_link_private_ips_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_link_public_ip.go b/v2/model_link_public_ip.go index 5386b685c..39a7a13f9 100644 --- a/v2/model_link_public_ip.go +++ b/v2/model_link_public_ip.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_link_public_ip_light_for_vm.go b/v2/model_link_public_ip_light_for_vm.go index fcc7b803a..5c70fb77e 100644 --- a/v2/model_link_public_ip_light_for_vm.go +++ b/v2/model_link_public_ip_light_for_vm.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_link_public_ip_request.go b/v2/model_link_public_ip_request.go index 3cdb4ae9c..b310910ba 100644 --- a/v2/model_link_public_ip_request.go +++ b/v2/model_link_public_ip_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -17,7 +17,7 @@ import ( // LinkPublicIpRequest struct for LinkPublicIpRequest type LinkPublicIpRequest struct { - // 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 EIP 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.) + // 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.) AllowRelink *bool `json:"AllowRelink,omitempty"` // If true, checks whether you have the required permissions to perform the action. DryRun *bool `json:"DryRun,omitempty"` diff --git a/v2/model_link_public_ip_response.go b/v2/model_link_public_ip_response.go index 7b7303d83..b1dcdcac7 100644 --- a/v2/model_link_public_ip_response.go +++ b/v2/model_link_public_ip_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_link_route_table.go b/v2/model_link_route_table.go index d12046cd8..5ccdf4502 100644 --- a/v2/model_link_route_table.go +++ b/v2/model_link_route_table.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -21,6 +21,8 @@ type LinkRouteTable struct { LinkRouteTableId *string `json:"LinkRouteTableId,omitempty"` // If true, the route table is the main one. Main *bool `json:"Main,omitempty"` + // The ID of the Net. + NetId *string `json:"NetId,omitempty"` // The ID of the route table. RouteTableId *string `json:"RouteTableId,omitempty"` // The ID of the Subnet. @@ -108,6 +110,38 @@ func (o *LinkRouteTable) SetMain(v bool) { o.Main = &v } +// GetNetId returns the NetId field value if set, zero value otherwise. +func (o *LinkRouteTable) GetNetId() string { + if o == nil || o.NetId == nil { + var ret string + return ret + } + return *o.NetId +} + +// GetNetIdOk returns a tuple with the NetId field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *LinkRouteTable) GetNetIdOk() (*string, bool) { + if o == nil || o.NetId == nil { + return nil, false + } + return o.NetId, true +} + +// HasNetId returns a boolean if a field has been set. +func (o *LinkRouteTable) HasNetId() bool { + if o != nil && o.NetId != nil { + return true + } + + return false +} + +// SetNetId gets a reference to the given string and assigns it to the NetId field. +func (o *LinkRouteTable) SetNetId(v string) { + o.NetId = &v +} + // GetRouteTableId returns the RouteTableId field value if set, zero value otherwise. func (o *LinkRouteTable) GetRouteTableId() string { if o == nil || o.RouteTableId == nil { @@ -180,6 +214,9 @@ func (o LinkRouteTable) MarshalJSON() ([]byte, error) { if o.Main != nil { toSerialize["Main"] = o.Main } + if o.NetId != nil { + toSerialize["NetId"] = o.NetId + } if o.RouteTableId != nil { toSerialize["RouteTableId"] = o.RouteTableId } diff --git a/v2/model_link_route_table_request.go b/v2/model_link_route_table_request.go index 376ec9146..1dd4f8e13 100644 --- a/v2/model_link_route_table_request.go +++ b/v2/model_link_route_table_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_link_route_table_response.go b/v2/model_link_route_table_response.go index 8ab3bb1a0..fc11b1468 100644 --- a/v2/model_link_route_table_response.go +++ b/v2/model_link_route_table_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_link_virtual_gateway_request.go b/v2/model_link_virtual_gateway_request.go index 407692bc1..16489e8ea 100644 --- a/v2/model_link_virtual_gateway_request.go +++ b/v2/model_link_virtual_gateway_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_link_virtual_gateway_response.go b/v2/model_link_virtual_gateway_response.go index c92fb021e..7e068688d 100644 --- a/v2/model_link_virtual_gateway_response.go +++ b/v2/model_link_virtual_gateway_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_link_volume_request.go b/v2/model_link_volume_request.go index a6ef22106..d586a6189 100644 --- a/v2/model_link_volume_request.go +++ b/v2/model_link_volume_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_link_volume_response.go b/v2/model_link_volume_response.go index f234df839..da63b9b87 100644 --- a/v2/model_link_volume_response.go +++ b/v2/model_link_volume_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_linked_policy.go b/v2/model_linked_policy.go new file mode 100644 index 000000000..b95c68b2a --- /dev/null +++ b/v2/model_linked_policy.go @@ -0,0 +1,264 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" + "time" +) + +// LinkedPolicy Information about the attached policy. +type LinkedPolicy struct { + // The date and time of creation of the attached policy. + CreationDate *time.Time `json:"CreationDate,omitempty"` + // The date and time at which the attached policy was last modified. + LastModificationDate *time.Time `json:"LastModificationDate,omitempty"` + // The Outscale Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + Orn *string `json:"Orn,omitempty"` + // The ID of the policy. + PolicyId *string `json:"PolicyId,omitempty"` + // The name of the policy. + PolicyName *string `json:"PolicyName,omitempty"` +} + +// NewLinkedPolicy instantiates a new LinkedPolicy object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewLinkedPolicy() *LinkedPolicy { + this := LinkedPolicy{} + return &this +} + +// NewLinkedPolicyWithDefaults instantiates a new LinkedPolicy object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewLinkedPolicyWithDefaults() *LinkedPolicy { + this := LinkedPolicy{} + return &this +} + +// GetCreationDate returns the CreationDate field value if set, zero value otherwise. +func (o *LinkedPolicy) GetCreationDate() time.Time { + if o == nil || o.CreationDate == nil { + var ret time.Time + return ret + } + return *o.CreationDate +} + +// GetCreationDateOk returns a tuple with the CreationDate field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *LinkedPolicy) GetCreationDateOk() (*time.Time, bool) { + if o == nil || o.CreationDate == nil { + return nil, false + } + return o.CreationDate, true +} + +// HasCreationDate returns a boolean if a field has been set. +func (o *LinkedPolicy) HasCreationDate() bool { + if o != nil && o.CreationDate != nil { + return true + } + + return false +} + +// SetCreationDate gets a reference to the given time.Time and assigns it to the CreationDate field. +func (o *LinkedPolicy) SetCreationDate(v time.Time) { + o.CreationDate = &v +} + +// GetLastModificationDate returns the LastModificationDate field value if set, zero value otherwise. +func (o *LinkedPolicy) GetLastModificationDate() time.Time { + if o == nil || o.LastModificationDate == nil { + var ret time.Time + return ret + } + return *o.LastModificationDate +} + +// GetLastModificationDateOk returns a tuple with the LastModificationDate field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *LinkedPolicy) GetLastModificationDateOk() (*time.Time, bool) { + if o == nil || o.LastModificationDate == nil { + return nil, false + } + return o.LastModificationDate, true +} + +// HasLastModificationDate returns a boolean if a field has been set. +func (o *LinkedPolicy) HasLastModificationDate() bool { + if o != nil && o.LastModificationDate != nil { + return true + } + + return false +} + +// SetLastModificationDate gets a reference to the given time.Time and assigns it to the LastModificationDate field. +func (o *LinkedPolicy) SetLastModificationDate(v time.Time) { + o.LastModificationDate = &v +} + +// GetOrn returns the Orn field value if set, zero value otherwise. +func (o *LinkedPolicy) GetOrn() string { + if o == nil || o.Orn == nil { + var ret string + return ret + } + return *o.Orn +} + +// GetOrnOk returns a tuple with the Orn field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *LinkedPolicy) GetOrnOk() (*string, bool) { + if o == nil || o.Orn == nil { + return nil, false + } + return o.Orn, true +} + +// HasOrn returns a boolean if a field has been set. +func (o *LinkedPolicy) HasOrn() bool { + if o != nil && o.Orn != nil { + return true + } + + return false +} + +// SetOrn gets a reference to the given string and assigns it to the Orn field. +func (o *LinkedPolicy) SetOrn(v string) { + o.Orn = &v +} + +// GetPolicyId returns the PolicyId field value if set, zero value otherwise. +func (o *LinkedPolicy) GetPolicyId() string { + if o == nil || o.PolicyId == nil { + var ret string + return ret + } + return *o.PolicyId +} + +// GetPolicyIdOk returns a tuple with the PolicyId field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *LinkedPolicy) GetPolicyIdOk() (*string, bool) { + if o == nil || o.PolicyId == nil { + return nil, false + } + return o.PolicyId, true +} + +// HasPolicyId returns a boolean if a field has been set. +func (o *LinkedPolicy) HasPolicyId() bool { + if o != nil && o.PolicyId != nil { + return true + } + + return false +} + +// SetPolicyId gets a reference to the given string and assigns it to the PolicyId field. +func (o *LinkedPolicy) SetPolicyId(v string) { + o.PolicyId = &v +} + +// GetPolicyName returns the PolicyName field value if set, zero value otherwise. +func (o *LinkedPolicy) GetPolicyName() string { + if o == nil || o.PolicyName == nil { + var ret string + return ret + } + return *o.PolicyName +} + +// GetPolicyNameOk returns a tuple with the PolicyName field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *LinkedPolicy) GetPolicyNameOk() (*string, bool) { + if o == nil || o.PolicyName == nil { + return nil, false + } + return o.PolicyName, true +} + +// HasPolicyName returns a boolean if a field has been set. +func (o *LinkedPolicy) HasPolicyName() bool { + if o != nil && o.PolicyName != nil { + return true + } + + return false +} + +// SetPolicyName gets a reference to the given string and assigns it to the PolicyName field. +func (o *LinkedPolicy) SetPolicyName(v string) { + o.PolicyName = &v +} + +func (o LinkedPolicy) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.CreationDate != nil { + toSerialize["CreationDate"] = o.CreationDate + } + if o.LastModificationDate != nil { + toSerialize["LastModificationDate"] = o.LastModificationDate + } + if o.Orn != nil { + toSerialize["Orn"] = o.Orn + } + if o.PolicyId != nil { + toSerialize["PolicyId"] = o.PolicyId + } + if o.PolicyName != nil { + toSerialize["PolicyName"] = o.PolicyName + } + return json.Marshal(toSerialize) +} + +type NullableLinkedPolicy struct { + value *LinkedPolicy + isSet bool +} + +func (v NullableLinkedPolicy) Get() *LinkedPolicy { + return v.value +} + +func (v *NullableLinkedPolicy) Set(val *LinkedPolicy) { + v.value = val + v.isSet = true +} + +func (v NullableLinkedPolicy) IsSet() bool { + return v.isSet +} + +func (v *NullableLinkedPolicy) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableLinkedPolicy(val *LinkedPolicy) *NullableLinkedPolicy { + return &NullableLinkedPolicy{value: val, isSet: true} +} + +func (v NullableLinkedPolicy) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableLinkedPolicy) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_linked_volume.go b/v2/model_linked_volume.go index b1a3cca38..52d36efca 100644 --- a/v2/model_linked_volume.go +++ b/v2/model_linked_volume.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_listener.go b/v2/model_listener.go index acc74c702..d04e8e75d 100644 --- a/v2/model_listener.go +++ b/v2/model_listener.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_listener_for_creation.go b/v2/model_listener_for_creation.go index c10f887ab..6da491492 100644 --- a/v2/model_listener_for_creation.go +++ b/v2/model_listener_for_creation.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_listener_rule.go b/v2/model_listener_rule.go index f4e511ce3..9fb8fc3f6 100644 --- a/v2/model_listener_rule.go +++ b/v2/model_listener_rule.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_listener_rule_for_creation.go b/v2/model_listener_rule_for_creation.go index 896b60705..9f2f83699 100644 --- a/v2/model_listener_rule_for_creation.go +++ b/v2/model_listener_rule_for_creation.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_load_balancer.go b/v2/model_load_balancer.go index 4aa2ed430..692f79dd8 100644 --- a/v2/model_load_balancer.go +++ b/v2/model_load_balancer.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_load_balancer_light.go b/v2/model_load_balancer_light.go index 651541fc0..a20fc94a1 100644 --- a/v2/model_load_balancer_light.go +++ b/v2/model_load_balancer_light.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_load_balancer_sticky_cookie_policy.go b/v2/model_load_balancer_sticky_cookie_policy.go index c8a7f14d4..569b941c3 100644 --- a/v2/model_load_balancer_sticky_cookie_policy.go +++ b/v2/model_load_balancer_sticky_cookie_policy.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_load_balancer_tag.go b/v2/model_load_balancer_tag.go index 53aaac4a8..1a0d37b37 100644 --- a/v2/model_load_balancer_tag.go +++ b/v2/model_load_balancer_tag.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_location.go b/v2/model_location.go index 9a56d3f5d..2278d3a76 100644 --- a/v2/model_location.go +++ b/v2/model_location.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_log.go b/v2/model_log.go index 69a3bd59f..74edc1bbe 100644 --- a/v2/model_log.go +++ b/v2/model_log.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_maintenance_event.go b/v2/model_maintenance_event.go index 7d2787e1c..ca2fb0405 100644 --- a/v2/model_maintenance_event.go +++ b/v2/model_maintenance_event.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_nat_service.go b/v2/model_nat_service.go index 0116644a1..fd6e94486 100644 --- a/v2/model_nat_service.go +++ b/v2/model_nat_service.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_net.go b/v2/model_net.go index 51b2c6983..44e98931d 100644 --- a/v2/model_net.go +++ b/v2/model_net.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -23,7 +23,7 @@ type Net struct { IpRange *string `json:"IpRange,omitempty"` // The ID of the Net. NetId *string `json:"NetId,omitempty"` - // The state of the Net (`pending` \\| `available` \\| `deleted`). + // The state of the Net (`pending` \\| `available` \\| `deleting`). State *string `json:"State,omitempty"` // One or more tags associated with the Net. Tags *[]ResourceTag `json:"Tags,omitempty"` diff --git a/v2/model_net_access_point.go b/v2/model_net_access_point.go index 6d251ab45..8857f2b72 100644 --- a/v2/model_net_access_point.go +++ b/v2/model_net_access_point.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_net_peering.go b/v2/model_net_peering.go index 838533f34..93ec63174 100644 --- a/v2/model_net_peering.go +++ b/v2/model_net_peering.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -13,11 +13,14 @@ package osc import ( "encoding/json" + "time" ) // NetPeering Information about the Net peering. type NetPeering struct { AccepterNet *AccepterNet `json:"AccepterNet,omitempty"` + // The date and time at which the Net peerings expire. + ExpirationDate NullableTime `json:"ExpirationDate,omitempty"` // The ID of the Net peering. NetPeeringId *string `json:"NetPeeringId,omitempty"` SourceNet *SourceNet `json:"SourceNet,omitempty"` @@ -75,6 +78,49 @@ func (o *NetPeering) SetAccepterNet(v AccepterNet) { o.AccepterNet = &v } +// GetExpirationDate returns the ExpirationDate field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *NetPeering) GetExpirationDate() time.Time { + if o == nil || o.ExpirationDate.Get() == nil { + var ret time.Time + return ret + } + return *o.ExpirationDate.Get() +} + +// GetExpirationDateOk returns a tuple with the ExpirationDate field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *NetPeering) GetExpirationDateOk() (*time.Time, bool) { + if o == nil { + return nil, false + } + return o.ExpirationDate.Get(), o.ExpirationDate.IsSet() +} + +// HasExpirationDate returns a boolean if a field has been set. +func (o *NetPeering) HasExpirationDate() bool { + if o != nil && o.ExpirationDate.IsSet() { + return true + } + + return false +} + +// SetExpirationDate gets a reference to the given NullableTime and assigns it to the ExpirationDate field. +func (o *NetPeering) SetExpirationDate(v time.Time) { + o.ExpirationDate.Set(&v) +} + +// SetExpirationDateNil sets the value for ExpirationDate to be an explicit nil +func (o *NetPeering) SetExpirationDateNil() { + o.ExpirationDate.Set(nil) +} + +// UnsetExpirationDate ensures that no value is present for ExpirationDate, not even an explicit nil +func (o *NetPeering) UnsetExpirationDate() { + o.ExpirationDate.Unset() +} + // GetNetPeeringId returns the NetPeeringId field value if set, zero value otherwise. func (o *NetPeering) GetNetPeeringId() string { if o == nil || o.NetPeeringId == nil { @@ -208,6 +254,9 @@ func (o NetPeering) MarshalJSON() ([]byte, error) { if o.AccepterNet != nil { toSerialize["AccepterNet"] = o.AccepterNet } + if o.ExpirationDate.IsSet() { + toSerialize["ExpirationDate"] = o.ExpirationDate.Get() + } if o.NetPeeringId != nil { toSerialize["NetPeeringId"] = o.NetPeeringId } diff --git a/v2/model_net_peering_state.go b/v2/model_net_peering_state.go index 6ba7c0d91..f37e1da65 100644 --- a/v2/model_net_peering_state.go +++ b/v2/model_net_peering_state.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_net_to_virtual_gateway_link.go b/v2/model_net_to_virtual_gateway_link.go index 67ba45940..f24f9b977 100644 --- a/v2/model_net_to_virtual_gateway_link.go +++ b/v2/model_net_to_virtual_gateway_link.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_nic.go b/v2/model_nic.go index 233424e0d..681ce112f 100644 --- a/v2/model_nic.go +++ b/v2/model_nic.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_nic_for_vm_creation.go b/v2/model_nic_for_vm_creation.go index 57041648d..28606c2b1 100644 --- a/v2/model_nic_for_vm_creation.go +++ b/v2/model_nic_for_vm_creation.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_nic_light.go b/v2/model_nic_light.go index ffb38fdd3..162f88118 100644 --- a/v2/model_nic_light.go +++ b/v2/model_nic_light.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_osu_api_key.go b/v2/model_osu_api_key.go index 40f4648a5..a0399481c 100644 --- a/v2/model_osu_api_key.go +++ b/v2/model_osu_api_key.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_osu_export_image_export_task.go b/v2/model_osu_export_image_export_task.go index 8e491634c..62b2739ab 100644 --- a/v2/model_osu_export_image_export_task.go +++ b/v2/model_osu_export_image_export_task.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_osu_export_snapshot_export_task.go b/v2/model_osu_export_snapshot_export_task.go index efcbd13dc..7352de52f 100644 --- a/v2/model_osu_export_snapshot_export_task.go +++ b/v2/model_osu_export_snapshot_export_task.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_osu_export_to_create.go b/v2/model_osu_export_to_create.go index c2eb21d74..97cebf9ea 100644 --- a/v2/model_osu_export_to_create.go +++ b/v2/model_osu_export_to_create.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_permissions_on_resource.go b/v2/model_permissions_on_resource.go index 91772e180..7703a09bd 100644 --- a/v2/model_permissions_on_resource.go +++ b/v2/model_permissions_on_resource.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_permissions_on_resource_creation.go b/v2/model_permissions_on_resource_creation.go index 76abeb662..30b5403fc 100644 --- a/v2/model_permissions_on_resource_creation.go +++ b/v2/model_permissions_on_resource_creation.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_phase1_options.go b/v2/model_phase1_options.go index 23ffe4185..bbf758353 100644 --- a/v2/model_phase1_options.go +++ b/v2/model_phase1_options.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_phase2_options.go b/v2/model_phase2_options.go index 09ca33b71..074f8b0ee 100644 --- a/v2/model_phase2_options.go +++ b/v2/model_phase2_options.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_phase2_options_to_update.go b/v2/model_phase2_options_to_update.go new file mode 100644 index 000000000..b0397616d --- /dev/null +++ b/v2/model_phase2_options_to_update.go @@ -0,0 +1,115 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// Phase2OptionsToUpdate Information about Phase 2 of the Internet Key Exchange (IKE) negotiation. +type Phase2OptionsToUpdate struct { + // 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 ("). + PreSharedKey *string `json:"PreSharedKey,omitempty"` +} + +// NewPhase2OptionsToUpdate instantiates a new Phase2OptionsToUpdate object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewPhase2OptionsToUpdate() *Phase2OptionsToUpdate { + this := Phase2OptionsToUpdate{} + return &this +} + +// NewPhase2OptionsToUpdateWithDefaults instantiates a new Phase2OptionsToUpdate object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewPhase2OptionsToUpdateWithDefaults() *Phase2OptionsToUpdate { + this := Phase2OptionsToUpdate{} + return &this +} + +// GetPreSharedKey returns the PreSharedKey field value if set, zero value otherwise. +func (o *Phase2OptionsToUpdate) GetPreSharedKey() string { + if o == nil || o.PreSharedKey == nil { + var ret string + return ret + } + return *o.PreSharedKey +} + +// GetPreSharedKeyOk returns a tuple with the PreSharedKey field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Phase2OptionsToUpdate) GetPreSharedKeyOk() (*string, bool) { + if o == nil || o.PreSharedKey == nil { + return nil, false + } + return o.PreSharedKey, true +} + +// HasPreSharedKey returns a boolean if a field has been set. +func (o *Phase2OptionsToUpdate) HasPreSharedKey() bool { + if o != nil && o.PreSharedKey != nil { + return true + } + + return false +} + +// SetPreSharedKey gets a reference to the given string and assigns it to the PreSharedKey field. +func (o *Phase2OptionsToUpdate) SetPreSharedKey(v string) { + o.PreSharedKey = &v +} + +func (o Phase2OptionsToUpdate) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.PreSharedKey != nil { + toSerialize["PreSharedKey"] = o.PreSharedKey + } + return json.Marshal(toSerialize) +} + +type NullablePhase2OptionsToUpdate struct { + value *Phase2OptionsToUpdate + isSet bool +} + +func (v NullablePhase2OptionsToUpdate) Get() *Phase2OptionsToUpdate { + return v.value +} + +func (v *NullablePhase2OptionsToUpdate) Set(val *Phase2OptionsToUpdate) { + v.value = val + v.isSet = true +} + +func (v NullablePhase2OptionsToUpdate) IsSet() bool { + return v.isSet +} + +func (v *NullablePhase2OptionsToUpdate) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullablePhase2OptionsToUpdate(val *Phase2OptionsToUpdate) *NullablePhase2OptionsToUpdate { + return &NullablePhase2OptionsToUpdate{value: val, isSet: true} +} + +func (v NullablePhase2OptionsToUpdate) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullablePhase2OptionsToUpdate) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_placement.go b/v2/model_placement.go index eb970afb1..969f9fa53 100644 --- a/v2/model_placement.go +++ b/v2/model_placement.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -19,7 +19,7 @@ import ( type Placement struct { // The name of the Subregion. If you specify this parameter, you must not specify the `Nics` parameter. SubregionName *string `json:"SubregionName,omitempty"` - // The tenancy of the VM (`default` \\| `dedicated`). + // The tenancy of the VM (`default`, `dedicated`, or a dedicated group ID). Tenancy *string `json:"Tenancy,omitempty"` } diff --git a/v2/model_policy.go b/v2/model_policy.go new file mode 100644 index 000000000..a8a390c23 --- /dev/null +++ b/v2/model_policy.go @@ -0,0 +1,449 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" + "time" +) + +// Policy Information about the policy. +type Policy struct { + // The date and time of creation of the policy. + CreationDate *time.Time `json:"CreationDate,omitempty"` + // A friendly name for the policy (between 0 and 1000 characters). + Description *string `json:"Description,omitempty"` + // Indicates whether the policy can be linked to a group or an EIM user. + IsLinkable *bool `json:"IsLinkable,omitempty"` + // The date and time at which the policy was last modified. + LastModificationDate *time.Time `json:"LastModificationDate,omitempty"` + // The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + Orn *string `json:"Orn,omitempty"` + // The path to the policy. + Path *string `json:"Path,omitempty"` + // The ID of the policy default version. + PolicyDefaultVersionId *string `json:"PolicyDefaultVersionId,omitempty"` + // The ID of the policy. + PolicyId *string `json:"PolicyId,omitempty"` + // The name of the policy. + PolicyName *string `json:"PolicyName,omitempty"` + // The number of resources attached to the policy. + ResourcesCount *int32 `json:"ResourcesCount,omitempty"` +} + +// NewPolicy instantiates a new Policy object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewPolicy() *Policy { + this := Policy{} + return &this +} + +// NewPolicyWithDefaults instantiates a new Policy object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewPolicyWithDefaults() *Policy { + this := Policy{} + return &this +} + +// GetCreationDate returns the CreationDate field value if set, zero value otherwise. +func (o *Policy) GetCreationDate() time.Time { + if o == nil || o.CreationDate == nil { + var ret time.Time + return ret + } + return *o.CreationDate +} + +// GetCreationDateOk returns a tuple with the CreationDate field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Policy) GetCreationDateOk() (*time.Time, bool) { + if o == nil || o.CreationDate == nil { + return nil, false + } + return o.CreationDate, true +} + +// HasCreationDate returns a boolean if a field has been set. +func (o *Policy) HasCreationDate() bool { + if o != nil && o.CreationDate != nil { + return true + } + + return false +} + +// SetCreationDate gets a reference to the given time.Time and assigns it to the CreationDate field. +func (o *Policy) SetCreationDate(v time.Time) { + o.CreationDate = &v +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *Policy) GetDescription() string { + if o == nil || o.Description == nil { + var ret string + return ret + } + return *o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Policy) GetDescriptionOk() (*string, bool) { + if o == nil || o.Description == nil { + return nil, false + } + return o.Description, true +} + +// HasDescription returns a boolean if a field has been set. +func (o *Policy) HasDescription() bool { + if o != nil && o.Description != nil { + return true + } + + return false +} + +// SetDescription gets a reference to the given string and assigns it to the Description field. +func (o *Policy) SetDescription(v string) { + o.Description = &v +} + +// GetIsLinkable returns the IsLinkable field value if set, zero value otherwise. +func (o *Policy) GetIsLinkable() bool { + if o == nil || o.IsLinkable == nil { + var ret bool + return ret + } + return *o.IsLinkable +} + +// GetIsLinkableOk returns a tuple with the IsLinkable field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Policy) GetIsLinkableOk() (*bool, bool) { + if o == nil || o.IsLinkable == nil { + return nil, false + } + return o.IsLinkable, true +} + +// HasIsLinkable returns a boolean if a field has been set. +func (o *Policy) HasIsLinkable() bool { + if o != nil && o.IsLinkable != nil { + return true + } + + return false +} + +// SetIsLinkable gets a reference to the given bool and assigns it to the IsLinkable field. +func (o *Policy) SetIsLinkable(v bool) { + o.IsLinkable = &v +} + +// GetLastModificationDate returns the LastModificationDate field value if set, zero value otherwise. +func (o *Policy) GetLastModificationDate() time.Time { + if o == nil || o.LastModificationDate == nil { + var ret time.Time + return ret + } + return *o.LastModificationDate +} + +// GetLastModificationDateOk returns a tuple with the LastModificationDate field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Policy) GetLastModificationDateOk() (*time.Time, bool) { + if o == nil || o.LastModificationDate == nil { + return nil, false + } + return o.LastModificationDate, true +} + +// HasLastModificationDate returns a boolean if a field has been set. +func (o *Policy) HasLastModificationDate() bool { + if o != nil && o.LastModificationDate != nil { + return true + } + + return false +} + +// SetLastModificationDate gets a reference to the given time.Time and assigns it to the LastModificationDate field. +func (o *Policy) SetLastModificationDate(v time.Time) { + o.LastModificationDate = &v +} + +// GetOrn returns the Orn field value if set, zero value otherwise. +func (o *Policy) GetOrn() string { + if o == nil || o.Orn == nil { + var ret string + return ret + } + return *o.Orn +} + +// GetOrnOk returns a tuple with the Orn field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Policy) GetOrnOk() (*string, bool) { + if o == nil || o.Orn == nil { + return nil, false + } + return o.Orn, true +} + +// HasOrn returns a boolean if a field has been set. +func (o *Policy) HasOrn() bool { + if o != nil && o.Orn != nil { + return true + } + + return false +} + +// SetOrn gets a reference to the given string and assigns it to the Orn field. +func (o *Policy) SetOrn(v string) { + o.Orn = &v +} + +// GetPath returns the Path field value if set, zero value otherwise. +func (o *Policy) GetPath() string { + if o == nil || o.Path == nil { + var ret string + return ret + } + return *o.Path +} + +// GetPathOk returns a tuple with the Path field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Policy) GetPathOk() (*string, bool) { + if o == nil || o.Path == nil { + return nil, false + } + return o.Path, true +} + +// HasPath returns a boolean if a field has been set. +func (o *Policy) HasPath() bool { + if o != nil && o.Path != nil { + return true + } + + return false +} + +// SetPath gets a reference to the given string and assigns it to the Path field. +func (o *Policy) SetPath(v string) { + o.Path = &v +} + +// GetPolicyDefaultVersionId returns the PolicyDefaultVersionId field value if set, zero value otherwise. +func (o *Policy) GetPolicyDefaultVersionId() string { + if o == nil || o.PolicyDefaultVersionId == nil { + var ret string + return ret + } + return *o.PolicyDefaultVersionId +} + +// GetPolicyDefaultVersionIdOk returns a tuple with the PolicyDefaultVersionId field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Policy) GetPolicyDefaultVersionIdOk() (*string, bool) { + if o == nil || o.PolicyDefaultVersionId == nil { + return nil, false + } + return o.PolicyDefaultVersionId, true +} + +// HasPolicyDefaultVersionId returns a boolean if a field has been set. +func (o *Policy) HasPolicyDefaultVersionId() bool { + if o != nil && o.PolicyDefaultVersionId != nil { + return true + } + + return false +} + +// SetPolicyDefaultVersionId gets a reference to the given string and assigns it to the PolicyDefaultVersionId field. +func (o *Policy) SetPolicyDefaultVersionId(v string) { + o.PolicyDefaultVersionId = &v +} + +// GetPolicyId returns the PolicyId field value if set, zero value otherwise. +func (o *Policy) GetPolicyId() string { + if o == nil || o.PolicyId == nil { + var ret string + return ret + } + return *o.PolicyId +} + +// GetPolicyIdOk returns a tuple with the PolicyId field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Policy) GetPolicyIdOk() (*string, bool) { + if o == nil || o.PolicyId == nil { + return nil, false + } + return o.PolicyId, true +} + +// HasPolicyId returns a boolean if a field has been set. +func (o *Policy) HasPolicyId() bool { + if o != nil && o.PolicyId != nil { + return true + } + + return false +} + +// SetPolicyId gets a reference to the given string and assigns it to the PolicyId field. +func (o *Policy) SetPolicyId(v string) { + o.PolicyId = &v +} + +// GetPolicyName returns the PolicyName field value if set, zero value otherwise. +func (o *Policy) GetPolicyName() string { + if o == nil || o.PolicyName == nil { + var ret string + return ret + } + return *o.PolicyName +} + +// GetPolicyNameOk returns a tuple with the PolicyName field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Policy) GetPolicyNameOk() (*string, bool) { + if o == nil || o.PolicyName == nil { + return nil, false + } + return o.PolicyName, true +} + +// HasPolicyName returns a boolean if a field has been set. +func (o *Policy) HasPolicyName() bool { + if o != nil && o.PolicyName != nil { + return true + } + + return false +} + +// SetPolicyName gets a reference to the given string and assigns it to the PolicyName field. +func (o *Policy) SetPolicyName(v string) { + o.PolicyName = &v +} + +// GetResourcesCount returns the ResourcesCount field value if set, zero value otherwise. +func (o *Policy) GetResourcesCount() int32 { + if o == nil || o.ResourcesCount == nil { + var ret int32 + return ret + } + return *o.ResourcesCount +} + +// GetResourcesCountOk returns a tuple with the ResourcesCount field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Policy) GetResourcesCountOk() (*int32, bool) { + if o == nil || o.ResourcesCount == nil { + return nil, false + } + return o.ResourcesCount, true +} + +// HasResourcesCount returns a boolean if a field has been set. +func (o *Policy) HasResourcesCount() bool { + if o != nil && o.ResourcesCount != nil { + return true + } + + return false +} + +// SetResourcesCount gets a reference to the given int32 and assigns it to the ResourcesCount field. +func (o *Policy) SetResourcesCount(v int32) { + o.ResourcesCount = &v +} + +func (o Policy) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.CreationDate != nil { + toSerialize["CreationDate"] = o.CreationDate + } + if o.Description != nil { + toSerialize["Description"] = o.Description + } + if o.IsLinkable != nil { + toSerialize["IsLinkable"] = o.IsLinkable + } + if o.LastModificationDate != nil { + toSerialize["LastModificationDate"] = o.LastModificationDate + } + if o.Orn != nil { + toSerialize["Orn"] = o.Orn + } + if o.Path != nil { + toSerialize["Path"] = o.Path + } + if o.PolicyDefaultVersionId != nil { + toSerialize["PolicyDefaultVersionId"] = o.PolicyDefaultVersionId + } + if o.PolicyId != nil { + toSerialize["PolicyId"] = o.PolicyId + } + if o.PolicyName != nil { + toSerialize["PolicyName"] = o.PolicyName + } + if o.ResourcesCount != nil { + toSerialize["ResourcesCount"] = o.ResourcesCount + } + return json.Marshal(toSerialize) +} + +type NullablePolicy struct { + value *Policy + isSet bool +} + +func (v NullablePolicy) Get() *Policy { + return v.value +} + +func (v *NullablePolicy) Set(val *Policy) { + v.value = val + v.isSet = true +} + +func (v NullablePolicy) IsSet() bool { + return v.isSet +} + +func (v *NullablePolicy) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullablePolicy(val *Policy) *NullablePolicy { + return &NullablePolicy{value: val, isSet: true} +} + +func (v NullablePolicy) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullablePolicy) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_policy_version.go b/v2/model_policy_version.go new file mode 100644 index 000000000..79deb9682 --- /dev/null +++ b/v2/model_policy_version.go @@ -0,0 +1,227 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" + "time" +) + +// PolicyVersion Information about the policy version. +type PolicyVersion struct { + // The policy document as a json string. + Body *string `json:"Body,omitempty"` + // The date and time of creation of the version. + CreationDate *time.Time `json:"CreationDate,omitempty"` + // If true, the version is the default one. + DefaultVersion *bool `json:"DefaultVersion,omitempty"` + // The ID of the version. + VersionId *string `json:"VersionId,omitempty"` +} + +// NewPolicyVersion instantiates a new PolicyVersion object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewPolicyVersion() *PolicyVersion { + this := PolicyVersion{} + return &this +} + +// NewPolicyVersionWithDefaults instantiates a new PolicyVersion object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewPolicyVersionWithDefaults() *PolicyVersion { + this := PolicyVersion{} + return &this +} + +// GetBody returns the Body field value if set, zero value otherwise. +func (o *PolicyVersion) GetBody() string { + if o == nil || o.Body == nil { + var ret string + return ret + } + return *o.Body +} + +// GetBodyOk returns a tuple with the Body field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *PolicyVersion) GetBodyOk() (*string, bool) { + if o == nil || o.Body == nil { + return nil, false + } + return o.Body, true +} + +// HasBody returns a boolean if a field has been set. +func (o *PolicyVersion) HasBody() bool { + if o != nil && o.Body != nil { + return true + } + + return false +} + +// SetBody gets a reference to the given string and assigns it to the Body field. +func (o *PolicyVersion) SetBody(v string) { + o.Body = &v +} + +// GetCreationDate returns the CreationDate field value if set, zero value otherwise. +func (o *PolicyVersion) GetCreationDate() time.Time { + if o == nil || o.CreationDate == nil { + var ret time.Time + return ret + } + return *o.CreationDate +} + +// GetCreationDateOk returns a tuple with the CreationDate field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *PolicyVersion) GetCreationDateOk() (*time.Time, bool) { + if o == nil || o.CreationDate == nil { + return nil, false + } + return o.CreationDate, true +} + +// HasCreationDate returns a boolean if a field has been set. +func (o *PolicyVersion) HasCreationDate() bool { + if o != nil && o.CreationDate != nil { + return true + } + + return false +} + +// SetCreationDate gets a reference to the given time.Time and assigns it to the CreationDate field. +func (o *PolicyVersion) SetCreationDate(v time.Time) { + o.CreationDate = &v +} + +// GetDefaultVersion returns the DefaultVersion field value if set, zero value otherwise. +func (o *PolicyVersion) GetDefaultVersion() bool { + if o == nil || o.DefaultVersion == nil { + var ret bool + return ret + } + return *o.DefaultVersion +} + +// GetDefaultVersionOk returns a tuple with the DefaultVersion field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *PolicyVersion) GetDefaultVersionOk() (*bool, bool) { + if o == nil || o.DefaultVersion == nil { + return nil, false + } + return o.DefaultVersion, true +} + +// HasDefaultVersion returns a boolean if a field has been set. +func (o *PolicyVersion) HasDefaultVersion() bool { + if o != nil && o.DefaultVersion != nil { + return true + } + + return false +} + +// SetDefaultVersion gets a reference to the given bool and assigns it to the DefaultVersion field. +func (o *PolicyVersion) SetDefaultVersion(v bool) { + o.DefaultVersion = &v +} + +// GetVersionId returns the VersionId field value if set, zero value otherwise. +func (o *PolicyVersion) GetVersionId() string { + if o == nil || o.VersionId == nil { + var ret string + return ret + } + return *o.VersionId +} + +// GetVersionIdOk returns a tuple with the VersionId field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *PolicyVersion) GetVersionIdOk() (*string, bool) { + if o == nil || o.VersionId == nil { + return nil, false + } + return o.VersionId, true +} + +// HasVersionId returns a boolean if a field has been set. +func (o *PolicyVersion) HasVersionId() bool { + if o != nil && o.VersionId != nil { + return true + } + + return false +} + +// SetVersionId gets a reference to the given string and assigns it to the VersionId field. +func (o *PolicyVersion) SetVersionId(v string) { + o.VersionId = &v +} + +func (o PolicyVersion) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.Body != nil { + toSerialize["Body"] = o.Body + } + if o.CreationDate != nil { + toSerialize["CreationDate"] = o.CreationDate + } + if o.DefaultVersion != nil { + toSerialize["DefaultVersion"] = o.DefaultVersion + } + if o.VersionId != nil { + toSerialize["VersionId"] = o.VersionId + } + return json.Marshal(toSerialize) +} + +type NullablePolicyVersion struct { + value *PolicyVersion + isSet bool +} + +func (v NullablePolicyVersion) Get() *PolicyVersion { + return v.value +} + +func (v *NullablePolicyVersion) Set(val *PolicyVersion) { + v.value = val + v.isSet = true +} + +func (v NullablePolicyVersion) IsSet() bool { + return v.isSet +} + +func (v *NullablePolicyVersion) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullablePolicyVersion(val *PolicyVersion) *NullablePolicyVersion { + return &NullablePolicyVersion{value: val, isSet: true} +} + +func (v NullablePolicyVersion) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullablePolicyVersion) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_private_ip.go b/v2/model_private_ip.go index c2ec515a9..61176813d 100644 --- a/v2/model_private_ip.go +++ b/v2/model_private_ip.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_private_ip_light.go b/v2/model_private_ip_light.go index bc1171dd6..6472b0ab1 100644 --- a/v2/model_private_ip_light.go +++ b/v2/model_private_ip_light.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_private_ip_light_for_vm.go b/v2/model_private_ip_light_for_vm.go index b7af30cb2..49486b7e3 100644 --- a/v2/model_private_ip_light_for_vm.go +++ b/v2/model_private_ip_light_for_vm.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_product_type.go b/v2/model_product_type.go index 2fbed19f6..58cc48c4b 100644 --- a/v2/model_product_type.go +++ b/v2/model_product_type.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_public_ip.go b/v2/model_public_ip.go index baa738b08..a76e612de 100644 --- a/v2/model_public_ip.go +++ b/v2/model_public_ip.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_public_ip_light.go b/v2/model_public_ip_light.go index 09326a9a1..d1f8e747f 100644 --- a/v2/model_public_ip_light.go +++ b/v2/model_public_ip_light.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_quota.go b/v2/model_quota.go index 15732078f..84c7c4c71 100644 --- a/v2/model_quota.go +++ b/v2/model_quota.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -21,7 +21,7 @@ type Quota struct { AccountId *string `json:"AccountId,omitempty"` // The description of the quota. Description *string `json:"Description,omitempty"` - // The maximum value of the quota for the OUTSCALE user account (if there is no limit, `0`). + // The maximum value of the quota for the account (if there is no limit, `0`). MaxValue *int32 `json:"MaxValue,omitempty"` // The unique name of the quota. Name *string `json:"Name,omitempty"` @@ -29,7 +29,7 @@ type Quota struct { QuotaCollection *string `json:"QuotaCollection,omitempty"` // The description of the quota. ShortDescription *string `json:"ShortDescription,omitempty"` - // The limit value currently used by the OUTSCALE user account. + // The limit value currently used by the account. UsedValue *int32 `json:"UsedValue,omitempty"` } diff --git a/v2/model_quota_types.go b/v2/model_quota_types.go index 2dab7822e..4dfa73084 100644 --- a/v2/model_quota_types.go +++ b/v2/model_quota_types.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -19,7 +19,7 @@ import ( type QuotaTypes struct { // The resource ID if it is a resource-specific quota, `global` if it is not. QuotaType *string `json:"QuotaType,omitempty"` - // One or more quotas associated with the user. + // One or more quotas associated with the account. Quotas *[]Quota `json:"Quotas,omitempty"` } diff --git a/v2/model_read_access_keys_request.go b/v2/model_read_access_keys_request.go index 38430b708..39afb24a3 100644 --- a/v2/model_read_access_keys_request.go +++ b/v2/model_read_access_keys_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_access_keys_response.go b/v2/model_read_access_keys_response.go index e3d1fd1f6..d76cb9dd2 100644 --- a/v2/model_read_access_keys_response.go +++ b/v2/model_read_access_keys_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_accounts_request.go b/v2/model_read_accounts_request.go index a894b7758..e2ba9eec8 100644 --- a/v2/model_read_accounts_request.go +++ b/v2/model_read_accounts_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_accounts_response.go b/v2/model_read_accounts_response.go index c01f1f9d6..fd01560a4 100644 --- a/v2/model_read_accounts_response.go +++ b/v2/model_read_accounts_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_admin_password_request.go b/v2/model_read_admin_password_request.go index 0b138bfc5..0f575f7af 100644 --- a/v2/model_read_admin_password_request.go +++ b/v2/model_read_admin_password_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_admin_password_response.go b/v2/model_read_admin_password_response.go index b7b18c825..859f00f4c 100644 --- a/v2/model_read_admin_password_response.go +++ b/v2/model_read_admin_password_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_api_access_policy_request.go b/v2/model_read_api_access_policy_request.go index 669188623..cc55210d1 100644 --- a/v2/model_read_api_access_policy_request.go +++ b/v2/model_read_api_access_policy_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_api_access_policy_response.go b/v2/model_read_api_access_policy_response.go index 63fe73a64..84b633b65 100644 --- a/v2/model_read_api_access_policy_response.go +++ b/v2/model_read_api_access_policy_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_api_access_rules_request.go b/v2/model_read_api_access_rules_request.go index 436ded36d..53035ac58 100644 --- a/v2/model_read_api_access_rules_request.go +++ b/v2/model_read_api_access_rules_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_api_access_rules_response.go b/v2/model_read_api_access_rules_response.go index 6583fe2be..1ae12a8b4 100644 --- a/v2/model_read_api_access_rules_response.go +++ b/v2/model_read_api_access_rules_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_api_logs_request.go b/v2/model_read_api_logs_request.go index bf4079e70..d99a5ed1b 100644 --- a/v2/model_read_api_logs_request.go +++ b/v2/model_read_api_logs_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_api_logs_response.go b/v2/model_read_api_logs_response.go index 3658a6023..46ff65568 100644 --- a/v2/model_read_api_logs_response.go +++ b/v2/model_read_api_logs_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_cas_request.go b/v2/model_read_cas_request.go index 7037025c6..579b7b39f 100644 --- a/v2/model_read_cas_request.go +++ b/v2/model_read_cas_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_cas_response.go b/v2/model_read_cas_response.go index b03fa5539..9e389039c 100644 --- a/v2/model_read_cas_response.go +++ b/v2/model_read_cas_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_catalog_request.go b/v2/model_read_catalog_request.go index 32d9d1bd1..9067a62ce 100644 --- a/v2/model_read_catalog_request.go +++ b/v2/model_read_catalog_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_catalog_response.go b/v2/model_read_catalog_response.go index 7c3828ca7..aac19f6ec 100644 --- a/v2/model_read_catalog_response.go +++ b/v2/model_read_catalog_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_catalogs_request.go b/v2/model_read_catalogs_request.go index 81f5fb512..6e5be1261 100644 --- a/v2/model_read_catalogs_request.go +++ b/v2/model_read_catalogs_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_catalogs_response.go b/v2/model_read_catalogs_response.go index 951920d22..8cb922381 100644 --- a/v2/model_read_catalogs_response.go +++ b/v2/model_read_catalogs_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_client_gateways_request.go b/v2/model_read_client_gateways_request.go index 005b1e207..8a08f453f 100644 --- a/v2/model_read_client_gateways_request.go +++ b/v2/model_read_client_gateways_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_client_gateways_response.go b/v2/model_read_client_gateways_response.go index 5daafba94..227460a0e 100644 --- a/v2/model_read_client_gateways_response.go +++ b/v2/model_read_client_gateways_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_console_output_request.go b/v2/model_read_console_output_request.go index 3f3e3fd22..9e5d00450 100644 --- a/v2/model_read_console_output_request.go +++ b/v2/model_read_console_output_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_console_output_response.go b/v2/model_read_console_output_response.go index 399f3288a..fdee8e803 100644 --- a/v2/model_read_console_output_response.go +++ b/v2/model_read_console_output_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_consumption_account_request.go b/v2/model_read_consumption_account_request.go index 1b81dca06..bf8a8a7c1 100644 --- a/v2/model_read_consumption_account_request.go +++ b/v2/model_read_consumption_account_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -23,6 +23,8 @@ type ReadConsumptionAccountRequest struct { FromDate string `json:"FromDate"` // By default or 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). Overall *bool `json:"Overall,omitempty"` + // By default or if false, returns only the consumption of the specific account that sends this request. If true, returns the unit price of the consumed resource, and the total price of the consumed resource during the specified time period in the currency of the catalog of the Region where the API method was used. + ShowPrice *bool `json:"ShowPrice,omitempty"` // 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`). ToDate string `json:"ToDate"` } @@ -138,6 +140,38 @@ func (o *ReadConsumptionAccountRequest) SetOverall(v bool) { o.Overall = &v } +// GetShowPrice returns the ShowPrice field value if set, zero value otherwise. +func (o *ReadConsumptionAccountRequest) GetShowPrice() bool { + if o == nil || o.ShowPrice == nil { + var ret bool + return ret + } + return *o.ShowPrice +} + +// GetShowPriceOk returns a tuple with the ShowPrice field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadConsumptionAccountRequest) GetShowPriceOk() (*bool, bool) { + if o == nil || o.ShowPrice == nil { + return nil, false + } + return o.ShowPrice, true +} + +// HasShowPrice returns a boolean if a field has been set. +func (o *ReadConsumptionAccountRequest) HasShowPrice() bool { + if o != nil && o.ShowPrice != nil { + return true + } + + return false +} + +// SetShowPrice gets a reference to the given bool and assigns it to the ShowPrice field. +func (o *ReadConsumptionAccountRequest) SetShowPrice(v bool) { + o.ShowPrice = &v +} + // GetToDate returns the ToDate field value func (o *ReadConsumptionAccountRequest) GetToDate() string { if o == nil { @@ -173,6 +207,9 @@ func (o ReadConsumptionAccountRequest) MarshalJSON() ([]byte, error) { if o.Overall != nil { toSerialize["Overall"] = o.Overall } + if o.ShowPrice != nil { + toSerialize["ShowPrice"] = o.ShowPrice + } if true { toSerialize["ToDate"] = o.ToDate } diff --git a/v2/model_read_consumption_account_response.go b/v2/model_read_consumption_account_response.go index 424dbc2d8..6ba06df6f 100644 --- a/v2/model_read_consumption_account_response.go +++ b/v2/model_read_consumption_account_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_dedicated_groups_request.go b/v2/model_read_dedicated_groups_request.go new file mode 100644 index 000000000..f2e857360 --- /dev/null +++ b/v2/model_read_dedicated_groups_request.go @@ -0,0 +1,151 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// ReadDedicatedGroupsRequest struct for ReadDedicatedGroupsRequest +type ReadDedicatedGroupsRequest struct { + // If true, checks whether you have the required permissions to perform the action. + DryRun *bool `json:"DryRun,omitempty"` + Filters *FiltersDedicatedGroup `json:"Filters,omitempty"` +} + +// NewReadDedicatedGroupsRequest instantiates a new ReadDedicatedGroupsRequest object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewReadDedicatedGroupsRequest() *ReadDedicatedGroupsRequest { + this := ReadDedicatedGroupsRequest{} + return &this +} + +// NewReadDedicatedGroupsRequestWithDefaults instantiates a new ReadDedicatedGroupsRequest object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewReadDedicatedGroupsRequestWithDefaults() *ReadDedicatedGroupsRequest { + this := ReadDedicatedGroupsRequest{} + return &this +} + +// GetDryRun returns the DryRun field value if set, zero value otherwise. +func (o *ReadDedicatedGroupsRequest) GetDryRun() bool { + if o == nil || o.DryRun == nil { + var ret bool + return ret + } + return *o.DryRun +} + +// GetDryRunOk returns a tuple with the DryRun field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadDedicatedGroupsRequest) GetDryRunOk() (*bool, bool) { + if o == nil || o.DryRun == nil { + return nil, false + } + return o.DryRun, true +} + +// HasDryRun returns a boolean if a field has been set. +func (o *ReadDedicatedGroupsRequest) HasDryRun() bool { + if o != nil && o.DryRun != nil { + return true + } + + return false +} + +// SetDryRun gets a reference to the given bool and assigns it to the DryRun field. +func (o *ReadDedicatedGroupsRequest) SetDryRun(v bool) { + o.DryRun = &v +} + +// GetFilters returns the Filters field value if set, zero value otherwise. +func (o *ReadDedicatedGroupsRequest) GetFilters() FiltersDedicatedGroup { + if o == nil || o.Filters == nil { + var ret FiltersDedicatedGroup + return ret + } + return *o.Filters +} + +// GetFiltersOk returns a tuple with the Filters field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadDedicatedGroupsRequest) GetFiltersOk() (*FiltersDedicatedGroup, bool) { + if o == nil || o.Filters == nil { + return nil, false + } + return o.Filters, true +} + +// HasFilters returns a boolean if a field has been set. +func (o *ReadDedicatedGroupsRequest) HasFilters() bool { + if o != nil && o.Filters != nil { + return true + } + + return false +} + +// SetFilters gets a reference to the given FiltersDedicatedGroup and assigns it to the Filters field. +func (o *ReadDedicatedGroupsRequest) SetFilters(v FiltersDedicatedGroup) { + o.Filters = &v +} + +func (o ReadDedicatedGroupsRequest) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.DryRun != nil { + toSerialize["DryRun"] = o.DryRun + } + if o.Filters != nil { + toSerialize["Filters"] = o.Filters + } + return json.Marshal(toSerialize) +} + +type NullableReadDedicatedGroupsRequest struct { + value *ReadDedicatedGroupsRequest + isSet bool +} + +func (v NullableReadDedicatedGroupsRequest) Get() *ReadDedicatedGroupsRequest { + return v.value +} + +func (v *NullableReadDedicatedGroupsRequest) Set(val *ReadDedicatedGroupsRequest) { + v.value = val + v.isSet = true +} + +func (v NullableReadDedicatedGroupsRequest) IsSet() bool { + return v.isSet +} + +func (v *NullableReadDedicatedGroupsRequest) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableReadDedicatedGroupsRequest(val *ReadDedicatedGroupsRequest) *NullableReadDedicatedGroupsRequest { + return &NullableReadDedicatedGroupsRequest{value: val, isSet: true} +} + +func (v NullableReadDedicatedGroupsRequest) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableReadDedicatedGroupsRequest) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_read_dedicated_groups_response.go b/v2/model_read_dedicated_groups_response.go new file mode 100644 index 000000000..17cf9af86 --- /dev/null +++ b/v2/model_read_dedicated_groups_response.go @@ -0,0 +1,151 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// ReadDedicatedGroupsResponse struct for ReadDedicatedGroupsResponse +type ReadDedicatedGroupsResponse struct { + // Information about one or more dedicated groups. + DedicatedGroups *[]DedicatedGroup `json:"DedicatedGroups,omitempty"` + ResponseContext *ResponseContext `json:"ResponseContext,omitempty"` +} + +// NewReadDedicatedGroupsResponse instantiates a new ReadDedicatedGroupsResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewReadDedicatedGroupsResponse() *ReadDedicatedGroupsResponse { + this := ReadDedicatedGroupsResponse{} + return &this +} + +// NewReadDedicatedGroupsResponseWithDefaults instantiates a new ReadDedicatedGroupsResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewReadDedicatedGroupsResponseWithDefaults() *ReadDedicatedGroupsResponse { + this := ReadDedicatedGroupsResponse{} + return &this +} + +// GetDedicatedGroups returns the DedicatedGroups field value if set, zero value otherwise. +func (o *ReadDedicatedGroupsResponse) GetDedicatedGroups() []DedicatedGroup { + if o == nil || o.DedicatedGroups == nil { + var ret []DedicatedGroup + return ret + } + return *o.DedicatedGroups +} + +// GetDedicatedGroupsOk returns a tuple with the DedicatedGroups field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadDedicatedGroupsResponse) GetDedicatedGroupsOk() (*[]DedicatedGroup, bool) { + if o == nil || o.DedicatedGroups == nil { + return nil, false + } + return o.DedicatedGroups, true +} + +// HasDedicatedGroups returns a boolean if a field has been set. +func (o *ReadDedicatedGroupsResponse) HasDedicatedGroups() bool { + if o != nil && o.DedicatedGroups != nil { + return true + } + + return false +} + +// SetDedicatedGroups gets a reference to the given []DedicatedGroup and assigns it to the DedicatedGroups field. +func (o *ReadDedicatedGroupsResponse) SetDedicatedGroups(v []DedicatedGroup) { + o.DedicatedGroups = &v +} + +// GetResponseContext returns the ResponseContext field value if set, zero value otherwise. +func (o *ReadDedicatedGroupsResponse) GetResponseContext() ResponseContext { + if o == nil || o.ResponseContext == nil { + var ret ResponseContext + return ret + } + return *o.ResponseContext +} + +// GetResponseContextOk returns a tuple with the ResponseContext field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadDedicatedGroupsResponse) GetResponseContextOk() (*ResponseContext, bool) { + if o == nil || o.ResponseContext == nil { + return nil, false + } + return o.ResponseContext, true +} + +// HasResponseContext returns a boolean if a field has been set. +func (o *ReadDedicatedGroupsResponse) HasResponseContext() bool { + if o != nil && o.ResponseContext != nil { + return true + } + + return false +} + +// SetResponseContext gets a reference to the given ResponseContext and assigns it to the ResponseContext field. +func (o *ReadDedicatedGroupsResponse) SetResponseContext(v ResponseContext) { + o.ResponseContext = &v +} + +func (o ReadDedicatedGroupsResponse) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.DedicatedGroups != nil { + toSerialize["DedicatedGroups"] = o.DedicatedGroups + } + if o.ResponseContext != nil { + toSerialize["ResponseContext"] = o.ResponseContext + } + return json.Marshal(toSerialize) +} + +type NullableReadDedicatedGroupsResponse struct { + value *ReadDedicatedGroupsResponse + isSet bool +} + +func (v NullableReadDedicatedGroupsResponse) Get() *ReadDedicatedGroupsResponse { + return v.value +} + +func (v *NullableReadDedicatedGroupsResponse) Set(val *ReadDedicatedGroupsResponse) { + v.value = val + v.isSet = true +} + +func (v NullableReadDedicatedGroupsResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableReadDedicatedGroupsResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableReadDedicatedGroupsResponse(val *ReadDedicatedGroupsResponse) *NullableReadDedicatedGroupsResponse { + return &NullableReadDedicatedGroupsResponse{value: val, isSet: true} +} + +func (v NullableReadDedicatedGroupsResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableReadDedicatedGroupsResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_read_dhcp_options_request.go b/v2/model_read_dhcp_options_request.go index c5635311a..700c2bd40 100644 --- a/v2/model_read_dhcp_options_request.go +++ b/v2/model_read_dhcp_options_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -20,6 +20,10 @@ type ReadDhcpOptionsRequest struct { // If true, checks whether you have the required permissions to perform the action. DryRun *bool `json:"DryRun,omitempty"` Filters *FiltersDhcpOptions `json:"Filters,omitempty"` + // The token to request the next page of results. Each token refers to a specific page. + NextPageToken *string `json:"NextPageToken,omitempty"` + // The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`. + ResultsPerPage *int32 `json:"ResultsPerPage,omitempty"` } // NewReadDhcpOptionsRequest instantiates a new ReadDhcpOptionsRequest object @@ -103,6 +107,70 @@ func (o *ReadDhcpOptionsRequest) SetFilters(v FiltersDhcpOptions) { o.Filters = &v } +// GetNextPageToken returns the NextPageToken field value if set, zero value otherwise. +func (o *ReadDhcpOptionsRequest) GetNextPageToken() string { + if o == nil || o.NextPageToken == nil { + var ret string + return ret + } + return *o.NextPageToken +} + +// GetNextPageTokenOk returns a tuple with the NextPageToken field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadDhcpOptionsRequest) GetNextPageTokenOk() (*string, bool) { + if o == nil || o.NextPageToken == nil { + return nil, false + } + return o.NextPageToken, true +} + +// HasNextPageToken returns a boolean if a field has been set. +func (o *ReadDhcpOptionsRequest) HasNextPageToken() bool { + if o != nil && o.NextPageToken != nil { + return true + } + + return false +} + +// SetNextPageToken gets a reference to the given string and assigns it to the NextPageToken field. +func (o *ReadDhcpOptionsRequest) SetNextPageToken(v string) { + o.NextPageToken = &v +} + +// GetResultsPerPage returns the ResultsPerPage field value if set, zero value otherwise. +func (o *ReadDhcpOptionsRequest) GetResultsPerPage() int32 { + if o == nil || o.ResultsPerPage == nil { + var ret int32 + return ret + } + return *o.ResultsPerPage +} + +// GetResultsPerPageOk returns a tuple with the ResultsPerPage field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadDhcpOptionsRequest) GetResultsPerPageOk() (*int32, bool) { + if o == nil || o.ResultsPerPage == nil { + return nil, false + } + return o.ResultsPerPage, true +} + +// HasResultsPerPage returns a boolean if a field has been set. +func (o *ReadDhcpOptionsRequest) HasResultsPerPage() bool { + if o != nil && o.ResultsPerPage != nil { + return true + } + + return false +} + +// SetResultsPerPage gets a reference to the given int32 and assigns it to the ResultsPerPage field. +func (o *ReadDhcpOptionsRequest) SetResultsPerPage(v int32) { + o.ResultsPerPage = &v +} + func (o ReadDhcpOptionsRequest) MarshalJSON() ([]byte, error) { toSerialize := map[string]interface{}{} if o.DryRun != nil { @@ -111,6 +179,12 @@ func (o ReadDhcpOptionsRequest) MarshalJSON() ([]byte, error) { if o.Filters != nil { toSerialize["Filters"] = o.Filters } + if o.NextPageToken != nil { + toSerialize["NextPageToken"] = o.NextPageToken + } + if o.ResultsPerPage != nil { + toSerialize["ResultsPerPage"] = o.ResultsPerPage + } return json.Marshal(toSerialize) } diff --git a/v2/model_read_dhcp_options_response.go b/v2/model_read_dhcp_options_response.go index 1ba97fd79..518909ae5 100644 --- a/v2/model_read_dhcp_options_response.go +++ b/v2/model_read_dhcp_options_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -19,7 +19,9 @@ import ( type ReadDhcpOptionsResponse struct { // Information about one or more DHCP options sets. DhcpOptionsSets *[]DhcpOptionsSet `json:"DhcpOptionsSets,omitempty"` - ResponseContext *ResponseContext `json:"ResponseContext,omitempty"` + // The token to request the next page of results. Each token refers to a specific page. + NextPageToken *string `json:"NextPageToken,omitempty"` + ResponseContext *ResponseContext `json:"ResponseContext,omitempty"` } // NewReadDhcpOptionsResponse instantiates a new ReadDhcpOptionsResponse object @@ -71,6 +73,38 @@ func (o *ReadDhcpOptionsResponse) SetDhcpOptionsSets(v []DhcpOptionsSet) { o.DhcpOptionsSets = &v } +// GetNextPageToken returns the NextPageToken field value if set, zero value otherwise. +func (o *ReadDhcpOptionsResponse) GetNextPageToken() string { + if o == nil || o.NextPageToken == nil { + var ret string + return ret + } + return *o.NextPageToken +} + +// GetNextPageTokenOk returns a tuple with the NextPageToken field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadDhcpOptionsResponse) GetNextPageTokenOk() (*string, bool) { + if o == nil || o.NextPageToken == nil { + return nil, false + } + return o.NextPageToken, true +} + +// HasNextPageToken returns a boolean if a field has been set. +func (o *ReadDhcpOptionsResponse) HasNextPageToken() bool { + if o != nil && o.NextPageToken != nil { + return true + } + + return false +} + +// SetNextPageToken gets a reference to the given string and assigns it to the NextPageToken field. +func (o *ReadDhcpOptionsResponse) SetNextPageToken(v string) { + o.NextPageToken = &v +} + // GetResponseContext returns the ResponseContext field value if set, zero value otherwise. func (o *ReadDhcpOptionsResponse) GetResponseContext() ResponseContext { if o == nil || o.ResponseContext == nil { @@ -108,6 +142,9 @@ func (o ReadDhcpOptionsResponse) MarshalJSON() ([]byte, error) { if o.DhcpOptionsSets != nil { toSerialize["DhcpOptionsSets"] = o.DhcpOptionsSets } + if o.NextPageToken != nil { + toSerialize["NextPageToken"] = o.NextPageToken + } if o.ResponseContext != nil { toSerialize["ResponseContext"] = o.ResponseContext } diff --git a/v2/model_read_direct_link_interfaces_request.go b/v2/model_read_direct_link_interfaces_request.go index 80c43948e..a52eb23c7 100644 --- a/v2/model_read_direct_link_interfaces_request.go +++ b/v2/model_read_direct_link_interfaces_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_direct_link_interfaces_response.go b/v2/model_read_direct_link_interfaces_response.go index 07a331fcc..a72d8d307 100644 --- a/v2/model_read_direct_link_interfaces_response.go +++ b/v2/model_read_direct_link_interfaces_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_direct_links_request.go b/v2/model_read_direct_links_request.go index b66dcc3bb..043e645a7 100644 --- a/v2/model_read_direct_links_request.go +++ b/v2/model_read_direct_links_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_direct_links_response.go b/v2/model_read_direct_links_response.go index e9a0487f3..0bb9141cc 100644 --- a/v2/model_read_direct_links_response.go +++ b/v2/model_read_direct_links_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_flexible_gpu_catalog_request.go b/v2/model_read_flexible_gpu_catalog_request.go index 8314b363a..9d40996de 100644 --- a/v2/model_read_flexible_gpu_catalog_request.go +++ b/v2/model_read_flexible_gpu_catalog_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_flexible_gpu_catalog_response.go b/v2/model_read_flexible_gpu_catalog_response.go index 2f256c033..a2a7fc4ab 100644 --- a/v2/model_read_flexible_gpu_catalog_response.go +++ b/v2/model_read_flexible_gpu_catalog_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_flexible_gpus_request.go b/v2/model_read_flexible_gpus_request.go index 084e2a9ff..48d7e13a6 100644 --- a/v2/model_read_flexible_gpus_request.go +++ b/v2/model_read_flexible_gpus_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_flexible_gpus_response.go b/v2/model_read_flexible_gpus_response.go index 1ff43d719..b01836ef1 100644 --- a/v2/model_read_flexible_gpus_response.go +++ b/v2/model_read_flexible_gpus_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_image_export_tasks_request.go b/v2/model_read_image_export_tasks_request.go index 7488a62ea..3187cb019 100644 --- a/v2/model_read_image_export_tasks_request.go +++ b/v2/model_read_image_export_tasks_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_image_export_tasks_response.go b/v2/model_read_image_export_tasks_response.go index 731e50673..ff59cfb83 100644 --- a/v2/model_read_image_export_tasks_response.go +++ b/v2/model_read_image_export_tasks_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_images_request.go b/v2/model_read_images_request.go index 7f9d98c80..b9b7a00c1 100644 --- a/v2/model_read_images_request.go +++ b/v2/model_read_images_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -20,6 +20,10 @@ type ReadImagesRequest struct { // If true, checks whether you have the required permissions to perform the action. DryRun *bool `json:"DryRun,omitempty"` Filters *FiltersImage `json:"Filters,omitempty"` + // The token to request the next page of results. Each token refers to a specific page. + NextPageToken *string `json:"NextPageToken,omitempty"` + // The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`. + ResultsPerPage *int32 `json:"ResultsPerPage,omitempty"` } // NewReadImagesRequest instantiates a new ReadImagesRequest object @@ -103,6 +107,70 @@ func (o *ReadImagesRequest) SetFilters(v FiltersImage) { o.Filters = &v } +// GetNextPageToken returns the NextPageToken field value if set, zero value otherwise. +func (o *ReadImagesRequest) GetNextPageToken() string { + if o == nil || o.NextPageToken == nil { + var ret string + return ret + } + return *o.NextPageToken +} + +// GetNextPageTokenOk returns a tuple with the NextPageToken field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadImagesRequest) GetNextPageTokenOk() (*string, bool) { + if o == nil || o.NextPageToken == nil { + return nil, false + } + return o.NextPageToken, true +} + +// HasNextPageToken returns a boolean if a field has been set. +func (o *ReadImagesRequest) HasNextPageToken() bool { + if o != nil && o.NextPageToken != nil { + return true + } + + return false +} + +// SetNextPageToken gets a reference to the given string and assigns it to the NextPageToken field. +func (o *ReadImagesRequest) SetNextPageToken(v string) { + o.NextPageToken = &v +} + +// GetResultsPerPage returns the ResultsPerPage field value if set, zero value otherwise. +func (o *ReadImagesRequest) GetResultsPerPage() int32 { + if o == nil || o.ResultsPerPage == nil { + var ret int32 + return ret + } + return *o.ResultsPerPage +} + +// GetResultsPerPageOk returns a tuple with the ResultsPerPage field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadImagesRequest) GetResultsPerPageOk() (*int32, bool) { + if o == nil || o.ResultsPerPage == nil { + return nil, false + } + return o.ResultsPerPage, true +} + +// HasResultsPerPage returns a boolean if a field has been set. +func (o *ReadImagesRequest) HasResultsPerPage() bool { + if o != nil && o.ResultsPerPage != nil { + return true + } + + return false +} + +// SetResultsPerPage gets a reference to the given int32 and assigns it to the ResultsPerPage field. +func (o *ReadImagesRequest) SetResultsPerPage(v int32) { + o.ResultsPerPage = &v +} + func (o ReadImagesRequest) MarshalJSON() ([]byte, error) { toSerialize := map[string]interface{}{} if o.DryRun != nil { @@ -111,6 +179,12 @@ func (o ReadImagesRequest) MarshalJSON() ([]byte, error) { if o.Filters != nil { toSerialize["Filters"] = o.Filters } + if o.NextPageToken != nil { + toSerialize["NextPageToken"] = o.NextPageToken + } + if o.ResultsPerPage != nil { + toSerialize["ResultsPerPage"] = o.ResultsPerPage + } return json.Marshal(toSerialize) } diff --git a/v2/model_read_images_response.go b/v2/model_read_images_response.go index 7b6413382..1c9c932d8 100644 --- a/v2/model_read_images_response.go +++ b/v2/model_read_images_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -18,7 +18,9 @@ import ( // ReadImagesResponse struct for ReadImagesResponse type ReadImagesResponse struct { // Information about one or more OMIs. - Images *[]Image `json:"Images,omitempty"` + Images *[]Image `json:"Images,omitempty"` + // The token to request the next page of results. Each token refers to a specific page. + NextPageToken *string `json:"NextPageToken,omitempty"` ResponseContext *ResponseContext `json:"ResponseContext,omitempty"` } @@ -71,6 +73,38 @@ func (o *ReadImagesResponse) SetImages(v []Image) { o.Images = &v } +// GetNextPageToken returns the NextPageToken field value if set, zero value otherwise. +func (o *ReadImagesResponse) GetNextPageToken() string { + if o == nil || o.NextPageToken == nil { + var ret string + return ret + } + return *o.NextPageToken +} + +// GetNextPageTokenOk returns a tuple with the NextPageToken field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadImagesResponse) GetNextPageTokenOk() (*string, bool) { + if o == nil || o.NextPageToken == nil { + return nil, false + } + return o.NextPageToken, true +} + +// HasNextPageToken returns a boolean if a field has been set. +func (o *ReadImagesResponse) HasNextPageToken() bool { + if o != nil && o.NextPageToken != nil { + return true + } + + return false +} + +// SetNextPageToken gets a reference to the given string and assigns it to the NextPageToken field. +func (o *ReadImagesResponse) SetNextPageToken(v string) { + o.NextPageToken = &v +} + // GetResponseContext returns the ResponseContext field value if set, zero value otherwise. func (o *ReadImagesResponse) GetResponseContext() ResponseContext { if o == nil || o.ResponseContext == nil { @@ -108,6 +142,9 @@ func (o ReadImagesResponse) MarshalJSON() ([]byte, error) { if o.Images != nil { toSerialize["Images"] = o.Images } + if o.NextPageToken != nil { + toSerialize["NextPageToken"] = o.NextPageToken + } if o.ResponseContext != nil { toSerialize["ResponseContext"] = o.ResponseContext } diff --git a/v2/model_read_internet_services_request.go b/v2/model_read_internet_services_request.go index 5d022052f..29016f8e6 100644 --- a/v2/model_read_internet_services_request.go +++ b/v2/model_read_internet_services_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_internet_services_response.go b/v2/model_read_internet_services_response.go index 371a94fc8..332a66e6f 100644 --- a/v2/model_read_internet_services_response.go +++ b/v2/model_read_internet_services_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_keypairs_request.go b/v2/model_read_keypairs_request.go index 2546db680..6515dd9d0 100644 --- a/v2/model_read_keypairs_request.go +++ b/v2/model_read_keypairs_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_keypairs_response.go b/v2/model_read_keypairs_response.go index 0d047e09e..28eed5786 100644 --- a/v2/model_read_keypairs_response.go +++ b/v2/model_read_keypairs_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -18,8 +18,7 @@ import ( // ReadKeypairsResponse struct for ReadKeypairsResponse type ReadKeypairsResponse struct { // Information about one or more keypairs. - Keypairs *[]Keypair `json:"Keypairs,omitempty"` - ResponseContext *ResponseContext `json:"ResponseContext,omitempty"` + Keypairs *[]Keypair `json:"Keypairs,omitempty"` } // NewReadKeypairsResponse instantiates a new ReadKeypairsResponse object @@ -71,46 +70,11 @@ func (o *ReadKeypairsResponse) SetKeypairs(v []Keypair) { o.Keypairs = &v } -// GetResponseContext returns the ResponseContext field value if set, zero value otherwise. -func (o *ReadKeypairsResponse) GetResponseContext() ResponseContext { - if o == nil || o.ResponseContext == nil { - var ret ResponseContext - return ret - } - return *o.ResponseContext -} - -// GetResponseContextOk returns a tuple with the ResponseContext field value if set, nil otherwise -// and a boolean to check if the value has been set. -func (o *ReadKeypairsResponse) GetResponseContextOk() (*ResponseContext, bool) { - if o == nil || o.ResponseContext == nil { - return nil, false - } - return o.ResponseContext, true -} - -// HasResponseContext returns a boolean if a field has been set. -func (o *ReadKeypairsResponse) HasResponseContext() bool { - if o != nil && o.ResponseContext != nil { - return true - } - - return false -} - -// SetResponseContext gets a reference to the given ResponseContext and assigns it to the ResponseContext field. -func (o *ReadKeypairsResponse) SetResponseContext(v ResponseContext) { - o.ResponseContext = &v -} - func (o ReadKeypairsResponse) MarshalJSON() ([]byte, error) { toSerialize := map[string]interface{}{} if o.Keypairs != nil { toSerialize["Keypairs"] = o.Keypairs } - if o.ResponseContext != nil { - toSerialize["ResponseContext"] = o.ResponseContext - } return json.Marshal(toSerialize) } diff --git a/v2/model_read_linked_policies_filters.go b/v2/model_read_linked_policies_filters.go new file mode 100644 index 000000000..2531efc70 --- /dev/null +++ b/v2/model_read_linked_policies_filters.go @@ -0,0 +1,115 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// ReadLinkedPoliciesFilters One or more filters. +type ReadLinkedPoliciesFilters struct { + // The path prefix of the policies, set to a slash (`/`) by default. + PathPrefix *string `json:"PathPrefix,omitempty"` +} + +// NewReadLinkedPoliciesFilters instantiates a new ReadLinkedPoliciesFilters object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewReadLinkedPoliciesFilters() *ReadLinkedPoliciesFilters { + this := ReadLinkedPoliciesFilters{} + return &this +} + +// NewReadLinkedPoliciesFiltersWithDefaults instantiates a new ReadLinkedPoliciesFilters object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewReadLinkedPoliciesFiltersWithDefaults() *ReadLinkedPoliciesFilters { + this := ReadLinkedPoliciesFilters{} + return &this +} + +// GetPathPrefix returns the PathPrefix field value if set, zero value otherwise. +func (o *ReadLinkedPoliciesFilters) GetPathPrefix() string { + if o == nil || o.PathPrefix == nil { + var ret string + return ret + } + return *o.PathPrefix +} + +// GetPathPrefixOk returns a tuple with the PathPrefix field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadLinkedPoliciesFilters) GetPathPrefixOk() (*string, bool) { + if o == nil || o.PathPrefix == nil { + return nil, false + } + return o.PathPrefix, true +} + +// HasPathPrefix returns a boolean if a field has been set. +func (o *ReadLinkedPoliciesFilters) HasPathPrefix() bool { + if o != nil && o.PathPrefix != nil { + return true + } + + return false +} + +// SetPathPrefix gets a reference to the given string and assigns it to the PathPrefix field. +func (o *ReadLinkedPoliciesFilters) SetPathPrefix(v string) { + o.PathPrefix = &v +} + +func (o ReadLinkedPoliciesFilters) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.PathPrefix != nil { + toSerialize["PathPrefix"] = o.PathPrefix + } + return json.Marshal(toSerialize) +} + +type NullableReadLinkedPoliciesFilters struct { + value *ReadLinkedPoliciesFilters + isSet bool +} + +func (v NullableReadLinkedPoliciesFilters) Get() *ReadLinkedPoliciesFilters { + return v.value +} + +func (v *NullableReadLinkedPoliciesFilters) Set(val *ReadLinkedPoliciesFilters) { + v.value = val + v.isSet = true +} + +func (v NullableReadLinkedPoliciesFilters) IsSet() bool { + return v.isSet +} + +func (v *NullableReadLinkedPoliciesFilters) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableReadLinkedPoliciesFilters(val *ReadLinkedPoliciesFilters) *NullableReadLinkedPoliciesFilters { + return &NullableReadLinkedPoliciesFilters{value: val, isSet: true} +} + +func (v NullableReadLinkedPoliciesFilters) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableReadLinkedPoliciesFilters) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_read_linked_policies_request.go b/v2/model_read_linked_policies_request.go new file mode 100644 index 000000000..01c8ad4e3 --- /dev/null +++ b/v2/model_read_linked_policies_request.go @@ -0,0 +1,262 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// ReadLinkedPoliciesRequest struct for ReadLinkedPoliciesRequest +type ReadLinkedPoliciesRequest struct { + // If true, checks whether you have the required permissions to perform the action. + DryRun *bool `json:"DryRun,omitempty"` + Filters *ReadLinkedPoliciesFilters `json:"Filters,omitempty"` + // The item starting the list of policies requested. + FirstItem *int32 `json:"FirstItem,omitempty"` + // The maximum number of items that can be returned in a single response (by default, 100). + ResultsPerPage *int32 `json:"ResultsPerPage,omitempty"` + // The name of the user the policies are linked to. + UserName *string `json:"UserName,omitempty"` +} + +// NewReadLinkedPoliciesRequest instantiates a new ReadLinkedPoliciesRequest object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewReadLinkedPoliciesRequest() *ReadLinkedPoliciesRequest { + this := ReadLinkedPoliciesRequest{} + return &this +} + +// NewReadLinkedPoliciesRequestWithDefaults instantiates a new ReadLinkedPoliciesRequest object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewReadLinkedPoliciesRequestWithDefaults() *ReadLinkedPoliciesRequest { + this := ReadLinkedPoliciesRequest{} + return &this +} + +// GetDryRun returns the DryRun field value if set, zero value otherwise. +func (o *ReadLinkedPoliciesRequest) GetDryRun() bool { + if o == nil || o.DryRun == nil { + var ret bool + return ret + } + return *o.DryRun +} + +// GetDryRunOk returns a tuple with the DryRun field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadLinkedPoliciesRequest) GetDryRunOk() (*bool, bool) { + if o == nil || o.DryRun == nil { + return nil, false + } + return o.DryRun, true +} + +// HasDryRun returns a boolean if a field has been set. +func (o *ReadLinkedPoliciesRequest) HasDryRun() bool { + if o != nil && o.DryRun != nil { + return true + } + + return false +} + +// SetDryRun gets a reference to the given bool and assigns it to the DryRun field. +func (o *ReadLinkedPoliciesRequest) SetDryRun(v bool) { + o.DryRun = &v +} + +// GetFilters returns the Filters field value if set, zero value otherwise. +func (o *ReadLinkedPoliciesRequest) GetFilters() ReadLinkedPoliciesFilters { + if o == nil || o.Filters == nil { + var ret ReadLinkedPoliciesFilters + return ret + } + return *o.Filters +} + +// GetFiltersOk returns a tuple with the Filters field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadLinkedPoliciesRequest) GetFiltersOk() (*ReadLinkedPoliciesFilters, bool) { + if o == nil || o.Filters == nil { + return nil, false + } + return o.Filters, true +} + +// HasFilters returns a boolean if a field has been set. +func (o *ReadLinkedPoliciesRequest) HasFilters() bool { + if o != nil && o.Filters != nil { + return true + } + + return false +} + +// SetFilters gets a reference to the given ReadLinkedPoliciesFilters and assigns it to the Filters field. +func (o *ReadLinkedPoliciesRequest) SetFilters(v ReadLinkedPoliciesFilters) { + o.Filters = &v +} + +// GetFirstItem returns the FirstItem field value if set, zero value otherwise. +func (o *ReadLinkedPoliciesRequest) GetFirstItem() int32 { + if o == nil || o.FirstItem == nil { + var ret int32 + return ret + } + return *o.FirstItem +} + +// GetFirstItemOk returns a tuple with the FirstItem field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadLinkedPoliciesRequest) GetFirstItemOk() (*int32, bool) { + if o == nil || o.FirstItem == nil { + return nil, false + } + return o.FirstItem, true +} + +// HasFirstItem returns a boolean if a field has been set. +func (o *ReadLinkedPoliciesRequest) HasFirstItem() bool { + if o != nil && o.FirstItem != nil { + return true + } + + return false +} + +// SetFirstItem gets a reference to the given int32 and assigns it to the FirstItem field. +func (o *ReadLinkedPoliciesRequest) SetFirstItem(v int32) { + o.FirstItem = &v +} + +// GetResultsPerPage returns the ResultsPerPage field value if set, zero value otherwise. +func (o *ReadLinkedPoliciesRequest) GetResultsPerPage() int32 { + if o == nil || o.ResultsPerPage == nil { + var ret int32 + return ret + } + return *o.ResultsPerPage +} + +// GetResultsPerPageOk returns a tuple with the ResultsPerPage field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadLinkedPoliciesRequest) GetResultsPerPageOk() (*int32, bool) { + if o == nil || o.ResultsPerPage == nil { + return nil, false + } + return o.ResultsPerPage, true +} + +// HasResultsPerPage returns a boolean if a field has been set. +func (o *ReadLinkedPoliciesRequest) HasResultsPerPage() bool { + if o != nil && o.ResultsPerPage != nil { + return true + } + + return false +} + +// SetResultsPerPage gets a reference to the given int32 and assigns it to the ResultsPerPage field. +func (o *ReadLinkedPoliciesRequest) SetResultsPerPage(v int32) { + o.ResultsPerPage = &v +} + +// GetUserName returns the UserName field value if set, zero value otherwise. +func (o *ReadLinkedPoliciesRequest) GetUserName() string { + if o == nil || o.UserName == nil { + var ret string + return ret + } + return *o.UserName +} + +// GetUserNameOk returns a tuple with the UserName field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadLinkedPoliciesRequest) GetUserNameOk() (*string, bool) { + if o == nil || o.UserName == nil { + return nil, false + } + return o.UserName, true +} + +// HasUserName returns a boolean if a field has been set. +func (o *ReadLinkedPoliciesRequest) HasUserName() bool { + if o != nil && o.UserName != nil { + return true + } + + return false +} + +// SetUserName gets a reference to the given string and assigns it to the UserName field. +func (o *ReadLinkedPoliciesRequest) SetUserName(v string) { + o.UserName = &v +} + +func (o ReadLinkedPoliciesRequest) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.DryRun != nil { + toSerialize["DryRun"] = o.DryRun + } + if o.Filters != nil { + toSerialize["Filters"] = o.Filters + } + if o.FirstItem != nil { + toSerialize["FirstItem"] = o.FirstItem + } + if o.ResultsPerPage != nil { + toSerialize["ResultsPerPage"] = o.ResultsPerPage + } + if o.UserName != nil { + toSerialize["UserName"] = o.UserName + } + return json.Marshal(toSerialize) +} + +type NullableReadLinkedPoliciesRequest struct { + value *ReadLinkedPoliciesRequest + isSet bool +} + +func (v NullableReadLinkedPoliciesRequest) Get() *ReadLinkedPoliciesRequest { + return v.value +} + +func (v *NullableReadLinkedPoliciesRequest) Set(val *ReadLinkedPoliciesRequest) { + v.value = val + v.isSet = true +} + +func (v NullableReadLinkedPoliciesRequest) IsSet() bool { + return v.isSet +} + +func (v *NullableReadLinkedPoliciesRequest) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableReadLinkedPoliciesRequest(val *ReadLinkedPoliciesRequest) *NullableReadLinkedPoliciesRequest { + return &NullableReadLinkedPoliciesRequest{value: val, isSet: true} +} + +func (v NullableReadLinkedPoliciesRequest) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableReadLinkedPoliciesRequest) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_read_linked_policies_response.go b/v2/model_read_linked_policies_response.go new file mode 100644 index 000000000..384757f70 --- /dev/null +++ b/v2/model_read_linked_policies_response.go @@ -0,0 +1,262 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// ReadLinkedPoliciesResponse struct for ReadLinkedPoliciesResponse +type ReadLinkedPoliciesResponse struct { + // If true, there are more items to return using the `FirstItem` parameter in a new request. + HasMoreItems *bool `json:"HasMoreItems,omitempty"` + // Indicates maximum results defined for the operation. + MaxResultsLimit *int32 `json:"MaxResultsLimit,omitempty"` + // If true, indicates whether requested page size is more than allowed. + MaxResultsTruncated *bool `json:"MaxResultsTruncated,omitempty"` + // One or more policies linked to the specified user. + Policies *[]LinkedPolicy `json:"Policies,omitempty"` + ResponseContext *ResponseContext `json:"ResponseContext,omitempty"` +} + +// NewReadLinkedPoliciesResponse instantiates a new ReadLinkedPoliciesResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewReadLinkedPoliciesResponse() *ReadLinkedPoliciesResponse { + this := ReadLinkedPoliciesResponse{} + return &this +} + +// NewReadLinkedPoliciesResponseWithDefaults instantiates a new ReadLinkedPoliciesResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewReadLinkedPoliciesResponseWithDefaults() *ReadLinkedPoliciesResponse { + this := ReadLinkedPoliciesResponse{} + return &this +} + +// GetHasMoreItems returns the HasMoreItems field value if set, zero value otherwise. +func (o *ReadLinkedPoliciesResponse) GetHasMoreItems() bool { + if o == nil || o.HasMoreItems == nil { + var ret bool + return ret + } + return *o.HasMoreItems +} + +// GetHasMoreItemsOk returns a tuple with the HasMoreItems field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadLinkedPoliciesResponse) GetHasMoreItemsOk() (*bool, bool) { + if o == nil || o.HasMoreItems == nil { + return nil, false + } + return o.HasMoreItems, true +} + +// HasHasMoreItems returns a boolean if a field has been set. +func (o *ReadLinkedPoliciesResponse) HasHasMoreItems() bool { + if o != nil && o.HasMoreItems != nil { + return true + } + + return false +} + +// SetHasMoreItems gets a reference to the given bool and assigns it to the HasMoreItems field. +func (o *ReadLinkedPoliciesResponse) SetHasMoreItems(v bool) { + o.HasMoreItems = &v +} + +// GetMaxResultsLimit returns the MaxResultsLimit field value if set, zero value otherwise. +func (o *ReadLinkedPoliciesResponse) GetMaxResultsLimit() int32 { + if o == nil || o.MaxResultsLimit == nil { + var ret int32 + return ret + } + return *o.MaxResultsLimit +} + +// GetMaxResultsLimitOk returns a tuple with the MaxResultsLimit field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadLinkedPoliciesResponse) GetMaxResultsLimitOk() (*int32, bool) { + if o == nil || o.MaxResultsLimit == nil { + return nil, false + } + return o.MaxResultsLimit, true +} + +// HasMaxResultsLimit returns a boolean if a field has been set. +func (o *ReadLinkedPoliciesResponse) HasMaxResultsLimit() bool { + if o != nil && o.MaxResultsLimit != nil { + return true + } + + return false +} + +// SetMaxResultsLimit gets a reference to the given int32 and assigns it to the MaxResultsLimit field. +func (o *ReadLinkedPoliciesResponse) SetMaxResultsLimit(v int32) { + o.MaxResultsLimit = &v +} + +// GetMaxResultsTruncated returns the MaxResultsTruncated field value if set, zero value otherwise. +func (o *ReadLinkedPoliciesResponse) GetMaxResultsTruncated() bool { + if o == nil || o.MaxResultsTruncated == nil { + var ret bool + return ret + } + return *o.MaxResultsTruncated +} + +// GetMaxResultsTruncatedOk returns a tuple with the MaxResultsTruncated field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadLinkedPoliciesResponse) GetMaxResultsTruncatedOk() (*bool, bool) { + if o == nil || o.MaxResultsTruncated == nil { + return nil, false + } + return o.MaxResultsTruncated, true +} + +// HasMaxResultsTruncated returns a boolean if a field has been set. +func (o *ReadLinkedPoliciesResponse) HasMaxResultsTruncated() bool { + if o != nil && o.MaxResultsTruncated != nil { + return true + } + + return false +} + +// SetMaxResultsTruncated gets a reference to the given bool and assigns it to the MaxResultsTruncated field. +func (o *ReadLinkedPoliciesResponse) SetMaxResultsTruncated(v bool) { + o.MaxResultsTruncated = &v +} + +// GetPolicies returns the Policies field value if set, zero value otherwise. +func (o *ReadLinkedPoliciesResponse) GetPolicies() []LinkedPolicy { + if o == nil || o.Policies == nil { + var ret []LinkedPolicy + return ret + } + return *o.Policies +} + +// GetPoliciesOk returns a tuple with the Policies field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadLinkedPoliciesResponse) GetPoliciesOk() (*[]LinkedPolicy, bool) { + if o == nil || o.Policies == nil { + return nil, false + } + return o.Policies, true +} + +// HasPolicies returns a boolean if a field has been set. +func (o *ReadLinkedPoliciesResponse) HasPolicies() bool { + if o != nil && o.Policies != nil { + return true + } + + return false +} + +// SetPolicies gets a reference to the given []LinkedPolicy and assigns it to the Policies field. +func (o *ReadLinkedPoliciesResponse) SetPolicies(v []LinkedPolicy) { + o.Policies = &v +} + +// GetResponseContext returns the ResponseContext field value if set, zero value otherwise. +func (o *ReadLinkedPoliciesResponse) GetResponseContext() ResponseContext { + if o == nil || o.ResponseContext == nil { + var ret ResponseContext + return ret + } + return *o.ResponseContext +} + +// GetResponseContextOk returns a tuple with the ResponseContext field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadLinkedPoliciesResponse) GetResponseContextOk() (*ResponseContext, bool) { + if o == nil || o.ResponseContext == nil { + return nil, false + } + return o.ResponseContext, true +} + +// HasResponseContext returns a boolean if a field has been set. +func (o *ReadLinkedPoliciesResponse) HasResponseContext() bool { + if o != nil && o.ResponseContext != nil { + return true + } + + return false +} + +// SetResponseContext gets a reference to the given ResponseContext and assigns it to the ResponseContext field. +func (o *ReadLinkedPoliciesResponse) SetResponseContext(v ResponseContext) { + o.ResponseContext = &v +} + +func (o ReadLinkedPoliciesResponse) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.HasMoreItems != nil { + toSerialize["HasMoreItems"] = o.HasMoreItems + } + if o.MaxResultsLimit != nil { + toSerialize["MaxResultsLimit"] = o.MaxResultsLimit + } + if o.MaxResultsTruncated != nil { + toSerialize["MaxResultsTruncated"] = o.MaxResultsTruncated + } + if o.Policies != nil { + toSerialize["Policies"] = o.Policies + } + if o.ResponseContext != nil { + toSerialize["ResponseContext"] = o.ResponseContext + } + return json.Marshal(toSerialize) +} + +type NullableReadLinkedPoliciesResponse struct { + value *ReadLinkedPoliciesResponse + isSet bool +} + +func (v NullableReadLinkedPoliciesResponse) Get() *ReadLinkedPoliciesResponse { + return v.value +} + +func (v *NullableReadLinkedPoliciesResponse) Set(val *ReadLinkedPoliciesResponse) { + v.value = val + v.isSet = true +} + +func (v NullableReadLinkedPoliciesResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableReadLinkedPoliciesResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableReadLinkedPoliciesResponse(val *ReadLinkedPoliciesResponse) *NullableReadLinkedPoliciesResponse { + return &NullableReadLinkedPoliciesResponse{value: val, isSet: true} +} + +func (v NullableReadLinkedPoliciesResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableReadLinkedPoliciesResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_read_listener_rules_request.go b/v2/model_read_listener_rules_request.go index 389981df9..653016930 100644 --- a/v2/model_read_listener_rules_request.go +++ b/v2/model_read_listener_rules_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_listener_rules_response.go b/v2/model_read_listener_rules_response.go index 57dfab2bf..5cfec3bb3 100644 --- a/v2/model_read_listener_rules_response.go +++ b/v2/model_read_listener_rules_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_load_balancer_tags_request.go b/v2/model_read_load_balancer_tags_request.go index 1ea80d78d..182e27171 100644 --- a/v2/model_read_load_balancer_tags_request.go +++ b/v2/model_read_load_balancer_tags_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_load_balancer_tags_response.go b/v2/model_read_load_balancer_tags_response.go index 01fcb339d..8a54b5245 100644 --- a/v2/model_read_load_balancer_tags_response.go +++ b/v2/model_read_load_balancer_tags_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_load_balancers_request.go b/v2/model_read_load_balancers_request.go index e3fe28c93..84bec1afa 100644 --- a/v2/model_read_load_balancers_request.go +++ b/v2/model_read_load_balancers_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_load_balancers_response.go b/v2/model_read_load_balancers_response.go index 6e2ec8d3f..f30732700 100644 --- a/v2/model_read_load_balancers_response.go +++ b/v2/model_read_load_balancers_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_locations_request.go b/v2/model_read_locations_request.go index ba11717d4..3872a713d 100644 --- a/v2/model_read_locations_request.go +++ b/v2/model_read_locations_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_locations_response.go b/v2/model_read_locations_response.go index 5ec0f6291..0582a6b2a 100644 --- a/v2/model_read_locations_response.go +++ b/v2/model_read_locations_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_nat_services_request.go b/v2/model_read_nat_services_request.go index b27ef7af3..a6bc4c5ae 100644 --- a/v2/model_read_nat_services_request.go +++ b/v2/model_read_nat_services_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -20,6 +20,10 @@ type ReadNatServicesRequest struct { // If true, checks whether you have the required permissions to perform the action. DryRun *bool `json:"DryRun,omitempty"` Filters *FiltersNatService `json:"Filters,omitempty"` + // The token to request the next page of results. Each token refers to a specific page. + NextPageToken *string `json:"NextPageToken,omitempty"` + // The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`. + ResultsPerPage *int32 `json:"ResultsPerPage,omitempty"` } // NewReadNatServicesRequest instantiates a new ReadNatServicesRequest object @@ -103,6 +107,70 @@ func (o *ReadNatServicesRequest) SetFilters(v FiltersNatService) { o.Filters = &v } +// GetNextPageToken returns the NextPageToken field value if set, zero value otherwise. +func (o *ReadNatServicesRequest) GetNextPageToken() string { + if o == nil || o.NextPageToken == nil { + var ret string + return ret + } + return *o.NextPageToken +} + +// GetNextPageTokenOk returns a tuple with the NextPageToken field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadNatServicesRequest) GetNextPageTokenOk() (*string, bool) { + if o == nil || o.NextPageToken == nil { + return nil, false + } + return o.NextPageToken, true +} + +// HasNextPageToken returns a boolean if a field has been set. +func (o *ReadNatServicesRequest) HasNextPageToken() bool { + if o != nil && o.NextPageToken != nil { + return true + } + + return false +} + +// SetNextPageToken gets a reference to the given string and assigns it to the NextPageToken field. +func (o *ReadNatServicesRequest) SetNextPageToken(v string) { + o.NextPageToken = &v +} + +// GetResultsPerPage returns the ResultsPerPage field value if set, zero value otherwise. +func (o *ReadNatServicesRequest) GetResultsPerPage() int32 { + if o == nil || o.ResultsPerPage == nil { + var ret int32 + return ret + } + return *o.ResultsPerPage +} + +// GetResultsPerPageOk returns a tuple with the ResultsPerPage field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadNatServicesRequest) GetResultsPerPageOk() (*int32, bool) { + if o == nil || o.ResultsPerPage == nil { + return nil, false + } + return o.ResultsPerPage, true +} + +// HasResultsPerPage returns a boolean if a field has been set. +func (o *ReadNatServicesRequest) HasResultsPerPage() bool { + if o != nil && o.ResultsPerPage != nil { + return true + } + + return false +} + +// SetResultsPerPage gets a reference to the given int32 and assigns it to the ResultsPerPage field. +func (o *ReadNatServicesRequest) SetResultsPerPage(v int32) { + o.ResultsPerPage = &v +} + func (o ReadNatServicesRequest) MarshalJSON() ([]byte, error) { toSerialize := map[string]interface{}{} if o.DryRun != nil { @@ -111,6 +179,12 @@ func (o ReadNatServicesRequest) MarshalJSON() ([]byte, error) { if o.Filters != nil { toSerialize["Filters"] = o.Filters } + if o.NextPageToken != nil { + toSerialize["NextPageToken"] = o.NextPageToken + } + if o.ResultsPerPage != nil { + toSerialize["ResultsPerPage"] = o.ResultsPerPage + } return json.Marshal(toSerialize) } diff --git a/v2/model_read_nat_services_response.go b/v2/model_read_nat_services_response.go index 841456806..421bb4770 100644 --- a/v2/model_read_nat_services_response.go +++ b/v2/model_read_nat_services_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -18,7 +18,9 @@ import ( // ReadNatServicesResponse struct for ReadNatServicesResponse type ReadNatServicesResponse struct { // Information about one or more NAT services. - NatServices *[]NatService `json:"NatServices,omitempty"` + NatServices *[]NatService `json:"NatServices,omitempty"` + // The token to request the next page of results. Each token refers to a specific page. + NextPageToken *string `json:"NextPageToken,omitempty"` ResponseContext *ResponseContext `json:"ResponseContext,omitempty"` } @@ -71,6 +73,38 @@ func (o *ReadNatServicesResponse) SetNatServices(v []NatService) { o.NatServices = &v } +// GetNextPageToken returns the NextPageToken field value if set, zero value otherwise. +func (o *ReadNatServicesResponse) GetNextPageToken() string { + if o == nil || o.NextPageToken == nil { + var ret string + return ret + } + return *o.NextPageToken +} + +// GetNextPageTokenOk returns a tuple with the NextPageToken field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadNatServicesResponse) GetNextPageTokenOk() (*string, bool) { + if o == nil || o.NextPageToken == nil { + return nil, false + } + return o.NextPageToken, true +} + +// HasNextPageToken returns a boolean if a field has been set. +func (o *ReadNatServicesResponse) HasNextPageToken() bool { + if o != nil && o.NextPageToken != nil { + return true + } + + return false +} + +// SetNextPageToken gets a reference to the given string and assigns it to the NextPageToken field. +func (o *ReadNatServicesResponse) SetNextPageToken(v string) { + o.NextPageToken = &v +} + // GetResponseContext returns the ResponseContext field value if set, zero value otherwise. func (o *ReadNatServicesResponse) GetResponseContext() ResponseContext { if o == nil || o.ResponseContext == nil { @@ -108,6 +142,9 @@ func (o ReadNatServicesResponse) MarshalJSON() ([]byte, error) { if o.NatServices != nil { toSerialize["NatServices"] = o.NatServices } + if o.NextPageToken != nil { + toSerialize["NextPageToken"] = o.NextPageToken + } if o.ResponseContext != nil { toSerialize["ResponseContext"] = o.ResponseContext } diff --git a/v2/model_read_net_access_point_services_request.go b/v2/model_read_net_access_point_services_request.go index 118032b35..d52ad2c1b 100644 --- a/v2/model_read_net_access_point_services_request.go +++ b/v2/model_read_net_access_point_services_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_net_access_point_services_response.go b/v2/model_read_net_access_point_services_response.go index 502c6b2a2..2d593b6ff 100644 --- a/v2/model_read_net_access_point_services_response.go +++ b/v2/model_read_net_access_point_services_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_net_access_points_request.go b/v2/model_read_net_access_points_request.go index 5c03e4691..652970b52 100644 --- a/v2/model_read_net_access_points_request.go +++ b/v2/model_read_net_access_points_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -20,6 +20,10 @@ type ReadNetAccessPointsRequest struct { // If true, checks whether you have the required permissions to perform the action. DryRun *bool `json:"DryRun,omitempty"` Filters *FiltersNetAccessPoint `json:"Filters,omitempty"` + // The token to request the next page of results. Each token refers to a specific page. + NextPageToken *string `json:"NextPageToken,omitempty"` + // The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`. + ResultsPerPage *int32 `json:"ResultsPerPage,omitempty"` } // NewReadNetAccessPointsRequest instantiates a new ReadNetAccessPointsRequest object @@ -103,6 +107,70 @@ func (o *ReadNetAccessPointsRequest) SetFilters(v FiltersNetAccessPoint) { o.Filters = &v } +// GetNextPageToken returns the NextPageToken field value if set, zero value otherwise. +func (o *ReadNetAccessPointsRequest) GetNextPageToken() string { + if o == nil || o.NextPageToken == nil { + var ret string + return ret + } + return *o.NextPageToken +} + +// GetNextPageTokenOk returns a tuple with the NextPageToken field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadNetAccessPointsRequest) GetNextPageTokenOk() (*string, bool) { + if o == nil || o.NextPageToken == nil { + return nil, false + } + return o.NextPageToken, true +} + +// HasNextPageToken returns a boolean if a field has been set. +func (o *ReadNetAccessPointsRequest) HasNextPageToken() bool { + if o != nil && o.NextPageToken != nil { + return true + } + + return false +} + +// SetNextPageToken gets a reference to the given string and assigns it to the NextPageToken field. +func (o *ReadNetAccessPointsRequest) SetNextPageToken(v string) { + o.NextPageToken = &v +} + +// GetResultsPerPage returns the ResultsPerPage field value if set, zero value otherwise. +func (o *ReadNetAccessPointsRequest) GetResultsPerPage() int32 { + if o == nil || o.ResultsPerPage == nil { + var ret int32 + return ret + } + return *o.ResultsPerPage +} + +// GetResultsPerPageOk returns a tuple with the ResultsPerPage field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadNetAccessPointsRequest) GetResultsPerPageOk() (*int32, bool) { + if o == nil || o.ResultsPerPage == nil { + return nil, false + } + return o.ResultsPerPage, true +} + +// HasResultsPerPage returns a boolean if a field has been set. +func (o *ReadNetAccessPointsRequest) HasResultsPerPage() bool { + if o != nil && o.ResultsPerPage != nil { + return true + } + + return false +} + +// SetResultsPerPage gets a reference to the given int32 and assigns it to the ResultsPerPage field. +func (o *ReadNetAccessPointsRequest) SetResultsPerPage(v int32) { + o.ResultsPerPage = &v +} + func (o ReadNetAccessPointsRequest) MarshalJSON() ([]byte, error) { toSerialize := map[string]interface{}{} if o.DryRun != nil { @@ -111,6 +179,12 @@ func (o ReadNetAccessPointsRequest) MarshalJSON() ([]byte, error) { if o.Filters != nil { toSerialize["Filters"] = o.Filters } + if o.NextPageToken != nil { + toSerialize["NextPageToken"] = o.NextPageToken + } + if o.ResultsPerPage != nil { + toSerialize["ResultsPerPage"] = o.ResultsPerPage + } return json.Marshal(toSerialize) } diff --git a/v2/model_read_net_access_points_response.go b/v2/model_read_net_access_points_response.go index 81a802afc..99d43736d 100644 --- a/v2/model_read_net_access_points_response.go +++ b/v2/model_read_net_access_points_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -19,7 +19,9 @@ import ( type ReadNetAccessPointsResponse struct { // One or more Net access points. NetAccessPoints *[]NetAccessPoint `json:"NetAccessPoints,omitempty"` - ResponseContext *ResponseContext `json:"ResponseContext,omitempty"` + // The token to request the next page of results. Each token refers to a specific page. + NextPageToken *string `json:"NextPageToken,omitempty"` + ResponseContext *ResponseContext `json:"ResponseContext,omitempty"` } // NewReadNetAccessPointsResponse instantiates a new ReadNetAccessPointsResponse object @@ -71,6 +73,38 @@ func (o *ReadNetAccessPointsResponse) SetNetAccessPoints(v []NetAccessPoint) { o.NetAccessPoints = &v } +// GetNextPageToken returns the NextPageToken field value if set, zero value otherwise. +func (o *ReadNetAccessPointsResponse) GetNextPageToken() string { + if o == nil || o.NextPageToken == nil { + var ret string + return ret + } + return *o.NextPageToken +} + +// GetNextPageTokenOk returns a tuple with the NextPageToken field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadNetAccessPointsResponse) GetNextPageTokenOk() (*string, bool) { + if o == nil || o.NextPageToken == nil { + return nil, false + } + return o.NextPageToken, true +} + +// HasNextPageToken returns a boolean if a field has been set. +func (o *ReadNetAccessPointsResponse) HasNextPageToken() bool { + if o != nil && o.NextPageToken != nil { + return true + } + + return false +} + +// SetNextPageToken gets a reference to the given string and assigns it to the NextPageToken field. +func (o *ReadNetAccessPointsResponse) SetNextPageToken(v string) { + o.NextPageToken = &v +} + // GetResponseContext returns the ResponseContext field value if set, zero value otherwise. func (o *ReadNetAccessPointsResponse) GetResponseContext() ResponseContext { if o == nil || o.ResponseContext == nil { @@ -108,6 +142,9 @@ func (o ReadNetAccessPointsResponse) MarshalJSON() ([]byte, error) { if o.NetAccessPoints != nil { toSerialize["NetAccessPoints"] = o.NetAccessPoints } + if o.NextPageToken != nil { + toSerialize["NextPageToken"] = o.NextPageToken + } if o.ResponseContext != nil { toSerialize["ResponseContext"] = o.ResponseContext } diff --git a/v2/model_read_net_peerings_request.go b/v2/model_read_net_peerings_request.go index 10c47ac6d..74ca79da5 100644 --- a/v2/model_read_net_peerings_request.go +++ b/v2/model_read_net_peerings_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -20,6 +20,10 @@ type ReadNetPeeringsRequest struct { // If true, checks whether you have the required permissions to perform the action. DryRun *bool `json:"DryRun,omitempty"` Filters *FiltersNetPeering `json:"Filters,omitempty"` + // The token to request the next page of results. Each token refers to a specific page. + NextPageToken *string `json:"NextPageToken,omitempty"` + // The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`. + ResultsPerPage *int32 `json:"ResultsPerPage,omitempty"` } // NewReadNetPeeringsRequest instantiates a new ReadNetPeeringsRequest object @@ -103,6 +107,70 @@ func (o *ReadNetPeeringsRequest) SetFilters(v FiltersNetPeering) { o.Filters = &v } +// GetNextPageToken returns the NextPageToken field value if set, zero value otherwise. +func (o *ReadNetPeeringsRequest) GetNextPageToken() string { + if o == nil || o.NextPageToken == nil { + var ret string + return ret + } + return *o.NextPageToken +} + +// GetNextPageTokenOk returns a tuple with the NextPageToken field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadNetPeeringsRequest) GetNextPageTokenOk() (*string, bool) { + if o == nil || o.NextPageToken == nil { + return nil, false + } + return o.NextPageToken, true +} + +// HasNextPageToken returns a boolean if a field has been set. +func (o *ReadNetPeeringsRequest) HasNextPageToken() bool { + if o != nil && o.NextPageToken != nil { + return true + } + + return false +} + +// SetNextPageToken gets a reference to the given string and assigns it to the NextPageToken field. +func (o *ReadNetPeeringsRequest) SetNextPageToken(v string) { + o.NextPageToken = &v +} + +// GetResultsPerPage returns the ResultsPerPage field value if set, zero value otherwise. +func (o *ReadNetPeeringsRequest) GetResultsPerPage() int32 { + if o == nil || o.ResultsPerPage == nil { + var ret int32 + return ret + } + return *o.ResultsPerPage +} + +// GetResultsPerPageOk returns a tuple with the ResultsPerPage field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadNetPeeringsRequest) GetResultsPerPageOk() (*int32, bool) { + if o == nil || o.ResultsPerPage == nil { + return nil, false + } + return o.ResultsPerPage, true +} + +// HasResultsPerPage returns a boolean if a field has been set. +func (o *ReadNetPeeringsRequest) HasResultsPerPage() bool { + if o != nil && o.ResultsPerPage != nil { + return true + } + + return false +} + +// SetResultsPerPage gets a reference to the given int32 and assigns it to the ResultsPerPage field. +func (o *ReadNetPeeringsRequest) SetResultsPerPage(v int32) { + o.ResultsPerPage = &v +} + func (o ReadNetPeeringsRequest) MarshalJSON() ([]byte, error) { toSerialize := map[string]interface{}{} if o.DryRun != nil { @@ -111,6 +179,12 @@ func (o ReadNetPeeringsRequest) MarshalJSON() ([]byte, error) { if o.Filters != nil { toSerialize["Filters"] = o.Filters } + if o.NextPageToken != nil { + toSerialize["NextPageToken"] = o.NextPageToken + } + if o.ResultsPerPage != nil { + toSerialize["ResultsPerPage"] = o.ResultsPerPage + } return json.Marshal(toSerialize) } diff --git a/v2/model_read_net_peerings_response.go b/v2/model_read_net_peerings_response.go index f94651f13..f913ff064 100644 --- a/v2/model_read_net_peerings_response.go +++ b/v2/model_read_net_peerings_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -18,7 +18,9 @@ import ( // ReadNetPeeringsResponse struct for ReadNetPeeringsResponse type ReadNetPeeringsResponse struct { // Information about one or more Net peerings. - NetPeerings *[]NetPeering `json:"NetPeerings,omitempty"` + NetPeerings *[]NetPeering `json:"NetPeerings,omitempty"` + // The token to request the next page of results. Each token refers to a specific page. + NextPageToken *string `json:"NextPageToken,omitempty"` ResponseContext *ResponseContext `json:"ResponseContext,omitempty"` } @@ -71,6 +73,38 @@ func (o *ReadNetPeeringsResponse) SetNetPeerings(v []NetPeering) { o.NetPeerings = &v } +// GetNextPageToken returns the NextPageToken field value if set, zero value otherwise. +func (o *ReadNetPeeringsResponse) GetNextPageToken() string { + if o == nil || o.NextPageToken == nil { + var ret string + return ret + } + return *o.NextPageToken +} + +// GetNextPageTokenOk returns a tuple with the NextPageToken field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadNetPeeringsResponse) GetNextPageTokenOk() (*string, bool) { + if o == nil || o.NextPageToken == nil { + return nil, false + } + return o.NextPageToken, true +} + +// HasNextPageToken returns a boolean if a field has been set. +func (o *ReadNetPeeringsResponse) HasNextPageToken() bool { + if o != nil && o.NextPageToken != nil { + return true + } + + return false +} + +// SetNextPageToken gets a reference to the given string and assigns it to the NextPageToken field. +func (o *ReadNetPeeringsResponse) SetNextPageToken(v string) { + o.NextPageToken = &v +} + // GetResponseContext returns the ResponseContext field value if set, zero value otherwise. func (o *ReadNetPeeringsResponse) GetResponseContext() ResponseContext { if o == nil || o.ResponseContext == nil { @@ -108,6 +142,9 @@ func (o ReadNetPeeringsResponse) MarshalJSON() ([]byte, error) { if o.NetPeerings != nil { toSerialize["NetPeerings"] = o.NetPeerings } + if o.NextPageToken != nil { + toSerialize["NextPageToken"] = o.NextPageToken + } if o.ResponseContext != nil { toSerialize["ResponseContext"] = o.ResponseContext } diff --git a/v2/model_read_nets_request.go b/v2/model_read_nets_request.go index 9d3d56349..e7734111f 100644 --- a/v2/model_read_nets_request.go +++ b/v2/model_read_nets_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_nets_response.go b/v2/model_read_nets_response.go index 0019d70c5..3f94c2469 100644 --- a/v2/model_read_nets_response.go +++ b/v2/model_read_nets_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_nics_request.go b/v2/model_read_nics_request.go index 74c953145..2ae2671fd 100644 --- a/v2/model_read_nics_request.go +++ b/v2/model_read_nics_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_nics_response.go b/v2/model_read_nics_response.go index 45f330094..58f33fc23 100644 --- a/v2/model_read_nics_response.go +++ b/v2/model_read_nics_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_policies_filters.go b/v2/model_read_policies_filters.go new file mode 100644 index 000000000..05fad54bd --- /dev/null +++ b/v2/model_read_policies_filters.go @@ -0,0 +1,189 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// ReadPoliciesFilters One or more filters. +type ReadPoliciesFilters struct { + // If set to true, lists only the policies attached to a user. + OnlyLinked *bool `json:"OnlyLinked,omitempty"` + // The path prefix you can use to filter the results, set to a slash (`/`) by default. + PathPrefix *string `json:"PathPrefix,omitempty"` + // The scope to filter policies (`ALL` \\| `OWS` \\| `local`). + Scope *string `json:"Scope,omitempty"` +} + +// NewReadPoliciesFilters instantiates a new ReadPoliciesFilters object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewReadPoliciesFilters() *ReadPoliciesFilters { + this := ReadPoliciesFilters{} + return &this +} + +// NewReadPoliciesFiltersWithDefaults instantiates a new ReadPoliciesFilters object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewReadPoliciesFiltersWithDefaults() *ReadPoliciesFilters { + this := ReadPoliciesFilters{} + return &this +} + +// GetOnlyLinked returns the OnlyLinked field value if set, zero value otherwise. +func (o *ReadPoliciesFilters) GetOnlyLinked() bool { + if o == nil || o.OnlyLinked == nil { + var ret bool + return ret + } + return *o.OnlyLinked +} + +// GetOnlyLinkedOk returns a tuple with the OnlyLinked field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadPoliciesFilters) GetOnlyLinkedOk() (*bool, bool) { + if o == nil || o.OnlyLinked == nil { + return nil, false + } + return o.OnlyLinked, true +} + +// HasOnlyLinked returns a boolean if a field has been set. +func (o *ReadPoliciesFilters) HasOnlyLinked() bool { + if o != nil && o.OnlyLinked != nil { + return true + } + + return false +} + +// SetOnlyLinked gets a reference to the given bool and assigns it to the OnlyLinked field. +func (o *ReadPoliciesFilters) SetOnlyLinked(v bool) { + o.OnlyLinked = &v +} + +// GetPathPrefix returns the PathPrefix field value if set, zero value otherwise. +func (o *ReadPoliciesFilters) GetPathPrefix() string { + if o == nil || o.PathPrefix == nil { + var ret string + return ret + } + return *o.PathPrefix +} + +// GetPathPrefixOk returns a tuple with the PathPrefix field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadPoliciesFilters) GetPathPrefixOk() (*string, bool) { + if o == nil || o.PathPrefix == nil { + return nil, false + } + return o.PathPrefix, true +} + +// HasPathPrefix returns a boolean if a field has been set. +func (o *ReadPoliciesFilters) HasPathPrefix() bool { + if o != nil && o.PathPrefix != nil { + return true + } + + return false +} + +// SetPathPrefix gets a reference to the given string and assigns it to the PathPrefix field. +func (o *ReadPoliciesFilters) SetPathPrefix(v string) { + o.PathPrefix = &v +} + +// GetScope returns the Scope field value if set, zero value otherwise. +func (o *ReadPoliciesFilters) GetScope() string { + if o == nil || o.Scope == nil { + var ret string + return ret + } + return *o.Scope +} + +// GetScopeOk returns a tuple with the Scope field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadPoliciesFilters) GetScopeOk() (*string, bool) { + if o == nil || o.Scope == nil { + return nil, false + } + return o.Scope, true +} + +// HasScope returns a boolean if a field has been set. +func (o *ReadPoliciesFilters) HasScope() bool { + if o != nil && o.Scope != nil { + return true + } + + return false +} + +// SetScope gets a reference to the given string and assigns it to the Scope field. +func (o *ReadPoliciesFilters) SetScope(v string) { + o.Scope = &v +} + +func (o ReadPoliciesFilters) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.OnlyLinked != nil { + toSerialize["OnlyLinked"] = o.OnlyLinked + } + if o.PathPrefix != nil { + toSerialize["PathPrefix"] = o.PathPrefix + } + if o.Scope != nil { + toSerialize["Scope"] = o.Scope + } + return json.Marshal(toSerialize) +} + +type NullableReadPoliciesFilters struct { + value *ReadPoliciesFilters + isSet bool +} + +func (v NullableReadPoliciesFilters) Get() *ReadPoliciesFilters { + return v.value +} + +func (v *NullableReadPoliciesFilters) Set(val *ReadPoliciesFilters) { + v.value = val + v.isSet = true +} + +func (v NullableReadPoliciesFilters) IsSet() bool { + return v.isSet +} + +func (v *NullableReadPoliciesFilters) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableReadPoliciesFilters(val *ReadPoliciesFilters) *NullableReadPoliciesFilters { + return &NullableReadPoliciesFilters{value: val, isSet: true} +} + +func (v NullableReadPoliciesFilters) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableReadPoliciesFilters) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_read_policies_request.go b/v2/model_read_policies_request.go new file mode 100644 index 000000000..4a080a839 --- /dev/null +++ b/v2/model_read_policies_request.go @@ -0,0 +1,225 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// ReadPoliciesRequest struct for ReadPoliciesRequest +type ReadPoliciesRequest struct { + // If true, checks whether you have the required permissions to perform the action. + DryRun *bool `json:"DryRun,omitempty"` + Filters *ReadPoliciesFilters `json:"Filters,omitempty"` + // The item starting the list of policies requested. + FirstItem *int32 `json:"FirstItem,omitempty"` + // The maximum number of items that can be returned in a single response (by default, 100). + ResultsPerPage *int32 `json:"ResultsPerPage,omitempty"` +} + +// NewReadPoliciesRequest instantiates a new ReadPoliciesRequest object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewReadPoliciesRequest() *ReadPoliciesRequest { + this := ReadPoliciesRequest{} + return &this +} + +// NewReadPoliciesRequestWithDefaults instantiates a new ReadPoliciesRequest object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewReadPoliciesRequestWithDefaults() *ReadPoliciesRequest { + this := ReadPoliciesRequest{} + return &this +} + +// GetDryRun returns the DryRun field value if set, zero value otherwise. +func (o *ReadPoliciesRequest) GetDryRun() bool { + if o == nil || o.DryRun == nil { + var ret bool + return ret + } + return *o.DryRun +} + +// GetDryRunOk returns a tuple with the DryRun field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadPoliciesRequest) GetDryRunOk() (*bool, bool) { + if o == nil || o.DryRun == nil { + return nil, false + } + return o.DryRun, true +} + +// HasDryRun returns a boolean if a field has been set. +func (o *ReadPoliciesRequest) HasDryRun() bool { + if o != nil && o.DryRun != nil { + return true + } + + return false +} + +// SetDryRun gets a reference to the given bool and assigns it to the DryRun field. +func (o *ReadPoliciesRequest) SetDryRun(v bool) { + o.DryRun = &v +} + +// GetFilters returns the Filters field value if set, zero value otherwise. +func (o *ReadPoliciesRequest) GetFilters() ReadPoliciesFilters { + if o == nil || o.Filters == nil { + var ret ReadPoliciesFilters + return ret + } + return *o.Filters +} + +// GetFiltersOk returns a tuple with the Filters field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadPoliciesRequest) GetFiltersOk() (*ReadPoliciesFilters, bool) { + if o == nil || o.Filters == nil { + return nil, false + } + return o.Filters, true +} + +// HasFilters returns a boolean if a field has been set. +func (o *ReadPoliciesRequest) HasFilters() bool { + if o != nil && o.Filters != nil { + return true + } + + return false +} + +// SetFilters gets a reference to the given ReadPoliciesFilters and assigns it to the Filters field. +func (o *ReadPoliciesRequest) SetFilters(v ReadPoliciesFilters) { + o.Filters = &v +} + +// GetFirstItem returns the FirstItem field value if set, zero value otherwise. +func (o *ReadPoliciesRequest) GetFirstItem() int32 { + if o == nil || o.FirstItem == nil { + var ret int32 + return ret + } + return *o.FirstItem +} + +// GetFirstItemOk returns a tuple with the FirstItem field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadPoliciesRequest) GetFirstItemOk() (*int32, bool) { + if o == nil || o.FirstItem == nil { + return nil, false + } + return o.FirstItem, true +} + +// HasFirstItem returns a boolean if a field has been set. +func (o *ReadPoliciesRequest) HasFirstItem() bool { + if o != nil && o.FirstItem != nil { + return true + } + + return false +} + +// SetFirstItem gets a reference to the given int32 and assigns it to the FirstItem field. +func (o *ReadPoliciesRequest) SetFirstItem(v int32) { + o.FirstItem = &v +} + +// GetResultsPerPage returns the ResultsPerPage field value if set, zero value otherwise. +func (o *ReadPoliciesRequest) GetResultsPerPage() int32 { + if o == nil || o.ResultsPerPage == nil { + var ret int32 + return ret + } + return *o.ResultsPerPage +} + +// GetResultsPerPageOk returns a tuple with the ResultsPerPage field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadPoliciesRequest) GetResultsPerPageOk() (*int32, bool) { + if o == nil || o.ResultsPerPage == nil { + return nil, false + } + return o.ResultsPerPage, true +} + +// HasResultsPerPage returns a boolean if a field has been set. +func (o *ReadPoliciesRequest) HasResultsPerPage() bool { + if o != nil && o.ResultsPerPage != nil { + return true + } + + return false +} + +// SetResultsPerPage gets a reference to the given int32 and assigns it to the ResultsPerPage field. +func (o *ReadPoliciesRequest) SetResultsPerPage(v int32) { + o.ResultsPerPage = &v +} + +func (o ReadPoliciesRequest) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.DryRun != nil { + toSerialize["DryRun"] = o.DryRun + } + if o.Filters != nil { + toSerialize["Filters"] = o.Filters + } + if o.FirstItem != nil { + toSerialize["FirstItem"] = o.FirstItem + } + if o.ResultsPerPage != nil { + toSerialize["ResultsPerPage"] = o.ResultsPerPage + } + return json.Marshal(toSerialize) +} + +type NullableReadPoliciesRequest struct { + value *ReadPoliciesRequest + isSet bool +} + +func (v NullableReadPoliciesRequest) Get() *ReadPoliciesRequest { + return v.value +} + +func (v *NullableReadPoliciesRequest) Set(val *ReadPoliciesRequest) { + v.value = val + v.isSet = true +} + +func (v NullableReadPoliciesRequest) IsSet() bool { + return v.isSet +} + +func (v *NullableReadPoliciesRequest) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableReadPoliciesRequest(val *ReadPoliciesRequest) *NullableReadPoliciesRequest { + return &NullableReadPoliciesRequest{value: val, isSet: true} +} + +func (v NullableReadPoliciesRequest) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableReadPoliciesRequest) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_read_policies_response.go b/v2/model_read_policies_response.go new file mode 100644 index 000000000..2bb17cd5a --- /dev/null +++ b/v2/model_read_policies_response.go @@ -0,0 +1,262 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// ReadPoliciesResponse struct for ReadPoliciesResponse +type ReadPoliciesResponse struct { + // If true, there are more items to return using the `FirstItem` parameter in a new request. + HasMoreItems *bool `json:"HasMoreItems,omitempty"` + // Indicates maximum results defined for the operation. + MaxResultsLimit *int32 `json:"MaxResultsLimit,omitempty"` + // If true, indicates whether requested page size is more than allowed. + MaxResultsTruncated *bool `json:"MaxResultsTruncated,omitempty"` + // Information about one or more policies. + Policies *[]Policy `json:"Policies,omitempty"` + ResponseContext *ResponseContext `json:"ResponseContext,omitempty"` +} + +// NewReadPoliciesResponse instantiates a new ReadPoliciesResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewReadPoliciesResponse() *ReadPoliciesResponse { + this := ReadPoliciesResponse{} + return &this +} + +// NewReadPoliciesResponseWithDefaults instantiates a new ReadPoliciesResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewReadPoliciesResponseWithDefaults() *ReadPoliciesResponse { + this := ReadPoliciesResponse{} + return &this +} + +// GetHasMoreItems returns the HasMoreItems field value if set, zero value otherwise. +func (o *ReadPoliciesResponse) GetHasMoreItems() bool { + if o == nil || o.HasMoreItems == nil { + var ret bool + return ret + } + return *o.HasMoreItems +} + +// GetHasMoreItemsOk returns a tuple with the HasMoreItems field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadPoliciesResponse) GetHasMoreItemsOk() (*bool, bool) { + if o == nil || o.HasMoreItems == nil { + return nil, false + } + return o.HasMoreItems, true +} + +// HasHasMoreItems returns a boolean if a field has been set. +func (o *ReadPoliciesResponse) HasHasMoreItems() bool { + if o != nil && o.HasMoreItems != nil { + return true + } + + return false +} + +// SetHasMoreItems gets a reference to the given bool and assigns it to the HasMoreItems field. +func (o *ReadPoliciesResponse) SetHasMoreItems(v bool) { + o.HasMoreItems = &v +} + +// GetMaxResultsLimit returns the MaxResultsLimit field value if set, zero value otherwise. +func (o *ReadPoliciesResponse) GetMaxResultsLimit() int32 { + if o == nil || o.MaxResultsLimit == nil { + var ret int32 + return ret + } + return *o.MaxResultsLimit +} + +// GetMaxResultsLimitOk returns a tuple with the MaxResultsLimit field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadPoliciesResponse) GetMaxResultsLimitOk() (*int32, bool) { + if o == nil || o.MaxResultsLimit == nil { + return nil, false + } + return o.MaxResultsLimit, true +} + +// HasMaxResultsLimit returns a boolean if a field has been set. +func (o *ReadPoliciesResponse) HasMaxResultsLimit() bool { + if o != nil && o.MaxResultsLimit != nil { + return true + } + + return false +} + +// SetMaxResultsLimit gets a reference to the given int32 and assigns it to the MaxResultsLimit field. +func (o *ReadPoliciesResponse) SetMaxResultsLimit(v int32) { + o.MaxResultsLimit = &v +} + +// GetMaxResultsTruncated returns the MaxResultsTruncated field value if set, zero value otherwise. +func (o *ReadPoliciesResponse) GetMaxResultsTruncated() bool { + if o == nil || o.MaxResultsTruncated == nil { + var ret bool + return ret + } + return *o.MaxResultsTruncated +} + +// GetMaxResultsTruncatedOk returns a tuple with the MaxResultsTruncated field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadPoliciesResponse) GetMaxResultsTruncatedOk() (*bool, bool) { + if o == nil || o.MaxResultsTruncated == nil { + return nil, false + } + return o.MaxResultsTruncated, true +} + +// HasMaxResultsTruncated returns a boolean if a field has been set. +func (o *ReadPoliciesResponse) HasMaxResultsTruncated() bool { + if o != nil && o.MaxResultsTruncated != nil { + return true + } + + return false +} + +// SetMaxResultsTruncated gets a reference to the given bool and assigns it to the MaxResultsTruncated field. +func (o *ReadPoliciesResponse) SetMaxResultsTruncated(v bool) { + o.MaxResultsTruncated = &v +} + +// GetPolicies returns the Policies field value if set, zero value otherwise. +func (o *ReadPoliciesResponse) GetPolicies() []Policy { + if o == nil || o.Policies == nil { + var ret []Policy + return ret + } + return *o.Policies +} + +// GetPoliciesOk returns a tuple with the Policies field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadPoliciesResponse) GetPoliciesOk() (*[]Policy, bool) { + if o == nil || o.Policies == nil { + return nil, false + } + return o.Policies, true +} + +// HasPolicies returns a boolean if a field has been set. +func (o *ReadPoliciesResponse) HasPolicies() bool { + if o != nil && o.Policies != nil { + return true + } + + return false +} + +// SetPolicies gets a reference to the given []Policy and assigns it to the Policies field. +func (o *ReadPoliciesResponse) SetPolicies(v []Policy) { + o.Policies = &v +} + +// GetResponseContext returns the ResponseContext field value if set, zero value otherwise. +func (o *ReadPoliciesResponse) GetResponseContext() ResponseContext { + if o == nil || o.ResponseContext == nil { + var ret ResponseContext + return ret + } + return *o.ResponseContext +} + +// GetResponseContextOk returns a tuple with the ResponseContext field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadPoliciesResponse) GetResponseContextOk() (*ResponseContext, bool) { + if o == nil || o.ResponseContext == nil { + return nil, false + } + return o.ResponseContext, true +} + +// HasResponseContext returns a boolean if a field has been set. +func (o *ReadPoliciesResponse) HasResponseContext() bool { + if o != nil && o.ResponseContext != nil { + return true + } + + return false +} + +// SetResponseContext gets a reference to the given ResponseContext and assigns it to the ResponseContext field. +func (o *ReadPoliciesResponse) SetResponseContext(v ResponseContext) { + o.ResponseContext = &v +} + +func (o ReadPoliciesResponse) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.HasMoreItems != nil { + toSerialize["HasMoreItems"] = o.HasMoreItems + } + if o.MaxResultsLimit != nil { + toSerialize["MaxResultsLimit"] = o.MaxResultsLimit + } + if o.MaxResultsTruncated != nil { + toSerialize["MaxResultsTruncated"] = o.MaxResultsTruncated + } + if o.Policies != nil { + toSerialize["Policies"] = o.Policies + } + if o.ResponseContext != nil { + toSerialize["ResponseContext"] = o.ResponseContext + } + return json.Marshal(toSerialize) +} + +type NullableReadPoliciesResponse struct { + value *ReadPoliciesResponse + isSet bool +} + +func (v NullableReadPoliciesResponse) Get() *ReadPoliciesResponse { + return v.value +} + +func (v *NullableReadPoliciesResponse) Set(val *ReadPoliciesResponse) { + v.value = val + v.isSet = true +} + +func (v NullableReadPoliciesResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableReadPoliciesResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableReadPoliciesResponse(val *ReadPoliciesResponse) *NullableReadPoliciesResponse { + return &NullableReadPoliciesResponse{value: val, isSet: true} +} + +func (v NullableReadPoliciesResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableReadPoliciesResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_read_policy_request.go b/v2/model_read_policy_request.go new file mode 100644 index 000000000..c4a5c3210 --- /dev/null +++ b/v2/model_read_policy_request.go @@ -0,0 +1,108 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// ReadPolicyRequest struct for ReadPolicyRequest +type ReadPolicyRequest struct { + // The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + PolicyOrn string `json:"PolicyOrn"` +} + +// NewReadPolicyRequest instantiates a new ReadPolicyRequest object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewReadPolicyRequest(policyOrn string) *ReadPolicyRequest { + this := ReadPolicyRequest{} + this.PolicyOrn = policyOrn + return &this +} + +// NewReadPolicyRequestWithDefaults instantiates a new ReadPolicyRequest object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewReadPolicyRequestWithDefaults() *ReadPolicyRequest { + this := ReadPolicyRequest{} + return &this +} + +// GetPolicyOrn returns the PolicyOrn field value +func (o *ReadPolicyRequest) GetPolicyOrn() string { + if o == nil { + var ret string + return ret + } + + return o.PolicyOrn +} + +// GetPolicyOrnOk returns a tuple with the PolicyOrn field value +// and a boolean to check if the value has been set. +func (o *ReadPolicyRequest) GetPolicyOrnOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.PolicyOrn, true +} + +// SetPolicyOrn sets field value +func (o *ReadPolicyRequest) SetPolicyOrn(v string) { + o.PolicyOrn = v +} + +func (o ReadPolicyRequest) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["PolicyOrn"] = o.PolicyOrn + } + return json.Marshal(toSerialize) +} + +type NullableReadPolicyRequest struct { + value *ReadPolicyRequest + isSet bool +} + +func (v NullableReadPolicyRequest) Get() *ReadPolicyRequest { + return v.value +} + +func (v *NullableReadPolicyRequest) Set(val *ReadPolicyRequest) { + v.value = val + v.isSet = true +} + +func (v NullableReadPolicyRequest) IsSet() bool { + return v.isSet +} + +func (v *NullableReadPolicyRequest) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableReadPolicyRequest(val *ReadPolicyRequest) *NullableReadPolicyRequest { + return &NullableReadPolicyRequest{value: val, isSet: true} +} + +func (v NullableReadPolicyRequest) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableReadPolicyRequest) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_read_policy_response.go b/v2/model_read_policy_response.go new file mode 100644 index 000000000..d62155534 --- /dev/null +++ b/v2/model_read_policy_response.go @@ -0,0 +1,150 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// ReadPolicyResponse struct for ReadPolicyResponse +type ReadPolicyResponse struct { + Policy *Policy `json:"Policy,omitempty"` + ResponseContext *ResponseContext `json:"ResponseContext,omitempty"` +} + +// NewReadPolicyResponse instantiates a new ReadPolicyResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewReadPolicyResponse() *ReadPolicyResponse { + this := ReadPolicyResponse{} + return &this +} + +// NewReadPolicyResponseWithDefaults instantiates a new ReadPolicyResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewReadPolicyResponseWithDefaults() *ReadPolicyResponse { + this := ReadPolicyResponse{} + return &this +} + +// GetPolicy returns the Policy field value if set, zero value otherwise. +func (o *ReadPolicyResponse) GetPolicy() Policy { + if o == nil || o.Policy == nil { + var ret Policy + return ret + } + return *o.Policy +} + +// GetPolicyOk returns a tuple with the Policy field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadPolicyResponse) GetPolicyOk() (*Policy, bool) { + if o == nil || o.Policy == nil { + return nil, false + } + return o.Policy, true +} + +// HasPolicy returns a boolean if a field has been set. +func (o *ReadPolicyResponse) HasPolicy() bool { + if o != nil && o.Policy != nil { + return true + } + + return false +} + +// SetPolicy gets a reference to the given Policy and assigns it to the Policy field. +func (o *ReadPolicyResponse) SetPolicy(v Policy) { + o.Policy = &v +} + +// GetResponseContext returns the ResponseContext field value if set, zero value otherwise. +func (o *ReadPolicyResponse) GetResponseContext() ResponseContext { + if o == nil || o.ResponseContext == nil { + var ret ResponseContext + return ret + } + return *o.ResponseContext +} + +// GetResponseContextOk returns a tuple with the ResponseContext field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadPolicyResponse) GetResponseContextOk() (*ResponseContext, bool) { + if o == nil || o.ResponseContext == nil { + return nil, false + } + return o.ResponseContext, true +} + +// HasResponseContext returns a boolean if a field has been set. +func (o *ReadPolicyResponse) HasResponseContext() bool { + if o != nil && o.ResponseContext != nil { + return true + } + + return false +} + +// SetResponseContext gets a reference to the given ResponseContext and assigns it to the ResponseContext field. +func (o *ReadPolicyResponse) SetResponseContext(v ResponseContext) { + o.ResponseContext = &v +} + +func (o ReadPolicyResponse) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.Policy != nil { + toSerialize["Policy"] = o.Policy + } + if o.ResponseContext != nil { + toSerialize["ResponseContext"] = o.ResponseContext + } + return json.Marshal(toSerialize) +} + +type NullableReadPolicyResponse struct { + value *ReadPolicyResponse + isSet bool +} + +func (v NullableReadPolicyResponse) Get() *ReadPolicyResponse { + return v.value +} + +func (v *NullableReadPolicyResponse) Set(val *ReadPolicyResponse) { + v.value = val + v.isSet = true +} + +func (v NullableReadPolicyResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableReadPolicyResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableReadPolicyResponse(val *ReadPolicyResponse) *NullableReadPolicyResponse { + return &NullableReadPolicyResponse{value: val, isSet: true} +} + +func (v NullableReadPolicyResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableReadPolicyResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_read_policy_version_request.go b/v2/model_read_policy_version_request.go new file mode 100644 index 000000000..b8a7f0673 --- /dev/null +++ b/v2/model_read_policy_version_request.go @@ -0,0 +1,138 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// ReadPolicyVersionRequest struct for ReadPolicyVersionRequest +type ReadPolicyVersionRequest struct { + // The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + PolicyOrn string `json:"PolicyOrn"` + // The ID of the policy version. + VersionId string `json:"VersionId"` +} + +// NewReadPolicyVersionRequest instantiates a new ReadPolicyVersionRequest object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewReadPolicyVersionRequest(policyOrn string, versionId string) *ReadPolicyVersionRequest { + this := ReadPolicyVersionRequest{} + this.PolicyOrn = policyOrn + this.VersionId = versionId + return &this +} + +// NewReadPolicyVersionRequestWithDefaults instantiates a new ReadPolicyVersionRequest object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewReadPolicyVersionRequestWithDefaults() *ReadPolicyVersionRequest { + this := ReadPolicyVersionRequest{} + return &this +} + +// GetPolicyOrn returns the PolicyOrn field value +func (o *ReadPolicyVersionRequest) GetPolicyOrn() string { + if o == nil { + var ret string + return ret + } + + return o.PolicyOrn +} + +// GetPolicyOrnOk returns a tuple with the PolicyOrn field value +// and a boolean to check if the value has been set. +func (o *ReadPolicyVersionRequest) GetPolicyOrnOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.PolicyOrn, true +} + +// SetPolicyOrn sets field value +func (o *ReadPolicyVersionRequest) SetPolicyOrn(v string) { + o.PolicyOrn = v +} + +// GetVersionId returns the VersionId field value +func (o *ReadPolicyVersionRequest) GetVersionId() string { + if o == nil { + var ret string + return ret + } + + return o.VersionId +} + +// GetVersionIdOk returns a tuple with the VersionId field value +// and a boolean to check if the value has been set. +func (o *ReadPolicyVersionRequest) GetVersionIdOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.VersionId, true +} + +// SetVersionId sets field value +func (o *ReadPolicyVersionRequest) SetVersionId(v string) { + o.VersionId = v +} + +func (o ReadPolicyVersionRequest) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["PolicyOrn"] = o.PolicyOrn + } + if true { + toSerialize["VersionId"] = o.VersionId + } + return json.Marshal(toSerialize) +} + +type NullableReadPolicyVersionRequest struct { + value *ReadPolicyVersionRequest + isSet bool +} + +func (v NullableReadPolicyVersionRequest) Get() *ReadPolicyVersionRequest { + return v.value +} + +func (v *NullableReadPolicyVersionRequest) Set(val *ReadPolicyVersionRequest) { + v.value = val + v.isSet = true +} + +func (v NullableReadPolicyVersionRequest) IsSet() bool { + return v.isSet +} + +func (v *NullableReadPolicyVersionRequest) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableReadPolicyVersionRequest(val *ReadPolicyVersionRequest) *NullableReadPolicyVersionRequest { + return &NullableReadPolicyVersionRequest{value: val, isSet: true} +} + +func (v NullableReadPolicyVersionRequest) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableReadPolicyVersionRequest) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_read_policy_version_response.go b/v2/model_read_policy_version_response.go new file mode 100644 index 000000000..813eeab53 --- /dev/null +++ b/v2/model_read_policy_version_response.go @@ -0,0 +1,150 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// ReadPolicyVersionResponse struct for ReadPolicyVersionResponse +type ReadPolicyVersionResponse struct { + PolicyVersion *PolicyVersion `json:"PolicyVersion,omitempty"` + ResponseContext *ResponseContext `json:"ResponseContext,omitempty"` +} + +// NewReadPolicyVersionResponse instantiates a new ReadPolicyVersionResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewReadPolicyVersionResponse() *ReadPolicyVersionResponse { + this := ReadPolicyVersionResponse{} + return &this +} + +// NewReadPolicyVersionResponseWithDefaults instantiates a new ReadPolicyVersionResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewReadPolicyVersionResponseWithDefaults() *ReadPolicyVersionResponse { + this := ReadPolicyVersionResponse{} + return &this +} + +// GetPolicyVersion returns the PolicyVersion field value if set, zero value otherwise. +func (o *ReadPolicyVersionResponse) GetPolicyVersion() PolicyVersion { + if o == nil || o.PolicyVersion == nil { + var ret PolicyVersion + return ret + } + return *o.PolicyVersion +} + +// GetPolicyVersionOk returns a tuple with the PolicyVersion field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadPolicyVersionResponse) GetPolicyVersionOk() (*PolicyVersion, bool) { + if o == nil || o.PolicyVersion == nil { + return nil, false + } + return o.PolicyVersion, true +} + +// HasPolicyVersion returns a boolean if a field has been set. +func (o *ReadPolicyVersionResponse) HasPolicyVersion() bool { + if o != nil && o.PolicyVersion != nil { + return true + } + + return false +} + +// SetPolicyVersion gets a reference to the given PolicyVersion and assigns it to the PolicyVersion field. +func (o *ReadPolicyVersionResponse) SetPolicyVersion(v PolicyVersion) { + o.PolicyVersion = &v +} + +// GetResponseContext returns the ResponseContext field value if set, zero value otherwise. +func (o *ReadPolicyVersionResponse) GetResponseContext() ResponseContext { + if o == nil || o.ResponseContext == nil { + var ret ResponseContext + return ret + } + return *o.ResponseContext +} + +// GetResponseContextOk returns a tuple with the ResponseContext field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadPolicyVersionResponse) GetResponseContextOk() (*ResponseContext, bool) { + if o == nil || o.ResponseContext == nil { + return nil, false + } + return o.ResponseContext, true +} + +// HasResponseContext returns a boolean if a field has been set. +func (o *ReadPolicyVersionResponse) HasResponseContext() bool { + if o != nil && o.ResponseContext != nil { + return true + } + + return false +} + +// SetResponseContext gets a reference to the given ResponseContext and assigns it to the ResponseContext field. +func (o *ReadPolicyVersionResponse) SetResponseContext(v ResponseContext) { + o.ResponseContext = &v +} + +func (o ReadPolicyVersionResponse) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.PolicyVersion != nil { + toSerialize["PolicyVersion"] = o.PolicyVersion + } + if o.ResponseContext != nil { + toSerialize["ResponseContext"] = o.ResponseContext + } + return json.Marshal(toSerialize) +} + +type NullableReadPolicyVersionResponse struct { + value *ReadPolicyVersionResponse + isSet bool +} + +func (v NullableReadPolicyVersionResponse) Get() *ReadPolicyVersionResponse { + return v.value +} + +func (v *NullableReadPolicyVersionResponse) Set(val *ReadPolicyVersionResponse) { + v.value = val + v.isSet = true +} + +func (v NullableReadPolicyVersionResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableReadPolicyVersionResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableReadPolicyVersionResponse(val *ReadPolicyVersionResponse) *NullableReadPolicyVersionResponse { + return &NullableReadPolicyVersionResponse{value: val, isSet: true} +} + +func (v NullableReadPolicyVersionResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableReadPolicyVersionResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_read_policy_versions_request.go b/v2/model_read_policy_versions_request.go new file mode 100644 index 000000000..8787a5962 --- /dev/null +++ b/v2/model_read_policy_versions_request.go @@ -0,0 +1,182 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// ReadPolicyVersionsRequest struct for ReadPolicyVersionsRequest +type ReadPolicyVersionsRequest struct { + // The item starting the list of policies requested. + FirstItem *int32 `json:"FirstItem,omitempty"` + // The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + PolicyOrn string `json:"PolicyOrn"` + // The maximum number of items that can be returned in a single response (by default, 100). + ResultsPerPage *int32 `json:"ResultsPerPage,omitempty"` +} + +// NewReadPolicyVersionsRequest instantiates a new ReadPolicyVersionsRequest object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewReadPolicyVersionsRequest(policyOrn string) *ReadPolicyVersionsRequest { + this := ReadPolicyVersionsRequest{} + this.PolicyOrn = policyOrn + return &this +} + +// NewReadPolicyVersionsRequestWithDefaults instantiates a new ReadPolicyVersionsRequest object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewReadPolicyVersionsRequestWithDefaults() *ReadPolicyVersionsRequest { + this := ReadPolicyVersionsRequest{} + return &this +} + +// GetFirstItem returns the FirstItem field value if set, zero value otherwise. +func (o *ReadPolicyVersionsRequest) GetFirstItem() int32 { + if o == nil || o.FirstItem == nil { + var ret int32 + return ret + } + return *o.FirstItem +} + +// GetFirstItemOk returns a tuple with the FirstItem field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadPolicyVersionsRequest) GetFirstItemOk() (*int32, bool) { + if o == nil || o.FirstItem == nil { + return nil, false + } + return o.FirstItem, true +} + +// HasFirstItem returns a boolean if a field has been set. +func (o *ReadPolicyVersionsRequest) HasFirstItem() bool { + if o != nil && o.FirstItem != nil { + return true + } + + return false +} + +// SetFirstItem gets a reference to the given int32 and assigns it to the FirstItem field. +func (o *ReadPolicyVersionsRequest) SetFirstItem(v int32) { + o.FirstItem = &v +} + +// GetPolicyOrn returns the PolicyOrn field value +func (o *ReadPolicyVersionsRequest) GetPolicyOrn() string { + if o == nil { + var ret string + return ret + } + + return o.PolicyOrn +} + +// GetPolicyOrnOk returns a tuple with the PolicyOrn field value +// and a boolean to check if the value has been set. +func (o *ReadPolicyVersionsRequest) GetPolicyOrnOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.PolicyOrn, true +} + +// SetPolicyOrn sets field value +func (o *ReadPolicyVersionsRequest) SetPolicyOrn(v string) { + o.PolicyOrn = v +} + +// GetResultsPerPage returns the ResultsPerPage field value if set, zero value otherwise. +func (o *ReadPolicyVersionsRequest) GetResultsPerPage() int32 { + if o == nil || o.ResultsPerPage == nil { + var ret int32 + return ret + } + return *o.ResultsPerPage +} + +// GetResultsPerPageOk returns a tuple with the ResultsPerPage field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadPolicyVersionsRequest) GetResultsPerPageOk() (*int32, bool) { + if o == nil || o.ResultsPerPage == nil { + return nil, false + } + return o.ResultsPerPage, true +} + +// HasResultsPerPage returns a boolean if a field has been set. +func (o *ReadPolicyVersionsRequest) HasResultsPerPage() bool { + if o != nil && o.ResultsPerPage != nil { + return true + } + + return false +} + +// SetResultsPerPage gets a reference to the given int32 and assigns it to the ResultsPerPage field. +func (o *ReadPolicyVersionsRequest) SetResultsPerPage(v int32) { + o.ResultsPerPage = &v +} + +func (o ReadPolicyVersionsRequest) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.FirstItem != nil { + toSerialize["FirstItem"] = o.FirstItem + } + if true { + toSerialize["PolicyOrn"] = o.PolicyOrn + } + if o.ResultsPerPage != nil { + toSerialize["ResultsPerPage"] = o.ResultsPerPage + } + return json.Marshal(toSerialize) +} + +type NullableReadPolicyVersionsRequest struct { + value *ReadPolicyVersionsRequest + isSet bool +} + +func (v NullableReadPolicyVersionsRequest) Get() *ReadPolicyVersionsRequest { + return v.value +} + +func (v *NullableReadPolicyVersionsRequest) Set(val *ReadPolicyVersionsRequest) { + v.value = val + v.isSet = true +} + +func (v NullableReadPolicyVersionsRequest) IsSet() bool { + return v.isSet +} + +func (v *NullableReadPolicyVersionsRequest) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableReadPolicyVersionsRequest(val *ReadPolicyVersionsRequest) *NullableReadPolicyVersionsRequest { + return &NullableReadPolicyVersionsRequest{value: val, isSet: true} +} + +func (v NullableReadPolicyVersionsRequest) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableReadPolicyVersionsRequest) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_read_policy_versions_response.go b/v2/model_read_policy_versions_response.go new file mode 100644 index 000000000..8672a76ec --- /dev/null +++ b/v2/model_read_policy_versions_response.go @@ -0,0 +1,225 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// ReadPolicyVersionsResponse struct for ReadPolicyVersionsResponse +type ReadPolicyVersionsResponse struct { + // If true, there are more items to return using the `FirstItem` parameter in a new request. + HasMoreItems *bool `json:"HasMoreItems,omitempty"` + // Indicates maximum results defined for the operation. + MaxResultsLimit *int32 `json:"MaxResultsLimit,omitempty"` + // A list of all the versions of the policy. + PolicyVersions *[]PolicyVersion `json:"PolicyVersions,omitempty"` + ResponseContext *ResponseContext `json:"ResponseContext,omitempty"` +} + +// NewReadPolicyVersionsResponse instantiates a new ReadPolicyVersionsResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewReadPolicyVersionsResponse() *ReadPolicyVersionsResponse { + this := ReadPolicyVersionsResponse{} + return &this +} + +// NewReadPolicyVersionsResponseWithDefaults instantiates a new ReadPolicyVersionsResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewReadPolicyVersionsResponseWithDefaults() *ReadPolicyVersionsResponse { + this := ReadPolicyVersionsResponse{} + return &this +} + +// GetHasMoreItems returns the HasMoreItems field value if set, zero value otherwise. +func (o *ReadPolicyVersionsResponse) GetHasMoreItems() bool { + if o == nil || o.HasMoreItems == nil { + var ret bool + return ret + } + return *o.HasMoreItems +} + +// GetHasMoreItemsOk returns a tuple with the HasMoreItems field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadPolicyVersionsResponse) GetHasMoreItemsOk() (*bool, bool) { + if o == nil || o.HasMoreItems == nil { + return nil, false + } + return o.HasMoreItems, true +} + +// HasHasMoreItems returns a boolean if a field has been set. +func (o *ReadPolicyVersionsResponse) HasHasMoreItems() bool { + if o != nil && o.HasMoreItems != nil { + return true + } + + return false +} + +// SetHasMoreItems gets a reference to the given bool and assigns it to the HasMoreItems field. +func (o *ReadPolicyVersionsResponse) SetHasMoreItems(v bool) { + o.HasMoreItems = &v +} + +// GetMaxResultsLimit returns the MaxResultsLimit field value if set, zero value otherwise. +func (o *ReadPolicyVersionsResponse) GetMaxResultsLimit() int32 { + if o == nil || o.MaxResultsLimit == nil { + var ret int32 + return ret + } + return *o.MaxResultsLimit +} + +// GetMaxResultsLimitOk returns a tuple with the MaxResultsLimit field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadPolicyVersionsResponse) GetMaxResultsLimitOk() (*int32, bool) { + if o == nil || o.MaxResultsLimit == nil { + return nil, false + } + return o.MaxResultsLimit, true +} + +// HasMaxResultsLimit returns a boolean if a field has been set. +func (o *ReadPolicyVersionsResponse) HasMaxResultsLimit() bool { + if o != nil && o.MaxResultsLimit != nil { + return true + } + + return false +} + +// SetMaxResultsLimit gets a reference to the given int32 and assigns it to the MaxResultsLimit field. +func (o *ReadPolicyVersionsResponse) SetMaxResultsLimit(v int32) { + o.MaxResultsLimit = &v +} + +// GetPolicyVersions returns the PolicyVersions field value if set, zero value otherwise. +func (o *ReadPolicyVersionsResponse) GetPolicyVersions() []PolicyVersion { + if o == nil || o.PolicyVersions == nil { + var ret []PolicyVersion + return ret + } + return *o.PolicyVersions +} + +// GetPolicyVersionsOk returns a tuple with the PolicyVersions field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadPolicyVersionsResponse) GetPolicyVersionsOk() (*[]PolicyVersion, bool) { + if o == nil || o.PolicyVersions == nil { + return nil, false + } + return o.PolicyVersions, true +} + +// HasPolicyVersions returns a boolean if a field has been set. +func (o *ReadPolicyVersionsResponse) HasPolicyVersions() bool { + if o != nil && o.PolicyVersions != nil { + return true + } + + return false +} + +// SetPolicyVersions gets a reference to the given []PolicyVersion and assigns it to the PolicyVersions field. +func (o *ReadPolicyVersionsResponse) SetPolicyVersions(v []PolicyVersion) { + o.PolicyVersions = &v +} + +// GetResponseContext returns the ResponseContext field value if set, zero value otherwise. +func (o *ReadPolicyVersionsResponse) GetResponseContext() ResponseContext { + if o == nil || o.ResponseContext == nil { + var ret ResponseContext + return ret + } + return *o.ResponseContext +} + +// GetResponseContextOk returns a tuple with the ResponseContext field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadPolicyVersionsResponse) GetResponseContextOk() (*ResponseContext, bool) { + if o == nil || o.ResponseContext == nil { + return nil, false + } + return o.ResponseContext, true +} + +// HasResponseContext returns a boolean if a field has been set. +func (o *ReadPolicyVersionsResponse) HasResponseContext() bool { + if o != nil && o.ResponseContext != nil { + return true + } + + return false +} + +// SetResponseContext gets a reference to the given ResponseContext and assigns it to the ResponseContext field. +func (o *ReadPolicyVersionsResponse) SetResponseContext(v ResponseContext) { + o.ResponseContext = &v +} + +func (o ReadPolicyVersionsResponse) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.HasMoreItems != nil { + toSerialize["HasMoreItems"] = o.HasMoreItems + } + if o.MaxResultsLimit != nil { + toSerialize["MaxResultsLimit"] = o.MaxResultsLimit + } + if o.PolicyVersions != nil { + toSerialize["PolicyVersions"] = o.PolicyVersions + } + if o.ResponseContext != nil { + toSerialize["ResponseContext"] = o.ResponseContext + } + return json.Marshal(toSerialize) +} + +type NullableReadPolicyVersionsResponse struct { + value *ReadPolicyVersionsResponse + isSet bool +} + +func (v NullableReadPolicyVersionsResponse) Get() *ReadPolicyVersionsResponse { + return v.value +} + +func (v *NullableReadPolicyVersionsResponse) Set(val *ReadPolicyVersionsResponse) { + v.value = val + v.isSet = true +} + +func (v NullableReadPolicyVersionsResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableReadPolicyVersionsResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableReadPolicyVersionsResponse(val *ReadPolicyVersionsResponse) *NullableReadPolicyVersionsResponse { + return &NullableReadPolicyVersionsResponse{value: val, isSet: true} +} + +func (v NullableReadPolicyVersionsResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableReadPolicyVersionsResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_read_product_types_request.go b/v2/model_read_product_types_request.go index f6bce167f..442981703 100644 --- a/v2/model_read_product_types_request.go +++ b/v2/model_read_product_types_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_product_types_response.go b/v2/model_read_product_types_response.go index 83ca70d90..88823c621 100644 --- a/v2/model_read_product_types_response.go +++ b/v2/model_read_product_types_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_public_catalog_request.go b/v2/model_read_public_catalog_request.go index 316cd00a4..574fc9196 100644 --- a/v2/model_read_public_catalog_request.go +++ b/v2/model_read_public_catalog_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_public_catalog_response.go b/v2/model_read_public_catalog_response.go index 2cda1a350..6985103f6 100644 --- a/v2/model_read_public_catalog_response.go +++ b/v2/model_read_public_catalog_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_public_ip_ranges_request.go b/v2/model_read_public_ip_ranges_request.go index c1d93463c..e75eb6aaa 100644 --- a/v2/model_read_public_ip_ranges_request.go +++ b/v2/model_read_public_ip_ranges_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_public_ip_ranges_response.go b/v2/model_read_public_ip_ranges_response.go index 114914cbf..f40bf5b52 100644 --- a/v2/model_read_public_ip_ranges_response.go +++ b/v2/model_read_public_ip_ranges_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_public_ips_request.go b/v2/model_read_public_ips_request.go index e2656a73f..abbf7ad83 100644 --- a/v2/model_read_public_ips_request.go +++ b/v2/model_read_public_ips_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -20,6 +20,10 @@ type ReadPublicIpsRequest struct { // If true, checks whether you have the required permissions to perform the action. DryRun *bool `json:"DryRun,omitempty"` Filters *FiltersPublicIp `json:"Filters,omitempty"` + // The token to request the next page of results. Each token refers to a specific page. + NextPageToken *string `json:"NextPageToken,omitempty"` + // The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`. + ResultsPerPage *int32 `json:"ResultsPerPage,omitempty"` } // NewReadPublicIpsRequest instantiates a new ReadPublicIpsRequest object @@ -103,6 +107,70 @@ func (o *ReadPublicIpsRequest) SetFilters(v FiltersPublicIp) { o.Filters = &v } +// GetNextPageToken returns the NextPageToken field value if set, zero value otherwise. +func (o *ReadPublicIpsRequest) GetNextPageToken() string { + if o == nil || o.NextPageToken == nil { + var ret string + return ret + } + return *o.NextPageToken +} + +// GetNextPageTokenOk returns a tuple with the NextPageToken field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadPublicIpsRequest) GetNextPageTokenOk() (*string, bool) { + if o == nil || o.NextPageToken == nil { + return nil, false + } + return o.NextPageToken, true +} + +// HasNextPageToken returns a boolean if a field has been set. +func (o *ReadPublicIpsRequest) HasNextPageToken() bool { + if o != nil && o.NextPageToken != nil { + return true + } + + return false +} + +// SetNextPageToken gets a reference to the given string and assigns it to the NextPageToken field. +func (o *ReadPublicIpsRequest) SetNextPageToken(v string) { + o.NextPageToken = &v +} + +// GetResultsPerPage returns the ResultsPerPage field value if set, zero value otherwise. +func (o *ReadPublicIpsRequest) GetResultsPerPage() int32 { + if o == nil || o.ResultsPerPage == nil { + var ret int32 + return ret + } + return *o.ResultsPerPage +} + +// GetResultsPerPageOk returns a tuple with the ResultsPerPage field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadPublicIpsRequest) GetResultsPerPageOk() (*int32, bool) { + if o == nil || o.ResultsPerPage == nil { + return nil, false + } + return o.ResultsPerPage, true +} + +// HasResultsPerPage returns a boolean if a field has been set. +func (o *ReadPublicIpsRequest) HasResultsPerPage() bool { + if o != nil && o.ResultsPerPage != nil { + return true + } + + return false +} + +// SetResultsPerPage gets a reference to the given int32 and assigns it to the ResultsPerPage field. +func (o *ReadPublicIpsRequest) SetResultsPerPage(v int32) { + o.ResultsPerPage = &v +} + func (o ReadPublicIpsRequest) MarshalJSON() ([]byte, error) { toSerialize := map[string]interface{}{} if o.DryRun != nil { @@ -111,6 +179,12 @@ func (o ReadPublicIpsRequest) MarshalJSON() ([]byte, error) { if o.Filters != nil { toSerialize["Filters"] = o.Filters } + if o.NextPageToken != nil { + toSerialize["NextPageToken"] = o.NextPageToken + } + if o.ResultsPerPage != nil { + toSerialize["ResultsPerPage"] = o.ResultsPerPage + } return json.Marshal(toSerialize) } diff --git a/v2/model_read_public_ips_response.go b/v2/model_read_public_ips_response.go index c00a56dac..a7fd03ad4 100644 --- a/v2/model_read_public_ips_response.go +++ b/v2/model_read_public_ips_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -17,6 +17,8 @@ import ( // ReadPublicIpsResponse struct for ReadPublicIpsResponse type ReadPublicIpsResponse struct { + // The token to request the next page of results. Each token refers to a specific page. + NextPageToken *string `json:"NextPageToken,omitempty"` // Information about one or more public IPs. PublicIps *[]PublicIp `json:"PublicIps,omitempty"` ResponseContext *ResponseContext `json:"ResponseContext,omitempty"` @@ -39,6 +41,38 @@ func NewReadPublicIpsResponseWithDefaults() *ReadPublicIpsResponse { return &this } +// GetNextPageToken returns the NextPageToken field value if set, zero value otherwise. +func (o *ReadPublicIpsResponse) GetNextPageToken() string { + if o == nil || o.NextPageToken == nil { + var ret string + return ret + } + return *o.NextPageToken +} + +// GetNextPageTokenOk returns a tuple with the NextPageToken field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadPublicIpsResponse) GetNextPageTokenOk() (*string, bool) { + if o == nil || o.NextPageToken == nil { + return nil, false + } + return o.NextPageToken, true +} + +// HasNextPageToken returns a boolean if a field has been set. +func (o *ReadPublicIpsResponse) HasNextPageToken() bool { + if o != nil && o.NextPageToken != nil { + return true + } + + return false +} + +// SetNextPageToken gets a reference to the given string and assigns it to the NextPageToken field. +func (o *ReadPublicIpsResponse) SetNextPageToken(v string) { + o.NextPageToken = &v +} + // GetPublicIps returns the PublicIps field value if set, zero value otherwise. func (o *ReadPublicIpsResponse) GetPublicIps() []PublicIp { if o == nil || o.PublicIps == nil { @@ -105,6 +139,9 @@ func (o *ReadPublicIpsResponse) SetResponseContext(v ResponseContext) { func (o ReadPublicIpsResponse) MarshalJSON() ([]byte, error) { toSerialize := map[string]interface{}{} + if o.NextPageToken != nil { + toSerialize["NextPageToken"] = o.NextPageToken + } if o.PublicIps != nil { toSerialize["PublicIps"] = o.PublicIps } diff --git a/v2/model_read_quotas_request.go b/v2/model_read_quotas_request.go index 782d3fc7b..f90ef7bb4 100644 --- a/v2/model_read_quotas_request.go +++ b/v2/model_read_quotas_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_quotas_response.go b/v2/model_read_quotas_response.go index a2727d628..38b446dde 100644 --- a/v2/model_read_quotas_response.go +++ b/v2/model_read_quotas_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_regions_request.go b/v2/model_read_regions_request.go index e0bf4529b..e4bc0014c 100644 --- a/v2/model_read_regions_request.go +++ b/v2/model_read_regions_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_regions_response.go b/v2/model_read_regions_response.go index 6a6e733be..da224eb45 100644 --- a/v2/model_read_regions_response.go +++ b/v2/model_read_regions_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_route_tables_request.go b/v2/model_read_route_tables_request.go index 0b27f4c4d..3fce540bc 100644 --- a/v2/model_read_route_tables_request.go +++ b/v2/model_read_route_tables_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -20,6 +20,10 @@ type ReadRouteTablesRequest struct { // If true, checks whether you have the required permissions to perform the action. DryRun *bool `json:"DryRun,omitempty"` Filters *FiltersRouteTable `json:"Filters,omitempty"` + // The token to request the next page of results. Each token refers to a specific page. + NextPageToken *string `json:"NextPageToken,omitempty"` + // The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`. + ResultsPerPage *int32 `json:"ResultsPerPage,omitempty"` } // NewReadRouteTablesRequest instantiates a new ReadRouteTablesRequest object @@ -103,6 +107,70 @@ func (o *ReadRouteTablesRequest) SetFilters(v FiltersRouteTable) { o.Filters = &v } +// GetNextPageToken returns the NextPageToken field value if set, zero value otherwise. +func (o *ReadRouteTablesRequest) GetNextPageToken() string { + if o == nil || o.NextPageToken == nil { + var ret string + return ret + } + return *o.NextPageToken +} + +// GetNextPageTokenOk returns a tuple with the NextPageToken field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadRouteTablesRequest) GetNextPageTokenOk() (*string, bool) { + if o == nil || o.NextPageToken == nil { + return nil, false + } + return o.NextPageToken, true +} + +// HasNextPageToken returns a boolean if a field has been set. +func (o *ReadRouteTablesRequest) HasNextPageToken() bool { + if o != nil && o.NextPageToken != nil { + return true + } + + return false +} + +// SetNextPageToken gets a reference to the given string and assigns it to the NextPageToken field. +func (o *ReadRouteTablesRequest) SetNextPageToken(v string) { + o.NextPageToken = &v +} + +// GetResultsPerPage returns the ResultsPerPage field value if set, zero value otherwise. +func (o *ReadRouteTablesRequest) GetResultsPerPage() int32 { + if o == nil || o.ResultsPerPage == nil { + var ret int32 + return ret + } + return *o.ResultsPerPage +} + +// GetResultsPerPageOk returns a tuple with the ResultsPerPage field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadRouteTablesRequest) GetResultsPerPageOk() (*int32, bool) { + if o == nil || o.ResultsPerPage == nil { + return nil, false + } + return o.ResultsPerPage, true +} + +// HasResultsPerPage returns a boolean if a field has been set. +func (o *ReadRouteTablesRequest) HasResultsPerPage() bool { + if o != nil && o.ResultsPerPage != nil { + return true + } + + return false +} + +// SetResultsPerPage gets a reference to the given int32 and assigns it to the ResultsPerPage field. +func (o *ReadRouteTablesRequest) SetResultsPerPage(v int32) { + o.ResultsPerPage = &v +} + func (o ReadRouteTablesRequest) MarshalJSON() ([]byte, error) { toSerialize := map[string]interface{}{} if o.DryRun != nil { @@ -111,6 +179,12 @@ func (o ReadRouteTablesRequest) MarshalJSON() ([]byte, error) { if o.Filters != nil { toSerialize["Filters"] = o.Filters } + if o.NextPageToken != nil { + toSerialize["NextPageToken"] = o.NextPageToken + } + if o.ResultsPerPage != nil { + toSerialize["ResultsPerPage"] = o.ResultsPerPage + } return json.Marshal(toSerialize) } diff --git a/v2/model_read_route_tables_response.go b/v2/model_read_route_tables_response.go index 6190defbe..afaf689b1 100644 --- a/v2/model_read_route_tables_response.go +++ b/v2/model_read_route_tables_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -17,6 +17,8 @@ import ( // ReadRouteTablesResponse struct for ReadRouteTablesResponse type ReadRouteTablesResponse struct { + // The token to request the next page of results. Each token refers to a specific page. + NextPageToken *string `json:"NextPageToken,omitempty"` ResponseContext *ResponseContext `json:"ResponseContext,omitempty"` // Information about one or more route tables. RouteTables *[]RouteTable `json:"RouteTables,omitempty"` @@ -39,6 +41,38 @@ func NewReadRouteTablesResponseWithDefaults() *ReadRouteTablesResponse { return &this } +// GetNextPageToken returns the NextPageToken field value if set, zero value otherwise. +func (o *ReadRouteTablesResponse) GetNextPageToken() string { + if o == nil || o.NextPageToken == nil { + var ret string + return ret + } + return *o.NextPageToken +} + +// GetNextPageTokenOk returns a tuple with the NextPageToken field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadRouteTablesResponse) GetNextPageTokenOk() (*string, bool) { + if o == nil || o.NextPageToken == nil { + return nil, false + } + return o.NextPageToken, true +} + +// HasNextPageToken returns a boolean if a field has been set. +func (o *ReadRouteTablesResponse) HasNextPageToken() bool { + if o != nil && o.NextPageToken != nil { + return true + } + + return false +} + +// SetNextPageToken gets a reference to the given string and assigns it to the NextPageToken field. +func (o *ReadRouteTablesResponse) SetNextPageToken(v string) { + o.NextPageToken = &v +} + // GetResponseContext returns the ResponseContext field value if set, zero value otherwise. func (o *ReadRouteTablesResponse) GetResponseContext() ResponseContext { if o == nil || o.ResponseContext == nil { @@ -105,6 +139,9 @@ func (o *ReadRouteTablesResponse) SetRouteTables(v []RouteTable) { func (o ReadRouteTablesResponse) MarshalJSON() ([]byte, error) { toSerialize := map[string]interface{}{} + if o.NextPageToken != nil { + toSerialize["NextPageToken"] = o.NextPageToken + } if o.ResponseContext != nil { toSerialize["ResponseContext"] = o.ResponseContext } diff --git a/v2/model_read_secret_access_key_request.go b/v2/model_read_secret_access_key_request.go index dda451d4c..51294107a 100644 --- a/v2/model_read_secret_access_key_request.go +++ b/v2/model_read_secret_access_key_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_secret_access_key_response.go b/v2/model_read_secret_access_key_response.go index eb59ea303..4efc78d12 100644 --- a/v2/model_read_secret_access_key_response.go +++ b/v2/model_read_secret_access_key_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_security_groups_request.go b/v2/model_read_security_groups_request.go index f733a02fe..f27d504b7 100644 --- a/v2/model_read_security_groups_request.go +++ b/v2/model_read_security_groups_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_security_groups_response.go b/v2/model_read_security_groups_response.go index db4fbc855..b7403513a 100644 --- a/v2/model_read_security_groups_response.go +++ b/v2/model_read_security_groups_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_server_certificates_request.go b/v2/model_read_server_certificates_request.go index b0f899fe7..ea53aad7c 100644 --- a/v2/model_read_server_certificates_request.go +++ b/v2/model_read_server_certificates_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_server_certificates_response.go b/v2/model_read_server_certificates_response.go index 9ce03fe14..55ffe338e 100644 --- a/v2/model_read_server_certificates_response.go +++ b/v2/model_read_server_certificates_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_snapshot_export_tasks_request.go b/v2/model_read_snapshot_export_tasks_request.go index 9d26bdafc..5909c8b7f 100644 --- a/v2/model_read_snapshot_export_tasks_request.go +++ b/v2/model_read_snapshot_export_tasks_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_snapshot_export_tasks_response.go b/v2/model_read_snapshot_export_tasks_response.go index c22ff415f..eb82f0e81 100644 --- a/v2/model_read_snapshot_export_tasks_response.go +++ b/v2/model_read_snapshot_export_tasks_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_snapshots_request.go b/v2/model_read_snapshots_request.go index 05c3ea952..16d4a0f3b 100644 --- a/v2/model_read_snapshots_request.go +++ b/v2/model_read_snapshots_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_snapshots_response.go b/v2/model_read_snapshots_response.go index b76084b6a..cb00b9be8 100644 --- a/v2/model_read_snapshots_response.go +++ b/v2/model_read_snapshots_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_subnets_request.go b/v2/model_read_subnets_request.go index e39dd3285..d3a1f2295 100644 --- a/v2/model_read_subnets_request.go +++ b/v2/model_read_subnets_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_subnets_response.go b/v2/model_read_subnets_response.go index 8f958b881..ad7827534 100644 --- a/v2/model_read_subnets_response.go +++ b/v2/model_read_subnets_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_subregions_request.go b/v2/model_read_subregions_request.go index cccd971f2..bd98878de 100644 --- a/v2/model_read_subregions_request.go +++ b/v2/model_read_subregions_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_subregions_response.go b/v2/model_read_subregions_response.go index 2a08a6bd1..35e23a798 100644 --- a/v2/model_read_subregions_response.go +++ b/v2/model_read_subregions_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_tags_request.go b/v2/model_read_tags_request.go index fa77c3248..0bbccbc10 100644 --- a/v2/model_read_tags_request.go +++ b/v2/model_read_tags_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_tags_response.go b/v2/model_read_tags_response.go index c3a61c6bc..6e763d563 100644 --- a/v2/model_read_tags_response.go +++ b/v2/model_read_tags_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_users_request.go b/v2/model_read_users_request.go index 7b248916f..7b1f9ef0a 100644 --- a/v2/model_read_users_request.go +++ b/v2/model_read_users_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_users_response.go b/v2/model_read_users_response.go index 8bdfdd795..8ae8dd409 100644 --- a/v2/model_read_users_response.go +++ b/v2/model_read_users_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_virtual_gateways_request.go b/v2/model_read_virtual_gateways_request.go index 7700c5005..35166ba61 100644 --- a/v2/model_read_virtual_gateways_request.go +++ b/v2/model_read_virtual_gateways_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -20,6 +20,10 @@ type ReadVirtualGatewaysRequest struct { // If true, checks whether you have the required permissions to perform the action. DryRun *bool `json:"DryRun,omitempty"` Filters *FiltersVirtualGateway `json:"Filters,omitempty"` + // The token to request the next page of results. Each token refers to a specific page. + NextPageToken *string `json:"NextPageToken,omitempty"` + // The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`. + ResultsPerPage *int32 `json:"ResultsPerPage,omitempty"` } // NewReadVirtualGatewaysRequest instantiates a new ReadVirtualGatewaysRequest object @@ -103,6 +107,70 @@ func (o *ReadVirtualGatewaysRequest) SetFilters(v FiltersVirtualGateway) { o.Filters = &v } +// GetNextPageToken returns the NextPageToken field value if set, zero value otherwise. +func (o *ReadVirtualGatewaysRequest) GetNextPageToken() string { + if o == nil || o.NextPageToken == nil { + var ret string + return ret + } + return *o.NextPageToken +} + +// GetNextPageTokenOk returns a tuple with the NextPageToken field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadVirtualGatewaysRequest) GetNextPageTokenOk() (*string, bool) { + if o == nil || o.NextPageToken == nil { + return nil, false + } + return o.NextPageToken, true +} + +// HasNextPageToken returns a boolean if a field has been set. +func (o *ReadVirtualGatewaysRequest) HasNextPageToken() bool { + if o != nil && o.NextPageToken != nil { + return true + } + + return false +} + +// SetNextPageToken gets a reference to the given string and assigns it to the NextPageToken field. +func (o *ReadVirtualGatewaysRequest) SetNextPageToken(v string) { + o.NextPageToken = &v +} + +// GetResultsPerPage returns the ResultsPerPage field value if set, zero value otherwise. +func (o *ReadVirtualGatewaysRequest) GetResultsPerPage() int32 { + if o == nil || o.ResultsPerPage == nil { + var ret int32 + return ret + } + return *o.ResultsPerPage +} + +// GetResultsPerPageOk returns a tuple with the ResultsPerPage field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadVirtualGatewaysRequest) GetResultsPerPageOk() (*int32, bool) { + if o == nil || o.ResultsPerPage == nil { + return nil, false + } + return o.ResultsPerPage, true +} + +// HasResultsPerPage returns a boolean if a field has been set. +func (o *ReadVirtualGatewaysRequest) HasResultsPerPage() bool { + if o != nil && o.ResultsPerPage != nil { + return true + } + + return false +} + +// SetResultsPerPage gets a reference to the given int32 and assigns it to the ResultsPerPage field. +func (o *ReadVirtualGatewaysRequest) SetResultsPerPage(v int32) { + o.ResultsPerPage = &v +} + func (o ReadVirtualGatewaysRequest) MarshalJSON() ([]byte, error) { toSerialize := map[string]interface{}{} if o.DryRun != nil { @@ -111,6 +179,12 @@ func (o ReadVirtualGatewaysRequest) MarshalJSON() ([]byte, error) { if o.Filters != nil { toSerialize["Filters"] = o.Filters } + if o.NextPageToken != nil { + toSerialize["NextPageToken"] = o.NextPageToken + } + if o.ResultsPerPage != nil { + toSerialize["ResultsPerPage"] = o.ResultsPerPage + } return json.Marshal(toSerialize) } diff --git a/v2/model_read_virtual_gateways_response.go b/v2/model_read_virtual_gateways_response.go index 95fc4ad7e..8766a3307 100644 --- a/v2/model_read_virtual_gateways_response.go +++ b/v2/model_read_virtual_gateways_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -17,6 +17,8 @@ import ( // ReadVirtualGatewaysResponse struct for ReadVirtualGatewaysResponse type ReadVirtualGatewaysResponse struct { + // The token to request the next page of results. Each token refers to a specific page. + NextPageToken *string `json:"NextPageToken,omitempty"` ResponseContext *ResponseContext `json:"ResponseContext,omitempty"` // Information about one or more virtual gateways. VirtualGateways *[]VirtualGateway `json:"VirtualGateways,omitempty"` @@ -39,6 +41,38 @@ func NewReadVirtualGatewaysResponseWithDefaults() *ReadVirtualGatewaysResponse { return &this } +// GetNextPageToken returns the NextPageToken field value if set, zero value otherwise. +func (o *ReadVirtualGatewaysResponse) GetNextPageToken() string { + if o == nil || o.NextPageToken == nil { + var ret string + return ret + } + return *o.NextPageToken +} + +// GetNextPageTokenOk returns a tuple with the NextPageToken field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadVirtualGatewaysResponse) GetNextPageTokenOk() (*string, bool) { + if o == nil || o.NextPageToken == nil { + return nil, false + } + return o.NextPageToken, true +} + +// HasNextPageToken returns a boolean if a field has been set. +func (o *ReadVirtualGatewaysResponse) HasNextPageToken() bool { + if o != nil && o.NextPageToken != nil { + return true + } + + return false +} + +// SetNextPageToken gets a reference to the given string and assigns it to the NextPageToken field. +func (o *ReadVirtualGatewaysResponse) SetNextPageToken(v string) { + o.NextPageToken = &v +} + // GetResponseContext returns the ResponseContext field value if set, zero value otherwise. func (o *ReadVirtualGatewaysResponse) GetResponseContext() ResponseContext { if o == nil || o.ResponseContext == nil { @@ -105,6 +139,9 @@ func (o *ReadVirtualGatewaysResponse) SetVirtualGateways(v []VirtualGateway) { func (o ReadVirtualGatewaysResponse) MarshalJSON() ([]byte, error) { toSerialize := map[string]interface{}{} + if o.NextPageToken != nil { + toSerialize["NextPageToken"] = o.NextPageToken + } if o.ResponseContext != nil { toSerialize["ResponseContext"] = o.ResponseContext } diff --git a/v2/model_read_vm_groups_request.go b/v2/model_read_vm_groups_request.go index e0e33cacf..d4bb272cc 100644 --- a/v2/model_read_vm_groups_request.go +++ b/v2/model_read_vm_groups_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_vm_groups_response.go b/v2/model_read_vm_groups_response.go index 59439ee3e..1a50a0822 100644 --- a/v2/model_read_vm_groups_response.go +++ b/v2/model_read_vm_groups_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_vm_templates_request.go b/v2/model_read_vm_templates_request.go index 757a271a5..835dfacca 100644 --- a/v2/model_read_vm_templates_request.go +++ b/v2/model_read_vm_templates_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_vm_templates_response.go b/v2/model_read_vm_templates_response.go index eb5648122..3e41f387d 100644 --- a/v2/model_read_vm_templates_response.go +++ b/v2/model_read_vm_templates_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_vm_types_request.go b/v2/model_read_vm_types_request.go index 92f668e82..c2263cb40 100644 --- a/v2/model_read_vm_types_request.go +++ b/v2/model_read_vm_types_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_vm_types_response.go b/v2/model_read_vm_types_response.go index b02dc7924..7ea62a094 100644 --- a/v2/model_read_vm_types_response.go +++ b/v2/model_read_vm_types_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_vms_health_request.go b/v2/model_read_vms_health_request.go index f19318710..53356436e 100644 --- a/v2/model_read_vms_health_request.go +++ b/v2/model_read_vms_health_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_vms_health_response.go b/v2/model_read_vms_health_response.go index 17d7bfa0f..74ad71a5b 100644 --- a/v2/model_read_vms_health_response.go +++ b/v2/model_read_vms_health_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_vms_request.go b/v2/model_read_vms_request.go index 76f965c4a..e1b80a3d1 100644 --- a/v2/model_read_vms_request.go +++ b/v2/model_read_vms_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -20,6 +20,10 @@ type ReadVmsRequest struct { // If true, checks whether you have the required permissions to perform the action. DryRun *bool `json:"DryRun,omitempty"` Filters *FiltersVm `json:"Filters,omitempty"` + // The token to request the next page of results. Each token refers to a specific page. + NextPageToken *string `json:"NextPageToken,omitempty"` + // The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`. + ResultsPerPage *int32 `json:"ResultsPerPage,omitempty"` } // NewReadVmsRequest instantiates a new ReadVmsRequest object @@ -103,6 +107,70 @@ func (o *ReadVmsRequest) SetFilters(v FiltersVm) { o.Filters = &v } +// GetNextPageToken returns the NextPageToken field value if set, zero value otherwise. +func (o *ReadVmsRequest) GetNextPageToken() string { + if o == nil || o.NextPageToken == nil { + var ret string + return ret + } + return *o.NextPageToken +} + +// GetNextPageTokenOk returns a tuple with the NextPageToken field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadVmsRequest) GetNextPageTokenOk() (*string, bool) { + if o == nil || o.NextPageToken == nil { + return nil, false + } + return o.NextPageToken, true +} + +// HasNextPageToken returns a boolean if a field has been set. +func (o *ReadVmsRequest) HasNextPageToken() bool { + if o != nil && o.NextPageToken != nil { + return true + } + + return false +} + +// SetNextPageToken gets a reference to the given string and assigns it to the NextPageToken field. +func (o *ReadVmsRequest) SetNextPageToken(v string) { + o.NextPageToken = &v +} + +// GetResultsPerPage returns the ResultsPerPage field value if set, zero value otherwise. +func (o *ReadVmsRequest) GetResultsPerPage() int32 { + if o == nil || o.ResultsPerPage == nil { + var ret int32 + return ret + } + return *o.ResultsPerPage +} + +// GetResultsPerPageOk returns a tuple with the ResultsPerPage field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadVmsRequest) GetResultsPerPageOk() (*int32, bool) { + if o == nil || o.ResultsPerPage == nil { + return nil, false + } + return o.ResultsPerPage, true +} + +// HasResultsPerPage returns a boolean if a field has been set. +func (o *ReadVmsRequest) HasResultsPerPage() bool { + if o != nil && o.ResultsPerPage != nil { + return true + } + + return false +} + +// SetResultsPerPage gets a reference to the given int32 and assigns it to the ResultsPerPage field. +func (o *ReadVmsRequest) SetResultsPerPage(v int32) { + o.ResultsPerPage = &v +} + func (o ReadVmsRequest) MarshalJSON() ([]byte, error) { toSerialize := map[string]interface{}{} if o.DryRun != nil { @@ -111,6 +179,12 @@ func (o ReadVmsRequest) MarshalJSON() ([]byte, error) { if o.Filters != nil { toSerialize["Filters"] = o.Filters } + if o.NextPageToken != nil { + toSerialize["NextPageToken"] = o.NextPageToken + } + if o.ResultsPerPage != nil { + toSerialize["ResultsPerPage"] = o.ResultsPerPage + } return json.Marshal(toSerialize) } diff --git a/v2/model_read_vms_response.go b/v2/model_read_vms_response.go index 3a943e712..414e594c5 100644 --- a/v2/model_read_vms_response.go +++ b/v2/model_read_vms_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -17,6 +17,8 @@ import ( // ReadVmsResponse struct for ReadVmsResponse type ReadVmsResponse struct { + // The token to request the next page of results. Each token refers to a specific page. + NextPageToken *string `json:"NextPageToken,omitempty"` ResponseContext *ResponseContext `json:"ResponseContext,omitempty"` // Information about one or more VMs. Vms *[]Vm `json:"Vms,omitempty"` @@ -39,6 +41,38 @@ func NewReadVmsResponseWithDefaults() *ReadVmsResponse { return &this } +// GetNextPageToken returns the NextPageToken field value if set, zero value otherwise. +func (o *ReadVmsResponse) GetNextPageToken() string { + if o == nil || o.NextPageToken == nil { + var ret string + return ret + } + return *o.NextPageToken +} + +// GetNextPageTokenOk returns a tuple with the NextPageToken field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadVmsResponse) GetNextPageTokenOk() (*string, bool) { + if o == nil || o.NextPageToken == nil { + return nil, false + } + return o.NextPageToken, true +} + +// HasNextPageToken returns a boolean if a field has been set. +func (o *ReadVmsResponse) HasNextPageToken() bool { + if o != nil && o.NextPageToken != nil { + return true + } + + return false +} + +// SetNextPageToken gets a reference to the given string and assigns it to the NextPageToken field. +func (o *ReadVmsResponse) SetNextPageToken(v string) { + o.NextPageToken = &v +} + // GetResponseContext returns the ResponseContext field value if set, zero value otherwise. func (o *ReadVmsResponse) GetResponseContext() ResponseContext { if o == nil || o.ResponseContext == nil { @@ -105,6 +139,9 @@ func (o *ReadVmsResponse) SetVms(v []Vm) { func (o ReadVmsResponse) MarshalJSON() ([]byte, error) { toSerialize := map[string]interface{}{} + if o.NextPageToken != nil { + toSerialize["NextPageToken"] = o.NextPageToken + } if o.ResponseContext != nil { toSerialize["ResponseContext"] = o.ResponseContext } diff --git a/v2/model_read_vms_state_request.go b/v2/model_read_vms_state_request.go index ee56d62cb..7d0af1320 100644 --- a/v2/model_read_vms_state_request.go +++ b/v2/model_read_vms_state_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_vms_state_response.go b/v2/model_read_vms_state_response.go index d1cff8cf4..d29463f67 100644 --- a/v2/model_read_vms_state_response.go +++ b/v2/model_read_vms_state_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_read_volumes_request.go b/v2/model_read_volumes_request.go index 7576e60be..91bb235af 100644 --- a/v2/model_read_volumes_request.go +++ b/v2/model_read_volumes_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -20,6 +20,10 @@ type ReadVolumesRequest struct { // If true, checks whether you have the required permissions to perform the action. DryRun *bool `json:"DryRun,omitempty"` Filters *FiltersVolume `json:"Filters,omitempty"` + // The token to request the next page of results. Each token refers to a specific page. + NextPageToken *string `json:"NextPageToken,omitempty"` + // The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`. + ResultsPerPage *int32 `json:"ResultsPerPage,omitempty"` } // NewReadVolumesRequest instantiates a new ReadVolumesRequest object @@ -103,6 +107,70 @@ func (o *ReadVolumesRequest) SetFilters(v FiltersVolume) { o.Filters = &v } +// GetNextPageToken returns the NextPageToken field value if set, zero value otherwise. +func (o *ReadVolumesRequest) GetNextPageToken() string { + if o == nil || o.NextPageToken == nil { + var ret string + return ret + } + return *o.NextPageToken +} + +// GetNextPageTokenOk returns a tuple with the NextPageToken field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadVolumesRequest) GetNextPageTokenOk() (*string, bool) { + if o == nil || o.NextPageToken == nil { + return nil, false + } + return o.NextPageToken, true +} + +// HasNextPageToken returns a boolean if a field has been set. +func (o *ReadVolumesRequest) HasNextPageToken() bool { + if o != nil && o.NextPageToken != nil { + return true + } + + return false +} + +// SetNextPageToken gets a reference to the given string and assigns it to the NextPageToken field. +func (o *ReadVolumesRequest) SetNextPageToken(v string) { + o.NextPageToken = &v +} + +// GetResultsPerPage returns the ResultsPerPage field value if set, zero value otherwise. +func (o *ReadVolumesRequest) GetResultsPerPage() int32 { + if o == nil || o.ResultsPerPage == nil { + var ret int32 + return ret + } + return *o.ResultsPerPage +} + +// GetResultsPerPageOk returns a tuple with the ResultsPerPage field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadVolumesRequest) GetResultsPerPageOk() (*int32, bool) { + if o == nil || o.ResultsPerPage == nil { + return nil, false + } + return o.ResultsPerPage, true +} + +// HasResultsPerPage returns a boolean if a field has been set. +func (o *ReadVolumesRequest) HasResultsPerPage() bool { + if o != nil && o.ResultsPerPage != nil { + return true + } + + return false +} + +// SetResultsPerPage gets a reference to the given int32 and assigns it to the ResultsPerPage field. +func (o *ReadVolumesRequest) SetResultsPerPage(v int32) { + o.ResultsPerPage = &v +} + func (o ReadVolumesRequest) MarshalJSON() ([]byte, error) { toSerialize := map[string]interface{}{} if o.DryRun != nil { @@ -111,6 +179,12 @@ func (o ReadVolumesRequest) MarshalJSON() ([]byte, error) { if o.Filters != nil { toSerialize["Filters"] = o.Filters } + if o.NextPageToken != nil { + toSerialize["NextPageToken"] = o.NextPageToken + } + if o.ResultsPerPage != nil { + toSerialize["ResultsPerPage"] = o.ResultsPerPage + } return json.Marshal(toSerialize) } diff --git a/v2/model_read_volumes_response.go b/v2/model_read_volumes_response.go index 0331e03b6..5d438ab15 100644 --- a/v2/model_read_volumes_response.go +++ b/v2/model_read_volumes_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -17,6 +17,8 @@ import ( // ReadVolumesResponse struct for ReadVolumesResponse type ReadVolumesResponse struct { + // The token to request the next page of results. Each token refers to a specific page. + NextPageToken *string `json:"NextPageToken,omitempty"` ResponseContext *ResponseContext `json:"ResponseContext,omitempty"` // Information about one or more volumes. Volumes *[]Volume `json:"Volumes,omitempty"` @@ -39,6 +41,38 @@ func NewReadVolumesResponseWithDefaults() *ReadVolumesResponse { return &this } +// GetNextPageToken returns the NextPageToken field value if set, zero value otherwise. +func (o *ReadVolumesResponse) GetNextPageToken() string { + if o == nil || o.NextPageToken == nil { + var ret string + return ret + } + return *o.NextPageToken +} + +// GetNextPageTokenOk returns a tuple with the NextPageToken field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadVolumesResponse) GetNextPageTokenOk() (*string, bool) { + if o == nil || o.NextPageToken == nil { + return nil, false + } + return o.NextPageToken, true +} + +// HasNextPageToken returns a boolean if a field has been set. +func (o *ReadVolumesResponse) HasNextPageToken() bool { + if o != nil && o.NextPageToken != nil { + return true + } + + return false +} + +// SetNextPageToken gets a reference to the given string and assigns it to the NextPageToken field. +func (o *ReadVolumesResponse) SetNextPageToken(v string) { + o.NextPageToken = &v +} + // GetResponseContext returns the ResponseContext field value if set, zero value otherwise. func (o *ReadVolumesResponse) GetResponseContext() ResponseContext { if o == nil || o.ResponseContext == nil { @@ -105,6 +139,9 @@ func (o *ReadVolumesResponse) SetVolumes(v []Volume) { func (o ReadVolumesResponse) MarshalJSON() ([]byte, error) { toSerialize := map[string]interface{}{} + if o.NextPageToken != nil { + toSerialize["NextPageToken"] = o.NextPageToken + } if o.ResponseContext != nil { toSerialize["ResponseContext"] = o.ResponseContext } diff --git a/v2/model_read_vpn_connections_request.go b/v2/model_read_vpn_connections_request.go index 9a4450bbc..c37a78bcc 100644 --- a/v2/model_read_vpn_connections_request.go +++ b/v2/model_read_vpn_connections_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -20,6 +20,10 @@ type ReadVpnConnectionsRequest struct { // If true, checks whether you have the required permissions to perform the action. DryRun *bool `json:"DryRun,omitempty"` Filters *FiltersVpnConnection `json:"Filters,omitempty"` + // The token to request the next page of results. Each token refers to a specific page. + NextPageToken *string `json:"NextPageToken,omitempty"` + // The maximum number of logs returned in a single response (between `1`and `1000`, both included). By default, `100`. + ResultsPerPage *int32 `json:"ResultsPerPage,omitempty"` } // NewReadVpnConnectionsRequest instantiates a new ReadVpnConnectionsRequest object @@ -103,6 +107,70 @@ func (o *ReadVpnConnectionsRequest) SetFilters(v FiltersVpnConnection) { o.Filters = &v } +// GetNextPageToken returns the NextPageToken field value if set, zero value otherwise. +func (o *ReadVpnConnectionsRequest) GetNextPageToken() string { + if o == nil || o.NextPageToken == nil { + var ret string + return ret + } + return *o.NextPageToken +} + +// GetNextPageTokenOk returns a tuple with the NextPageToken field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadVpnConnectionsRequest) GetNextPageTokenOk() (*string, bool) { + if o == nil || o.NextPageToken == nil { + return nil, false + } + return o.NextPageToken, true +} + +// HasNextPageToken returns a boolean if a field has been set. +func (o *ReadVpnConnectionsRequest) HasNextPageToken() bool { + if o != nil && o.NextPageToken != nil { + return true + } + + return false +} + +// SetNextPageToken gets a reference to the given string and assigns it to the NextPageToken field. +func (o *ReadVpnConnectionsRequest) SetNextPageToken(v string) { + o.NextPageToken = &v +} + +// GetResultsPerPage returns the ResultsPerPage field value if set, zero value otherwise. +func (o *ReadVpnConnectionsRequest) GetResultsPerPage() int32 { + if o == nil || o.ResultsPerPage == nil { + var ret int32 + return ret + } + return *o.ResultsPerPage +} + +// GetResultsPerPageOk returns a tuple with the ResultsPerPage field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadVpnConnectionsRequest) GetResultsPerPageOk() (*int32, bool) { + if o == nil || o.ResultsPerPage == nil { + return nil, false + } + return o.ResultsPerPage, true +} + +// HasResultsPerPage returns a boolean if a field has been set. +func (o *ReadVpnConnectionsRequest) HasResultsPerPage() bool { + if o != nil && o.ResultsPerPage != nil { + return true + } + + return false +} + +// SetResultsPerPage gets a reference to the given int32 and assigns it to the ResultsPerPage field. +func (o *ReadVpnConnectionsRequest) SetResultsPerPage(v int32) { + o.ResultsPerPage = &v +} + func (o ReadVpnConnectionsRequest) MarshalJSON() ([]byte, error) { toSerialize := map[string]interface{}{} if o.DryRun != nil { @@ -111,6 +179,12 @@ func (o ReadVpnConnectionsRequest) MarshalJSON() ([]byte, error) { if o.Filters != nil { toSerialize["Filters"] = o.Filters } + if o.NextPageToken != nil { + toSerialize["NextPageToken"] = o.NextPageToken + } + if o.ResultsPerPage != nil { + toSerialize["ResultsPerPage"] = o.ResultsPerPage + } return json.Marshal(toSerialize) } diff --git a/v2/model_read_vpn_connections_response.go b/v2/model_read_vpn_connections_response.go index de9abe58b..ad2c7c017 100644 --- a/v2/model_read_vpn_connections_response.go +++ b/v2/model_read_vpn_connections_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -17,6 +17,8 @@ import ( // ReadVpnConnectionsResponse struct for ReadVpnConnectionsResponse type ReadVpnConnectionsResponse struct { + // The token to request the next page of results. Each token refers to a specific page. + NextPageToken *string `json:"NextPageToken,omitempty"` ResponseContext *ResponseContext `json:"ResponseContext,omitempty"` // Information about one or more VPN connections. VpnConnections *[]VpnConnection `json:"VpnConnections,omitempty"` @@ -39,6 +41,38 @@ func NewReadVpnConnectionsResponseWithDefaults() *ReadVpnConnectionsResponse { return &this } +// GetNextPageToken returns the NextPageToken field value if set, zero value otherwise. +func (o *ReadVpnConnectionsResponse) GetNextPageToken() string { + if o == nil || o.NextPageToken == nil { + var ret string + return ret + } + return *o.NextPageToken +} + +// GetNextPageTokenOk returns a tuple with the NextPageToken field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReadVpnConnectionsResponse) GetNextPageTokenOk() (*string, bool) { + if o == nil || o.NextPageToken == nil { + return nil, false + } + return o.NextPageToken, true +} + +// HasNextPageToken returns a boolean if a field has been set. +func (o *ReadVpnConnectionsResponse) HasNextPageToken() bool { + if o != nil && o.NextPageToken != nil { + return true + } + + return false +} + +// SetNextPageToken gets a reference to the given string and assigns it to the NextPageToken field. +func (o *ReadVpnConnectionsResponse) SetNextPageToken(v string) { + o.NextPageToken = &v +} + // GetResponseContext returns the ResponseContext field value if set, zero value otherwise. func (o *ReadVpnConnectionsResponse) GetResponseContext() ResponseContext { if o == nil || o.ResponseContext == nil { @@ -105,6 +139,9 @@ func (o *ReadVpnConnectionsResponse) SetVpnConnections(v []VpnConnection) { func (o ReadVpnConnectionsResponse) MarshalJSON() ([]byte, error) { toSerialize := map[string]interface{}{} + if o.NextPageToken != nil { + toSerialize["NextPageToken"] = o.NextPageToken + } if o.ResponseContext != nil { toSerialize["ResponseContext"] = o.ResponseContext } diff --git a/v2/model_reboot_vms_request.go b/v2/model_reboot_vms_request.go index 938f0216a..8bbd9d3d4 100644 --- a/v2/model_reboot_vms_request.go +++ b/v2/model_reboot_vms_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_reboot_vms_response.go b/v2/model_reboot_vms_response.go index 67dc6f0e8..bfb57534c 100644 --- a/v2/model_reboot_vms_response.go +++ b/v2/model_reboot_vms_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_region.go b/v2/model_region.go index a72247658..d28f89628 100644 --- a/v2/model_region.go +++ b/v2/model_region.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_register_vms_in_load_balancer_request.go b/v2/model_register_vms_in_load_balancer_request.go index 9dcbe6706..a2c58889e 100644 --- a/v2/model_register_vms_in_load_balancer_request.go +++ b/v2/model_register_vms_in_load_balancer_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_register_vms_in_load_balancer_response.go b/v2/model_register_vms_in_load_balancer_response.go index c372df6d1..24334c1e7 100644 --- a/v2/model_register_vms_in_load_balancer_response.go +++ b/v2/model_register_vms_in_load_balancer_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_reject_net_peering_request.go b/v2/model_reject_net_peering_request.go index 1b8c8717c..1049bdef9 100644 --- a/v2/model_reject_net_peering_request.go +++ b/v2/model_reject_net_peering_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_reject_net_peering_response.go b/v2/model_reject_net_peering_response.go index 3842e1f4d..e1e21684d 100644 --- a/v2/model_reject_net_peering_response.go +++ b/v2/model_reject_net_peering_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_reset_account_password_request.go b/v2/model_reset_account_password_request.go deleted file mode 100644 index 4212c93f1..000000000 --- a/v2/model_reset_account_password_request.go +++ /dev/null @@ -1,175 +0,0 @@ -/* - * 3DS OUTSCALE API - * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). - * - * API version: 1.27 - * Contact: support@outscale.com - */ - -// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. - -package osc - -import ( - "encoding/json" -) - -// ResetAccountPasswordRequest struct for ResetAccountPasswordRequest -type ResetAccountPasswordRequest struct { - // If true, checks whether you have the required permissions to perform the action. - DryRun *bool `json:"DryRun,omitempty"` - // The new password for the account. - Password string `json:"Password"` - // The token you received at the email address provided for the account. - Token string `json:"Token"` -} - -// NewResetAccountPasswordRequest instantiates a new ResetAccountPasswordRequest object -// This constructor will assign default values to properties that have it defined, -// and makes sure properties required by API are set, but the set of arguments -// will change when the set of required properties is changed -func NewResetAccountPasswordRequest(password string, token string) *ResetAccountPasswordRequest { - this := ResetAccountPasswordRequest{} - this.Password = password - this.Token = token - return &this -} - -// NewResetAccountPasswordRequestWithDefaults instantiates a new ResetAccountPasswordRequest object -// This constructor will only assign default values to properties that have it defined, -// but it doesn't guarantee that properties required by API are set -func NewResetAccountPasswordRequestWithDefaults() *ResetAccountPasswordRequest { - this := ResetAccountPasswordRequest{} - return &this -} - -// GetDryRun returns the DryRun field value if set, zero value otherwise. -func (o *ResetAccountPasswordRequest) GetDryRun() bool { - if o == nil || o.DryRun == nil { - var ret bool - return ret - } - return *o.DryRun -} - -// GetDryRunOk returns a tuple with the DryRun field value if set, nil otherwise -// and a boolean to check if the value has been set. -func (o *ResetAccountPasswordRequest) GetDryRunOk() (*bool, bool) { - if o == nil || o.DryRun == nil { - return nil, false - } - return o.DryRun, true -} - -// HasDryRun returns a boolean if a field has been set. -func (o *ResetAccountPasswordRequest) HasDryRun() bool { - if o != nil && o.DryRun != nil { - return true - } - - return false -} - -// SetDryRun gets a reference to the given bool and assigns it to the DryRun field. -func (o *ResetAccountPasswordRequest) SetDryRun(v bool) { - o.DryRun = &v -} - -// GetPassword returns the Password field value -func (o *ResetAccountPasswordRequest) GetPassword() string { - if o == nil { - var ret string - return ret - } - - return o.Password -} - -// GetPasswordOk returns a tuple with the Password field value -// and a boolean to check if the value has been set. -func (o *ResetAccountPasswordRequest) GetPasswordOk() (*string, bool) { - if o == nil { - return nil, false - } - return &o.Password, true -} - -// SetPassword sets field value -func (o *ResetAccountPasswordRequest) SetPassword(v string) { - o.Password = v -} - -// GetToken returns the Token field value -func (o *ResetAccountPasswordRequest) GetToken() string { - if o == nil { - var ret string - return ret - } - - return o.Token -} - -// GetTokenOk returns a tuple with the Token field value -// and a boolean to check if the value has been set. -func (o *ResetAccountPasswordRequest) GetTokenOk() (*string, bool) { - if o == nil { - return nil, false - } - return &o.Token, true -} - -// SetToken sets field value -func (o *ResetAccountPasswordRequest) SetToken(v string) { - o.Token = v -} - -func (o ResetAccountPasswordRequest) MarshalJSON() ([]byte, error) { - toSerialize := map[string]interface{}{} - if o.DryRun != nil { - toSerialize["DryRun"] = o.DryRun - } - if true { - toSerialize["Password"] = o.Password - } - if true { - toSerialize["Token"] = o.Token - } - return json.Marshal(toSerialize) -} - -type NullableResetAccountPasswordRequest struct { - value *ResetAccountPasswordRequest - isSet bool -} - -func (v NullableResetAccountPasswordRequest) Get() *ResetAccountPasswordRequest { - return v.value -} - -func (v *NullableResetAccountPasswordRequest) Set(val *ResetAccountPasswordRequest) { - v.value = val - v.isSet = true -} - -func (v NullableResetAccountPasswordRequest) IsSet() bool { - return v.isSet -} - -func (v *NullableResetAccountPasswordRequest) Unset() { - v.value = nil - v.isSet = false -} - -func NewNullableResetAccountPasswordRequest(val *ResetAccountPasswordRequest) *NullableResetAccountPasswordRequest { - return &NullableResetAccountPasswordRequest{value: val, isSet: true} -} - -func (v NullableResetAccountPasswordRequest) MarshalJSON() ([]byte, error) { - return json.Marshal(v.value) -} - -func (v *NullableResetAccountPasswordRequest) UnmarshalJSON(src []byte) error { - v.isSet = true - return json.Unmarshal(src, &v.value) -} diff --git a/v2/model_reset_account_password_response.go b/v2/model_reset_account_password_response.go deleted file mode 100644 index 656fbb7b6..000000000 --- a/v2/model_reset_account_password_response.go +++ /dev/null @@ -1,114 +0,0 @@ -/* - * 3DS OUTSCALE API - * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). - * - * API version: 1.27 - * Contact: support@outscale.com - */ - -// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. - -package osc - -import ( - "encoding/json" -) - -// ResetAccountPasswordResponse struct for ResetAccountPasswordResponse -type ResetAccountPasswordResponse struct { - ResponseContext *ResponseContext `json:"ResponseContext,omitempty"` -} - -// NewResetAccountPasswordResponse instantiates a new ResetAccountPasswordResponse object -// This constructor will assign default values to properties that have it defined, -// and makes sure properties required by API are set, but the set of arguments -// will change when the set of required properties is changed -func NewResetAccountPasswordResponse() *ResetAccountPasswordResponse { - this := ResetAccountPasswordResponse{} - return &this -} - -// NewResetAccountPasswordResponseWithDefaults instantiates a new ResetAccountPasswordResponse object -// This constructor will only assign default values to properties that have it defined, -// but it doesn't guarantee that properties required by API are set -func NewResetAccountPasswordResponseWithDefaults() *ResetAccountPasswordResponse { - this := ResetAccountPasswordResponse{} - return &this -} - -// GetResponseContext returns the ResponseContext field value if set, zero value otherwise. -func (o *ResetAccountPasswordResponse) GetResponseContext() ResponseContext { - if o == nil || o.ResponseContext == nil { - var ret ResponseContext - return ret - } - return *o.ResponseContext -} - -// GetResponseContextOk returns a tuple with the ResponseContext field value if set, nil otherwise -// and a boolean to check if the value has been set. -func (o *ResetAccountPasswordResponse) GetResponseContextOk() (*ResponseContext, bool) { - if o == nil || o.ResponseContext == nil { - return nil, false - } - return o.ResponseContext, true -} - -// HasResponseContext returns a boolean if a field has been set. -func (o *ResetAccountPasswordResponse) HasResponseContext() bool { - if o != nil && o.ResponseContext != nil { - return true - } - - return false -} - -// SetResponseContext gets a reference to the given ResponseContext and assigns it to the ResponseContext field. -func (o *ResetAccountPasswordResponse) SetResponseContext(v ResponseContext) { - o.ResponseContext = &v -} - -func (o ResetAccountPasswordResponse) MarshalJSON() ([]byte, error) { - toSerialize := map[string]interface{}{} - if o.ResponseContext != nil { - toSerialize["ResponseContext"] = o.ResponseContext - } - return json.Marshal(toSerialize) -} - -type NullableResetAccountPasswordResponse struct { - value *ResetAccountPasswordResponse - isSet bool -} - -func (v NullableResetAccountPasswordResponse) Get() *ResetAccountPasswordResponse { - return v.value -} - -func (v *NullableResetAccountPasswordResponse) Set(val *ResetAccountPasswordResponse) { - v.value = val - v.isSet = true -} - -func (v NullableResetAccountPasswordResponse) IsSet() bool { - return v.isSet -} - -func (v *NullableResetAccountPasswordResponse) Unset() { - v.value = nil - v.isSet = false -} - -func NewNullableResetAccountPasswordResponse(val *ResetAccountPasswordResponse) *NullableResetAccountPasswordResponse { - return &NullableResetAccountPasswordResponse{value: val, isSet: true} -} - -func (v NullableResetAccountPasswordResponse) MarshalJSON() ([]byte, error) { - return json.Marshal(v.value) -} - -func (v *NullableResetAccountPasswordResponse) UnmarshalJSON(src []byte) error { - v.isSet = true - return json.Unmarshal(src, &v.value) -} diff --git a/v2/model_resource_load_balancer_tag.go b/v2/model_resource_load_balancer_tag.go index 41a323e52..528516e5d 100644 --- a/v2/model_resource_load_balancer_tag.go +++ b/v2/model_resource_load_balancer_tag.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_resource_tag.go b/v2/model_resource_tag.go index 34f0e5c0c..a76913534 100644 --- a/v2/model_resource_tag.go +++ b/v2/model_resource_tag.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_response_context.go b/v2/model_response_context.go index b13fd8849..190bbcf51 100644 --- a/v2/model_response_context.go +++ b/v2/model_response_context.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_route.go b/v2/model_route.go index 965e99363..5c1994d37 100644 --- a/v2/model_route.go +++ b/v2/model_route.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_route_light.go b/v2/model_route_light.go index 589d1c15e..c664bb8e6 100644 --- a/v2/model_route_light.go +++ b/v2/model_route_light.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_route_propagating_virtual_gateway.go b/v2/model_route_propagating_virtual_gateway.go index d8001789c..fdf91c88a 100644 --- a/v2/model_route_propagating_virtual_gateway.go +++ b/v2/model_route_propagating_virtual_gateway.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_route_table.go b/v2/model_route_table.go index 10c8ab6ec..c6c299fd9 100644 --- a/v2/model_route_table.go +++ b/v2/model_route_table.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_scale_down_vm_group_request.go b/v2/model_scale_down_vm_group_request.go index 1ad153db5..e56fc005c 100644 --- a/v2/model_scale_down_vm_group_request.go +++ b/v2/model_scale_down_vm_group_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_scale_down_vm_group_response.go b/v2/model_scale_down_vm_group_response.go index 56c55770b..a615182bd 100644 --- a/v2/model_scale_down_vm_group_response.go +++ b/v2/model_scale_down_vm_group_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_scale_up_vm_group_request.go b/v2/model_scale_up_vm_group_request.go index d94204d21..822cd0e6f 100644 --- a/v2/model_scale_up_vm_group_request.go +++ b/v2/model_scale_up_vm_group_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_scale_up_vm_group_response.go b/v2/model_scale_up_vm_group_response.go index 4b0aa59e4..33f4f5faa 100644 --- a/v2/model_scale_up_vm_group_response.go +++ b/v2/model_scale_up_vm_group_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_security_group.go b/v2/model_security_group.go index f48a7f6aa..c42b3b173 100644 --- a/v2/model_security_group.go +++ b/v2/model_security_group.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -17,7 +17,7 @@ import ( // SecurityGroup Information about the security group. type SecurityGroup struct { - // The account ID of a user that has been granted permission. + // The account ID that has been granted permission. AccountId *string `json:"AccountId,omitempty"` // The description of the security group. Description *string `json:"Description,omitempty"` diff --git a/v2/model_security_group_light.go b/v2/model_security_group_light.go index 1f48f98d8..f8a9cb713 100644 --- a/v2/model_security_group_light.go +++ b/v2/model_security_group_light.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_security_group_rule.go b/v2/model_security_group_rule.go index 9a523aca9..6b9940cb0 100644 --- a/v2/model_security_group_rule.go +++ b/v2/model_security_group_rule.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_security_groups_member.go b/v2/model_security_groups_member.go index 2132668b7..e5f8172ed 100644 --- a/v2/model_security_groups_member.go +++ b/v2/model_security_groups_member.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_send_reset_password_email_request.go b/v2/model_send_reset_password_email_request.go deleted file mode 100644 index acf8e0135..000000000 --- a/v2/model_send_reset_password_email_request.go +++ /dev/null @@ -1,145 +0,0 @@ -/* - * 3DS OUTSCALE API - * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). - * - * API version: 1.27 - * Contact: support@outscale.com - */ - -// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. - -package osc - -import ( - "encoding/json" -) - -// SendResetPasswordEmailRequest struct for SendResetPasswordEmailRequest -type SendResetPasswordEmailRequest struct { - // If true, checks whether you have the required permissions to perform the action. - DryRun *bool `json:"DryRun,omitempty"` - // The email address provided for the account. - Email string `json:"Email"` -} - -// NewSendResetPasswordEmailRequest instantiates a new SendResetPasswordEmailRequest object -// This constructor will assign default values to properties that have it defined, -// and makes sure properties required by API are set, but the set of arguments -// will change when the set of required properties is changed -func NewSendResetPasswordEmailRequest(email string) *SendResetPasswordEmailRequest { - this := SendResetPasswordEmailRequest{} - this.Email = email - return &this -} - -// NewSendResetPasswordEmailRequestWithDefaults instantiates a new SendResetPasswordEmailRequest object -// This constructor will only assign default values to properties that have it defined, -// but it doesn't guarantee that properties required by API are set -func NewSendResetPasswordEmailRequestWithDefaults() *SendResetPasswordEmailRequest { - this := SendResetPasswordEmailRequest{} - return &this -} - -// GetDryRun returns the DryRun field value if set, zero value otherwise. -func (o *SendResetPasswordEmailRequest) GetDryRun() bool { - if o == nil || o.DryRun == nil { - var ret bool - return ret - } - return *o.DryRun -} - -// GetDryRunOk returns a tuple with the DryRun field value if set, nil otherwise -// and a boolean to check if the value has been set. -func (o *SendResetPasswordEmailRequest) GetDryRunOk() (*bool, bool) { - if o == nil || o.DryRun == nil { - return nil, false - } - return o.DryRun, true -} - -// HasDryRun returns a boolean if a field has been set. -func (o *SendResetPasswordEmailRequest) HasDryRun() bool { - if o != nil && o.DryRun != nil { - return true - } - - return false -} - -// SetDryRun gets a reference to the given bool and assigns it to the DryRun field. -func (o *SendResetPasswordEmailRequest) SetDryRun(v bool) { - o.DryRun = &v -} - -// GetEmail returns the Email field value -func (o *SendResetPasswordEmailRequest) GetEmail() string { - if o == nil { - var ret string - return ret - } - - return o.Email -} - -// GetEmailOk returns a tuple with the Email field value -// and a boolean to check if the value has been set. -func (o *SendResetPasswordEmailRequest) GetEmailOk() (*string, bool) { - if o == nil { - return nil, false - } - return &o.Email, true -} - -// SetEmail sets field value -func (o *SendResetPasswordEmailRequest) SetEmail(v string) { - o.Email = v -} - -func (o SendResetPasswordEmailRequest) MarshalJSON() ([]byte, error) { - toSerialize := map[string]interface{}{} - if o.DryRun != nil { - toSerialize["DryRun"] = o.DryRun - } - if true { - toSerialize["Email"] = o.Email - } - return json.Marshal(toSerialize) -} - -type NullableSendResetPasswordEmailRequest struct { - value *SendResetPasswordEmailRequest - isSet bool -} - -func (v NullableSendResetPasswordEmailRequest) Get() *SendResetPasswordEmailRequest { - return v.value -} - -func (v *NullableSendResetPasswordEmailRequest) Set(val *SendResetPasswordEmailRequest) { - v.value = val - v.isSet = true -} - -func (v NullableSendResetPasswordEmailRequest) IsSet() bool { - return v.isSet -} - -func (v *NullableSendResetPasswordEmailRequest) Unset() { - v.value = nil - v.isSet = false -} - -func NewNullableSendResetPasswordEmailRequest(val *SendResetPasswordEmailRequest) *NullableSendResetPasswordEmailRequest { - return &NullableSendResetPasswordEmailRequest{value: val, isSet: true} -} - -func (v NullableSendResetPasswordEmailRequest) MarshalJSON() ([]byte, error) { - return json.Marshal(v.value) -} - -func (v *NullableSendResetPasswordEmailRequest) UnmarshalJSON(src []byte) error { - v.isSet = true - return json.Unmarshal(src, &v.value) -} diff --git a/v2/model_send_reset_password_email_response.go b/v2/model_send_reset_password_email_response.go deleted file mode 100644 index b2a2ba5d9..000000000 --- a/v2/model_send_reset_password_email_response.go +++ /dev/null @@ -1,114 +0,0 @@ -/* - * 3DS OUTSCALE API - * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). - * - * API version: 1.27 - * Contact: support@outscale.com - */ - -// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. - -package osc - -import ( - "encoding/json" -) - -// SendResetPasswordEmailResponse struct for SendResetPasswordEmailResponse -type SendResetPasswordEmailResponse struct { - ResponseContext *ResponseContext `json:"ResponseContext,omitempty"` -} - -// NewSendResetPasswordEmailResponse instantiates a new SendResetPasswordEmailResponse object -// This constructor will assign default values to properties that have it defined, -// and makes sure properties required by API are set, but the set of arguments -// will change when the set of required properties is changed -func NewSendResetPasswordEmailResponse() *SendResetPasswordEmailResponse { - this := SendResetPasswordEmailResponse{} - return &this -} - -// NewSendResetPasswordEmailResponseWithDefaults instantiates a new SendResetPasswordEmailResponse object -// This constructor will only assign default values to properties that have it defined, -// but it doesn't guarantee that properties required by API are set -func NewSendResetPasswordEmailResponseWithDefaults() *SendResetPasswordEmailResponse { - this := SendResetPasswordEmailResponse{} - return &this -} - -// GetResponseContext returns the ResponseContext field value if set, zero value otherwise. -func (o *SendResetPasswordEmailResponse) GetResponseContext() ResponseContext { - if o == nil || o.ResponseContext == nil { - var ret ResponseContext - return ret - } - return *o.ResponseContext -} - -// GetResponseContextOk returns a tuple with the ResponseContext field value if set, nil otherwise -// and a boolean to check if the value has been set. -func (o *SendResetPasswordEmailResponse) GetResponseContextOk() (*ResponseContext, bool) { - if o == nil || o.ResponseContext == nil { - return nil, false - } - return o.ResponseContext, true -} - -// HasResponseContext returns a boolean if a field has been set. -func (o *SendResetPasswordEmailResponse) HasResponseContext() bool { - if o != nil && o.ResponseContext != nil { - return true - } - - return false -} - -// SetResponseContext gets a reference to the given ResponseContext and assigns it to the ResponseContext field. -func (o *SendResetPasswordEmailResponse) SetResponseContext(v ResponseContext) { - o.ResponseContext = &v -} - -func (o SendResetPasswordEmailResponse) MarshalJSON() ([]byte, error) { - toSerialize := map[string]interface{}{} - if o.ResponseContext != nil { - toSerialize["ResponseContext"] = o.ResponseContext - } - return json.Marshal(toSerialize) -} - -type NullableSendResetPasswordEmailResponse struct { - value *SendResetPasswordEmailResponse - isSet bool -} - -func (v NullableSendResetPasswordEmailResponse) Get() *SendResetPasswordEmailResponse { - return v.value -} - -func (v *NullableSendResetPasswordEmailResponse) Set(val *SendResetPasswordEmailResponse) { - v.value = val - v.isSet = true -} - -func (v NullableSendResetPasswordEmailResponse) IsSet() bool { - return v.isSet -} - -func (v *NullableSendResetPasswordEmailResponse) Unset() { - v.value = nil - v.isSet = false -} - -func NewNullableSendResetPasswordEmailResponse(val *SendResetPasswordEmailResponse) *NullableSendResetPasswordEmailResponse { - return &NullableSendResetPasswordEmailResponse{value: val, isSet: true} -} - -func (v NullableSendResetPasswordEmailResponse) MarshalJSON() ([]byte, error) { - return json.Marshal(v.value) -} - -func (v *NullableSendResetPasswordEmailResponse) UnmarshalJSON(src []byte) error { - v.isSet = true - return json.Unmarshal(src, &v.value) -} diff --git a/v2/model_server_certificate.go b/v2/model_server_certificate.go index cafa78a76..183206e9c 100644 --- a/v2/model_server_certificate.go +++ b/v2/model_server_certificate.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_service.go b/v2/model_service.go index 9ad04706d..43ef04ecd 100644 --- a/v2/model_service.go +++ b/v2/model_service.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_set_default_policy_version_request.go b/v2/model_set_default_policy_version_request.go new file mode 100644 index 000000000..71a0f6b3a --- /dev/null +++ b/v2/model_set_default_policy_version_request.go @@ -0,0 +1,138 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// SetDefaultPolicyVersionRequest struct for SetDefaultPolicyVersionRequest +type SetDefaultPolicyVersionRequest struct { + // The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + PolicyOrn string `json:"PolicyOrn"` + // The ID of the version. + VersionId string `json:"VersionId"` +} + +// NewSetDefaultPolicyVersionRequest instantiates a new SetDefaultPolicyVersionRequest object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewSetDefaultPolicyVersionRequest(policyOrn string, versionId string) *SetDefaultPolicyVersionRequest { + this := SetDefaultPolicyVersionRequest{} + this.PolicyOrn = policyOrn + this.VersionId = versionId + return &this +} + +// NewSetDefaultPolicyVersionRequestWithDefaults instantiates a new SetDefaultPolicyVersionRequest object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewSetDefaultPolicyVersionRequestWithDefaults() *SetDefaultPolicyVersionRequest { + this := SetDefaultPolicyVersionRequest{} + return &this +} + +// GetPolicyOrn returns the PolicyOrn field value +func (o *SetDefaultPolicyVersionRequest) GetPolicyOrn() string { + if o == nil { + var ret string + return ret + } + + return o.PolicyOrn +} + +// GetPolicyOrnOk returns a tuple with the PolicyOrn field value +// and a boolean to check if the value has been set. +func (o *SetDefaultPolicyVersionRequest) GetPolicyOrnOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.PolicyOrn, true +} + +// SetPolicyOrn sets field value +func (o *SetDefaultPolicyVersionRequest) SetPolicyOrn(v string) { + o.PolicyOrn = v +} + +// GetVersionId returns the VersionId field value +func (o *SetDefaultPolicyVersionRequest) GetVersionId() string { + if o == nil { + var ret string + return ret + } + + return o.VersionId +} + +// GetVersionIdOk returns a tuple with the VersionId field value +// and a boolean to check if the value has been set. +func (o *SetDefaultPolicyVersionRequest) GetVersionIdOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.VersionId, true +} + +// SetVersionId sets field value +func (o *SetDefaultPolicyVersionRequest) SetVersionId(v string) { + o.VersionId = v +} + +func (o SetDefaultPolicyVersionRequest) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["PolicyOrn"] = o.PolicyOrn + } + if true { + toSerialize["VersionId"] = o.VersionId + } + return json.Marshal(toSerialize) +} + +type NullableSetDefaultPolicyVersionRequest struct { + value *SetDefaultPolicyVersionRequest + isSet bool +} + +func (v NullableSetDefaultPolicyVersionRequest) Get() *SetDefaultPolicyVersionRequest { + return v.value +} + +func (v *NullableSetDefaultPolicyVersionRequest) Set(val *SetDefaultPolicyVersionRequest) { + v.value = val + v.isSet = true +} + +func (v NullableSetDefaultPolicyVersionRequest) IsSet() bool { + return v.isSet +} + +func (v *NullableSetDefaultPolicyVersionRequest) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableSetDefaultPolicyVersionRequest(val *SetDefaultPolicyVersionRequest) *NullableSetDefaultPolicyVersionRequest { + return &NullableSetDefaultPolicyVersionRequest{value: val, isSet: true} +} + +func (v NullableSetDefaultPolicyVersionRequest) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableSetDefaultPolicyVersionRequest) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_set_default_policy_version_response.go b/v2/model_set_default_policy_version_response.go new file mode 100644 index 000000000..c4452f82d --- /dev/null +++ b/v2/model_set_default_policy_version_response.go @@ -0,0 +1,114 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// SetDefaultPolicyVersionResponse struct for SetDefaultPolicyVersionResponse +type SetDefaultPolicyVersionResponse struct { + ResponseContext *ResponseContext `json:"ResponseContext,omitempty"` +} + +// NewSetDefaultPolicyVersionResponse instantiates a new SetDefaultPolicyVersionResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewSetDefaultPolicyVersionResponse() *SetDefaultPolicyVersionResponse { + this := SetDefaultPolicyVersionResponse{} + return &this +} + +// NewSetDefaultPolicyVersionResponseWithDefaults instantiates a new SetDefaultPolicyVersionResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewSetDefaultPolicyVersionResponseWithDefaults() *SetDefaultPolicyVersionResponse { + this := SetDefaultPolicyVersionResponse{} + return &this +} + +// GetResponseContext returns the ResponseContext field value if set, zero value otherwise. +func (o *SetDefaultPolicyVersionResponse) GetResponseContext() ResponseContext { + if o == nil || o.ResponseContext == nil { + var ret ResponseContext + return ret + } + return *o.ResponseContext +} + +// GetResponseContextOk returns a tuple with the ResponseContext field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *SetDefaultPolicyVersionResponse) GetResponseContextOk() (*ResponseContext, bool) { + if o == nil || o.ResponseContext == nil { + return nil, false + } + return o.ResponseContext, true +} + +// HasResponseContext returns a boolean if a field has been set. +func (o *SetDefaultPolicyVersionResponse) HasResponseContext() bool { + if o != nil && o.ResponseContext != nil { + return true + } + + return false +} + +// SetResponseContext gets a reference to the given ResponseContext and assigns it to the ResponseContext field. +func (o *SetDefaultPolicyVersionResponse) SetResponseContext(v ResponseContext) { + o.ResponseContext = &v +} + +func (o SetDefaultPolicyVersionResponse) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.ResponseContext != nil { + toSerialize["ResponseContext"] = o.ResponseContext + } + return json.Marshal(toSerialize) +} + +type NullableSetDefaultPolicyVersionResponse struct { + value *SetDefaultPolicyVersionResponse + isSet bool +} + +func (v NullableSetDefaultPolicyVersionResponse) Get() *SetDefaultPolicyVersionResponse { + return v.value +} + +func (v *NullableSetDefaultPolicyVersionResponse) Set(val *SetDefaultPolicyVersionResponse) { + v.value = val + v.isSet = true +} + +func (v NullableSetDefaultPolicyVersionResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableSetDefaultPolicyVersionResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableSetDefaultPolicyVersionResponse(val *SetDefaultPolicyVersionResponse) *NullableSetDefaultPolicyVersionResponse { + return &NullableSetDefaultPolicyVersionResponse{value: val, isSet: true} +} + +func (v NullableSetDefaultPolicyVersionResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableSetDefaultPolicyVersionResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_snapshot.go b/v2/model_snapshot.go index 83650e35e..4ca50ee35 100644 --- a/v2/model_snapshot.go +++ b/v2/model_snapshot.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_snapshot_export_task.go b/v2/model_snapshot_export_task.go index b4128990b..d8c544072 100644 --- a/v2/model_snapshot_export_task.go +++ b/v2/model_snapshot_export_task.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_source_net.go b/v2/model_source_net.go index bffb6c773..5ca416c21 100644 --- a/v2/model_source_net.go +++ b/v2/model_source_net.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_source_security_group.go b/v2/model_source_security_group.go index f8682bf3b..2105e0672 100644 --- a/v2/model_source_security_group.go +++ b/v2/model_source_security_group.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_start_vms_request.go b/v2/model_start_vms_request.go index 3b0acc72c..40756eacd 100644 --- a/v2/model_start_vms_request.go +++ b/v2/model_start_vms_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_start_vms_response.go b/v2/model_start_vms_response.go index 58cf990a7..c769e3b06 100644 --- a/v2/model_start_vms_response.go +++ b/v2/model_start_vms_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_state_comment.go b/v2/model_state_comment.go index 09da2b44d..67a161437 100644 --- a/v2/model_state_comment.go +++ b/v2/model_state_comment.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_stop_vms_request.go b/v2/model_stop_vms_request.go index 9e6f9a676..c24499122 100644 --- a/v2/model_stop_vms_request.go +++ b/v2/model_stop_vms_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_stop_vms_response.go b/v2/model_stop_vms_response.go index bd25b4c90..7ea4b0601 100644 --- a/v2/model_stop_vms_response.go +++ b/v2/model_stop_vms_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_subnet.go b/v2/model_subnet.go index f47e30961..1335f54b2 100644 --- a/v2/model_subnet.go +++ b/v2/model_subnet.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_subregion.go b/v2/model_subregion.go index 2326b0a2f..604113b40 100644 --- a/v2/model_subregion.go +++ b/v2/model_subregion.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -21,7 +21,7 @@ type Subregion struct { LocationCode *string `json:"LocationCode,omitempty"` // The name of the Region containing the Subregion. RegionName *string `json:"RegionName,omitempty"` - // The state of the Subregion (`available` \\| `information` \\| `impaired` \\| `unavailable`). + // The state of the Subregion. State *string `json:"State,omitempty"` // The name of the Subregion. SubregionName *string `json:"SubregionName,omitempty"` diff --git a/v2/model_tag.go b/v2/model_tag.go index b97aee858..e31c69d3c 100644 --- a/v2/model_tag.go +++ b/v2/model_tag.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_unlink_flexible_gpu_request.go b/v2/model_unlink_flexible_gpu_request.go index ab1f0cd31..13de48de4 100644 --- a/v2/model_unlink_flexible_gpu_request.go +++ b/v2/model_unlink_flexible_gpu_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_unlink_flexible_gpu_response.go b/v2/model_unlink_flexible_gpu_response.go index df714c596..be32e8df9 100644 --- a/v2/model_unlink_flexible_gpu_response.go +++ b/v2/model_unlink_flexible_gpu_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_unlink_internet_service_request.go b/v2/model_unlink_internet_service_request.go index d97c36388..d7fa46e71 100644 --- a/v2/model_unlink_internet_service_request.go +++ b/v2/model_unlink_internet_service_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_unlink_internet_service_response.go b/v2/model_unlink_internet_service_response.go index 743262d57..bef31a30a 100644 --- a/v2/model_unlink_internet_service_response.go +++ b/v2/model_unlink_internet_service_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_unlink_load_balancer_backend_machines_request.go b/v2/model_unlink_load_balancer_backend_machines_request.go index e33dcca4c..9446a14b9 100644 --- a/v2/model_unlink_load_balancer_backend_machines_request.go +++ b/v2/model_unlink_load_balancer_backend_machines_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_unlink_load_balancer_backend_machines_response.go b/v2/model_unlink_load_balancer_backend_machines_response.go index b2f240e7f..dde4bcc15 100644 --- a/v2/model_unlink_load_balancer_backend_machines_response.go +++ b/v2/model_unlink_load_balancer_backend_machines_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_unlink_nic_request.go b/v2/model_unlink_nic_request.go index d1f16f003..9453b6c42 100644 --- a/v2/model_unlink_nic_request.go +++ b/v2/model_unlink_nic_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_unlink_nic_response.go b/v2/model_unlink_nic_response.go index d5bfcde5d..4641f1745 100644 --- a/v2/model_unlink_nic_response.go +++ b/v2/model_unlink_nic_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_unlink_policy_request.go b/v2/model_unlink_policy_request.go new file mode 100644 index 000000000..b73684d67 --- /dev/null +++ b/v2/model_unlink_policy_request.go @@ -0,0 +1,175 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// UnlinkPolicyRequest struct for UnlinkPolicyRequest +type UnlinkPolicyRequest struct { + // If true, checks whether you have the required permissions to perform the action. + DryRun *bool `json:"DryRun,omitempty"` + // The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html). + PolicyOrn string `json:"PolicyOrn"` + // The name of the user you want to detach the policy from. + UserName string `json:"UserName"` +} + +// NewUnlinkPolicyRequest instantiates a new UnlinkPolicyRequest object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewUnlinkPolicyRequest(policyOrn string, userName string) *UnlinkPolicyRequest { + this := UnlinkPolicyRequest{} + this.PolicyOrn = policyOrn + this.UserName = userName + return &this +} + +// NewUnlinkPolicyRequestWithDefaults instantiates a new UnlinkPolicyRequest object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewUnlinkPolicyRequestWithDefaults() *UnlinkPolicyRequest { + this := UnlinkPolicyRequest{} + return &this +} + +// GetDryRun returns the DryRun field value if set, zero value otherwise. +func (o *UnlinkPolicyRequest) GetDryRun() bool { + if o == nil || o.DryRun == nil { + var ret bool + return ret + } + return *o.DryRun +} + +// GetDryRunOk returns a tuple with the DryRun field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *UnlinkPolicyRequest) GetDryRunOk() (*bool, bool) { + if o == nil || o.DryRun == nil { + return nil, false + } + return o.DryRun, true +} + +// HasDryRun returns a boolean if a field has been set. +func (o *UnlinkPolicyRequest) HasDryRun() bool { + if o != nil && o.DryRun != nil { + return true + } + + return false +} + +// SetDryRun gets a reference to the given bool and assigns it to the DryRun field. +func (o *UnlinkPolicyRequest) SetDryRun(v bool) { + o.DryRun = &v +} + +// GetPolicyOrn returns the PolicyOrn field value +func (o *UnlinkPolicyRequest) GetPolicyOrn() string { + if o == nil { + var ret string + return ret + } + + return o.PolicyOrn +} + +// GetPolicyOrnOk returns a tuple with the PolicyOrn field value +// and a boolean to check if the value has been set. +func (o *UnlinkPolicyRequest) GetPolicyOrnOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.PolicyOrn, true +} + +// SetPolicyOrn sets field value +func (o *UnlinkPolicyRequest) SetPolicyOrn(v string) { + o.PolicyOrn = v +} + +// GetUserName returns the UserName field value +func (o *UnlinkPolicyRequest) GetUserName() string { + if o == nil { + var ret string + return ret + } + + return o.UserName +} + +// GetUserNameOk returns a tuple with the UserName field value +// and a boolean to check if the value has been set. +func (o *UnlinkPolicyRequest) GetUserNameOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.UserName, true +} + +// SetUserName sets field value +func (o *UnlinkPolicyRequest) SetUserName(v string) { + o.UserName = v +} + +func (o UnlinkPolicyRequest) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.DryRun != nil { + toSerialize["DryRun"] = o.DryRun + } + if true { + toSerialize["PolicyOrn"] = o.PolicyOrn + } + if true { + toSerialize["UserName"] = o.UserName + } + return json.Marshal(toSerialize) +} + +type NullableUnlinkPolicyRequest struct { + value *UnlinkPolicyRequest + isSet bool +} + +func (v NullableUnlinkPolicyRequest) Get() *UnlinkPolicyRequest { + return v.value +} + +func (v *NullableUnlinkPolicyRequest) Set(val *UnlinkPolicyRequest) { + v.value = val + v.isSet = true +} + +func (v NullableUnlinkPolicyRequest) IsSet() bool { + return v.isSet +} + +func (v *NullableUnlinkPolicyRequest) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableUnlinkPolicyRequest(val *UnlinkPolicyRequest) *NullableUnlinkPolicyRequest { + return &NullableUnlinkPolicyRequest{value: val, isSet: true} +} + +func (v NullableUnlinkPolicyRequest) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableUnlinkPolicyRequest) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_unlink_policy_response.go b/v2/model_unlink_policy_response.go new file mode 100644 index 000000000..f178ceadf --- /dev/null +++ b/v2/model_unlink_policy_response.go @@ -0,0 +1,114 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// UnlinkPolicyResponse struct for UnlinkPolicyResponse +type UnlinkPolicyResponse struct { + ResponseContext *ResponseContext `json:"ResponseContext,omitempty"` +} + +// NewUnlinkPolicyResponse instantiates a new UnlinkPolicyResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewUnlinkPolicyResponse() *UnlinkPolicyResponse { + this := UnlinkPolicyResponse{} + return &this +} + +// NewUnlinkPolicyResponseWithDefaults instantiates a new UnlinkPolicyResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewUnlinkPolicyResponseWithDefaults() *UnlinkPolicyResponse { + this := UnlinkPolicyResponse{} + return &this +} + +// GetResponseContext returns the ResponseContext field value if set, zero value otherwise. +func (o *UnlinkPolicyResponse) GetResponseContext() ResponseContext { + if o == nil || o.ResponseContext == nil { + var ret ResponseContext + return ret + } + return *o.ResponseContext +} + +// GetResponseContextOk returns a tuple with the ResponseContext field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *UnlinkPolicyResponse) GetResponseContextOk() (*ResponseContext, bool) { + if o == nil || o.ResponseContext == nil { + return nil, false + } + return o.ResponseContext, true +} + +// HasResponseContext returns a boolean if a field has been set. +func (o *UnlinkPolicyResponse) HasResponseContext() bool { + if o != nil && o.ResponseContext != nil { + return true + } + + return false +} + +// SetResponseContext gets a reference to the given ResponseContext and assigns it to the ResponseContext field. +func (o *UnlinkPolicyResponse) SetResponseContext(v ResponseContext) { + o.ResponseContext = &v +} + +func (o UnlinkPolicyResponse) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.ResponseContext != nil { + toSerialize["ResponseContext"] = o.ResponseContext + } + return json.Marshal(toSerialize) +} + +type NullableUnlinkPolicyResponse struct { + value *UnlinkPolicyResponse + isSet bool +} + +func (v NullableUnlinkPolicyResponse) Get() *UnlinkPolicyResponse { + return v.value +} + +func (v *NullableUnlinkPolicyResponse) Set(val *UnlinkPolicyResponse) { + v.value = val + v.isSet = true +} + +func (v NullableUnlinkPolicyResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableUnlinkPolicyResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableUnlinkPolicyResponse(val *UnlinkPolicyResponse) *NullableUnlinkPolicyResponse { + return &NullableUnlinkPolicyResponse{value: val, isSet: true} +} + +func (v NullableUnlinkPolicyResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableUnlinkPolicyResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_unlink_private_ips_request.go b/v2/model_unlink_private_ips_request.go index 1643d6569..ec8cd54d7 100644 --- a/v2/model_unlink_private_ips_request.go +++ b/v2/model_unlink_private_ips_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_unlink_private_ips_response.go b/v2/model_unlink_private_ips_response.go index 2190ada19..f1176c320 100644 --- a/v2/model_unlink_private_ips_response.go +++ b/v2/model_unlink_private_ips_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_unlink_public_ip_request.go b/v2/model_unlink_public_ip_request.go index 81602966b..ea1d8f16d 100644 --- a/v2/model_unlink_public_ip_request.go +++ b/v2/model_unlink_public_ip_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_unlink_public_ip_response.go b/v2/model_unlink_public_ip_response.go index fd79359db..28842f457 100644 --- a/v2/model_unlink_public_ip_response.go +++ b/v2/model_unlink_public_ip_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_unlink_route_table_request.go b/v2/model_unlink_route_table_request.go index 5a6d74729..2f63a41c3 100644 --- a/v2/model_unlink_route_table_request.go +++ b/v2/model_unlink_route_table_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_unlink_route_table_response.go b/v2/model_unlink_route_table_response.go index ddca6d0aa..ab9128164 100644 --- a/v2/model_unlink_route_table_response.go +++ b/v2/model_unlink_route_table_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_unlink_virtual_gateway_request.go b/v2/model_unlink_virtual_gateway_request.go index 73de6c05b..2b2c557ac 100644 --- a/v2/model_unlink_virtual_gateway_request.go +++ b/v2/model_unlink_virtual_gateway_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_unlink_virtual_gateway_response.go b/v2/model_unlink_virtual_gateway_response.go index a1e8aa679..81cf16ea4 100644 --- a/v2/model_unlink_virtual_gateway_response.go +++ b/v2/model_unlink_virtual_gateway_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_unlink_volume_request.go b/v2/model_unlink_volume_request.go index de7d18dbb..9f60d02a7 100644 --- a/v2/model_unlink_volume_request.go +++ b/v2/model_unlink_volume_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_unlink_volume_response.go b/v2/model_unlink_volume_response.go index 0835f015f..4d66333a8 100644 --- a/v2/model_unlink_volume_response.go +++ b/v2/model_unlink_volume_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_access_key_request.go b/v2/model_update_access_key_request.go index 1a5d178e8..2cd1c2a09 100644 --- a/v2/model_update_access_key_request.go +++ b/v2/model_update_access_key_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -25,7 +25,7 @@ type UpdateAccessKeyRequest struct { ExpirationDate *string `json:"ExpirationDate,omitempty"` // 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. State string `json:"State"` - // The name of the EIM 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). + // 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). UserName *string `json:"UserName,omitempty"` } diff --git a/v2/model_update_access_key_response.go b/v2/model_update_access_key_response.go index 606b0965f..0d89ca438 100644 --- a/v2/model_update_access_key_response.go +++ b/v2/model_update_access_key_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_account_request.go b/v2/model_update_account_request.go index 1b0ddcf72..d20c9abd0 100644 --- a/v2/model_update_account_request.go +++ b/v2/model_update_account_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_account_response.go b/v2/model_update_account_response.go index 405cc1a59..7c1677c03 100644 --- a/v2/model_update_account_response.go +++ b/v2/model_update_account_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_api_access_policy_request.go b/v2/model_update_api_access_policy_request.go index 36d51cf66..118967116 100644 --- a/v2/model_update_api_access_policy_request.go +++ b/v2/model_update_api_access_policy_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -21,7 +21,7 @@ type UpdateApiAccessPolicyRequest struct { DryRun *bool `json:"DryRun,omitempty"` // 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. MaxAccessKeyExpirationSeconds int64 `json:"MaxAccessKeyExpirationSeconds"` - // If true, a trusted session is activated, provided that you specify the `MaxAccessKeyExpirationSeconds` parameter with a value greater than `0`. + // If true, a trusted session is activated, provided that you specify the `MaxAccessKeyExpirationSeconds` parameter with a value greater than `0`.
Enabling this will require you and all your users to log in to Cockpit v2 using the WebAuthn method for multi-factor authentication. For more information, see [About Authentication > Multi-Factor Authentication](https://docs.outscale.com/en/userguide/About-Authentication.html#_multi_factor_authentication). RequireTrustedEnv bool `json:"RequireTrustedEnv"` } diff --git a/v2/model_update_api_access_policy_response.go b/v2/model_update_api_access_policy_response.go index d377a55dd..5e7a5e208 100644 --- a/v2/model_update_api_access_policy_response.go +++ b/v2/model_update_api_access_policy_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_api_access_rule_request.go b/v2/model_update_api_access_rule_request.go index f2d181e35..e6cd5078d 100644 --- a/v2/model_update_api_access_rule_request.go +++ b/v2/model_update_api_access_rule_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_api_access_rule_response.go b/v2/model_update_api_access_rule_response.go index fe9054e7f..cf16a9aa4 100644 --- a/v2/model_update_api_access_rule_response.go +++ b/v2/model_update_api_access_rule_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_ca_request.go b/v2/model_update_ca_request.go index d2ce1c3d6..05155af05 100644 --- a/v2/model_update_ca_request.go +++ b/v2/model_update_ca_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_ca_response.go b/v2/model_update_ca_response.go index 9d370ae52..0d4c3a0ab 100644 --- a/v2/model_update_ca_response.go +++ b/v2/model_update_ca_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_dedicated_group_request.go b/v2/model_update_dedicated_group_request.go new file mode 100644 index 000000000..e79ede806 --- /dev/null +++ b/v2/model_update_dedicated_group_request.go @@ -0,0 +1,175 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// UpdateDedicatedGroupRequest struct for UpdateDedicatedGroupRequest +type UpdateDedicatedGroupRequest struct { + // The ID of the dedicated group you want to update. + DedicatedGroupId string `json:"DedicatedGroupId"` + // If true, checks whether you have the required permissions to perform the action. + DryRun *bool `json:"DryRun,omitempty"` + // The new name of the dedicated group. + Name string `json:"Name"` +} + +// NewUpdateDedicatedGroupRequest instantiates a new UpdateDedicatedGroupRequest object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewUpdateDedicatedGroupRequest(dedicatedGroupId string, name string) *UpdateDedicatedGroupRequest { + this := UpdateDedicatedGroupRequest{} + this.DedicatedGroupId = dedicatedGroupId + this.Name = name + return &this +} + +// NewUpdateDedicatedGroupRequestWithDefaults instantiates a new UpdateDedicatedGroupRequest object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewUpdateDedicatedGroupRequestWithDefaults() *UpdateDedicatedGroupRequest { + this := UpdateDedicatedGroupRequest{} + return &this +} + +// GetDedicatedGroupId returns the DedicatedGroupId field value +func (o *UpdateDedicatedGroupRequest) GetDedicatedGroupId() string { + if o == nil { + var ret string + return ret + } + + return o.DedicatedGroupId +} + +// GetDedicatedGroupIdOk returns a tuple with the DedicatedGroupId field value +// and a boolean to check if the value has been set. +func (o *UpdateDedicatedGroupRequest) GetDedicatedGroupIdOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.DedicatedGroupId, true +} + +// SetDedicatedGroupId sets field value +func (o *UpdateDedicatedGroupRequest) SetDedicatedGroupId(v string) { + o.DedicatedGroupId = v +} + +// GetDryRun returns the DryRun field value if set, zero value otherwise. +func (o *UpdateDedicatedGroupRequest) GetDryRun() bool { + if o == nil || o.DryRun == nil { + var ret bool + return ret + } + return *o.DryRun +} + +// GetDryRunOk returns a tuple with the DryRun field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *UpdateDedicatedGroupRequest) GetDryRunOk() (*bool, bool) { + if o == nil || o.DryRun == nil { + return nil, false + } + return o.DryRun, true +} + +// HasDryRun returns a boolean if a field has been set. +func (o *UpdateDedicatedGroupRequest) HasDryRun() bool { + if o != nil && o.DryRun != nil { + return true + } + + return false +} + +// SetDryRun gets a reference to the given bool and assigns it to the DryRun field. +func (o *UpdateDedicatedGroupRequest) SetDryRun(v bool) { + o.DryRun = &v +} + +// GetName returns the Name field value +func (o *UpdateDedicatedGroupRequest) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// GetNameOk returns a tuple with the Name field value +// and a boolean to check if the value has been set. +func (o *UpdateDedicatedGroupRequest) GetNameOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.Name, true +} + +// SetName sets field value +func (o *UpdateDedicatedGroupRequest) SetName(v string) { + o.Name = v +} + +func (o UpdateDedicatedGroupRequest) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["DedicatedGroupId"] = o.DedicatedGroupId + } + if o.DryRun != nil { + toSerialize["DryRun"] = o.DryRun + } + if true { + toSerialize["Name"] = o.Name + } + return json.Marshal(toSerialize) +} + +type NullableUpdateDedicatedGroupRequest struct { + value *UpdateDedicatedGroupRequest + isSet bool +} + +func (v NullableUpdateDedicatedGroupRequest) Get() *UpdateDedicatedGroupRequest { + return v.value +} + +func (v *NullableUpdateDedicatedGroupRequest) Set(val *UpdateDedicatedGroupRequest) { + v.value = val + v.isSet = true +} + +func (v NullableUpdateDedicatedGroupRequest) IsSet() bool { + return v.isSet +} + +func (v *NullableUpdateDedicatedGroupRequest) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableUpdateDedicatedGroupRequest(val *UpdateDedicatedGroupRequest) *NullableUpdateDedicatedGroupRequest { + return &NullableUpdateDedicatedGroupRequest{value: val, isSet: true} +} + +func (v NullableUpdateDedicatedGroupRequest) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableUpdateDedicatedGroupRequest) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_update_dedicated_group_response.go b/v2/model_update_dedicated_group_response.go new file mode 100644 index 000000000..68cfa5153 --- /dev/null +++ b/v2/model_update_dedicated_group_response.go @@ -0,0 +1,150 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// UpdateDedicatedGroupResponse struct for UpdateDedicatedGroupResponse +type UpdateDedicatedGroupResponse struct { + DedicatedGroup *DedicatedGroup `json:"DedicatedGroup,omitempty"` + ResponseContext *ResponseContext `json:"ResponseContext,omitempty"` +} + +// NewUpdateDedicatedGroupResponse instantiates a new UpdateDedicatedGroupResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewUpdateDedicatedGroupResponse() *UpdateDedicatedGroupResponse { + this := UpdateDedicatedGroupResponse{} + return &this +} + +// NewUpdateDedicatedGroupResponseWithDefaults instantiates a new UpdateDedicatedGroupResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewUpdateDedicatedGroupResponseWithDefaults() *UpdateDedicatedGroupResponse { + this := UpdateDedicatedGroupResponse{} + return &this +} + +// GetDedicatedGroup returns the DedicatedGroup field value if set, zero value otherwise. +func (o *UpdateDedicatedGroupResponse) GetDedicatedGroup() DedicatedGroup { + if o == nil || o.DedicatedGroup == nil { + var ret DedicatedGroup + return ret + } + return *o.DedicatedGroup +} + +// GetDedicatedGroupOk returns a tuple with the DedicatedGroup field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *UpdateDedicatedGroupResponse) GetDedicatedGroupOk() (*DedicatedGroup, bool) { + if o == nil || o.DedicatedGroup == nil { + return nil, false + } + return o.DedicatedGroup, true +} + +// HasDedicatedGroup returns a boolean if a field has been set. +func (o *UpdateDedicatedGroupResponse) HasDedicatedGroup() bool { + if o != nil && o.DedicatedGroup != nil { + return true + } + + return false +} + +// SetDedicatedGroup gets a reference to the given DedicatedGroup and assigns it to the DedicatedGroup field. +func (o *UpdateDedicatedGroupResponse) SetDedicatedGroup(v DedicatedGroup) { + o.DedicatedGroup = &v +} + +// GetResponseContext returns the ResponseContext field value if set, zero value otherwise. +func (o *UpdateDedicatedGroupResponse) GetResponseContext() ResponseContext { + if o == nil || o.ResponseContext == nil { + var ret ResponseContext + return ret + } + return *o.ResponseContext +} + +// GetResponseContextOk returns a tuple with the ResponseContext field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *UpdateDedicatedGroupResponse) GetResponseContextOk() (*ResponseContext, bool) { + if o == nil || o.ResponseContext == nil { + return nil, false + } + return o.ResponseContext, true +} + +// HasResponseContext returns a boolean if a field has been set. +func (o *UpdateDedicatedGroupResponse) HasResponseContext() bool { + if o != nil && o.ResponseContext != nil { + return true + } + + return false +} + +// SetResponseContext gets a reference to the given ResponseContext and assigns it to the ResponseContext field. +func (o *UpdateDedicatedGroupResponse) SetResponseContext(v ResponseContext) { + o.ResponseContext = &v +} + +func (o UpdateDedicatedGroupResponse) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.DedicatedGroup != nil { + toSerialize["DedicatedGroup"] = o.DedicatedGroup + } + if o.ResponseContext != nil { + toSerialize["ResponseContext"] = o.ResponseContext + } + return json.Marshal(toSerialize) +} + +type NullableUpdateDedicatedGroupResponse struct { + value *UpdateDedicatedGroupResponse + isSet bool +} + +func (v NullableUpdateDedicatedGroupResponse) Get() *UpdateDedicatedGroupResponse { + return v.value +} + +func (v *NullableUpdateDedicatedGroupResponse) Set(val *UpdateDedicatedGroupResponse) { + v.value = val + v.isSet = true +} + +func (v NullableUpdateDedicatedGroupResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableUpdateDedicatedGroupResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableUpdateDedicatedGroupResponse(val *UpdateDedicatedGroupResponse) *NullableUpdateDedicatedGroupResponse { + return &NullableUpdateDedicatedGroupResponse{value: val, isSet: true} +} + +func (v NullableUpdateDedicatedGroupResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableUpdateDedicatedGroupResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_update_direct_link_interface_request.go b/v2/model_update_direct_link_interface_request.go index dd7b8c2fe..de183f82c 100644 --- a/v2/model_update_direct_link_interface_request.go +++ b/v2/model_update_direct_link_interface_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_direct_link_interface_response.go b/v2/model_update_direct_link_interface_response.go index ee3467f2a..10338272e 100644 --- a/v2/model_update_direct_link_interface_response.go +++ b/v2/model_update_direct_link_interface_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_flexible_gpu_request.go b/v2/model_update_flexible_gpu_request.go index 7f94e75cb..15e4ea8e5 100644 --- a/v2/model_update_flexible_gpu_request.go +++ b/v2/model_update_flexible_gpu_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_flexible_gpu_response.go b/v2/model_update_flexible_gpu_response.go index b48a71ae8..a02061845 100644 --- a/v2/model_update_flexible_gpu_response.go +++ b/v2/model_update_flexible_gpu_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_image_request.go b/v2/model_update_image_request.go index b3714c0e0..3716e6763 100644 --- a/v2/model_update_image_request.go +++ b/v2/model_update_image_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_image_response.go b/v2/model_update_image_response.go index 38677ba21..926b1a7ba 100644 --- a/v2/model_update_image_response.go +++ b/v2/model_update_image_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_listener_rule_request.go b/v2/model_update_listener_rule_request.go index 0ef6ebb7f..9ff706b65 100644 --- a/v2/model_update_listener_rule_request.go +++ b/v2/model_update_listener_rule_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_listener_rule_response.go b/v2/model_update_listener_rule_response.go index 228e30ba5..d6dd8cb40 100644 --- a/v2/model_update_listener_rule_response.go +++ b/v2/model_update_listener_rule_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_load_balancer_request.go b/v2/model_update_load_balancer_request.go index a91f4e241..f74b73f9e 100644 --- a/v2/model_update_load_balancer_request.go +++ b/v2/model_update_load_balancer_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_load_balancer_response.go b/v2/model_update_load_balancer_response.go index 7bac6b7b3..38a231d24 100644 --- a/v2/model_update_load_balancer_response.go +++ b/v2/model_update_load_balancer_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_net_access_point_request.go b/v2/model_update_net_access_point_request.go index 6d169c961..90f66fc98 100644 --- a/v2/model_update_net_access_point_request.go +++ b/v2/model_update_net_access_point_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_net_access_point_response.go b/v2/model_update_net_access_point_response.go index effdefb3a..5cd32940b 100644 --- a/v2/model_update_net_access_point_response.go +++ b/v2/model_update_net_access_point_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_net_request.go b/v2/model_update_net_request.go index 3a2abde14..22f8c6834 100644 --- a/v2/model_update_net_request.go +++ b/v2/model_update_net_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_net_response.go b/v2/model_update_net_response.go index 8214906fa..17e2c92e0 100644 --- a/v2/model_update_net_response.go +++ b/v2/model_update_net_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_nic_request.go b/v2/model_update_nic_request.go index 51b06ac23..94f1ba0f0 100644 --- a/v2/model_update_nic_request.go +++ b/v2/model_update_nic_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_nic_response.go b/v2/model_update_nic_response.go index 4bbf1405e..95d1f4564 100644 --- a/v2/model_update_nic_response.go +++ b/v2/model_update_nic_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_route_propagation_request.go b/v2/model_update_route_propagation_request.go index e029e454b..d9f2d7a11 100644 --- a/v2/model_update_route_propagation_request.go +++ b/v2/model_update_route_propagation_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_route_propagation_response.go b/v2/model_update_route_propagation_response.go index 52c423e1b..dc1d5896c 100644 --- a/v2/model_update_route_propagation_response.go +++ b/v2/model_update_route_propagation_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_route_request.go b/v2/model_update_route_request.go index 66ff2789c..4d6ea7d11 100644 --- a/v2/model_update_route_request.go +++ b/v2/model_update_route_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_route_response.go b/v2/model_update_route_response.go index 52a259bda..8c2283ce5 100644 --- a/v2/model_update_route_response.go +++ b/v2/model_update_route_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_route_table_link_request.go b/v2/model_update_route_table_link_request.go new file mode 100644 index 000000000..c308d557c --- /dev/null +++ b/v2/model_update_route_table_link_request.go @@ -0,0 +1,175 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// UpdateRouteTableLinkRequest struct for UpdateRouteTableLinkRequest +type UpdateRouteTableLinkRequest struct { + // If true, checks whether you have the required permissions to perform the action. + DryRun *bool `json:"DryRun,omitempty"` + // The ID of the current route table link. + LinkRouteTableId string `json:"LinkRouteTableId"` + // The ID of the new route table to associate with the Subnet. + RouteTableId string `json:"RouteTableId"` +} + +// NewUpdateRouteTableLinkRequest instantiates a new UpdateRouteTableLinkRequest object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewUpdateRouteTableLinkRequest(linkRouteTableId string, routeTableId string) *UpdateRouteTableLinkRequest { + this := UpdateRouteTableLinkRequest{} + this.LinkRouteTableId = linkRouteTableId + this.RouteTableId = routeTableId + return &this +} + +// NewUpdateRouteTableLinkRequestWithDefaults instantiates a new UpdateRouteTableLinkRequest object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewUpdateRouteTableLinkRequestWithDefaults() *UpdateRouteTableLinkRequest { + this := UpdateRouteTableLinkRequest{} + return &this +} + +// GetDryRun returns the DryRun field value if set, zero value otherwise. +func (o *UpdateRouteTableLinkRequest) GetDryRun() bool { + if o == nil || o.DryRun == nil { + var ret bool + return ret + } + return *o.DryRun +} + +// GetDryRunOk returns a tuple with the DryRun field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *UpdateRouteTableLinkRequest) GetDryRunOk() (*bool, bool) { + if o == nil || o.DryRun == nil { + return nil, false + } + return o.DryRun, true +} + +// HasDryRun returns a boolean if a field has been set. +func (o *UpdateRouteTableLinkRequest) HasDryRun() bool { + if o != nil && o.DryRun != nil { + return true + } + + return false +} + +// SetDryRun gets a reference to the given bool and assigns it to the DryRun field. +func (o *UpdateRouteTableLinkRequest) SetDryRun(v bool) { + o.DryRun = &v +} + +// GetLinkRouteTableId returns the LinkRouteTableId field value +func (o *UpdateRouteTableLinkRequest) GetLinkRouteTableId() string { + if o == nil { + var ret string + return ret + } + + return o.LinkRouteTableId +} + +// GetLinkRouteTableIdOk returns a tuple with the LinkRouteTableId field value +// and a boolean to check if the value has been set. +func (o *UpdateRouteTableLinkRequest) GetLinkRouteTableIdOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.LinkRouteTableId, true +} + +// SetLinkRouteTableId sets field value +func (o *UpdateRouteTableLinkRequest) SetLinkRouteTableId(v string) { + o.LinkRouteTableId = v +} + +// GetRouteTableId returns the RouteTableId field value +func (o *UpdateRouteTableLinkRequest) GetRouteTableId() string { + if o == nil { + var ret string + return ret + } + + return o.RouteTableId +} + +// GetRouteTableIdOk returns a tuple with the RouteTableId field value +// and a boolean to check if the value has been set. +func (o *UpdateRouteTableLinkRequest) GetRouteTableIdOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.RouteTableId, true +} + +// SetRouteTableId sets field value +func (o *UpdateRouteTableLinkRequest) SetRouteTableId(v string) { + o.RouteTableId = v +} + +func (o UpdateRouteTableLinkRequest) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.DryRun != nil { + toSerialize["DryRun"] = o.DryRun + } + if true { + toSerialize["LinkRouteTableId"] = o.LinkRouteTableId + } + if true { + toSerialize["RouteTableId"] = o.RouteTableId + } + return json.Marshal(toSerialize) +} + +type NullableUpdateRouteTableLinkRequest struct { + value *UpdateRouteTableLinkRequest + isSet bool +} + +func (v NullableUpdateRouteTableLinkRequest) Get() *UpdateRouteTableLinkRequest { + return v.value +} + +func (v *NullableUpdateRouteTableLinkRequest) Set(val *UpdateRouteTableLinkRequest) { + v.value = val + v.isSet = true +} + +func (v NullableUpdateRouteTableLinkRequest) IsSet() bool { + return v.isSet +} + +func (v *NullableUpdateRouteTableLinkRequest) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableUpdateRouteTableLinkRequest(val *UpdateRouteTableLinkRequest) *NullableUpdateRouteTableLinkRequest { + return &NullableUpdateRouteTableLinkRequest{value: val, isSet: true} +} + +func (v NullableUpdateRouteTableLinkRequest) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableUpdateRouteTableLinkRequest) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_update_route_table_link_response.go b/v2/model_update_route_table_link_response.go new file mode 100644 index 000000000..c5c987ee9 --- /dev/null +++ b/v2/model_update_route_table_link_response.go @@ -0,0 +1,151 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// UpdateRouteTableLinkResponse struct for UpdateRouteTableLinkResponse +type UpdateRouteTableLinkResponse struct { + // The ID of the association between the route table and the Subnet. + LinkRouteTableId *string `json:"LinkRouteTableId,omitempty"` + ResponseContext *ResponseContext `json:"ResponseContext,omitempty"` +} + +// NewUpdateRouteTableLinkResponse instantiates a new UpdateRouteTableLinkResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewUpdateRouteTableLinkResponse() *UpdateRouteTableLinkResponse { + this := UpdateRouteTableLinkResponse{} + return &this +} + +// NewUpdateRouteTableLinkResponseWithDefaults instantiates a new UpdateRouteTableLinkResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewUpdateRouteTableLinkResponseWithDefaults() *UpdateRouteTableLinkResponse { + this := UpdateRouteTableLinkResponse{} + return &this +} + +// GetLinkRouteTableId returns the LinkRouteTableId field value if set, zero value otherwise. +func (o *UpdateRouteTableLinkResponse) GetLinkRouteTableId() string { + if o == nil || o.LinkRouteTableId == nil { + var ret string + return ret + } + return *o.LinkRouteTableId +} + +// GetLinkRouteTableIdOk returns a tuple with the LinkRouteTableId field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *UpdateRouteTableLinkResponse) GetLinkRouteTableIdOk() (*string, bool) { + if o == nil || o.LinkRouteTableId == nil { + return nil, false + } + return o.LinkRouteTableId, true +} + +// HasLinkRouteTableId returns a boolean if a field has been set. +func (o *UpdateRouteTableLinkResponse) HasLinkRouteTableId() bool { + if o != nil && o.LinkRouteTableId != nil { + return true + } + + return false +} + +// SetLinkRouteTableId gets a reference to the given string and assigns it to the LinkRouteTableId field. +func (o *UpdateRouteTableLinkResponse) SetLinkRouteTableId(v string) { + o.LinkRouteTableId = &v +} + +// GetResponseContext returns the ResponseContext field value if set, zero value otherwise. +func (o *UpdateRouteTableLinkResponse) GetResponseContext() ResponseContext { + if o == nil || o.ResponseContext == nil { + var ret ResponseContext + return ret + } + return *o.ResponseContext +} + +// GetResponseContextOk returns a tuple with the ResponseContext field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *UpdateRouteTableLinkResponse) GetResponseContextOk() (*ResponseContext, bool) { + if o == nil || o.ResponseContext == nil { + return nil, false + } + return o.ResponseContext, true +} + +// HasResponseContext returns a boolean if a field has been set. +func (o *UpdateRouteTableLinkResponse) HasResponseContext() bool { + if o != nil && o.ResponseContext != nil { + return true + } + + return false +} + +// SetResponseContext gets a reference to the given ResponseContext and assigns it to the ResponseContext field. +func (o *UpdateRouteTableLinkResponse) SetResponseContext(v ResponseContext) { + o.ResponseContext = &v +} + +func (o UpdateRouteTableLinkResponse) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.LinkRouteTableId != nil { + toSerialize["LinkRouteTableId"] = o.LinkRouteTableId + } + if o.ResponseContext != nil { + toSerialize["ResponseContext"] = o.ResponseContext + } + return json.Marshal(toSerialize) +} + +type NullableUpdateRouteTableLinkResponse struct { + value *UpdateRouteTableLinkResponse + isSet bool +} + +func (v NullableUpdateRouteTableLinkResponse) Get() *UpdateRouteTableLinkResponse { + return v.value +} + +func (v *NullableUpdateRouteTableLinkResponse) Set(val *UpdateRouteTableLinkResponse) { + v.value = val + v.isSet = true +} + +func (v NullableUpdateRouteTableLinkResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableUpdateRouteTableLinkResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableUpdateRouteTableLinkResponse(val *UpdateRouteTableLinkResponse) *NullableUpdateRouteTableLinkResponse { + return &NullableUpdateRouteTableLinkResponse{value: val, isSet: true} +} + +func (v NullableUpdateRouteTableLinkResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableUpdateRouteTableLinkResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_update_server_certificate_request.go b/v2/model_update_server_certificate_request.go index b6af1de27..3bf9d4e30 100644 --- a/v2/model_update_server_certificate_request.go +++ b/v2/model_update_server_certificate_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_server_certificate_response.go b/v2/model_update_server_certificate_response.go index c104ca208..eee59c81d 100644 --- a/v2/model_update_server_certificate_response.go +++ b/v2/model_update_server_certificate_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_snapshot_request.go b/v2/model_update_snapshot_request.go index 22e455109..5b0181311 100644 --- a/v2/model_update_snapshot_request.go +++ b/v2/model_update_snapshot_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_snapshot_response.go b/v2/model_update_snapshot_response.go index 66d7a3d2c..4ffd873d6 100644 --- a/v2/model_update_snapshot_response.go +++ b/v2/model_update_snapshot_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_subnet_request.go b/v2/model_update_subnet_request.go index 09f26f243..06598e67e 100644 --- a/v2/model_update_subnet_request.go +++ b/v2/model_update_subnet_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_subnet_response.go b/v2/model_update_subnet_response.go index 6f24d5479..5346e08df 100644 --- a/v2/model_update_subnet_response.go +++ b/v2/model_update_subnet_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_user_request.go b/v2/model_update_user_request.go index f09ab389e..03b9804bb 100644 --- a/v2/model_update_user_request.go +++ b/v2/model_update_user_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_user_response.go b/v2/model_update_user_response.go index a8c8e0040..5b03cc3a7 100644 --- a/v2/model_update_user_response.go +++ b/v2/model_update_user_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_vm_group_request.go b/v2/model_update_vm_group_request.go index 0861b8a47..7018cffa9 100644 --- a/v2/model_update_vm_group_request.go +++ b/v2/model_update_vm_group_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_vm_group_response.go b/v2/model_update_vm_group_response.go index 1db632c9c..a38c026ff 100644 --- a/v2/model_update_vm_group_response.go +++ b/v2/model_update_vm_group_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_vm_request.go b/v2/model_update_vm_request.go index 03c7abe8c..d1279c0c5 100644 --- a/v2/model_update_vm_request.go +++ b/v2/model_update_vm_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -27,7 +27,7 @@ type UpdateVmRequest struct { DryRun *bool `json:"DryRun,omitempty"` // (Net only) If true, the source/destination check is enabled. If false, it is disabled. This value must be false for a NAT VM to perform network address translation (NAT) in a Net. IsSourceDestChecked *bool `json:"IsSourceDestChecked,omitempty"` - // The name of a keypair you want to associate with the VM.
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 an Instance](https://docs.outscale.com/en/userguide/Modifying-the-Keypair-of-an-Instance.html). + // The name of a keypair you want to associate with the VM.
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). KeypairName *string `json:"KeypairName,omitempty"` // (dedicated tenancy only) If true, nested virtualization is enabled. If false, it is disabled. NestedVirtualization *bool `json:"NestedVirtualization,omitempty"` @@ -41,7 +41,7 @@ type UpdateVmRequest struct { VmId string `json:"VmId"` // 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. VmInitiatedShutdownBehavior *string `json:"VmInitiatedShutdownBehavior,omitempty"` - // The type of VM. For more information, see [Instance Types](https://docs.outscale.com/en/userguide/Instance-Types.html). + // The type of VM. For more information, see [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html). VmType *string `json:"VmType,omitempty"` } diff --git a/v2/model_update_vm_response.go b/v2/model_update_vm_response.go index 135e42054..56f8655d0 100644 --- a/v2/model_update_vm_response.go +++ b/v2/model_update_vm_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_vm_template_request.go b/v2/model_update_vm_template_request.go index 48cd87206..704c5527b 100644 --- a/v2/model_update_vm_template_request.go +++ b/v2/model_update_vm_template_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_vm_template_response.go b/v2/model_update_vm_template_response.go index b9a070260..9f3e34617 100644 --- a/v2/model_update_vm_template_response.go +++ b/v2/model_update_vm_template_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_volume_request.go b/v2/model_update_volume_request.go index 7223acad4..a1d012325 100644 --- a/v2/model_update_volume_request.go +++ b/v2/model_update_volume_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -19,13 +19,13 @@ import ( type UpdateVolumeRequest struct { // If true, checks whether you have the required permissions to perform the action. DryRun *bool `json:"DryRun,omitempty"` - // The new number of I/O operations per second (IOPS). This parameter can be specified only if you update an `io1` volume. The maximum number of IOPS allowed for `io1` volumes is `13000` with a maximum performance ratio of 300 IOPS per gibibyte. This modification is instantaneous on a cold volume, not on a hot one. + // **Cold volume**: 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`. This modification is instantaneous.
**Hot volume**: the new number of I/O operations per second (IOPS). This parameter can be specified only if you update an `io1` volume. This modification is not instantaneous.

The maximum number of IOPS allowed for `io1` volumes is `13000` with a maximum performance ratio of 300 IOPS per gibibyte. Iops *int32 `json:"Iops,omitempty"` - // (cold volume only) 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. + // **Cold volume**: 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.
**Hot volume**: you cannot change the size of a hot volume. Size *int32 `json:"Size,omitempty"` // The ID of the volume you want to update. VolumeId string `json:"VolumeId"` - // (cold volume only) The new type of the volume (`standard` \\| `io1` \\| `gp2`). This modification is instantaneous. If you update to an `io1` volume, you must also specify the `Iops` parameter. + // **Cold volume**: the new type of the volume (`standard` \\| `io1` \\| `gp2`). This modification is instantaneous. If you update to an `io1` volume, you must also specify the `Iops` parameter.
**Hot volume**: you cannot change the type of a hot volume. VolumeType *string `json:"VolumeType,omitempty"` } diff --git a/v2/model_update_volume_response.go b/v2/model_update_volume_response.go index b241c51a0..1cb50da5d 100644 --- a/v2/model_update_volume_response.go +++ b/v2/model_update_volume_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_update_vpn_connection_request.go b/v2/model_update_vpn_connection_request.go index 7dd9306bf..913e71018 100644 --- a/v2/model_update_vpn_connection_request.go +++ b/v2/model_update_vpn_connection_request.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -24,8 +24,8 @@ type UpdateVpnConnectionRequest struct { // The ID of the virtual gateway. VirtualGatewayId *string `json:"VirtualGatewayId,omitempty"` // The ID of the VPN connection you want to modify. - VpnConnectionId string `json:"VpnConnectionId"` - VpnOptions *VpnOptions `json:"VpnOptions,omitempty"` + VpnConnectionId string `json:"VpnConnectionId"` + VpnOptions *VpnOptionsToUpdate `json:"VpnOptions,omitempty"` } // NewUpdateVpnConnectionRequest instantiates a new UpdateVpnConnectionRequest object @@ -167,9 +167,9 @@ func (o *UpdateVpnConnectionRequest) SetVpnConnectionId(v string) { } // GetVpnOptions returns the VpnOptions field value if set, zero value otherwise. -func (o *UpdateVpnConnectionRequest) GetVpnOptions() VpnOptions { +func (o *UpdateVpnConnectionRequest) GetVpnOptions() VpnOptionsToUpdate { if o == nil || o.VpnOptions == nil { - var ret VpnOptions + var ret VpnOptionsToUpdate return ret } return *o.VpnOptions @@ -177,7 +177,7 @@ func (o *UpdateVpnConnectionRequest) GetVpnOptions() VpnOptions { // GetVpnOptionsOk returns a tuple with the VpnOptions field value if set, nil otherwise // and a boolean to check if the value has been set. -func (o *UpdateVpnConnectionRequest) GetVpnOptionsOk() (*VpnOptions, bool) { +func (o *UpdateVpnConnectionRequest) GetVpnOptionsOk() (*VpnOptionsToUpdate, bool) { if o == nil || o.VpnOptions == nil { return nil, false } @@ -193,8 +193,8 @@ func (o *UpdateVpnConnectionRequest) HasVpnOptions() bool { return false } -// SetVpnOptions gets a reference to the given VpnOptions and assigns it to the VpnOptions field. -func (o *UpdateVpnConnectionRequest) SetVpnOptions(v VpnOptions) { +// SetVpnOptions gets a reference to the given VpnOptionsToUpdate and assigns it to the VpnOptions field. +func (o *UpdateVpnConnectionRequest) SetVpnOptions(v VpnOptionsToUpdate) { o.VpnOptions = &v } diff --git a/v2/model_update_vpn_connection_response.go b/v2/model_update_vpn_connection_response.go index 01058e8ec..12b95af22 100644 --- a/v2/model_update_vpn_connection_response.go +++ b/v2/model_update_vpn_connection_response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_user.go b/v2/model_user.go index 72c977ed4..0f1d4debf 100644 --- a/v2/model_user.go +++ b/v2/model_user.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_vgw_telemetry.go b/v2/model_vgw_telemetry.go index e8bfd6d1d..489c7db55 100644 --- a/v2/model_vgw_telemetry.go +++ b/v2/model_vgw_telemetry.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_virtual_gateway.go b/v2/model_virtual_gateway.go index 4620d11b8..0386ce718 100644 --- a/v2/model_virtual_gateway.go +++ b/v2/model_virtual_gateway.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_vm.go b/v2/model_vm.go index 1b7c9eed6..f6563bfdf 100644 --- a/v2/model_vm.go +++ b/v2/model_vm.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -62,7 +62,7 @@ type Vm struct { PublicIp *string `json:"PublicIp,omitempty"` // The reservation ID of the VM. ReservationId *string `json:"ReservationId,omitempty"` - // The name of the root device for the VM (for example, `/dev/vda1`). + // The name of the root device for the VM (for example, `/dev/sda1`). RootDeviceName *string `json:"RootDeviceName,omitempty"` // The type of root device used by the VM (always `bsu`). RootDeviceType *string `json:"RootDeviceType,omitempty"` @@ -82,7 +82,7 @@ type Vm struct { VmId *string `json:"VmId,omitempty"` // 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. VmInitiatedShutdownBehavior *string `json:"VmInitiatedShutdownBehavior,omitempty"` - // The type of VM. For more information, see [Instance Types](https://docs.outscale.com/en/userguide/Instance-Types.html). + // The type of VM. For more information, see [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html). VmType *string `json:"VmType,omitempty"` } diff --git a/v2/model_vm_group.go b/v2/model_vm_group.go index 002af1f1c..cbbf8c64d 100644 --- a/v2/model_vm_group.go +++ b/v2/model_vm_group.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_vm_state.go b/v2/model_vm_state.go index 0d259e432..ac873d176 100644 --- a/v2/model_vm_state.go +++ b/v2/model_vm_state.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_vm_states.go b/v2/model_vm_states.go index 79c10dad4..c1755b055 100644 --- a/v2/model_vm_states.go +++ b/v2/model_vm_states.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_vm_template.go b/v2/model_vm_template.go index 91505f652..b123b7805 100644 --- a/v2/model_vm_template.go +++ b/v2/model_vm_template.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_vm_type.go b/v2/model_vm_type.go index 83fb2685b..a9c3a5d09 100644 --- a/v2/model_vm_type.go +++ b/v2/model_vm_type.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ @@ -19,6 +19,12 @@ import ( type VmType struct { // This parameter is not available. It is present in our API for the sake of historical compatibility with AWS. BsuOptimized *bool `json:"BsuOptimized,omitempty"` + // The type of ephemeral storage disk. + EphemeralsType *string `json:"EphemeralsType,omitempty"` + // The number of Ethernet interface available. + Eth *int32 `json:"Eth,omitempty"` + // The number of GPU available. + Gpu *int32 `json:"Gpu,omitempty"` // The maximum number of private IPs per network interface card (NIC). MaxPrivateIps *int32 `json:"MaxPrivateIps,omitempty"` // The amount of memory, in gibibytes. @@ -82,6 +88,102 @@ func (o *VmType) SetBsuOptimized(v bool) { o.BsuOptimized = &v } +// GetEphemeralsType returns the EphemeralsType field value if set, zero value otherwise. +func (o *VmType) GetEphemeralsType() string { + if o == nil || o.EphemeralsType == nil { + var ret string + return ret + } + return *o.EphemeralsType +} + +// GetEphemeralsTypeOk returns a tuple with the EphemeralsType field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VmType) GetEphemeralsTypeOk() (*string, bool) { + if o == nil || o.EphemeralsType == nil { + return nil, false + } + return o.EphemeralsType, true +} + +// HasEphemeralsType returns a boolean if a field has been set. +func (o *VmType) HasEphemeralsType() bool { + if o != nil && o.EphemeralsType != nil { + return true + } + + return false +} + +// SetEphemeralsType gets a reference to the given string and assigns it to the EphemeralsType field. +func (o *VmType) SetEphemeralsType(v string) { + o.EphemeralsType = &v +} + +// GetEth returns the Eth field value if set, zero value otherwise. +func (o *VmType) GetEth() int32 { + if o == nil || o.Eth == nil { + var ret int32 + return ret + } + return *o.Eth +} + +// GetEthOk returns a tuple with the Eth field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VmType) GetEthOk() (*int32, bool) { + if o == nil || o.Eth == nil { + return nil, false + } + return o.Eth, true +} + +// HasEth returns a boolean if a field has been set. +func (o *VmType) HasEth() bool { + if o != nil && o.Eth != nil { + return true + } + + return false +} + +// SetEth gets a reference to the given int32 and assigns it to the Eth field. +func (o *VmType) SetEth(v int32) { + o.Eth = &v +} + +// GetGpu returns the Gpu field value if set, zero value otherwise. +func (o *VmType) GetGpu() int32 { + if o == nil || o.Gpu == nil { + var ret int32 + return ret + } + return *o.Gpu +} + +// GetGpuOk returns a tuple with the Gpu field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VmType) GetGpuOk() (*int32, bool) { + if o == nil || o.Gpu == nil { + return nil, false + } + return o.Gpu, true +} + +// HasGpu returns a boolean if a field has been set. +func (o *VmType) HasGpu() bool { + if o != nil && o.Gpu != nil { + return true + } + + return false +} + +// SetGpu gets a reference to the given int32 and assigns it to the Gpu field. +func (o *VmType) SetGpu(v int32) { + o.Gpu = &v +} + // GetMaxPrivateIps returns the MaxPrivateIps field value if set, zero value otherwise. func (o *VmType) GetMaxPrivateIps() int32 { if o == nil || o.MaxPrivateIps == nil { @@ -279,6 +381,15 @@ func (o VmType) MarshalJSON() ([]byte, error) { if o.BsuOptimized != nil { toSerialize["BsuOptimized"] = o.BsuOptimized } + if o.EphemeralsType != nil { + toSerialize["EphemeralsType"] = o.EphemeralsType + } + if o.Eth != nil { + toSerialize["Eth"] = o.Eth + } + if o.Gpu != nil { + toSerialize["Gpu"] = o.Gpu + } if o.MaxPrivateIps != nil { toSerialize["MaxPrivateIps"] = o.MaxPrivateIps } diff --git a/v2/model_volume.go b/v2/model_volume.go index 5d000a848..7e31d135f 100644 --- a/v2/model_volume.go +++ b/v2/model_volume.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_vpn_connection.go b/v2/model_vpn_connection.go index 9f3e4ca11..a269a4b06 100644 --- a/v2/model_vpn_connection.go +++ b/v2/model_vpn_connection.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_vpn_options.go b/v2/model_vpn_options.go index 6a31e52dd..7e0c42583 100644 --- a/v2/model_vpn_options.go +++ b/v2/model_vpn_options.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/model_vpn_options_to_update.go b/v2/model_vpn_options_to_update.go new file mode 100644 index 000000000..fd0b3c22f --- /dev/null +++ b/v2/model_vpn_options_to_update.go @@ -0,0 +1,151 @@ +/* + * 3DS OUTSCALE API + * + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). + * + * API version: 1.28.5 + * Contact: support@outscale.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package osc + +import ( + "encoding/json" +) + +// VpnOptionsToUpdate Information about the VPN options. +type VpnOptionsToUpdate struct { + Phase2Options *Phase2OptionsToUpdate `json:"Phase2Options,omitempty"` + // The range of inside IPs for the tunnel. This must be a /30 CIDR block from the 169.254.254.0/24 range. + TunnelInsideIpRange *string `json:"TunnelInsideIpRange,omitempty"` +} + +// NewVpnOptionsToUpdate instantiates a new VpnOptionsToUpdate object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewVpnOptionsToUpdate() *VpnOptionsToUpdate { + this := VpnOptionsToUpdate{} + return &this +} + +// NewVpnOptionsToUpdateWithDefaults instantiates a new VpnOptionsToUpdate object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewVpnOptionsToUpdateWithDefaults() *VpnOptionsToUpdate { + this := VpnOptionsToUpdate{} + return &this +} + +// GetPhase2Options returns the Phase2Options field value if set, zero value otherwise. +func (o *VpnOptionsToUpdate) GetPhase2Options() Phase2OptionsToUpdate { + if o == nil || o.Phase2Options == nil { + var ret Phase2OptionsToUpdate + return ret + } + return *o.Phase2Options +} + +// GetPhase2OptionsOk returns a tuple with the Phase2Options field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VpnOptionsToUpdate) GetPhase2OptionsOk() (*Phase2OptionsToUpdate, bool) { + if o == nil || o.Phase2Options == nil { + return nil, false + } + return o.Phase2Options, true +} + +// HasPhase2Options returns a boolean if a field has been set. +func (o *VpnOptionsToUpdate) HasPhase2Options() bool { + if o != nil && o.Phase2Options != nil { + return true + } + + return false +} + +// SetPhase2Options gets a reference to the given Phase2OptionsToUpdate and assigns it to the Phase2Options field. +func (o *VpnOptionsToUpdate) SetPhase2Options(v Phase2OptionsToUpdate) { + o.Phase2Options = &v +} + +// GetTunnelInsideIpRange returns the TunnelInsideIpRange field value if set, zero value otherwise. +func (o *VpnOptionsToUpdate) GetTunnelInsideIpRange() string { + if o == nil || o.TunnelInsideIpRange == nil { + var ret string + return ret + } + return *o.TunnelInsideIpRange +} + +// GetTunnelInsideIpRangeOk returns a tuple with the TunnelInsideIpRange field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *VpnOptionsToUpdate) GetTunnelInsideIpRangeOk() (*string, bool) { + if o == nil || o.TunnelInsideIpRange == nil { + return nil, false + } + return o.TunnelInsideIpRange, true +} + +// HasTunnelInsideIpRange returns a boolean if a field has been set. +func (o *VpnOptionsToUpdate) HasTunnelInsideIpRange() bool { + if o != nil && o.TunnelInsideIpRange != nil { + return true + } + + return false +} + +// SetTunnelInsideIpRange gets a reference to the given string and assigns it to the TunnelInsideIpRange field. +func (o *VpnOptionsToUpdate) SetTunnelInsideIpRange(v string) { + o.TunnelInsideIpRange = &v +} + +func (o VpnOptionsToUpdate) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.Phase2Options != nil { + toSerialize["Phase2Options"] = o.Phase2Options + } + if o.TunnelInsideIpRange != nil { + toSerialize["TunnelInsideIpRange"] = o.TunnelInsideIpRange + } + return json.Marshal(toSerialize) +} + +type NullableVpnOptionsToUpdate struct { + value *VpnOptionsToUpdate + isSet bool +} + +func (v NullableVpnOptionsToUpdate) Get() *VpnOptionsToUpdate { + return v.value +} + +func (v *NullableVpnOptionsToUpdate) Set(val *VpnOptionsToUpdate) { + v.value = val + v.isSet = true +} + +func (v NullableVpnOptionsToUpdate) IsSet() bool { + return v.isSet +} + +func (v *NullableVpnOptionsToUpdate) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableVpnOptionsToUpdate(val *VpnOptionsToUpdate) *NullableVpnOptionsToUpdate { + return &NullableVpnOptionsToUpdate{value: val, isSet: true} +} + +func (v NullableVpnOptionsToUpdate) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableVpnOptionsToUpdate) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v2/model_with.go b/v2/model_with.go index c23b22951..7a7929240 100644 --- a/v2/model_with.go +++ b/v2/model_with.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/response.go b/v2/response.go index e1a27aa4f..500dc17fe 100644 --- a/v2/response.go +++ b/v2/response.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */ diff --git a/v2/utils.go b/v2/utils.go index 4858b868e..e2ebb771c 100644 --- a/v2/utils.go +++ b/v2/utils.go @@ -1,9 +1,9 @@ /* * 3DS OUTSCALE API * - * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api). + * Welcome to the OUTSCALE API documentation.
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

You can learn more about errors returned by the API in the dedicated [errors page](api/errors).

Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.

An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
# Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
> For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.
### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). * - * API version: 1.27 + * API version: 1.28.5 * Contact: support@outscale.com */