AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::IoTSiteWise::Model::DescribePortalResult Class Reference

#include <DescribePortalResult.h>

Public Member Functions

 DescribePortalResult ()
 
 DescribePortalResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
DescribePortalResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::StringGetPortalId () const
 
void SetPortalId (const Aws::String &value)
 
void SetPortalId (Aws::String &&value)
 
void SetPortalId (const char *value)
 
DescribePortalResultWithPortalId (const Aws::String &value)
 
DescribePortalResultWithPortalId (Aws::String &&value)
 
DescribePortalResultWithPortalId (const char *value)
 
const Aws::StringGetPortalArn () const
 
void SetPortalArn (const Aws::String &value)
 
void SetPortalArn (Aws::String &&value)
 
void SetPortalArn (const char *value)
 
DescribePortalResultWithPortalArn (const Aws::String &value)
 
DescribePortalResultWithPortalArn (Aws::String &&value)
 
DescribePortalResultWithPortalArn (const char *value)
 
const Aws::StringGetPortalName () const
 
void SetPortalName (const Aws::String &value)
 
void SetPortalName (Aws::String &&value)
 
void SetPortalName (const char *value)
 
DescribePortalResultWithPortalName (const Aws::String &value)
 
DescribePortalResultWithPortalName (Aws::String &&value)
 
DescribePortalResultWithPortalName (const char *value)
 
const Aws::StringGetPortalDescription () const
 
void SetPortalDescription (const Aws::String &value)
 
void SetPortalDescription (Aws::String &&value)
 
void SetPortalDescription (const char *value)
 
DescribePortalResultWithPortalDescription (const Aws::String &value)
 
DescribePortalResultWithPortalDescription (Aws::String &&value)
 
DescribePortalResultWithPortalDescription (const char *value)
 
const Aws::StringGetPortalClientId () const
 
void SetPortalClientId (const Aws::String &value)
 
void SetPortalClientId (Aws::String &&value)
 
void SetPortalClientId (const char *value)
 
DescribePortalResultWithPortalClientId (const Aws::String &value)
 
DescribePortalResultWithPortalClientId (Aws::String &&value)
 
DescribePortalResultWithPortalClientId (const char *value)
 
const Aws::StringGetPortalStartUrl () const
 
void SetPortalStartUrl (const Aws::String &value)
 
void SetPortalStartUrl (Aws::String &&value)
 
void SetPortalStartUrl (const char *value)
 
DescribePortalResultWithPortalStartUrl (const Aws::String &value)
 
DescribePortalResultWithPortalStartUrl (Aws::String &&value)
 
DescribePortalResultWithPortalStartUrl (const char *value)
 
const Aws::StringGetPortalContactEmail () const
 
void SetPortalContactEmail (const Aws::String &value)
 
void SetPortalContactEmail (Aws::String &&value)
 
void SetPortalContactEmail (const char *value)
 
DescribePortalResultWithPortalContactEmail (const Aws::String &value)
 
DescribePortalResultWithPortalContactEmail (Aws::String &&value)
 
DescribePortalResultWithPortalContactEmail (const char *value)
 
const PortalStatusGetPortalStatus () const
 
void SetPortalStatus (const PortalStatus &value)
 
void SetPortalStatus (PortalStatus &&value)
 
DescribePortalResultWithPortalStatus (const PortalStatus &value)
 
DescribePortalResultWithPortalStatus (PortalStatus &&value)
 
const Aws::Utils::DateTimeGetPortalCreationDate () const
 
void SetPortalCreationDate (const Aws::Utils::DateTime &value)
 
void SetPortalCreationDate (Aws::Utils::DateTime &&value)
 
DescribePortalResultWithPortalCreationDate (const Aws::Utils::DateTime &value)
 
