outscale_api/apis/
task_api.rs

1/*
2 * 3DS OUTSCALE API
3 *
4 * Welcome to the OUTSCALE API documentation.<br /> The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.<br /><br /> Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.<br /> Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.<br /><br /> Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/About-the-APIs.html) between AWS and the OUTSCALE API.<br /> You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.<br /><br /> An OpenAPI description of this API is also available for download: <button>[GitHub repository](https://github.com/outscale/osc-api)</button><br /> # Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.<br /> The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).<br /><br /> In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.<br />  > For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html).  See the code samples in each section of this documentation for specific examples in different programming languages.<br /> For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html).  > If you try to sign requests with an invalid access key four times in a row, further authentication attempts will be prevented for 1 minute. This lockout time increases 1 minute every four failed attempts, for up to 10 minutes.  ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.<br /> This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.<br /> In most cases, however, you can use the Cockpit web interface to retrieve them.<br />  > For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`&quot;&quot;`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands.  See the code samples in each section of this documentation for specific examples in different programming languages.  > If you try to sign requests with an invalid password four times in a row, further authentication attempts will be prevented for 1 minute. This lockout time increases 1 minute every four failed attempts, for up to 10 minutes.  ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.<br /> ### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.<br /> For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). # Pagination Tutorial You can learn more about the pagination methods for read calls in the dedicated [pagination tutorial](https://docs.outscale.com/en/userguide/Tutorial-Paginating-an-API-Request.html). # Error Codes Reference You can learn more about errors returned by the API in the dedicated [errors page](api-errors.html).
5 *
6 * The version of the OpenAPI document: 1.37.1
7 * Contact: support@outscale.com
8 * Generated by: https://openapi-generator.tech
9 */
10
11use super::{configuration, Error};
12use crate::apis::ResponseContent;
13
14/// struct for typed errors of method [`delete_export_task`]
15#[derive(Debug, Clone, Serialize, Deserialize)]
16#[serde(untagged)]
17pub enum DeleteExportTaskError {
18    UnknownValue(serde_json::Value),
19}
20
21/// Deletes an export task.<br /> If the export task is not in the `active` or `pending` state, the command fails and an error is returned.
22pub fn delete_export_task(
23    configuration: &configuration::Configuration,
24    delete_export_task_request: Option<crate::models::DeleteExportTaskRequest>,
25) -> Result<crate::models::DeleteExportTaskResponse, Error<DeleteExportTaskError>> {
26    let local_var_configuration = configuration;
27
28    let local_var_client = &local_var_configuration.client;
29
30    let local_var_uri_str = format!("{}/DeleteExportTask", local_var_configuration.base_path);
31    let mut local_var_req_builder =
32        local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str());
33
34    if let Some(ref local_var_aws_v4_key) = local_var_configuration.aws_v4_key {
35        let local_var_new_headers = match local_var_aws_v4_key.sign(
36            &local_var_uri_str,
37            "POST",
38            &serde_json::to_string(&delete_export_task_request)
39                .expect("param should serialize to string"),
40        ) {
41            Ok(new_headers) => new_headers,
42            Err(err) => return Err(Error::AWSV4SignatureError(err)),
43        };
44        for (local_var_name, local_var_value) in local_var_new_headers.iter() {
45            local_var_req_builder =
46                local_var_req_builder.header(local_var_name.as_str(), local_var_value.as_str());
47        }
48    }
49    if let Some(ref local_var_user_agent) = local_var_configuration.user_agent {
50        local_var_req_builder =
51            local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone());
52    }
53    if let Some(ref local_var_apikey) = local_var_configuration.api_key {
54        let local_var_key = local_var_apikey.key.clone();
55        let local_var_value = match local_var_apikey.prefix {
56            Some(ref local_var_prefix) => format!("{} {}", local_var_prefix, local_var_key),
57            None => local_var_key,
58        };
59        local_var_req_builder = local_var_req_builder.header("Authorization", local_var_value);
60    };
61    local_var_req_builder = local_var_req_builder.json(&delete_export_task_request);
62
63    let local_var_req = local_var_req_builder.build()?;
64    let local_var_resp = local_var_client.execute(local_var_req)?;
65
66    let local_var_status = local_var_resp.status();
67    let local_var_content = local_var_resp.text()?;
68
69    if !local_var_status.is_client_error() && !local_var_status.is_server_error() {
70        serde_json::from_str(&local_var_content).map_err(Error::from)
71    } else {
72        let local_var_entity: Option<DeleteExportTaskError> =
73            serde_json::from_str(&local_var_content).ok();
74        let local_var_error = ResponseContent {
75            status: local_var_status,
76            content: local_var_content,
77            entity: local_var_entity,
78        };
79        Err(Error::ResponseError(local_var_error))
80    }
81}
outscale_api/apis/task_api.rs

outscale_api/apis/
task_api.rs
