« blib/lib/Paws/Cloud9/DeleteEnvironmentResult.pm
↑ Summary
blib/lib/Paws/Cloud9/DescribeEnvironmentMembershipsResult.pm »
| 1 | |||
| 2 | package Paws::Cloud9::DescribeEnvironmentMemberships; | ||
| 3 | use Moose; | ||
| 4 | has EnvironmentId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'environmentId' ); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults' ); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken' ); | ||
| 7 | has Permissions => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'permissions' ); | ||
| 8 | has UserArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'userArn' ); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeEnvironmentMemberships'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Cloud9::DescribeEnvironmentMembershipsResult'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Cloud9::DescribeEnvironmentMemberships - Arguments for method DescribeEnvironmentMemberships on L<Paws::Cloud9> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method DescribeEnvironmentMemberships on the | ||
| 26 | L<AWS Cloud9|Paws::Cloud9> service. Use the attributes of this class | ||
| 27 | as arguments to method DescribeEnvironmentMemberships. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeEnvironmentMemberships. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $cloud9 = Paws->service('Cloud9'); | ||
| 34 | # DescribeEnvironmentMemberships1 | ||
| 35 | # The following example gets information about all of the environment members | ||
| 36 | # for the specified AWS Cloud9 development environment. | ||
| 37 | my $DescribeEnvironmentMembershipsResult = | ||
| 38 | $cloud9->DescribeEnvironmentMemberships( | ||
| 39 | 'EnvironmentId' => '8d9967e2f0624182b74e7690ad69ebEX' ); | ||
| 40 | |||
| 41 | # Results: | ||
| 42 | my $memberships = $DescribeEnvironmentMembershipsResult->memberships; | ||
| 43 | |||
| 44 | # Returns a L<Paws::Cloud9::DescribeEnvironmentMembershipsResult> object. | ||
| 45 | # DescribeEnvironmentMemberships2 | ||
| 46 | # The following example gets information about the owner of the specified AWS | ||
| 47 | # Cloud9 development environment. | ||
| 48 | my $DescribeEnvironmentMembershipsResult = | ||
| 49 | $cloud9->DescribeEnvironmentMemberships( | ||
| 50 | 'EnvironmentId' => '8d9967e2f0624182b74e7690ad69ebEX', | ||
| 51 | 'Permissions' => ['owner'] | ||
| 52 | ); | ||
| 53 | |||
| 54 | # Results: | ||
| 55 | my $memberships = $DescribeEnvironmentMembershipsResult->memberships; | ||
| 56 | |||
| 57 | # Returns a L<Paws::Cloud9::DescribeEnvironmentMembershipsResult> object. | ||
| 58 | # DescribeEnvironmentMemberships3 | ||
| 59 | # The following example gets AWS Cloud9 development environment membership | ||
| 60 | # information for the specified user. | ||
| 61 | my $DescribeEnvironmentMembershipsResult = | ||
| 62 | $cloud9->DescribeEnvironmentMemberships( | ||
| 63 | 'UserArn' => 'arn:aws:iam::123456789012:user/MyDemoUser' ); | ||
| 64 | |||
| 65 | # Results: | ||
| 66 | my $memberships = $DescribeEnvironmentMembershipsResult->memberships; | ||
| 67 | |||
| 68 | # Returns a L<Paws::Cloud9::DescribeEnvironmentMembershipsResult> object. | ||
| 69 | |||
| 70 | 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. | ||
| 71 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/cloud9/DescribeEnvironmentMemberships> | ||
| 72 | |||
| 73 | =head1 ATTRIBUTES | ||
| 74 | |||
| 75 | |||
| 76 | =head2 EnvironmentId => Str | ||
| 77 | |||
| 78 | The ID of the environment to get environment member information about. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 MaxResults => Int | ||
| 83 | |||
| 84 | The maximum number of environment members to get information about. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 NextToken => Str | ||
| 89 | |||
| 90 | During a previous call, if there are more than 25 items in the list, | ||
| 91 | only the first 25 items are returned, along with a unique string called | ||
| 92 | a I<next token>. To get the next batch of items in the list, call this | ||
| 93 | operation again, adding the next token to the call. To get all of the | ||
| 94 | items in the list, keep calling this operation with each subsequent | ||
| 95 | next token that is returned, until no more next tokens are returned. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 Permissions => ArrayRef[Str|Undef] | ||
| 100 | |||
| 101 | The type of environment member permissions to get information about. | ||
| 102 | Available values include: | ||
| 103 | |||
| 104 | =over | ||
| 105 | |||
| 106 | =item * | ||
| 107 | |||
| 108 | C<owner>: Owns the environment. | ||
| 109 | |||
| 110 | =item * | ||
| 111 | |||
| 112 | C<read-only>: Has read-only access to the environment. | ||
| 113 | |||
| 114 | =item * | ||
| 115 | |||
| 116 | C<read-write>: Has read-write access to the environment. | ||
| 117 | |||
| 118 | =back | ||
| 119 | |||
| 120 | If no value is specified, information about all environment members are | ||
| 121 | returned. | ||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | =head2 UserArn => Str | ||
| 126 | |||
| 127 | The Amazon Resource Name (ARN) of an individual environment member to | ||
| 128 | get information about. If no value is specified, information about all | ||
| 129 | environment members are returned. | ||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | =head1 SEE ALSO | ||
| 135 | |||
| 136 | This class forms part of L<Paws>, documenting arguments for method DescribeEnvironmentMemberships in L<Paws::Cloud9> | ||
| 137 | |||
| 138 | =head1 BUGS and CONTRIBUTIONS | ||
| 139 | |||
| 140 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 141 | |||
| 142 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 143 | |||
| 144 | =cut | ||
| 145 |