Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. iotsitewise
  5. getPortal

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.iotsitewise.getPortal

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource schema for AWS::IoTSiteWise::Portal

    Using getPortal

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getPortal(args: GetPortalArgs, opts?: InvokeOptions): Promise<GetPortalResult>
function getPortalOutput(args: GetPortalOutputArgs, opts?: InvokeOptions): Output<GetPortalResult>
    def get_portal(portal_id: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetPortalResult
def get_portal_output(portal_id: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetPortalResult]
    func LookupPortal(ctx *Context, args *LookupPortalArgs, opts ...InvokeOption) (*LookupPortalResult, error)
func LookupPortalOutput(ctx *Context, args *LookupPortalOutputArgs, opts ...InvokeOption) LookupPortalResultOutput

    > Note: This function is named LookupPortal in the Go SDK.

    public static class GetPortal 
{
    public static Task<GetPortalResult> InvokeAsync(GetPortalArgs args, InvokeOptions? opts = null)
    public static Output<GetPortalResult> Invoke(GetPortalInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPortalResult> getPortal(GetPortalArgs args, InvokeOptions options)
public static Output<GetPortalResult> getPortal(GetPortalArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:iotsitewise:getPortal
  arguments:
    # arguments dictionary

    The following arguments are supported:

    PortalId string
    The ID of the portal.
    PortalId string
    The ID of the portal.
    portalId String
    The ID of the portal.
    portalId string
    The ID of the portal.
    portal_id str
    The ID of the portal.
    portalId String
    The ID of the portal.

    getPortal Result

    The following output properties are available:

    Alarms Pulumi.AwsNative.IoTSiteWise.Outputs.AlarmsProperties
    Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range.
    NotificationSenderEmail string
    The email address that sends alarm notifications.
    PortalArn string
    The ARN of the portal, which has the following format.
    PortalClientId string
    The AWS SSO application generated client ID (used with AWS SSO APIs).
    PortalContactEmail string
    The AWS administrator's contact email address.
    PortalDescription string
    A description for the portal.
    PortalId string
    The ID of the portal.
    PortalName string
    A friendly name for the portal.
    PortalStartUrl string
    The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.
    PortalTypeConfiguration Dictionary<string, Pulumi.AwsNative.IoTSiteWise.Outputs.PortalTypeEntry>
    RoleArn string
    The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    A list of key-value pairs that contain metadata for the portal.
    Alarms AlarmsProperties
    Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range.
    NotificationSenderEmail string
    The email address that sends alarm notifications.
    PortalArn string
    The ARN of the portal, which has the following format.
    PortalClientId string
    The AWS SSO application generated client ID (used with AWS SSO APIs).
    PortalContactEmail string
    The AWS administrator's contact email address.
    PortalDescription string
    A description for the portal.
    PortalId string
    The ID of the portal.
    PortalName string
    A friendly name for the portal.
    PortalStartUrl string
    The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.
    PortalTypeConfiguration map[string]PortalTypeEntry
    RoleArn string
    The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.
    Tags Tag
    A list of key-value pairs that contain metadata for the portal.
    alarms AlarmsProperties
    Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range.
    notificationSenderEmail String
    The email address that sends alarm notifications.
    portalArn String
    The ARN of the portal, which has the following format.
    portalClientId String
    The AWS SSO application generated client ID (used with AWS SSO APIs).
    portalContactEmail String
    The AWS administrator's contact email address.
    portalDescription String
    A description for the portal.
    portalId String
    The ID of the portal.
    portalName String
    A friendly name for the portal.
    portalStartUrl String
    The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.
    portalTypeConfiguration Map<String,PortalTypeEntry>
    roleArn String
    The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.
    tags List<Tag>
    A list of key-value pairs that contain metadata for the portal.
    alarms AlarmsProperties
    Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range.
    notificationSenderEmail string
    The email address that sends alarm notifications.
    portalArn string
    The ARN of the portal, which has the following format.
    portalClientId string
    The AWS SSO application generated client ID (used with AWS SSO APIs).
    portalContactEmail string
    The AWS administrator's contact email address.
    portalDescription string
    A description for the portal.
    portalId string
    The ID of the portal.
    portalName string
    A friendly name for the portal.
    portalStartUrl string
    The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.
    portalTypeConfiguration {[key: string]: PortalTypeEntry}
    roleArn string
    The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.
    tags Tag[]
    A list of key-value pairs that contain metadata for the portal.
    alarms AlarmsProperties
    Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range.
    notification_sender_email str
    The email address that sends alarm notifications.
    portal_arn str
    The ARN of the portal, which has the following format.
    portal_client_id str
    The AWS SSO application generated client ID (used with AWS SSO APIs).
    portal_contact_email str
    The AWS administrator's contact email address.
    portal_description str
    A description for the portal.
    portal_id str
    The ID of the portal.
    portal_name str
    A friendly name for the portal.
    portal_start_url str
    The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.
    portal_type_configuration Mapping[str, PortalTypeEntry]
    role_arn str
    The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.
    tags Sequence[root_Tag]
    A list of key-value pairs that contain metadata for the portal.
    alarms Property Map
    Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range.
    notificationSenderEmail String
    The email address that sends alarm notifications.
    portalArn String
    The ARN of the portal, which has the following format.
    portalClientId String
    The AWS SSO application generated client ID (used with AWS SSO APIs).
    portalContactEmail String
    The AWS administrator's contact email address.
    portalDescription String
    A description for the portal.
    portalId String
    The ID of the portal.
    portalName String
    A friendly name for the portal.
    portalStartUrl String
    The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.
    portalTypeConfiguration Map<Property Map>
    roleArn String
    The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.
    tags List<Property Map>
    A list of key-value pairs that contain metadata for the portal.

    Supporting Types

    AlarmsProperties

    AlarmRoleArn string
    The ARN of the IAM role that allows the alarm to perform actions and access AWS resources and services, such as AWS IoT Events.
    NotificationLambdaArn string
    The ARN of the AWS Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the AWS IoT Events Developer Guide.
    AlarmRoleArn string
    The ARN of the IAM role that allows the alarm to perform actions and access AWS resources and services, such as AWS IoT Events.
    NotificationLambdaArn string
    The ARN of the AWS Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the AWS IoT Events Developer Guide.
    alarmRoleArn String
    The ARN of the IAM role that allows the alarm to perform actions and access AWS resources and services, such as AWS IoT Events.
    notificationLambdaArn String
    The ARN of the AWS Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the AWS IoT Events Developer Guide.
    alarmRoleArn string
    The ARN of the IAM role that allows the alarm to perform actions and access AWS resources and services, such as AWS IoT Events.
    notificationLambdaArn string
    The ARN of the AWS Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the AWS IoT Events Developer Guide.
    alarm_role_arn str
    The ARN of the IAM role that allows the alarm to perform actions and access AWS resources and services, such as AWS IoT Events.
    notification_lambda_arn str
    The ARN of the AWS Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the AWS IoT Events Developer Guide.
    alarmRoleArn String
    The ARN of the IAM role that allows the alarm to perform actions and access AWS resources and services, such as AWS IoT Events.
    notificationLambdaArn String
    The ARN of the AWS Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the AWS IoT Events Developer Guide.

    PortalTypeEntry

    PortalTools List<string>
    The array of tools associated with the specified portal type. The possible values are ASSISTANT and DASHBOARD .
    PortalTools []string
    The array of tools associated with the specified portal type. The possible values are ASSISTANT and DASHBOARD .
    portalTools List<String>
    The array of tools associated with the specified portal type. The possible values are ASSISTANT and DASHBOARD .
    portalTools string[]
    The array of tools associated with the specified portal type. The possible values are ASSISTANT and DASHBOARD .
    portal_tools Sequence[str]
    The array of tools associated with the specified portal type. The possible values are ASSISTANT and DASHBOARD .
    portalTools List<String>
    The array of tools associated with the specified portal type. The possible values are ASSISTANT and DASHBOARD .

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
    pulumi/pulumi-aws-native