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

NAME

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

DESCRIPTION

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

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

SYNOPSIS

my $iotsitewise = Paws->service('IoTSiteWise');
my $UpdatePortalResponse = $iotsitewise->UpdatePortal(
  PortalContactEmail => 'MyEmail',
  PortalId           => 'MyID',
  PortalName         => 'MyName',
  RoleArn            => 'MyARN',
  Alarms             => {
    AlarmRoleArn          => 'MyARN',    # min: 1, max: 1600
    NotificationLambdaArn => 'MyARN',    # min: 1, max: 1600
  },    # OPTIONAL
  ClientToken             => 'MyClientToken',    # OPTIONAL
  NotificationSenderEmail => 'MyEmail',          # OPTIONAL
  PortalDescription       => 'MyDescription',    # OPTIONAL
  PortalLogoImage         => {
    File => {
      Data => 'BlobImageFileData',    # min: 1, max: 1500000
      Type => 'PNG',                  # values: PNG

    },    # OPTIONAL
    Id => 'MyID',    # min: 36, max: 36
  },    # OPTIONAL
);

# Results:
my $PortalStatus = $UpdatePortalResponse->PortalStatus;

# Returns a L<Paws::IoTSiteWise::UpdatePortalResponse> 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/UpdatePortal

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.

REQUIRED PortalContactEmail => Str

The AWS administrator's contact email address.

PortalDescription => Str

A new description for the portal.

REQUIRED PortalId => Str

The ID of the portal to update.

PortalLogoImage => Paws::IoTSiteWise::Image

REQUIRED PortalName => Str

A new 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.

SEE ALSO

This class forms part of Paws, documenting arguments for method UpdatePortal 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