DescribePortalResultWithPortalCreationDate (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetPortalLastUpdateDate () const
 
void SetPortalLastUpdateDate (const Aws::Utils::DateTime &value)
 
void SetPortalLastUpdateDate (Aws::Utils::DateTime &&value)
 
DescribePortalResultWithPortalLastUpdateDate (const Aws::Utils::DateTime &value)
 
DescribePortalResultWithPortalLastUpdateDate (Aws::Utils::DateTime &&value)
 
const ImageLocationGetPortalLogoImageLocation () const
 
void SetPortalLogoImageLocation (const ImageLocation &value)
 
void SetPortalLogoImageLocation (ImageLocation &&value)
 
DescribePortalResultWithPortalLogoImageLocation (const ImageLocation &value)
 
DescribePortalResultWithPortalLogoImageLocation (ImageLocation &&value)
 
const Aws::StringGetRoleArn () const
 
void SetRoleArn (const Aws::String &value)
 
void SetRoleArn (Aws::String &&value)
 
void SetRoleArn (const char *value)
 
DescribePortalResultWithRoleArn (const Aws::String &value)
 
DescribePortalResultWithRoleArn (Aws::String &&value)
 
DescribePortalResultWithRoleArn (const char *value)
 
const AuthModeGetPortalAuthMode () const
 
void SetPortalAuthMode (const AuthMode &value)
 
void SetPortalAuthMode (AuthMode &&value)
 
DescribePortalResultWithPortalAuthMode (const AuthMode &value)
 
DescribePortalResultWithPortalAuthMode (AuthMode &&value)
 

Detailed Description

Definition at line 31 of file DescribePortalResult.h.

Constructor & Destructor Documentation

◆ DescribePortalResult() [1/2]

Aws::IoTSiteWise::Model::DescribePortalResult::DescribePortalResult ( )

◆ DescribePortalResult() [2/2]

Aws::IoTSiteWise::Model::DescribePortalResult::DescribePortalResult ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

Member Function Documentation

◆ GetPortalArn()

const Aws::String& Aws::IoTSiteWise::Model::DescribePortalResult::GetPortalArn ( ) const
inline

The ARN of the portal, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}

Definition at line 82 of file DescribePortalResult.h.

◆ GetPortalAuthMode()

const AuthMode& Aws::IoTSiteWise::Model::DescribePortalResult::GetPortalAuthMode ( ) const
inline

The service to use to authenticate users to the portal.

Definition at line 558 of file DescribePortalResult.h.

◆ GetPortalClientId()

const Aws::String& Aws::IoTSiteWise::Model::DescribePortalResult::GetPortalClientId ( ) const
inline

The AWS SSO application generated client ID (used with AWS SSO APIs). AWS IoT SiteWise includes portalClientId for only portals that use AWS SSO to authenticate users.

Definition at line 216 of file DescribePortalResult.h.

◆ GetPortalContactEmail()

const Aws::String& Aws::IoTSiteWise::Model::DescribePortalResult::GetPortalContactEmail ( ) const
inline

The AWS administrator's contact email address.

Definition at line 335 of file DescribePortalResult.h.

◆ GetPortalCreationDate()

const Aws::Utils::DateTime& Aws::IoTSiteWise::Model::DescribePortalResult::GetPortalCreationDate ( ) const
inline

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

Definition at line 402 of file DescribePortalResult.h.

◆ GetPortalDescription()

const Aws::String& Aws::IoTSiteWise::Model::DescribePortalResult::GetPortalDescription ( ) const
inline

The portal's description.

Definition at line 178 of file DescribePortalResult.h.

◆ GetPortalId()

const Aws::String& Aws::IoTSiteWise::Model::DescribePortalResult::GetPortalId ( ) const
inline

The ID of the portal.

Definition at line 42 of file DescribePortalResult.h.

◆ GetPortalLastUpdateDate()

const Aws::Utils::DateTime& Aws::IoTSiteWise::Model::DescribePortalResult::GetPortalLastUpdateDate ( ) const
inline

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

Definition at line 428 of file DescribePortalResult.h.

◆ GetPortalLogoImageLocation()

const ImageLocation& Aws::IoTSiteWise::Model::DescribePortalResult::GetPortalLogoImageLocation ( ) const
inline

The portal's logo image, which is available at a URL.

Definition at line 454 of file DescribePortalResult.h.

◆ GetPortalName()

const Aws::String& Aws::IoTSiteWise::Model::DescribePortalResult::GetPortalName ( ) const
inline

The name of the portal.

Definition at line 142 of file DescribePortalResult.h.

◆ GetPortalStartUrl()

const Aws::String& Aws::IoTSiteWise::Model::DescribePortalResult::GetPortalStartUrl ( ) const
inline

The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the CreatePresignedPortalUrl operation to create a URL that you can use to access the portal.

Definition at line 269 of file DescribePortalResult.h.

◆ GetPortalStatus()

const PortalStatus& Aws::IoTSiteWise::Model::DescribePortalResult::GetPortalStatus ( ) const
inline

The current status of the portal, which contains a state and any error message.

Definition at line 372 of file DescribePortalResult.h.

◆ GetRoleArn()

const Aws::String& Aws::IoTSiteWise::Model::DescribePortalResult::GetRoleArn ( ) const
inline

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

Definition at line 486 of file DescribePortalResult.h.

◆ operator=()

DescribePortalResult& Aws::IoTSiteWise::Model::DescribePortalResult::operator= ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

◆ SetPortalArn() [1/3]

void Aws::IoTSiteWise::Model::DescribePortalResult::SetPortalArn ( const Aws::String value)
inline

The ARN of the portal, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}

Definition at line 91 of file DescribePortalResult.h.

◆ SetPortalArn() [2/3]

void Aws::IoTSiteWise::Model::DescribePortalResult::SetPortalArn ( Aws::String &&  value)
inline

The ARN of the portal, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}

Definition at line 100 of file DescribePortalResult.h.

◆ SetPortalArn() [3/3]

void Aws::IoTSiteWise::Model::DescribePortalResult::SetPortalArn ( const char *  value)
inline

The ARN of the portal, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}

Definition at line 109 of file DescribePortalResult.h.

◆ SetPortalAuthMode() [1/2]

void Aws::IoTSiteWise::Model::DescribePortalResult::SetPortalAuthMode ( const AuthMode value)
inline

The service to use to authenticate users to the portal.

Definition at line 563 of file DescribePortalResult.h.

◆ SetPortalAuthMode() [2/2]

void Aws::IoTSiteWise::Model::DescribePortalResult::SetPortalAuthMode ( AuthMode &&  value)
inline

The service to use to authenticate users to the portal.

Definition at line 568 of file DescribePortalResult.h.

◆ SetPortalClientId() [1/3]

void Aws::IoTSiteWise::Model::DescribePortalResult::SetPortalClientId ( const Aws::String value)
inline

The AWS SSO application generated client ID (used with AWS SSO APIs). AWS IoT SiteWise includes portalClientId for only portals that use AWS SSO to authenticate users.

Definition at line 223 of file DescribePortalResult.h.

◆ SetPortalClientId() [2/3]

void Aws::IoTSiteWise::Model::DescribePortalResult::SetPortalClientId ( Aws::String &&  value)
inline

The AWS SSO application generated client ID (used with AWS SSO APIs). AWS IoT SiteWise includes portalClientId for only portals that use AWS SSO to authenticate users.

Definition at line 230 of file DescribePortalResult.h.

◆ SetPortalClientId() [3/3]

void Aws::IoTSiteWise::Model::DescribePortalResult::SetPortalClientId ( const char *  value)
inline

The AWS SSO application generated client ID (used with AWS SSO APIs). AWS IoT SiteWise includes portalClientId for only portals that use AWS SSO to authenticate users.

Definition at line 237 of file DescribePortalResult.h.

◆ SetPortalContactEmail() [1/3]

void Aws::IoTSiteWise::Model::DescribePortalResult::SetPortalContactEmail ( const Aws::String value)
inline

The AWS administrator's contact email address.

Definition at line 340 of file DescribePortalResult.h.

◆ SetPortalContactEmail() [2/3]

