« blib/lib/Paws/IoTSiteWise/DescribeLoggingOptionsResponse.pm
↑ Summary
blib/lib/Paws/IoTSiteWise/DescribePortalResponse.pm »
| 1 | |||
| 2 | package Paws::IoTSiteWise::DescribePortal; | ||
| 3 | use Moose; | ||
| 4 | has PortalId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'portalId', required => 1); | ||
| 5 | |||
| 6 | use MooseX::ClassAttribute; | ||
| 7 | |||
| 8 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribePortal'); | ||
| 9 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/portals/{portalId}'); | ||
| 10 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoTSiteWise::DescribePortalResponse'); | ||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::IoTSiteWise::DescribePortal - Arguments for method DescribePortal on L<Paws::IoTSiteWise> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method DescribePortal on the | ||
| 23 | L<AWS IoT SiteWise|Paws::IoTSiteWise> service. Use the attributes of this class | ||
| 24 | as arguments to method DescribePortal. | ||
| 25 | |||
| 26 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribePortal. | ||
| 27 | |||
| 28 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $iotsitewise = Paws->service('IoTSiteWise'); | ||
| 31 | my $DescribePortalResponse = $iotsitewise->DescribePortal( | ||
| 32 | PortalId => 'MyID', | ||
| 33 | |||
| 34 | ); | ||
| 35 | |||
| 36 | # Results: | ||
| 37 | my $Alarms = $DescribePortalResponse->Alarms; | ||
| 38 | my $NotificationSenderEmail = | ||
| 39 | $DescribePortalResponse->NotificationSenderEmail; | ||
| 40 | my $PortalArn = $DescribePortalResponse->PortalArn; | ||
| 41 | my $PortalAuthMode = $DescribePortalResponse->PortalAuthMode; | ||
| 42 | my $PortalClientId = $DescribePortalResponse->PortalClientId; | ||
| 43 | my $PortalContactEmail = $DescribePortalResponse->PortalContactEmail; | ||
| 44 | my $PortalCreationDate = $DescribePortalResponse->PortalCreationDate; | ||
| 45 | my $PortalDescription = $DescribePortalResponse->PortalDescription; | ||
| 46 | my $PortalId = $DescribePortalResponse->PortalId; | ||
| 47 | my $PortalLastUpdateDate = $DescribePortalResponse->PortalLastUpdateDate; | ||
| 48 | my $PortalLogoImageLocation = | ||
| 49 | $DescribePortalResponse->PortalLogoImageLocation; | ||
| 50 | my $PortalName = $DescribePortalResponse->PortalName; | ||
| 51 | my $PortalStartUrl = $DescribePortalResponse->PortalStartUrl; | ||
| 52 | my $PortalStatus = $DescribePortalResponse->PortalStatus; | ||
| 53 | my $RoleArn = $DescribePortalResponse->RoleArn; | ||
| 54 | |||
| 55 | # Returns a L<Paws::IoTSiteWise::DescribePortalResponse> object. | ||
| 56 | |||
| 57 | 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. | ||
| 58 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iotsitewise/DescribePortal> | ||
| 59 | |||
| 60 | =head1 ATTRIBUTES | ||
| 61 | |||
| 62 | |||
| 63 | =head2 B<REQUIRED> PortalId => Str | ||
| 64 | |||
| 65 | The ID of the portal. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head1 SEE ALSO | ||
| 71 | |||
| 72 | This class forms part of L<Paws>, documenting arguments for method DescribePortal in L<Paws::IoTSiteWise> | ||
| 73 | |||
| 74 | =head1 BUGS and CONTRIBUTIONS | ||
| 75 | |||
| 76 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 77 | |||
| 78 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 79 | |||
| 80 | =cut | ||
| 81 |