Struct PortalSummary 

#[non_exhaustive]
pub struct PortalSummary {
    pub id: String,
    pub name: String,
    pub description: Option<String>,
    pub start_url: String,
    pub creation_date: Option<DateTime>,
    pub last_update_date: Option<DateTime>,
    pub role_arn: Option<String>,
    pub status: Option<PortalStatus>,
    pub portal_type: Option<PortalType>,
}

Contains a portal summary.

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.

id: String

The ID of the portal.

name: String

The name of the portal.

description: Option<String>

The portal's description.

start_url: String

The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use IAM Identity Center for authentication. For portals that use IAM for authentication, you must use the IoT SiteWise console to get a URL that you can use to access the portal.

creation_date: Option<DateTime>

The date the portal was created, in Unix epoch time.

last_update_date: Option<DateTime>

The date the portal was last updated, in Unix epoch time.

role_arn: Option<String>

The ARN of the service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide.

status: Option<PortalStatus>

Contains information about the current status of a portal.

portal_type: Option<PortalType>

Define the type of portal. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.

Implementations

impl PortalSummary

pub fn id(&self) -> &str

The ID of the portal.

pub fn name(&self) -> &str

The name of the portal.

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

The portal's description.

pub fn start_url(&self) -> &str

The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use IAM Identity Center for authentication. For portals that use IAM for authentication, you must use the IoT SiteWise console to get a URL that you can use to access the portal.

pub fn creation_date(&self) -> Option<&DateTime>

The date the portal was created, in Unix epoch time.

pub fn last_update_date(&self) -> Option<&DateTime>

The date the portal was last updated, in Unix epoch time.

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

The ARN of the service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide.

pub fn status(&self) -> Option<&PortalStatus>

Contains information about the current status of a portal.

pub fn portal_type(&self) -> Option<&PortalType>

Define the type of portal. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.

impl PortalSummary

pub fn builder() -> PortalSummaryBuilder

Creates a new builder-style object to manufacture PortalSummary.

Trait Implementations

impl Clone for PortalSummary

fn clone(&self) -> PortalSummary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PortalSummary

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

Formats the value using the given formatter.

impl PartialEq for PortalSummary

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for PortalSummary