aws_sdk_connect/client/
create_auth_code.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 [`CreateAuthCode`](crate::operation::create_auth_code::builders::CreateAuthCodeFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`instance_id(impl Into<String>)`](crate::operation::create_auth_code::builders::CreateAuthCodeFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::create_auth_code::builders::CreateAuthCodeFluentBuilder::set_instance_id):<br>required: **true**<br><p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p><br>
7    ///   - [`scope(AuthScope)`](crate::operation::create_auth_code::builders::CreateAuthCodeFluentBuilder::scope) / [`set_scope(Option<AuthScope>)`](crate::operation::create_auth_code::builders::CreateAuthCodeFluentBuilder::set_scope):<br>required: **true**<br><p>The scope for the authorization code. Defines the permissions and access boundaries for the session.</p><br>
8    ///   - [`max_session_duration_minutes(i32)`](crate::operation::create_auth_code::builders::CreateAuthCodeFluentBuilder::max_session_duration_minutes) / [`set_max_session_duration_minutes(Option<i32>)`](crate::operation::create_auth_code::builders::CreateAuthCodeFluentBuilder::set_max_session_duration_minutes):<br>required: **false**<br><p>The maximum duration of the session, in minutes. Minimum value of 1440 (24 hours). Maximum value of 43200 (30 days). If no value is provided, the session will expire after 400 days.</p><br>
9    ///   - [`session_inactivity_duration_minutes(i32)`](crate::operation::create_auth_code::builders::CreateAuthCodeFluentBuilder::session_inactivity_duration_minutes) / [`set_session_inactivity_duration_minutes(Option<i32>)`](crate::operation::create_auth_code::builders::CreateAuthCodeFluentBuilder::set_session_inactivity_duration_minutes):<br>required: **true**<br><p>The duration of inactivity, in minutes, after which the session expires. Minimum value of 1440 (24 hours). Maximum value of 20160 (14 days).</p><br>
10    /// - On success, responds with [`CreateAuthCodeOutput`](crate::operation::create_auth_code::CreateAuthCodeOutput) with field(s):
11    ///   - [`auth_code(Option<String>)`](crate::operation::create_auth_code::CreateAuthCodeOutput::auth_code): <p>The authorization code to use for establishing a session.</p>
12    ///   - [`session_id(Option<String>)`](crate::operation::create_auth_code::CreateAuthCodeOutput::session_id): <p>The identifier of the session created with the authorization code.</p>
13    ///   - [`entity_type(Option<AuthCodeEntityType>)`](crate::operation::create_auth_code::CreateAuthCodeOutput::entity_type): <p>The type of entity associated with the authorization code.</p>
14    ///   - [`entity_id(Option<String>)`](crate::operation::create_auth_code::CreateAuthCodeOutput::entity_id): <p>The identifier of the entity associated with the authorization code.</p>
15    /// - On failure, responds with [`SdkError<CreateAuthCodeError>`](crate::operation::create_auth_code::CreateAuthCodeError)
16    pub fn create_auth_code(&self) -> crate::operation::create_auth_code::builders::CreateAuthCodeFluentBuilder {
17        crate::operation::create_auth_code::builders::CreateAuthCodeFluentBuilder::new(self.handle.clone())
18    }
19}
aws_sdk_connect/client/create_auth_code.rs

aws_sdk_connect/client/
create_auth_code.rs
