Class: Aws::IoTSiteWise::Types::CreatePortalResponse

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-iotsitewise/types.rb

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#portal_arn ⇒ String

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

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

Returns:

  • (String) 


4666
4667
4668
4669
4670
4671
4672
4673
4674
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 4666

class CreatePortalResponse < Struct.new(
  :portal_id,
  :portal_arn,
  :portal_start_url,
  :portal_status,
  :sso_application_id)
  SENSITIVE = []
  include Aws::Structure
end

#portal_id ⇒ String

The ID of the created portal.

Returns:

  • (String) 


4666
4667
4668
4669
4670
4671
4672
4673
4674
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 4666

class CreatePortalResponse < Struct.new(
  :portal_id,
  :portal_arn,
  :portal_start_url,
  :portal_status,
  :sso_application_id)
  SENSITIVE = []
  include Aws::Structure
end

#portal_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.

Returns:

  • (String) 


4666
4667
4668
4669
4670
4671
4672
4673
4674
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 4666

class CreatePortalResponse < Struct.new(
  :portal_id,
  :portal_arn,
  :portal_start_url,
  :portal_status,
  :sso_application_id)
  SENSITIVE = []
  include Aws::Structure
end

#portal_status ⇒ Types::PortalStatus

The status of the portal, which contains a state (CREATING after successfully calling this operation) and any error message.

Returns:



4666
4667
4668
4669
4670
4671
4672
4673
4674
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 4666

class CreatePortalResponse < Struct.new(
  :portal_id,
  :portal_arn,
  :portal_start_url,
  :portal_status,
  :sso_application_id)
  SENSITIVE = []
  include Aws::Structure
end

#sso_application_id ⇒ String

The associated IAM Identity Center application ID, if the portal uses IAM Identity Center.

Returns:

  • (String) 


4666
4667
4668
4669
4670
4671
4672
4673
4674
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 4666

class CreatePortalResponse < Struct.new(
  :portal_id,
  :portal_arn,
  :portal_start_url,
  :portal_status,
  :sso_application_id)
  SENSITIVE = []
  include Aws::Structure
end