« blib/lib/Paws/IoTSiteWise/ConfigurationStatus.pm
↑ Summary
blib/lib/Paws/IoTSiteWise/CreateAccessPolicyResponse.pm »
| 1 | |||
| 2 | package Paws::IoTSiteWise::CreateAccessPolicy; | ||
| 3 | use Moose; | ||
| 4 | has AccessPolicyIdentity => (is => 'ro', isa => 'Paws::IoTSiteWise::Identity', traits => ['NameInRequest'], request_name => 'accessPolicyIdentity', required => 1); | ||
| 5 | has AccessPolicyPermission => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'accessPolicyPermission', required => 1); | ||
| 6 | has AccessPolicyResource => (is => 'ro', isa => 'Paws::IoTSiteWise::Resource', traits => ['NameInRequest'], request_name => 'accessPolicyResource', required => 1); | ||
| 7 | has ClientToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientToken'); | ||
| 8 | has Tags => (is => 'ro', isa => 'Paws::IoTSiteWise::TagMap', traits => ['NameInRequest'], request_name => 'tags'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateAccessPolicy'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/access-policies'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoTSiteWise::CreateAccessPolicyResponse'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::IoTSiteWise::CreateAccessPolicy - Arguments for method CreateAccessPolicy on L<Paws::IoTSiteWise> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method CreateAccessPolicy on the | ||
| 27 | L<AWS IoT SiteWise|Paws::IoTSiteWise> service. Use the attributes of this class | ||
| 28 | as arguments to method CreateAccessPolicy. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateAccessPolicy. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $iotsitewise = Paws->service('IoTSiteWise'); | ||
| 35 | my $CreateAccessPolicyResponse = $iotsitewise->CreateAccessPolicy( | ||
| 36 | AccessPolicyIdentity => { | ||
| 37 | Group => { | ||
| 38 | Id => 'MyIdentityId', # min: 1, max: 256 | ||
| 39 | |||
| 40 | }, # OPTIONAL | ||
| 41 | IamRole => { | ||
| 42 | Arn => 'MyARN', # min: 1, max: 1600 | ||
| 43 | |||
| 44 | }, # OPTIONAL | ||
| 45 | IamUser => { | ||
| 46 | Arn => 'MyARN', # min: 1, max: 1600 | ||
| 47 | |||
| 48 | }, # OPTIONAL | ||
| 49 | User => { | ||
| 50 | Id => 'MyIdentityId', # min: 1, max: 256 | ||
| 51 | |||
| 52 | }, # OPTIONAL | ||
| 53 | }, | ||
| 54 | AccessPolicyPermission => 'ADMINISTRATOR', | ||
| 55 | AccessPolicyResource => { | ||
| 56 | Portal => { | ||
| 57 | Id => 'MyID', # min: 36, max: 36 | ||
| 58 | |||
| 59 | }, # OPTIONAL | ||
| 60 | Project => { | ||
| 61 | Id => 'MyID', # min: 36, max: 36 | ||
| 62 | |||
| 63 | }, # OPTIONAL | ||
| 64 | }, | ||
| 65 | ClientToken => 'MyClientToken', # OPTIONAL | ||
| 66 | Tags => { | ||
| 67 | 'MyTagKey' => 'MyTagValue', # key: min: 1, max: 128, value: max: 256 | ||
| 68 | }, # OPTIONAL | ||
| 69 | ); | ||
| 70 | |||
| 71 | # Results: | ||
| 72 | my $AccessPolicyArn = $CreateAccessPolicyResponse->AccessPolicyArn; | ||
| 73 | my $AccessPolicyId = $CreateAccessPolicyResponse->AccessPolicyId; | ||
| 74 | |||
| 75 | # Returns a L<Paws::IoTSiteWise::CreateAccessPolicyResponse> object. | ||
| 76 | |||
| 77 | 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. | ||
| 78 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iotsitewise/CreateAccessPolicy> | ||
| 79 | |||
| 80 | =head1 ATTRIBUTES | ||
| 81 | |||
| 82 | |||
| 83 | =head2 B<REQUIRED> AccessPolicyIdentity => L<Paws::IoTSiteWise::Identity> | ||
| 84 | |||
| 85 | The identity for this access policy. Choose an AWS SSO user, an AWS SSO | ||
| 86 | group, or an IAM user. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 B<REQUIRED> AccessPolicyPermission => Str | ||
| 91 | |||
| 92 | The permission level for this access policy. Note that a project | ||
| 93 | C<ADMINISTRATOR> is also known as a project owner. | ||
| 94 | |||
| 95 | Valid values are: C<"ADMINISTRATOR">, C<"VIEWER"> | ||
| 96 | |||
| 97 | =head2 B<REQUIRED> AccessPolicyResource => L<Paws::IoTSiteWise::Resource> | ||
| 98 | |||
| 99 | The AWS IoT SiteWise Monitor resource for this access policy. Choose | ||
| 100 | either a portal or a project. | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | =head2 ClientToken => Str | ||
| 105 | |||
| 106 | A unique case-sensitive identifier that you can provide to ensure the | ||
| 107 | idempotency of the request. Don't reuse this client token if a new | ||
| 108 | idempotent request is required. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head2 Tags => L<Paws::IoTSiteWise::TagMap> | ||
| 113 | |||
| 114 | A list of key-value pairs that contain metadata for the access policy. | ||
| 115 | For more information, see Tagging your AWS IoT SiteWise resources | ||
| 116 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) | ||
| 117 | in the I<AWS IoT SiteWise User Guide>. | ||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | =head1 SEE ALSO | ||
| 123 | |||
| 124 | This class forms part of L<Paws>, documenting arguments for method CreateAccessPolicy in L<Paws::IoTSiteWise> | ||
| 125 | |||
| 126 | =head1 BUGS and CONTRIBUTIONS | ||
| 127 | |||
| 128 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 129 | |||
| 130 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 131 | |||
| 132 | =cut | ||
| 133 |