void Aws::IoTSiteWise::Model::DescribePortalResult::SetPortalContactEmail ( Aws::String &&  value)
inline

The AWS administrator's contact email address.

Definition at line 345 of file DescribePortalResult.h.

◆ SetPortalContactEmail() [3/3]

void Aws::IoTSiteWise::Model::DescribePortalResult::SetPortalContactEmail ( const char *  value)
inline

The AWS administrator's contact email address.

Definition at line 350 of file DescribePortalResult.h.

◆ SetPortalCreationDate() [1/2]

void Aws::IoTSiteWise::Model::DescribePortalResult::SetPortalCreationDate ( const Aws::Utils::DateTime value)
inline

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

Definition at line 407 of file DescribePortalResult.h.

◆ SetPortalCreationDate() [2/2]

void Aws::IoTSiteWise::Model::DescribePortalResult::SetPortalCreationDate ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 412 of file DescribePortalResult.h.

◆ SetPortalDescription() [1/3]

void Aws::IoTSiteWise::Model::DescribePortalResult::SetPortalDescription ( const Aws::String value)
inline

The portal's description.

Definition at line 183 of file DescribePortalResult.h.

◆ SetPortalDescription() [2/3]

void Aws::IoTSiteWise::Model::DescribePortalResult::SetPortalDescription ( Aws::String &&  value)
inline

The portal's description.

Definition at line 188 of file DescribePortalResult.h.

◆ SetPortalDescription() [3/3]

void Aws::IoTSiteWise::Model::DescribePortalResult::SetPortalDescription ( const char *  value)
inline

The portal's description.

Definition at line 193 of file DescribePortalResult.h.

◆ SetPortalId() [1/3]

void Aws::IoTSiteWise::Model::DescribePortalResult::SetPortalId ( const Aws::String value)
inline

The ID of the portal.

Definition at line 47 of file DescribePortalResult.h.

◆ SetPortalId() [2/3]

void Aws::IoTSiteWise::Model::DescribePortalResult::SetPortalId ( Aws::String &&  value)
inline

The ID of the portal.

Definition at line 52 of file DescribePortalResult.h.

◆ SetPortalId() [3/3]

void Aws::IoTSiteWise::Model::DescribePortalResult::SetPortalId ( const char *  value)
inline

The ID of the portal.

Definition at line 57 of file DescribePortalResult.h.

◆ SetPortalLastUpdateDate() [1/2]

void Aws::IoTSiteWise::Model::DescribePortalResult::SetPortalLastUpdateDate ( const Aws::Utils::DateTime value)
inline

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

Definition at line 433 of file DescribePortalResult.h.

◆ SetPortalLastUpdateDate() [2/2]

void Aws::IoTSiteWise::Model::DescribePortalResult::SetPortalLastUpdateDate ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 438 of file DescribePortalResult.h.

◆ SetPortalLogoImageLocation() [1/2]

void Aws::IoTSiteWise::Model::DescribePortalResult::SetPortalLogoImageLocation ( const ImageLocation value)
inline

The portal's logo image, which is available at a URL.

Definition at line 459 of file DescribePortalResult.h.

◆ SetPortalLogoImageLocation() [2/2]

void Aws::IoTSiteWise::Model::DescribePortalResult::SetPortalLogoImageLocation ( ImageLocation &&  value)
inline

The portal's logo image, which is available at a URL.

Definition at line 464 of file DescribePortalResult.h.

◆ SetPortalName() [1/3]

void Aws::IoTSiteWise::Model::DescribePortalResult::SetPortalName ( const Aws::String value)
inline

The name of the portal.

Definition at line 147 of file DescribePortalResult.h.

◆ SetPortalName() [2/3]

void Aws::IoTSiteWise::Model::DescribePortalResult::SetPortalName ( Aws::String &&  value)
inline

The name of the portal.

Definition at line 152 of file DescribePortalResult.h.

◆ SetPortalName() [3/3]

void Aws::IoTSiteWise::Model::DescribePortalResult::SetPortalName ( const char *  value)
inline

The name of the portal.

Definition at line 157 of file DescribePortalResult.h.

◆ SetPortalStartUrl() [1/3]

void Aws::IoTSiteWise::Model::DescribePortalResult::SetPortalStartUrl ( const Aws::String value)
inline

The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the CreatePresignedPortalUrl operation to create a URL that you can use to access the portal.

Definition at line 279 of file DescribePortalResult.h.

◆ SetPortalStartUrl() [2/3]

void Aws::IoTSiteWise::Model::DescribePortalResult::SetPortalStartUrl ( Aws::String &&  value)
inline

The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the CreatePresignedPortalUrl operation to create a URL that you can use to access the portal.

Definition at line 289 of file DescribePortalResult.h.

◆ SetPortalStartUrl() [3/3]

void Aws::IoTSiteWise::Model::DescribePortalResult::SetPortalStartUrl ( const char *  value)
inline

The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the CreatePresignedPortalUrl operation to create a URL that you can use to access the portal.

Definition at line 299 of file DescribePortalResult.h.

◆ SetPortalStatus() [1/2]

void Aws::IoTSiteWise::Model::DescribePortalResult::SetPortalStatus ( const PortalStatus value)
inline

The current status of the portal, which contains a state and any error message.

Definition at line 378 of file DescribePortalResult.h.

◆ SetPortalStatus() [2/2]

void Aws::IoTSiteWise::Model::DescribePortalResult::SetPortalStatus ( PortalStatus &&  value)
inline

The current status of the portal, which contains a state and any error message.

Definition at line 384 of file DescribePortalResult.h.

◆ SetRoleArn() [1/3]

void Aws::IoTSiteWise::Model::DescribePortalResult::SetRoleArn ( const Aws::String value)
inline

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

Definition at line 497 of file DescribePortalResult.h.

◆ SetRoleArn() [2/3]

void Aws::IoTSiteWise::Model::DescribePortalResult::SetRoleArn ( Aws::String &&  value)
inline

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

Definition at line 508 of file DescribePortalResult.h.

◆ SetRoleArn() [3/3]

void Aws::IoTSiteWise::Model::DescribePortalResult::SetRoleArn ( const char *  value)
inline

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

Definition at line 519 of file DescribePortalResult.h.

◆ WithPortalArn() [1/3]

DescribePortalResult& Aws::IoTSiteWise::Model::DescribePortalResult::WithPortalArn ( const Aws::String value)
inline

The ARN of the portal, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}

Definition at line 118 of file DescribePortalResult.h.

◆ WithPortalArn() [2/3]

DescribePortalResult& Aws::IoTSiteWise::Model::DescribePortalResult::WithPortalArn ( Aws::String &&  value)
inline

The ARN of the portal, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}

Definition at line 127 of file DescribePortalResult.h.

◆ WithPortalArn() [3/3]

DescribePortalResult& Aws::IoTSiteWise::Model::DescribePortalResult::WithPortalArn ( const char *  value)
inline

The ARN of the portal, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}

Definition at line 136 of file DescribePortalResult.h.

◆ WithPortalAuthMode() [1/2]

DescribePortalResult& Aws::IoTSiteWise::Model::DescribePortalResult::WithPortalAuthMode ( const AuthMode value)
inline

The service to use to authenticate users to the portal.

Definition at line 573 of file DescribePortalResult.h.

◆ WithPortalAuthMode() [2/2]

DescribePortalResult& Aws::IoTSiteWise::Model::DescribePortalResult::WithPortalAuthMode ( AuthMode &&  value)
inline

The service to use to authenticate users to the portal.

Definition at line 578 of file DescribePortalResult.h.

◆ WithPortalClientId() [1/3]

DescribePortalResult& Aws::IoTSiteWise::Model::DescribePortalResult::WithPortalClientId ( const Aws::String value)
inline

The AWS SSO application generated client ID (used with AWS SSO APIs). AWS IoT SiteWise includes portalClientId for only portals that use AWS SSO to authenticate users.

