aws_sdk_grafana/client/
create_workspace_api_key.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`CreateWorkspaceApiKey`](crate::operation::create_workspace_api_key::builders::CreateWorkspaceApiKeyFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`key_name(impl Into<String>)`](crate::operation::create_workspace_api_key::builders::CreateWorkspaceApiKeyFluentBuilder::key_name) / [`set_key_name(Option<String>)`](crate::operation::create_workspace_api_key::builders::CreateWorkspaceApiKeyFluentBuilder::set_key_name):<br>required: **true**<br><p>Specifies the name of the key. Keynames must be unique to the workspace.</p><br>
7    ///   - [`key_role(impl Into<String>)`](crate::operation::create_workspace_api_key::builders::CreateWorkspaceApiKeyFluentBuilder::key_role) / [`set_key_role(Option<String>)`](crate::operation::create_workspace_api_key::builders::CreateWorkspaceApiKeyFluentBuilder::set_key_role):<br>required: **true**<br><p>Specifies the permission level of the key.</p> <p>Valid values: <code>ADMIN</code>|<code>EDITOR</code>|<code>VIEWER</code></p><br>
8    ///   - [`seconds_to_live(i32)`](crate::operation::create_workspace_api_key::builders::CreateWorkspaceApiKeyFluentBuilder::seconds_to_live) / [`set_seconds_to_live(Option<i32>)`](crate::operation::create_workspace_api_key::builders::CreateWorkspaceApiKeyFluentBuilder::set_seconds_to_live):<br>required: **true**<br><p>Specifies the time in seconds until the key expires. Keys can be valid for up to 30 days.</p><br>
9    ///   - [`workspace_id(impl Into<String>)`](crate::operation::create_workspace_api_key::builders::CreateWorkspaceApiKeyFluentBuilder::workspace_id) / [`set_workspace_id(Option<String>)`](crate::operation::create_workspace_api_key::builders::CreateWorkspaceApiKeyFluentBuilder::set_workspace_id):<br>required: **true**<br><p>The ID of the workspace to create an API key.</p><br>
10    /// - On success, responds with [`CreateWorkspaceApiKeyOutput`](crate::operation::create_workspace_api_key::CreateWorkspaceApiKeyOutput) with field(s):
11    ///   - [`key_name(String)`](crate::operation::create_workspace_api_key::CreateWorkspaceApiKeyOutput::key_name): <p>The name of the key that was created.</p>
12    ///   - [`key(String)`](crate::operation::create_workspace_api_key::CreateWorkspaceApiKeyOutput::key): <p>The key token. Use this value as a bearer token to authenticate HTTP requests to the workspace.</p>
13    ///   - [`workspace_id(String)`](crate::operation::create_workspace_api_key::CreateWorkspaceApiKeyOutput::workspace_id): <p>The ID of the workspace that the key is valid for.</p>
14    /// - On failure, responds with [`SdkError<CreateWorkspaceApiKeyError>`](crate::operation::create_workspace_api_key::CreateWorkspaceApiKeyError)
15    pub fn create_workspace_api_key(&self) -> crate::operation::create_workspace_api_key::builders::CreateWorkspaceApiKeyFluentBuilder {
16        crate::operation::create_workspace_api_key::builders::CreateWorkspaceApiKeyFluentBuilder::new(self.handle.clone())
17    }
18}
aws_sdk_grafana/client/create_workspace_api_key.rs

aws_sdk_grafana/client/
create_workspace_api_key.rs
