/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::IoTSiteWise::CreatePortal

NAME

Paws::IoTSiteWise::CreatePortal - Arguments for method CreatePortal on Paws::IoTSiteWise

DESCRIPTION

This class represents the parameters used for calling the method CreatePortal on the AWS IoT SiteWise service. Use the attributes of this class as arguments to method CreatePortal.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreatePortal.

SYNOPSIS

my $iotsitewise = Paws->service('IoTSiteWise');
my $CreatePortalResponse = $iotsitewise->CreatePortal(
  PortalContactEmail => 'MyEmail',
  PortalName         => 'MyName',
  RoleArn            => 'MyARN',
  Alarms             => {
    AlarmRoleArn          => 'MyARN',    # min: 1, max: 1600
    NotificationLambdaArn => 'MyARN',    # min: 1, max: 1600
  },    # OPTIONAL
  ClientToken             => 'MyClientToken',    # OPTIONAL
  NotificationSenderEmail => 'MyEmail',          # OPTIONAL
  PortalAuthMode          => 'IAM',              # OPTIONAL
  PortalDescription       => 'MyDescription',    # OPTIONAL
  PortalLogoImageFile     => {
    Data => 'BlobImageFileData',                 # min: 1, max: 1500000
    Type => 'PNG',                               # values: PNG

  },    # OPTIONAL
  Tags => {
    'MyTagKey' => 'MyTagValue',    # key: min: 1, max: 128, value: max: 256
  },    # OPTIONAL
);

# Results:
my $PortalArn        = $CreatePortalResponse->PortalArn;
my $PortalId         = $CreatePortalResponse->PortalId;
my $PortalStartUrl   = $CreatePortalResponse->PortalStartUrl;
my $PortalStatus     = $CreatePortalResponse->PortalStatus;
my $SsoApplicationId = $CreatePortalResponse->SsoApplicationId;

# Returns a L<Paws::IoTSiteWise::CreatePortalResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise/CreatePortal

ATTRIBUTES

Alarms => Paws::IoTSiteWise::Alarms

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. For more information, see .

ClientToken => Str

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

NotificationSenderEmail => Str

The email address that sends alarm notifications.

If you use the AWS IoT Events managed AWS Lambda function to manage your emails, you must verify the sender email address in Amazon SES (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html).

PortalAuthMode => Str

The service to use to authenticate users to the portal. Choose from the following options:

  • SSO – The portal uses AWS Single Sign-On to authenticate users and manage user permissions. Before you can create a portal that uses AWS SSO, you must enable AWS SSO. For more information, see Enabling AWS SSO (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso) in the AWS IoT SiteWise User Guide. This option is only available in AWS Regions other than the China Regions.

  • IAM – The portal uses AWS Identity and Access Management (IAM) to authenticate users and manage user permissions. This option is only available in the China Regions.

You can't change this value after you create a portal.

Default: SSO

Valid values are: "IAM", "SSO"

REQUIRED PortalContactEmail => Str

The AWS administrator's contact email address.

PortalDescription => Str

A description for the portal.

PortalLogoImageFile => Paws::IoTSiteWise::ImageFile

A logo image to display in the portal. Upload a square, high-resolution image. The image is displayed on a dark background.

REQUIRED PortalName => Str

A friendly name for the portal.

REQUIRED RoleArn => Str

The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of a 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html) in the AWS IoT SiteWise User Guide.

Tags => Paws::IoTSiteWise::TagMap

A list of key-value pairs that contain metadata for the portal. For more information, see Tagging your AWS IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) in the AWS IoT SiteWise User Guide.

SEE ALSO

This class forms part of Paws, documenting arguments for method CreatePortal in Paws::IoTSiteWise

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues