« blib/lib/Paws/IoTSiteWise/CreateGatewayResponse.pm
↑ Summary
blib/lib/Paws/IoTSiteWise/CreatePortalResponse.pm »
| 1 | |||
| 2 | package Paws::IoTSiteWise::CreatePortal; | ||
| 3 | use Moose; | ||
| 4 | has Alarms => (is => 'ro', isa => 'Paws::IoTSiteWise::Alarms', traits => ['NameInRequest'], request_name => 'alarms'); | ||
| 5 | has ClientToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientToken'); | ||
| 6 | has NotificationSenderEmail => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'notificationSenderEmail'); | ||
| 7 | has PortalAuthMode => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'portalAuthMode'); | ||
| 8 | has PortalContactEmail => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'portalContactEmail', required => 1); | ||
| 9 | has PortalDescription => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'portalDescription'); | ||
| 10 | has PortalLogoImageFile => (is => 'ro', isa => 'Paws::IoTSiteWise::ImageFile', traits => ['NameInRequest'], request_name => 'portalLogoImageFile'); | ||
| 11 | has PortalName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'portalName', required => 1); | ||
| 12 | has RoleArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'roleArn', required => 1); | ||
| 13 | has Tags => (is => 'ro', isa => 'Paws::IoTSiteWise::TagMap', traits => ['NameInRequest'], request_name => 'tags'); | ||
| 14 | |||
| 15 | use MooseX::ClassAttribute; | ||
| 16 | |||
| 17 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreatePortal'); | ||
| 18 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/portals'); | ||
| 19 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 20 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoTSiteWise::CreatePortalResponse'); | ||
| 21 | 1; | ||
| 22 | |||
| 23 | ### main pod documentation begin ### | ||
| 24 | |||
| 25 | =head1 NAME | ||
| 26 | |||
| 27 | Paws::IoTSiteWise::CreatePortal - Arguments for method CreatePortal on L<Paws::IoTSiteWise> | ||
| 28 | |||
| 29 | =head1 DESCRIPTION | ||
| 30 | |||
| 31 | This class represents the parameters used for calling the method CreatePortal on the | ||
| 32 | L<AWS IoT SiteWise|Paws::IoTSiteWise> service. Use the attributes of this class | ||
| 33 | as arguments to method CreatePortal. | ||
| 34 | |||
| 35 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreatePortal. | ||
| 36 | |||
| 37 | =head1 SYNOPSIS | ||
| 38 | |||
| 39 | my $iotsitewise = Paws->service('IoTSiteWise'); | ||
| 40 | my $CreatePortalResponse = $iotsitewise->CreatePortal( | ||
| 41 | PortalContactEmail => 'MyEmail', | ||
| 42 | PortalName => 'MyName', | ||
| 43 | RoleArn => 'MyARN', | ||
| 44 | Alarms => { | ||
| 45 | AlarmRoleArn => 'MyARN', # min: 1, max: 1600 | ||
| 46 | NotificationLambdaArn => 'MyARN', # min: 1, max: 1600 | ||
| 47 | }, # OPTIONAL | ||
| 48 | ClientToken => 'MyClientToken', # OPTIONAL | ||
| 49 | NotificationSenderEmail => 'MyEmail', # OPTIONAL | ||
| 50 | PortalAuthMode => 'IAM', # OPTIONAL | ||
| 51 | PortalDescription => 'MyDescription', # OPTIONAL | ||
| 52 | PortalLogoImageFile => { | ||
| 53 | Data => 'BlobImageFileData', # min: 1, max: 1500000 | ||
| 54 | Type => 'PNG', # values: PNG | ||
| 55 | |||
| 56 | }, # OPTIONAL | ||
| 57 | Tags => { | ||
| 58 | 'MyTagKey' => 'MyTagValue', # key: min: 1, max: 128, value: max: 256 | ||
| 59 | }, # OPTIONAL | ||
| 60 | ); | ||
| 61 | |||
| 62 | # Results: | ||
| 63 | my $PortalArn = $CreatePortalResponse->PortalArn; | ||
| 64 | my $PortalId = $CreatePortalResponse->PortalId; | ||
| 65 | my $PortalStartUrl = $CreatePortalResponse->PortalStartUrl; | ||
| 66 | my $PortalStatus = $CreatePortalResponse->PortalStatus; | ||
| 67 | my $SsoApplicationId = $CreatePortalResponse->SsoApplicationId; | ||
| 68 | |||
| 69 | # Returns a L<Paws::IoTSiteWise::CreatePortalResponse> object. | ||
| 70 | |||
| 71 | 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. | ||
| 72 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iotsitewise/CreatePortal> | ||
| 73 | |||
| 74 | =head1 ATTRIBUTES | ||
| 75 | |||
| 76 | |||
| 77 | =head2 Alarms => L<Paws::IoTSiteWise::Alarms> | ||
| 78 | |||
| 79 | Contains the configuration information of an alarm created in an AWS | ||
| 80 | IoT SiteWise Monitor portal. You can use the alarm to monitor an asset | ||
| 81 | property and get notified when the asset property value is outside a | ||
| 82 | specified range. For more information, see . | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 ClientToken => Str | ||
| 87 | |||
| 88 | A unique case-sensitive identifier that you can provide to ensure the | ||
| 89 | idempotency of the request. Don't reuse this client token if a new | ||
| 90 | idempotent request is required. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 NotificationSenderEmail => Str | ||
| 95 | |||
| 96 | The email address that sends alarm notifications. | ||
| 97 | |||
| 98 | If you use the AWS IoT Events managed AWS Lambda function to manage | ||
| 99 | your emails, you must verify the sender email address in Amazon SES | ||
| 100 | (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html). | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | =head2 PortalAuthMode => Str | ||
| 105 | |||
| 106 | The service to use to authenticate users to the portal. Choose from the | ||
| 107 | following options: | ||
| 108 | |||
| 109 | =over | ||
| 110 | |||
| 111 | =item * | ||
| 112 | |||
| 113 | C<SSO> E<ndash> The portal uses AWS Single Sign-On to authenticate | ||
| 114 | users and manage user permissions. Before you can create a portal that | ||
| 115 | uses AWS SSO, you must enable AWS SSO. For more information, see | ||
| 116 | Enabling AWS SSO | ||
| 117 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso) | ||
| 118 | in the I<AWS IoT SiteWise User Guide>. This option is only available in | ||
| 119 | AWS Regions other than the China Regions. | ||
| 120 | |||
| 121 | =item * | ||
| 122 | |||
| 123 | C<IAM> E<ndash> The portal uses AWS Identity and Access Management | ||
| 124 | (IAM) to authenticate users and manage user permissions. This option is | ||
| 125 | only available in the China Regions. | ||
| 126 | |||
| 127 | =back | ||
| 128 | |||
| 129 | You can't change this value after you create a portal. | ||
| 130 | |||
| 131 | Default: C<SSO> | ||
| 132 | |||
| 133 | Valid values are: C<"IAM">, C<"SSO"> | ||
| 134 | |||
| 135 | =head2 B<REQUIRED> PortalContactEmail => Str | ||
| 136 | |||
| 137 | The AWS administrator's contact email address. | ||
| 138 | |||
| 139 | |||
| 140 | |||
| 141 | =head2 PortalDescription => Str | ||
| 142 | |||
| 143 | A description for the portal. | ||
| 144 | |||
| 145 | |||
| 146 | |||
| 147 | =head2 PortalLogoImageFile => L<Paws::IoTSiteWise::ImageFile> | ||
| 148 | |||
| 149 | A logo image to display in the portal. Upload a square, high-resolution | ||
| 150 | image. The image is displayed on a dark background. | ||
| 151 | |||
| 152 | |||
| 153 | |||
| 154 | =head2 B<REQUIRED> PortalName => Str | ||
| 155 | |||
| 156 | A friendly name for the portal. | ||
| 157 | |||
| 158 | |||
| 159 | |||
| 160 | =head2 B<REQUIRED> RoleArn => Str | ||
| 161 | |||
| 162 | The ARN | ||
| 163 | (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) | ||
| 164 | of a service role that allows the portal's users to access your AWS IoT | ||
| 165 | SiteWise resources on your behalf. For more information, see Using | ||
| 166 | service roles for AWS IoT SiteWise Monitor | ||
| 167 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html) | ||
| 168 | in the I<AWS IoT SiteWise User Guide>. | ||
| 169 | |||
| 170 | |||
| 171 | |||
| 172 | =head2 Tags => L<Paws::IoTSiteWise::TagMap> | ||
| 173 | |||
| 174 | A list of key-value pairs that contain metadata for the portal. For | ||
| 175 | more information, see Tagging your AWS IoT SiteWise resources | ||
| 176 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) | ||
| 177 | in the I<AWS IoT SiteWise User Guide>. | ||
| 178 | |||
| 179 | |||
| 180 | |||
| 181 | |||
| 182 | =head1 SEE ALSO | ||
| 183 | |||
| 184 | This class forms part of L<Paws>, documenting arguments for method CreatePortal in L<Paws::IoTSiteWise> | ||
| 185 | |||
| 186 | =head1 BUGS and CONTRIBUTIONS | ||
| 187 | |||
| 188 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 189 | |||
| 190 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 191 | |||
| 192 | =cut | ||
| 193 |