Definition at line 244 of file DescribePortalResult.h.

◆ WithPortalClientId() [2/3]

DescribePortalResult& Aws::IoTSiteWise::Model::DescribePortalResult::WithPortalClientId ( Aws::String &&  value)
inline

The AWS SSO application generated client ID (used with AWS SSO APIs). AWS IoT SiteWise includes portalClientId for only portals that use AWS SSO to authenticate users.

Definition at line 251 of file DescribePortalResult.h.

◆ WithPortalClientId() [3/3]

DescribePortalResult& Aws::IoTSiteWise::Model::DescribePortalResult::WithPortalClientId ( const char *  value)
inline

The AWS SSO application generated client ID (used with AWS SSO APIs). AWS IoT SiteWise includes portalClientId for only portals that use AWS SSO to authenticate users.

Definition at line 258 of file DescribePortalResult.h.

◆ WithPortalContactEmail() [1/3]

DescribePortalResult& Aws::IoTSiteWise::Model::DescribePortalResult::WithPortalContactEmail ( const Aws::String value)
inline

The AWS administrator's contact email address.

Definition at line 355 of file DescribePortalResult.h.

◆ WithPortalContactEmail() [2/3]

DescribePortalResult& Aws::IoTSiteWise::Model::DescribePortalResult::WithPortalContactEmail ( Aws::String &&  value)
inline

The AWS administrator's contact email address.

Definition at line 360 of file DescribePortalResult.h.

◆ WithPortalContactEmail() [3/3]

DescribePortalResult& Aws::IoTSiteWise::Model::DescribePortalResult::WithPortalContactEmail ( const char *  value)
inline

The AWS administrator's contact email address.

Definition at line 365 of file DescribePortalResult.h.

◆ WithPortalCreationDate() [1/2]

DescribePortalResult& Aws::IoTSiteWise::Model::DescribePortalResult::WithPortalCreationDate ( const Aws::Utils::DateTime value)
inline

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

Definition at line 417 of file DescribePortalResult.h.

◆ WithPortalCreationDate() [2/2]

DescribePortalResult& Aws::IoTSiteWise::Model::DescribePortalResult::WithPortalCreationDate ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 422 of file DescribePortalResult.h.

◆ WithPortalDescription() [1/3]

DescribePortalResult& Aws::IoTSiteWise::Model::DescribePortalResult::WithPortalDescription ( const Aws::String value)
inline

The portal's description.

Definition at line 198 of file DescribePortalResult.h.

◆ WithPortalDescription() [2/3]

DescribePortalResult& Aws::IoTSiteWise::Model::DescribePortalResult::WithPortalDescription ( Aws::String &&  value)
inline

The portal's description.

Definition at line 203 of file DescribePortalResult.h.

◆ WithPortalDescription() [3/3]

DescribePortalResult& Aws::IoTSiteWise::Model::DescribePortalResult::WithPortalDescription ( const char *  value)
inline

The portal's description.

Definition at line 208 of file DescribePortalResult.h.

◆ WithPortalId() [1/3]

DescribePortalResult& Aws::IoTSiteWise::Model::DescribePortalResult::WithPortalId ( const Aws::String value)
inline

The ID of the portal.

Definition at line 62 of file DescribePortalResult.h.

◆ WithPortalId() [2/3]

DescribePortalResult& Aws::IoTSiteWise::Model::DescribePortalResult::WithPortalId ( Aws::String &&  value)
inline

The ID of the portal.

Definition at line 67 of file DescribePortalResult.h.

◆ WithPortalId() [3/3]

DescribePortalResult& Aws::IoTSiteWise::Model::DescribePortalResult::WithPortalId ( const char *  value)
inline

The ID of the portal.

Definition at line 72 of file DescribePortalResult.h.

◆ WithPortalLastUpdateDate() [1/2]

DescribePortalResult& Aws::IoTSiteWise::Model::DescribePortalResult::WithPortalLastUpdateDate ( const Aws::Utils::DateTime value)
inline

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

Definition at line 443 of file DescribePortalResult.h.

