« blib/lib/Paws/IoTSiteWise/DescribePortal.pm
↑ Summary
blib/lib/Paws/IoTSiteWise/DescribeProject.pm »
| 1 | |||
| 2 | package Paws::IoTSiteWise::DescribePortalResponse; | ||
| 3 | use Moose; | ||
| 4 | has Alarms => (is => 'ro', isa => 'Paws::IoTSiteWise::Alarms', traits => ['NameInRequest'], request_name => 'alarms'); | ||
| 5 | has NotificationSenderEmail => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'notificationSenderEmail'); | ||
| 6 | has PortalArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'portalArn', required => 1); | ||
| 7 | has PortalAuthMode => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'portalAuthMode'); | ||
| 8 | has PortalClientId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'portalClientId', required => 1); | ||
| 9 | has PortalContactEmail => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'portalContactEmail', required => 1); | ||
| 10 | has PortalCreationDate => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'portalCreationDate', required => 1); | ||
| 11 | has PortalDescription => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'portalDescription'); | ||
| 12 | has PortalId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'portalId', required => 1); | ||
| 13 | has PortalLastUpdateDate => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'portalLastUpdateDate', required => 1); | ||
| 14 | has PortalLogoImageLocation => (is => 'ro', isa => 'Paws::IoTSiteWise::ImageLocation', traits => ['NameInRequest'], request_name => 'portalLogoImageLocation'); | ||
| 15 | has PortalName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'portalName', required => 1); | ||
| 16 | has PortalStartUrl => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'portalStartUrl', required => 1); | ||
| 17 | has PortalStatus => (is => 'ro', isa => 'Paws::IoTSiteWise::PortalStatus', traits => ['NameInRequest'], request_name => 'portalStatus', required => 1); | ||
| 18 | has RoleArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'roleArn'); | ||
| 19 | |||
| 20 | has _request_id => (is => 'ro', isa => 'Str'); | ||
| 21 | 1; | ||
| 22 | |||
| 23 | ### main pod documentation begin ### | ||
| 24 | |||
| 25 | =head1 NAME | ||
| 26 | |||
| 27 | Paws::IoTSiteWise::DescribePortalResponse | ||
| 28 | |||
| 29 | =head1 ATTRIBUTES | ||
| 30 | |||
| 31 | |||
| 32 | =head2 Alarms => L<Paws::IoTSiteWise::Alarms> | ||
| 33 | |||
| 34 | Contains the configuration information of an alarm created in a AWS IoT | ||
| 35 | SiteWise Monitor portal. | ||
| 36 | |||
| 37 | |||
| 38 | =head2 NotificationSenderEmail => Str | ||
| 39 | |||
| 40 | The email address that sends alarm notifications. | ||
| 41 | |||
| 42 | |||
| 43 | =head2 B<REQUIRED> PortalArn => Str | ||
| 44 | |||
| 45 | The ARN | ||
| 46 | (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) | ||
| 47 | of the portal, which has the following format. | ||
| 48 | |||
| 49 | C<arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}> | ||
| 50 | |||
| 51 | |||
| 52 | =head2 PortalAuthMode => Str | ||
| 53 | |||
| 54 | The service to use to authenticate users to the portal. | ||
| 55 | |||
| 56 | Valid values are: C<"IAM">, C<"SSO"> | ||
| 57 | =head2 B<REQUIRED> PortalClientId => Str | ||
| 58 | |||
| 59 | The AWS SSO application generated client ID (used with AWS SSO APIs). | ||
| 60 | AWS IoT SiteWise includes C<portalClientId> for only portals that use | ||
| 61 | AWS SSO to authenticate users. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 B<REQUIRED> PortalContactEmail => Str | ||
| 65 | |||
| 66 | The AWS administrator's contact email address. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 B<REQUIRED> PortalCreationDate => Str | ||
| 70 | |||
| 71 | The date the portal was created, in Unix epoch time. | ||
| 72 | |||
| 73 | |||
| 74 | =head2 PortalDescription => Str | ||
| 75 | |||
| 76 | The portal's description. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 B<REQUIRED> PortalId => Str | ||
| 80 | |||
| 81 | The ID of the portal. | ||
| 82 | |||
| 83 | |||
| 84 | =head2 B<REQUIRED> PortalLastUpdateDate => Str | ||
| 85 | |||
| 86 | The date the portal was last updated, in Unix epoch time. | ||
| 87 | |||
| 88 | |||
| 89 | =head2 PortalLogoImageLocation => L<Paws::IoTSiteWise::ImageLocation> | ||
| 90 | |||
| 91 | The portal's logo image, which is available at a URL. | ||
| 92 | |||
| 93 | |||
| 94 | =head2 B<REQUIRED> PortalName => Str | ||
| 95 | |||
| 96 | The name of the portal. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 B<REQUIRED> PortalStartUrl => Str | ||
| 100 | |||
| 101 | The URL for the AWS IoT SiteWise Monitor portal. You can use this URL | ||
| 102 | to access portals that use AWS SSO for authentication. For portals that | ||
| 103 | use IAM for authentication, you must use the AWS IoT SiteWise console | ||
| 104 | to get a URL that you can use to access the portal. | ||
| 105 | |||
| 106 | |||
| 107 | =head2 B<REQUIRED> PortalStatus => L<Paws::IoTSiteWise::PortalStatus> | ||
| 108 | |||
| 109 | The current status of the portal, which contains a state and any error | ||
| 110 | message. | ||
| 111 | |||
| 112 | |||
| 113 | =head2 RoleArn => Str | ||
| 114 | |||
| 115 | The ARN | ||
| 116 | (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) | ||
| 117 | of the service role that allows the portal's users to access your AWS | ||
| 118 | IoT SiteWise resources on your behalf. For more information, see Using | ||
| 119 | service roles for AWS IoT SiteWise Monitor | ||
| 120 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html) | ||
| 121 | in the I<AWS IoT SiteWise User Guide>. | ||
| 122 | |||
| 123 | |||
| 124 | =head2 _request_id => Str | ||
| 125 | |||
| 126 | |||
| 127 | =cut | ||
| 128 |