aws_sdk_ssooidc::operation::start_device_authorization

Struct StartDeviceAuthorizationOutput

Source
#[non_exhaustive]
pub struct StartDeviceAuthorizationOutput { pub device_code: Option<String>, pub user_code: Option<String>, pub verification_uri: Option<String>, pub verification_uri_complete: Option<String>, pub expires_in: i32, pub interval: i32, /* private fields */ }

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§device_code: Option<String>

The short-lived code that is used by the device when polling for a session token.

§user_code: Option<String>

A one-time user verification code. This is needed to authorize an in-use device.

§verification_uri: Option<String>

The URI of the verification page that takes the userCode to authorize the device.

§verification_uri_complete: Option<String>

An alternate URL that the client can use to automatically launch a browser. This process skips the manual step in which the user visits the verification page and enters their code.

§expires_in: i32

Indicates the number of seconds in which the verification code will become invalid.

§interval: i32

Indicates the number of seconds the client must wait between attempts when polling for a session.

Implementations§

Source§

impl StartDeviceAuthorizationOutput

Source

pub fn device_code(&self) -> Option<&str>

The short-lived code that is used by the device when polling for a session token.

Source

pub fn user_code(&self) -> Option<&str>

A one-time user verification code. This is needed to authorize an in-use device.

Source

pub fn verification_uri(&self) -> Option<&str>

The URI of the verification page that takes the userCode to authorize the device.

Source

pub fn verification_uri_complete(&self) -> Option<&str>

An alternate URL that the client can use to automatically launch a browser. This process skips the manual step in which the user visits the verification page and enters their code.

Source

pub fn expires_in(&self) -> i32

Indicates the number of seconds in which the verification code will become invalid.

Source

pub fn interval(&self) -> i32

Indicates the number of seconds the client must wait between attempts when polling for a session.

Source§

impl StartDeviceAuthorizationOutput

Source

pub fn builder() -> StartDeviceAuthorizationOutputBuilder

Creates a new builder-style object to manufacture StartDeviceAuthorizationOutput.

Trait Implementations§

Source§

impl Clone for StartDeviceAuthorizationOutput

Source§

fn clone(&self) -> StartDeviceAuthorizationOutput

Returns a copy of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for StartDeviceAuthorizationOutput

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl PartialEq for StartDeviceAuthorizationOutput

Source§

fn eq(&self, other: &StartDeviceAuthorizationOutput) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl RequestId for StartDeviceAuthorizationOutput

Source§

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.
Source§

impl StructuralPartialEq for StartDeviceAuthorizationOutput

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more