◆ WithPortalLastUpdateDate() [2/2]

DescribePortalResult& Aws::IoTSiteWise::Model::DescribePortalResult::WithPortalLastUpdateDate ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 448 of file DescribePortalResult.h.

◆ WithPortalLogoImageLocation() [1/2]

DescribePortalResult& Aws::IoTSiteWise::Model::DescribePortalResult::WithPortalLogoImageLocation ( const ImageLocation value)
inline

The portal's logo image, which is available at a URL.

Definition at line 469 of file DescribePortalResult.h.

◆ WithPortalLogoImageLocation() [2/2]

DescribePortalResult& Aws::IoTSiteWise::Model::DescribePortalResult::WithPortalLogoImageLocation ( ImageLocation &&  value)
inline

The portal's logo image, which is available at a URL.

Definition at line 474 of file DescribePortalResult.h.

◆ WithPortalName() [1/3]

DescribePortalResult& Aws::IoTSiteWise::Model::DescribePortalResult::WithPortalName ( const Aws::String value)
inline

The name of the portal.

Definition at line 162 of file DescribePortalResult.h.

◆ WithPortalName() [2/3]

DescribePortalResult& Aws::IoTSiteWise::Model::DescribePortalResult::WithPortalName ( Aws::String &&  value)
inline

The name of the portal.

Definition at line 167 of file DescribePortalResult.h.

◆ WithPortalName() [3/3]

DescribePortalResult& Aws::IoTSiteWise::Model::DescribePortalResult::WithPortalName ( const char *  value)
inline

The name of the portal.

Definition at line 172 of file DescribePortalResult.h.

◆ WithPortalStartUrl() [1/3]

DescribePortalResult& Aws::IoTSiteWise::Model::DescribePortalResult::WithPortalStartUrl ( const Aws::String value)
inline

The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the CreatePresignedPortalUrl operation to create a URL that you can use to access the portal.

Definition at line 309 of file DescribePortalResult.h.

◆ WithPortalStartUrl() [2/3]

DescribePortalResult& Aws::IoTSiteWise::Model::DescribePortalResult::WithPortalStartUrl ( Aws::String &&  value)
inline

The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the CreatePresignedPortalUrl operation to create a URL that you can use to access the portal.

Definition at line 319 of file DescribePortalResult.h.

◆ WithPortalStartUrl() [3/3]

DescribePortalResult& Aws::IoTSiteWise::Model::DescribePortalResult::WithPortalStartUrl ( const char *  value)
inline

The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the CreatePresignedPortalUrl operation to create a URL that you can use to access the portal.

Definition at line 329 of file DescribePortalResult.h.

◆ WithPortalStatus() [1/2]

DescribePortalResult& Aws::IoTSiteWise::Model::DescribePortalResult::WithPortalStatus ( const PortalStatus value)
inline

The current status of the portal, which contains a state and any error message.

Definition at line 390 of file DescribePortalResult.h.

◆ WithPortalStatus() [2/2]

DescribePortalResult& Aws::IoTSiteWise::Model::DescribePortalResult::WithPortalStatus ( PortalStatus &&  value)
inline

The current status of the portal, which contains a state and any error message.

Definition at line 396 of file DescribePortalResult.h.

◆ WithRoleArn() [1/3]

DescribePortalResult& Aws::IoTSiteWise::Model::DescribePortalResult::WithRoleArn ( const Aws::String value)
inline

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

Definition at line 530 of file DescribePortalResult.h.

◆ WithRoleArn() [2/3]

DescribePortalResult& Aws::IoTSiteWise::Model::DescribePortalResult::WithRoleArn ( Aws::String &&  value)
inline

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

Definition at line 541 of file DescribePortalResult.h.

◆ WithRoleArn() [3/3]

DescribePortalResult& Aws::IoTSiteWise::Model::DescribePortalResult::WithRoleArn ( const char *  value)
inline

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

Definition at line 552 of file DescribePortalResult.h.


The documentation for this class was generated from the following file: