AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#portal_arnString

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

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

Returns:

  • (String)


2136
2137
2138
2139
2140
2141
2142
2143
2144
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2136

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

#portal_idString

The ID of the created portal.

Returns:

  • (String)


2136
2137
2138
2139
2140
2141
2142
2143
2144
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2136

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

#portal_start_urlString

The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use Amazon Web Services SSO 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)


2136
2137
2138
2139
2140
2141
2142
2143
2144
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2136

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

#portal_statusTypes::PortalStatus

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

Returns:



2136
2137
2138
2139
2140
2141
2142
2143
2144
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2136

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

#sso_application_idString

The associated Amazon Web Services SSO application ID, if the portal uses Amazon Web Services SSO.

Returns:

  • (String)


2136
2137
2138
2139
2140
2141
2142
2143
2144
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2136

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