« blib/lib/Paws/Quicksight/CreateGroupResponse.pm
↑ Summary
blib/lib/Paws/Quicksight/CreateIAMPolicyAssignmentResponse.pm »
| 1 | |||
| 2 | package Paws::Quicksight::CreateIAMPolicyAssignment; | ||
| 3 | use Moose; | ||
| 4 | has AssignmentName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has AssignmentStatus => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has AwsAccountId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'AwsAccountId', required => 1); | ||
| 7 | has Identities => (is => 'ro', isa => 'Paws::Quicksight::IdentityMap'); | ||
| 8 | has Namespace => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'Namespace', required => 1); | ||
| 9 | has PolicyArn => (is => 'ro', isa => 'Str'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateIAMPolicyAssignment'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments/'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Quicksight::CreateIAMPolicyAssignmentResponse'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::Quicksight::CreateIAMPolicyAssignment - Arguments for method CreateIAMPolicyAssignment on L<Paws::Quicksight> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method CreateIAMPolicyAssignment on the | ||
| 28 | L<Amazon QuickSight|Paws::Quicksight> service. Use the attributes of this class | ||
| 29 | as arguments to method CreateIAMPolicyAssignment. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateIAMPolicyAssignment. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $quicksight = Paws->service('Quicksight'); | ||
| 36 | my $CreateIAMPolicyAssignmentResponse = | ||
| 37 | $quicksight->CreateIAMPolicyAssignment( | ||
| 38 | AssignmentName => 'MyIAMPolicyAssignmentName', | ||
| 39 | AssignmentStatus => 'ENABLED', | ||
| 40 | AwsAccountId => 'MyAwsAccountId', | ||
| 41 | Namespace => 'MyNamespace', | ||
| 42 | Identities => { | ||
| 43 | 'MyString' => [ | ||
| 44 | 'MyIdentityName', ... # min: 1 | ||
| 45 | ], | ||
| 46 | }, # OPTIONAL | ||
| 47 | PolicyArn => 'MyArn', # OPTIONAL | ||
| 48 | ); | ||
| 49 | |||
| 50 | # Results: | ||
| 51 | my $AssignmentId = $CreateIAMPolicyAssignmentResponse->AssignmentId; | ||
| 52 | my $AssignmentName = $CreateIAMPolicyAssignmentResponse->AssignmentName; | ||
| 53 | my $AssignmentStatus = $CreateIAMPolicyAssignmentResponse->AssignmentStatus; | ||
| 54 | my $Identities = $CreateIAMPolicyAssignmentResponse->Identities; | ||
| 55 | my $PolicyArn = $CreateIAMPolicyAssignmentResponse->PolicyArn; | ||
| 56 | my $RequestId = $CreateIAMPolicyAssignmentResponse->RequestId; | ||
| 57 | my $Status = $CreateIAMPolicyAssignmentResponse->Status; | ||
| 58 | |||
| 59 | # Returns a L<Paws::Quicksight::CreateIAMPolicyAssignmentResponse> object. | ||
| 60 | |||
| 61 | 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. | ||
| 62 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/quicksight/CreateIAMPolicyAssignment> | ||
| 63 | |||
| 64 | =head1 ATTRIBUTES | ||
| 65 | |||
| 66 | |||
| 67 | =head2 B<REQUIRED> AssignmentName => Str | ||
| 68 | |||
| 69 | The name of the assignment, also called a rule. It must be unique | ||
| 70 | within an AWS account. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 B<REQUIRED> AssignmentStatus => Str | ||
| 75 | |||
| 76 | The status of the assignment. Possible values are as follows: | ||
| 77 | |||
| 78 | =over | ||
| 79 | |||
| 80 | =item * | ||
| 81 | |||
| 82 | C<ENABLED> - Anything specified in this assignment is used when | ||
| 83 | creating the data source. | ||
| 84 | |||
| 85 | =item * | ||
| 86 | |||
| 87 | C<DISABLED> - This assignment isn't used when creating the data source. | ||
| 88 | |||
| 89 | =item * | ||
| 90 | |||
| 91 | C<DRAFT> - This assignment is an unfinished draft and isn't used when | ||
| 92 | creating the data source. | ||
| 93 | |||
| 94 | =back | ||
| 95 | |||
| 96 | |||
| 97 | Valid values are: C<"ENABLED">, C<"DRAFT">, C<"DISABLED"> | ||
| 98 | |||
| 99 | =head2 B<REQUIRED> AwsAccountId => Str | ||
| 100 | |||
| 101 | The ID of the AWS account where you want to assign an IAM policy to | ||
| 102 | QuickSight users or groups. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head2 Identities => L<Paws::Quicksight::IdentityMap> | ||
| 107 | |||
| 108 | The QuickSight users, groups, or both that you want to assign the | ||
| 109 | policy to. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head2 B<REQUIRED> Namespace => Str | ||
| 114 | |||
| 115 | The namespace that contains the assignment. | ||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | =head2 PolicyArn => Str | ||
| 120 | |||
| 121 | The ARN for the IAM policy to apply to the QuickSight users and groups | ||
| 122 | specified in this assignment. | ||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | =head1 SEE ALSO | ||
| 128 | |||
| 129 | This class forms part of L<Paws>, documenting arguments for method CreateIAMPolicyAssignment in L<Paws::Quicksight> | ||
| 130 | |||
| 131 | =head1 BUGS and CONTRIBUTIONS | ||
| 132 | |||
| 133 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 134 | |||
| 135 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 136 | |||
| 137 | =cut | ||
| 138 |