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)


3168
3169
3170
3171
3172
3173
3174
3175
3176
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3168

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)


3168
3169
3170
3171
3172
3173
3174
3175
3176
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3168

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


3168
3169
3170
3171
3172
3173
3174
3175
3176
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3168

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:



3168
3169
3170
3171
3172
3173
3174
3175
3176
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3168

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 IAM Identity Center application ID, if the portal uses IAM Identity Center.

Returns:

  • (String)


3168
3169
3170
3171
3172
3173
3174
3175
3176
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3168

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