« blib/lib/Paws/IAM/GetOpenIDConnectProviderResponse.pm
↑ Summary
blib/lib/Paws/IAM/GetOrganizationsAccessReportResponse.pm »
| 1 | |||
| 2 | package Paws::IAM::GetOrganizationsAccessReport; | ||
| 3 | use Moose; | ||
| 4 | has JobId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has Marker => (is => 'ro', isa => 'Str'); | ||
| 6 | has MaxItems => (is => 'ro', isa => 'Int'); | ||
| 7 | has SortKey => (is => 'ro', isa => 'Str'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetOrganizationsAccessReport'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IAM::GetOrganizationsAccessReportResponse'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'GetOrganizationsAccessReportResult'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::IAM::GetOrganizationsAccessReport - Arguments for method GetOrganizationsAccessReport on L<Paws::IAM> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method GetOrganizationsAccessReport on the | ||
| 25 | L<AWS Identity and Access Management|Paws::IAM> service. Use the attributes of this class | ||
| 26 | as arguments to method GetOrganizationsAccessReport. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetOrganizationsAccessReport. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $iam = Paws->service('IAM'); | ||
| 33 | my $GetOrganizationsAccessReportResponse = | ||
| 34 | $iam->GetOrganizationsAccessReport( | ||
| 35 | JobId => 'MyjobIDType', | ||
| 36 | Marker => 'MymarkerType', # OPTIONAL | ||
| 37 | MaxItems => 1, # OPTIONAL | ||
| 38 | SortKey => 'SERVICE_NAMESPACE_ASCENDING', # OPTIONAL | ||
| 39 | ); | ||
| 40 | |||
| 41 | # Results: | ||
| 42 | my $AccessDetails = $GetOrganizationsAccessReportResponse->AccessDetails; | ||
| 43 | my $ErrorDetails = $GetOrganizationsAccessReportResponse->ErrorDetails; | ||
| 44 | my $IsTruncated = $GetOrganizationsAccessReportResponse->IsTruncated; | ||
| 45 | my $JobCompletionDate = | ||
| 46 | $GetOrganizationsAccessReportResponse->JobCompletionDate; | ||
| 47 | my $JobCreationDate = | ||
| 48 | $GetOrganizationsAccessReportResponse->JobCreationDate; | ||
| 49 | my $JobStatus = $GetOrganizationsAccessReportResponse->JobStatus; | ||
| 50 | my $Marker = $GetOrganizationsAccessReportResponse->Marker; | ||
| 51 | my $NumberOfServicesAccessible = | ||
| 52 | $GetOrganizationsAccessReportResponse->NumberOfServicesAccessible; | ||
| 53 | my $NumberOfServicesNotAccessed = | ||
| 54 | $GetOrganizationsAccessReportResponse->NumberOfServicesNotAccessed; | ||
| 55 | |||
| 56 | # Returns a L<Paws::IAM::GetOrganizationsAccessReportResponse> object. | ||
| 57 | |||
| 58 | 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. | ||
| 59 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iam/GetOrganizationsAccessReport> | ||
| 60 | |||
| 61 | =head1 ATTRIBUTES | ||
| 62 | |||
| 63 | |||
| 64 | =head2 B<REQUIRED> JobId => Str | ||
| 65 | |||
| 66 | The identifier of the request generated by the | ||
| 67 | GenerateOrganizationsAccessReport operation. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 Marker => Str | ||
| 72 | |||
| 73 | Use this parameter only when paginating results and only after you | ||
| 74 | receive a response indicating that the results are truncated. Set it to | ||
| 75 | the value of the C<Marker> element in the response that you received to | ||
| 76 | indicate where the next call should start. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 MaxItems => Int | ||
| 81 | |||
| 82 | Use this only when paginating results to indicate the maximum number of | ||
| 83 | items you want in the response. If additional items exist beyond the | ||
| 84 | maximum you specify, the C<IsTruncated> response element is C<true>. | ||
| 85 | |||
| 86 | If you do not include this parameter, the number of items defaults to | ||
| 87 | 100. Note that IAM might return fewer results, even when there are more | ||
| 88 | results available. In that case, the C<IsTruncated> response element | ||
| 89 | returns C<true>, and C<Marker> contains a value to include in the | ||
| 90 | subsequent call that tells the service where to continue from. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 SortKey => Str | ||
| 95 | |||
| 96 | The key that is used to sort the results. If you choose the namespace | ||
| 97 | key, the results are returned in alphabetical order. If you choose the | ||
| 98 | time key, the results are sorted numerically by the date and time. | ||
| 99 | |||
| 100 | Valid values are: C<"SERVICE_NAMESPACE_ASCENDING">, C<"SERVICE_NAMESPACE_DESCENDING">, C<"LAST_AUTHENTICATED_TIME_ASCENDING">, C<"LAST_AUTHENTICATED_TIME_DESCENDING"> | ||
| 101 | |||
| 102 | |||
| 103 | =head1 SEE ALSO | ||
| 104 | |||
| 105 | This class forms part of L<Paws>, documenting arguments for method GetOrganizationsAccessReport in L<Paws::IAM> | ||
| 106 | |||
| 107 | =head1 BUGS and CONTRIBUTIONS | ||
| 108 | |||
| 109 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 110 | |||
| 111 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 112 | |||
| 113 | =cut | ||
| 114 |