Struct aws_sdk_ssooidc::operation::start_device_authorization::StartDeviceAuthorizationOutput

#[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)

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

impl StartDeviceAuthorizationOutput

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

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

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

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

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

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

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.

pub fn expires_in(&self) -> i32

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

pub fn interval(&self) -> i32

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

impl StartDeviceAuthorizationOutput

pub fn builder() -> StartDeviceAuthorizationOutputBuilder

Creates a new builder-style object to manufacture StartDeviceAuthorizationOutput.

Trait Implementations

impl Clone for StartDeviceAuthorizationOutput

fn clone(&self) -> StartDeviceAuthorizationOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartDeviceAuthorizationOutput

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

Formats the value using the given formatter.

impl PartialEq for StartDeviceAuthorizationOutput

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for StartDeviceAuthorizationOutput

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

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

impl StructuralPartialEq for StartDeviceAuthorizationOutput