« blib/lib/Paws/SSOAdmin/UpdatePermissionSetResponse.pm
↑ Summary
blib/lib/Paws/SSOIdentityStore/DescribeGroup.pm »
| 1 | package Paws::SSOIdentityStore; | ||
| 2 | use Moose; | ||
| 3 | sub service { 'identitystore' } | ||
| 4 | sub signing_name { 'identitystore' } | ||
| 5 | sub version { '2020-06-15' } | ||
| 6 | sub target_prefix { 'AWSIdentityStore' } | ||
| 7 | sub json_version { "1.1" } | ||
| 8 | has max_attempts => (is => 'ro', isa => 'Int', default => 5); | ||
| 9 | has retry => (is => 'ro', isa => 'HashRef', default => sub { | ||
| 10 | { base => 'rand', type => 'exponential', growth_factor => 2 } | ||
| 11 | }); | ||
| 12 | has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [ | ||
| 13 | ] }); | ||
| 14 | |||
| 15 | with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::JsonCaller'; | ||
| 16 | |||
| 17 | |||
| 18 | sub DescribeGroup { | ||
| 19 | my $self = shift; | ||
| 20 | my $call_object = $self->new_with_coercions('Paws::SSOIdentityStore::DescribeGroup', @_); | ||
| 21 | return $self->caller->do_call($self, $call_object); | ||
| 22 | } | ||
| 23 | sub DescribeUser { | ||
| 24 | my $self = shift; | ||
| 25 | my $call_object = $self->new_with_coercions('Paws::SSOIdentityStore::DescribeUser', @_); | ||
| 26 | return $self->caller->do_call($self, $call_object); | ||
| 27 | } | ||
| 28 | sub ListGroups { | ||
| 29 | my $self = shift; | ||
| 30 | my $call_object = $self->new_with_coercions('Paws::SSOIdentityStore::ListGroups', @_); | ||
| 31 | return $self->caller->do_call($self, $call_object); | ||
| 32 | } | ||
| 33 | sub ListUsers { | ||
| 34 | my $self = shift; | ||
| 35 | my $call_object = $self->new_with_coercions('Paws::SSOIdentityStore::ListUsers', @_); | ||
| 36 | return $self->caller->do_call($self, $call_object); | ||
| 37 | } | ||
| 38 | |||
| 39 | |||
| 40 | |||
| 41 | sub operations { qw/DescribeGroup DescribeUser ListGroups ListUsers / } | ||
| 42 | |||
| 43 | 1; | ||
| 44 | |||
| 45 | ### main pod documentation begin ### | ||
| 46 | |||
| 47 | =head1 NAME | ||
| 48 | |||
| 49 | Paws::SSOIdentityStore - Perl Interface to AWS AWS SSO Identity Store | ||
| 50 | |||
| 51 | =head1 SYNOPSIS | ||
| 52 | |||
| 53 | use Paws; | ||
| 54 | |||
| 55 | my $obj = Paws->service('SSOIdentityStore'); | ||
| 56 | my $res = $obj->Method( | ||
| 57 | Arg1 => $val1, | ||
| 58 | Arg2 => [ 'V1', 'V2' ], | ||
| 59 | # if Arg3 is an object, the HashRef will be used as arguments to the constructor | ||
| 60 | # of the arguments type | ||
| 61 | Arg3 => { Att1 => 'Val1' }, | ||
| 62 | # if Arg4 is an array of objects, the HashRefs will be passed as arguments to | ||
| 63 | # the constructor of the arguments type | ||
| 64 | Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ], | ||
| 65 | ); | ||
| 66 | |||
| 67 | =head1 DESCRIPTION | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15> | ||
| 72 | |||
| 73 | |||
| 74 | =head1 METHODS | ||
| 75 | |||
| 76 | =head2 DescribeGroup | ||
| 77 | |||
| 78 | =over | ||
| 79 | |||
| 80 | =item GroupId => Str | ||
| 81 | |||
| 82 | =item IdentityStoreId => Str | ||
| 83 | |||
| 84 | |||
| 85 | =back | ||
| 86 | |||
| 87 | Each argument is described in detail in: L<Paws::SSOIdentityStore::DescribeGroup> | ||
| 88 | |||
| 89 | Returns: a L<Paws::SSOIdentityStore::DescribeGroupResponse> instance | ||
| 90 | |||
| 91 | Retrieves the group metadata and attributes from C<GroupId> in an | ||
| 92 | identity store. | ||
| 93 | |||
| 94 | |||
| 95 | =head2 DescribeUser | ||
| 96 | |||
| 97 | =over | ||
| 98 | |||
| 99 | =item IdentityStoreId => Str | ||
| 100 | |||
| 101 | =item UserId => Str | ||
| 102 | |||
| 103 | |||
| 104 | =back | ||
| 105 | |||
| 106 | Each argument is described in detail in: L<Paws::SSOIdentityStore::DescribeUser> | ||
| 107 | |||
| 108 | Returns: a L<Paws::SSOIdentityStore::DescribeUserResponse> instance | ||
| 109 | |||
| 110 | Retrieves the user metadata and attributes from C<UserId> in an | ||
| 111 | identity store. | ||
| 112 | |||
| 113 | |||
| 114 | =head2 ListGroups | ||
| 115 | |||
| 116 | =over | ||
| 117 | |||
| 118 | =item IdentityStoreId => Str | ||
| 119 | |||
| 120 | =item [Filters => ArrayRef[L<Paws::SSOIdentityStore::Filter>]] | ||
| 121 | |||
| 122 | =item [MaxResults => Int] | ||
| 123 | |||
| 124 | =item [NextToken => Str] | ||
| 125 | |||
| 126 | |||
| 127 | =back | ||
| 128 | |||
| 129 | Each argument is described in detail in: L<Paws::SSOIdentityStore::ListGroups> | ||
| 130 | |||
| 131 | Returns: a L<Paws::SSOIdentityStore::ListGroupsResponse> instance | ||
| 132 | |||
| 133 | Lists the attribute name and value of the group that you specified in | ||
| 134 | the search. We only support C<DisplayName> as a valid filter attribute | ||
| 135 | path currently, and filter is required. This API returns minimum | ||
| 136 | attributes, including C<GroupId> and group C<DisplayName> in the | ||
| 137 | response. | ||
| 138 | |||
| 139 | |||
| 140 | =head2 ListUsers | ||
| 141 | |||
| 142 | =over | ||
| 143 | |||
| 144 | =item IdentityStoreId => Str | ||
| 145 | |||
| 146 | =item [Filters => ArrayRef[L<Paws::SSOIdentityStore::Filter>]] | ||
| 147 | |||
| 148 | =item [MaxResults => Int] | ||
| 149 | |||
| 150 | =item [NextToken => Str] | ||
| 151 | |||
| 152 | |||
| 153 | =back | ||
| 154 | |||
| 155 | Each argument is described in detail in: L<Paws::SSOIdentityStore::ListUsers> | ||
| 156 | |||
| 157 | Returns: a L<Paws::SSOIdentityStore::ListUsersResponse> instance | ||
| 158 | |||
| 159 | Lists the attribute name and value of the user that you specified in | ||
| 160 | the search. We only support C<UserName> as a valid filter attribute | ||
| 161 | path currently, and filter is required. This API returns minimum | ||
| 162 | attributes, including C<UserId> and C<UserName> in the response. | ||
| 163 | |||
| 164 | |||
| 165 | |||
| 166 | |||
| 167 | =head1 PAGINATORS | ||
| 168 | |||
| 169 | Paginator methods are helpers that repetively call methods that return partial results | ||
| 170 | |||
| 171 | |||
| 172 | |||
| 173 | |||
| 174 | =head1 SEE ALSO | ||
| 175 | |||
| 176 | This service class forms part of L<Paws> | ||
| 177 | |||
| 178 | =head1 BUGS and CONTRIBUTIONS | ||
| 179 | |||
| 180 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 181 | |||
| 182 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 183 | |||
| 184 | =cut | ||
| 185 |